From ab3f9082217dc4cf008bc879a6665044aa616ec6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Thu, 13 Sep 2018 11:06:52 +0200 Subject: [PATCH] classref: Add property overview and setter/getter like in editor docs Output from godotengine/godot#22013. Fixes #1729. --- classes/class_@gdscript.rst | 168 +- classes/class_@globalscope.rst | 166 +- classes/class_aabb.rst | 66 +- classes/class_acceptdialog.rst | 46 +- classes/class_animatedsprite.rst | 115 +- classes/class_animatedsprite3d.rst | 57 +- classes/class_animatedtexture.rst | 4117 +++++++++++++++++ classes/class_animation.rst | 162 +- classes/class_animationnode.rst | 51 +- classes/class_animationnodeadd2.rst | 13 + classes/class_animationnodeadd3.rst | 13 + classes/class_animationnodeanimation.rst | 16 +- classes/class_animationnodeblend2.rst | 13 + classes/class_animationnodeblend3.rst | 13 + classes/class_animationnodeblendspace1d.rst | 52 +- classes/class_animationnodeblendspace2d.rst | 76 +- classes/class_animationnodeblendtree.rst | 33 +- classes/class_animationnodeoneshot.rst | 61 +- classes/class_animationnodeoutput.rst | 1 + classes/class_animationnodestatemachine.rst | 46 +- ...lass_animationnodestatemachineplayback.rst | 14 +- ...ss_animationnodestatemachinetransition.rst | 59 +- classes/class_animationnodetimescale.rst | 1 + classes/class_animationnodetimeseek.rst | 1 + classes/class_animationnodetransition.rst | 533 +++ classes/class_animationplayer.rst | 177 +- classes/class_animationrootnode.rst | 2 + classes/class_animationtrackeditplugin.rst | 1 + classes/class_animationtree.rst | 55 +- classes/class_animationtreeplayer.rst | 173 +- classes/class_area.rst | 258 +- classes/class_area2d.rst | 210 +- classes/class_array.rst | 73 +- classes/class_arraymesh.rst | 68 +- classes/class_arvranchor.rst | 26 +- classes/class_arvrcamera.rst | 1 + classes/class_arvrcontroller.rst | 47 +- classes/class_arvrinterface.rst | 64 +- classes/class_arvrinterfacegdnative.rst | 1 + classes/class_arvrorigin.rst | 19 +- classes/class_arvrpositionaltracker.rst | 39 +- classes/class_arvrserver.rst | 64 +- classes/class_astar.rst | 42 +- classes/class_atlastexture.rst | 53 +- classes/class_audiobuslayout.rst | 1 + classes/class_audioeffect.rst | 2 + classes/class_audioeffectamplify.rst | 17 +- classes/class_audioeffectbandlimitfilter.rst | 1 + classes/class_audioeffectbandpassfilter.rst | 1 + classes/class_audioeffectchorus.rst | 329 +- classes/class_audioeffectcompressor.rst | 89 +- classes/class_audioeffectdelay.rst | 161 +- classes/class_audioeffectdistortion.rst | 68 +- classes/class_audioeffecteq.rst | 9 +- classes/class_audioeffecteq10.rst | 1 + classes/class_audioeffecteq21.rst | 1 + classes/class_audioeffecteq6.rst | 1 + classes/class_audioeffectfilter.rst | 53 +- classes/class_audioeffecthighpassfilter.rst | 1 + classes/class_audioeffecthighshelffilter.rst | 1 + classes/class_audioeffectlimiter.rst | 49 +- classes/class_audioeffectlowpassfilter.rst | 1 + classes/class_audioeffectlowshelffilter.rst | 1 + classes/class_audioeffectnotchfilter.rst | 1 + classes/class_audioeffectpanner.rst | 17 +- classes/class_audioeffectphaser.rst | 65 +- classes/class_audioeffectpitchshift.rst | 17 +- classes/class_audioeffectrecord.rst | 20 +- classes/class_audioeffectreverb.rst | 101 +- classes/class_audioeffectstereoenhance.rst | 29 + classes/class_audioserver.rst | 87 +- classes/class_audiostream.rst | 6 +- classes/class_audiostreammicrophone.rst | 1 + classes/class_audiostreamoggvorbis.rst | 33 +- classes/class_audiostreamplayback.rst | 1 + classes/class_audiostreamplayer.rst | 111 +- classes/class_audiostreamplayer2d.rst | 132 +- classes/class_audiostreamplayer3d.rst | 247 +- classes/class_audiostreamrandompitch.rst | 29 +- classes/class_audiostreamsample.rst | 97 +- classes/class_backbuffercopy.rst | 32 +- classes/class_bakedlightmap.rst | 130 +- classes/class_bakedlightmapdata.rst | 56 +- classes/class_basebutton.rst | 125 +- classes/class_basis.rst | 62 +- classes/class_bitmap.rst | 20 +- classes/class_bitmapfont.rst | 72 +- classes/class_bone2d.rst | 28 +- classes/class_boneattachment.rst | 17 +- classes/class_bool.rst | 7 +- classes/class_boxcontainer.rst | 24 +- classes/class_boxshape.rst | 17 +- .../class_bulletphysicsdirectbodystate.rst | 1 + classes/class_bulletphysicsserver.rst | 1 + classes/class_button.rst | 96 +- classes/class_buttongroup.rst | 11 +- classes/class_camera.rst | 184 +- classes/class_camera2d.rst | 309 +- classes/class_canvasitem.rst | 201 +- classes/class_canvasitemmaterial.rst | 34 +- classes/class_canvaslayer.rst | 94 +- classes/class_canvasmodulate.rst | 17 +- classes/class_capsulemesh.rst | 53 +- classes/class_capsuleshape.rst | 29 +- classes/class_capsuleshape2d.rst | 29 +- classes/class_centercontainer.rst | 17 +- classes/class_checkbox.rst | 38 + classes/class_checkbutton.rst | 34 + classes/class_circleshape2d.rst | 17 +- classes/class_classdb.rst | 42 +- classes/class_clippedcamera.rst | 63 +- classes/class_collisionobject.rst | 72 +- classes/class_collisionobject2d.rst | 64 +- classes/class_collisionpolygon.rst | 41 +- classes/class_collisionpolygon2d.rst | 56 +- classes/class_collisionshape.rst | 35 +- classes/class_collisionshape2d.rst | 42 +- classes/class_color.rst | 110 +- classes/class_colorpicker.rst | 84 +- classes/class_colorpickerbutton.rst | 70 +- classes/class_colorrect.rst | 19 +- classes/class_concavepolygonshape.rst | 6 +- classes/class_concavepolygonshape2d.rst | 17 +- classes/class_conetwistjoint.rst | 58 +- classes/class_configfile.rst | 20 +- classes/class_confirmationdialog.rst | 5 +- classes/class_container.rst | 11 +- classes/class_control.rst | 521 ++- classes/class_convexpolygonshape.rst | 17 +- classes/class_convexpolygonshape2d.rst | 20 +- classes/class_cpuparticles.rst | 499 +- classes/class_cpuparticles2d.rst | 491 +- classes/class_csgbox.rst | 53 +- classes/class_csgcombiner.rst | 1 + classes/class_csgcylinder.rst | 77 +- classes/class_csgmesh.rst | 17 +- classes/class_csgpolygon.rst | 166 +- classes/class_csgprimitive.rst | 18 +- classes/class_csgshape.rst | 44 +- classes/class_csgsphere.rst | 65 +- classes/class_csgtorus.rst | 77 +- classes/class_csharpscript.rst | 4 +- classes/class_cubemap.rst | 57 +- classes/class_cubemesh.rst | 53 +- classes/class_curve.rst | 86 +- classes/class_curve2d.rst | 54 +- classes/class_curve3d.rst | 76 +- classes/class_curvetexture.rst | 29 +- classes/class_cylindermesh.rst | 65 +- classes/class_cylindershape.rst | 29 +- classes/class_dampedspringjoint2d.rst | 53 +- classes/class_dictionary.rst | 21 +- classes/class_directionallight.rst | 119 +- classes/class_directory.rst | 39 +- classes/class_dynamicfont.rst | 131 +- classes/class_dynamicfontdata.rst | 32 +- classes/class_editorexportplugin.rst | 22 +- classes/class_editorfiledialog.rst | 124 +- classes/class_editorfilesystem.rst | 29 +- classes/class_editorfilesystemdirectory.rst | 32 +- classes/class_editorimportplugin.rst | 27 +- classes/class_editorinspector.rst | 17 +- classes/class_editorinspectorplugin.rst | 18 +- classes/class_editorinterface.rst | 42 +- classes/class_editorplugin.rst | 115 +- classes/class_editorproperty.rst | 79 +- .../class_editorresourceconversionplugin.rst | 6 +- classes/class_editorresourcepreview.rst | 15 +- .../class_editorresourcepreviewgenerator.rst | 8 +- classes/class_editorsceneimporter.rst | 15 +- classes/class_editorscenepostimport.rst | 9 +- classes/class_editorscript.rst | 10 +- classes/class_editorselection.rst | 15 +- classes/class_editorsettings.rst | 37 +- classes/class_editorspatialgizmo.rst | 30 +- classes/class_encodedobjectasid.rst | 6 +- classes/class_engine.rst | 86 +- classes/class_environment.rst | 879 +++- classes/class_expression.rst | 10 +- classes/class_file.rst | 112 +- classes/class_filedialog.rst | 123 +- classes/class_float.rst | 7 +- classes/class_font.rst | 21 +- classes/class_funcref.rst | 8 +- classes/class_gdnative.rst | 20 +- classes/class_gdnativelibrary.rst | 50 +- classes/class_gdscript.rst | 7 +- classes/class_gdscriptfunctionstate.rst | 9 +- classes/class_gdscriptnativeclass.rst | 4 +- classes/class_generic6dofjoint.rst | 694 ++- classes/class_geometry.rst | 48 +- classes/class_geometryinstance.rst | 107 +- classes/class_giprobe.rst | 94 +- classes/class_giprobedata.rst | 93 + classes/class_godotsharp.rst | 10 +- classes/class_gradient.rst | 46 +- classes/class_gradienttexture.rst | 29 +- classes/class_graphedit.rst | 146 +- classes/class_graphnode.rst | 153 +- classes/class_gridcontainer.rst | 29 +- classes/class_gridmap.rst | 154 +- classes/class_groovejoint2d.rst | 29 +- classes/class_hboxcontainer.rst | 8 + classes/class_hingejoint.rst | 114 +- classes/class_hscrollbar.rst | 24 + classes/class_hseparator.rst | 10 + classes/class_hslider.rst | 24 + classes/class_hsplitcontainer.rst | 14 + classes/class_httpclient.rst | 68 +- classes/class_httprequest.rst | 71 +- classes/class_image.rst | 123 +- classes/class_imagetexture.rst | 45 +- classes/class_immediategeometry.rst | 22 +- classes/class_input.rst | 86 +- classes/class_inputdefault.rst | 1 + classes/class_inputevent.rst | 40 +- classes/class_inputeventaction.rst | 30 +- classes/class_inputeventgesture.rst | 14 + classes/class_inputeventjoypadbutton.rst | 42 +- classes/class_inputeventjoypadmotion.rst | 30 +- classes/class_inputeventkey.rst | 57 +- classes/class_inputeventmagnifygesture.rst | 13 + classes/class_inputeventmouse.rst | 43 +- classes/class_inputeventmousebutton.rst | 54 +- classes/class_inputeventmousemotion.rst | 30 +- classes/class_inputeventpangesture.rst | 13 + classes/class_inputeventscreendrag.rst | 54 +- classes/class_inputeventscreentouch.rst | 42 +- classes/class_inputeventwithmodifiers.rst | 67 +- classes/class_inputmap.rst | 27 +- classes/class_instanceplaceholder.rst | 10 +- classes/class_int.rst | 7 +- classes/class_interpolatedcamera.rst | 44 +- classes/class_ip.rst | 23 +- classes/class_ip_unix.rst | 1 + classes/class_itemlist.rst | 233 +- classes/class_javascript.rst | 5 +- classes/class_joint.rst | 54 +- classes/class_joint2d.rst | 54 +- classes/class_json.rst | 6 +- classes/class_jsonparseresult.rst | 55 +- classes/class_kinematicbody.rst | 63 +- classes/class_kinematicbody2d.rst | 50 +- classes/class_kinematiccollision.rst | 115 +- classes/class_kinematiccollision2d.rst | 115 +- classes/class_label.rst | 162 +- classes/class_largetexture.rst | 18 +- classes/class_light.rst | 164 +- classes/class_light2d.rst | 262 +- classes/class_lightoccluder2d.rst | 29 +- classes/class_line2d.rst | 155 +- classes/class_lineedit.rst | 235 +- classes/class_lineshape2d.rst | 29 +- classes/class_linkbutton.rst | 41 +- classes/class_listener.rst | 10 +- classes/class_mainloop.rst | 30 +- classes/class_margincontainer.rst | 14 + classes/class_marshalls.rst | 14 +- classes/class_material.rst | 23 +- classes/class_menubutton.rst | 36 +- classes/class_mesh.rst | 42 +- classes/class_meshdatatool.rst | 78 +- classes/class_meshinstance.rst | 41 +- classes/class_meshinstance2d.rst | 29 + classes/class_meshlibrary.rst | 34 +- classes/class_mobilevrinterface.rst | 77 +- classes/class_multimesh.rst | 67 +- classes/class_multimeshinstance.rst | 17 +- classes/class_multiplayerapi.rst | 64 +- classes/class_multiplayerpeergdnative.rst | 1 + classes/class_mutex.rst | 8 +- classes/class_nativescript.rst | 48 +- classes/class_navigation.rst | 34 +- classes/class_navigation2d.rst | 14 +- classes/class_navigationmesh.rst | 157 +- classes/class_navigationmeshinstance.rst | 21 + classes/class_navigationpolygon.rst | 30 +- classes/class_navigationpolygoninstance.rst | 21 + classes/class_networkedmultiplayerenet.rst | 78 +- classes/class_networkedmultiplayerpeer.rst | 59 +- classes/class_nil.rst | 53 +- classes/class_ninepatchrect.rst | 119 +- classes/class_node.rst | 257 +- classes/class_node2d.rst | 174 +- classes/class_nodepath.rst | 19 +- classes/class_object.rst | 95 +- classes/class_occluderpolygon2d.rst | 44 +- classes/class_omnilight.rst | 59 +- classes/class_optionbutton.rst | 88 +- classes/class_orientedpathfollow.rst | 77 +- classes/class_os.rst | 361 +- classes/class_packeddatacontainer.rst | 14 +- classes/class_packeddatacontainerref.rst | 4 +- classes/class_packedscene.rst | 25 +- classes/class_packetpeer.rst | 27 +- classes/class_packetpeergdnative.rst | 1 + classes/class_packetpeerstream.rst | 33 +- classes/class_packetpeerudp.rst | 16 +- classes/class_panel.rst | 12 + classes/class_panelcontainer.rst | 9 + classes/class_panoramasky.rst | 17 +- classes/class_parallaxbackground.rst | 77 +- classes/class_parallaxlayer.rst | 41 +- classes/class_particles.rst | 234 +- classes/class_particles2d.rst | 217 +- classes/class_particlesmaterial.rst | 636 ++- classes/class_path.rst | 16 +- classes/class_path2d.rst | 17 +- classes/class_pathfollow.rst | 92 +- classes/class_pathfollow2d.rst | 97 +- classes/class_pckpacker.rst | 8 +- classes/class_performance.rst | 7 +- classes/class_phashtranslation.rst | 4 +- classes/class_physicalbone.rst | 81 +- classes/class_physics2ddirectbodystate.rst | 153 +- classes/class_physics2ddirectbodystatesw.rst | 1 + classes/class_physics2ddirectspacestate.rst | 15 +- classes/class_physics2dserver.rst | 226 +- classes/class_physics2dserversw.rst | 1 + .../class_physics2dshapequeryparameters.rst | 96 +- classes/class_physics2dshapequeryresult.rst | 12 +- classes/class_physics2dtestmotionresult.rst | 59 + classes/class_physicsbody.rst | 44 +- classes/class_physicsbody2d.rst | 50 +- classes/class_physicsdirectbodystate.rst | 165 +- classes/class_physicsdirectspacestate.rst | 13 +- classes/class_physicsmaterial.rst | 45 +- classes/class_physicsserver.rst | 262 +- classes/class_physicsshapequeryparameters.rst | 64 +- classes/class_physicsshapequeryresult.rst | 12 +- classes/class_pinjoint.rst | 44 +- classes/class_pinjoint2d.rst | 17 +- classes/class_plane.rst | 45 +- classes/class_planemesh.rst | 41 +- classes/class_planeshape.rst | 13 + classes/class_pluginscript.rst | 1 + classes/class_polygon2d.rst | 196 +- classes/class_polygonpathfinder.rst | 18 +- classes/class_poolbytearray.rst | 31 +- classes/class_poolcolorarray.rst | 21 +- classes/class_poolintarray.rst | 21 +- classes/class_poolrealarray.rst | 21 +- classes/class_poolstringarray.rst | 23 +- classes/class_poolvector2array.rst | 21 +- classes/class_poolvector3array.rst | 21 +- classes/class_popup.rst | 33 +- classes/class_popupdialog.rst | 1 + classes/class_popupmenu.rst | 188 +- classes/class_popuppanel.rst | 8 + classes/class_position2d.rst | 1 + classes/class_position3d.rst | 1 + classes/class_primitivemesh.rst | 37 +- classes/class_prismmesh.rst | 65 +- classes/class_proceduralsky.rst | 202 +- classes/class_progressbar.rst | 32 +- classes/class_projectsettings.rst | 924 +++- classes/class_proximitygroup.rst | 38 +- classes/class_proxytexture.rst | 13 + classes/class_quadmesh.rst | 13 + classes/class_quat.rst | 65 +- classes/class_range.rst | 136 +- classes/class_raycast.rst | 104 +- classes/class_raycast2d.rst | 104 +- classes/class_rayshape.rst | 29 +- classes/class_rayshape2d.rst | 29 +- classes/class_rect2.rst | 52 +- classes/class_rectangleshape2d.rst | 17 +- classes/class_reference.rst | 9 +- classes/class_referencerect.rst | 13 + classes/class_reflectionprobe.rst | 105 +- classes/class_regex.rst | 20 +- classes/class_regexmatch.rst | 44 +- classes/class_remotetransform.rst | 65 +- classes/class_remotetransform2d.rst | 65 +- classes/class_resource.rst | 46 +- classes/class_resourceimporter.rst | 2 + classes/class_resourceimporteroggvorbis.rst | 1 + classes/class_resourceinteractiveloader.rst | 12 +- classes/class_resourceloader.rst | 18 +- classes/class_resourcepreloader.rst | 14 +- classes/class_resourcesaver.rst | 9 +- classes/class_richtextlabel.rst | 240 +- classes/class_rid.rst | 5 +- classes/class_rigidbody.rst | 288 +- classes/class_rigidbody2d.rst | 278 +- classes/class_rootmotionview.rst | 45 + classes/class_scenestate.rst | 45 +- classes/class_scenetree.rst | 217 +- classes/class_scenetreetimer.rst | 16 +- classes/class_script.rst | 36 +- classes/class_scriptcreatedialog.rst | 7 +- classes/class_scripteditor.rst | 19 +- classes/class_scrollbar.rst | 17 +- classes/class_scrollcontainer.rst | 79 +- classes/class_segmentshape2d.rst | 29 +- classes/class_semaphore.rst | 6 +- classes/class_separator.rst | 2 + classes/class_shader.rst | 29 +- classes/class_shadermaterial.rst | 22 +- classes/class_shape.rst | 15 +- classes/class_shape2d.rst | 24 +- classes/class_shortcut.rst | 26 +- classes/class_skeleton.rst | 57 +- classes/class_skeleton2d.rst | 8 +- classes/class_skeletonik.rst | 86 +- classes/class_sky.rst | 23 +- classes/class_slider.rst | 46 + classes/class_sliderjoint.rst | 260 +- classes/class_softbody.rst | 118 +- classes/class_spatial.rst | 174 +- classes/class_spatialgizmo.rst | 2 + classes/class_spatialmaterial.rst | 817 +++- classes/class_spatialvelocitytracker.rst | 20 +- classes/class_spheremesh.rst | 65 +- classes/class_sphereshape.rst | 17 +- classes/class_spinbox.rst | 39 +- classes/class_splitcontainer.rst | 40 +- classes/class_spotlight.rst | 38 +- classes/class_springarm.rst | 46 +- classes/class_sprite.rst | 159 +- classes/class_sprite3d.rst | 80 +- classes/class_spritebase3d.rst | 156 +- classes/class_spriteframes.rst | 48 +- classes/class_staticbody.rst | 61 +- classes/class_staticbody2d.rst | 61 +- classes/class_streampeer.rst | 79 +- classes/class_streampeerbuffer.rst | 26 +- classes/class_streampeergdnative.rst | 1 + classes/class_streampeerssl.rst | 28 +- classes/class_streampeertcp.rst | 21 +- classes/class_streamtexture.rst | 17 +- classes/class_string.rst | 187 +- classes/class_stylebox.rst | 51 +- classes/class_styleboxempty.rst | 1 + classes/class_styleboxflat.rst | 270 +- classes/class_styleboxline.rst | 45 + classes/class_styleboxtexture.rst | 136 +- classes/class_surfacetool.rst | 46 +- classes/class_tabcontainer.rst | 129 +- classes/class_tabs.rst | 141 +- classes/class_tcp_server.rst | 10 +- classes/class_textedit.rst | 357 +- classes/class_textfile.rst | 1 + classes/class_texture.rst | 38 +- classes/class_texture3d.rst | 1 + classes/class_texturearray.rst | 1 + classes/class_texturebutton.rst | 104 +- classes/class_texturelayered.rst | 36 +- classes/class_textureprogress.rst | 176 +- classes/class_texturerect.rst | 44 +- classes/class_theme.rst | 74 +- classes/class_thread.rst | 13 +- classes/class_tilemap.rst | 236 +- classes/class_tileset.rst | 109 +- classes/class_timer.rst | 88 +- classes/class_toolbutton.rst | 28 + classes/class_touchscreenbutton.rst | 124 +- classes/class_transform.rst | 49 +- classes/class_transform2d.rst | 58 +- classes/class_translation.rst | 25 +- classes/class_translationserver.rst | 16 +- classes/class_tree.rst | 253 +- classes/class_treeitem.rst | 155 +- classes/class_trianglemesh.rst | 1 + classes/class_tween.rst | 100 +- classes/class_undoredo.rst | 31 +- classes/class_upnp.rst | 69 +- classes/class_upnpdevice.rst | 89 +- classes/class_vboxcontainer.rst | 8 + classes/class_vector2.rst | 75 +- classes/class_vector3.rst | 81 +- classes/class_vehiclebody.rst | 41 +- classes/class_vehiclewheel.rst | 142 +- classes/class_videoplayer.rst | 135 +- classes/class_videostream.rst | 2 + classes/class_videostreamtheora.rst | 6 +- classes/class_videostreamwebm.rst | 6 +- classes/class_viewport.rst | 393 +- classes/class_viewportcontainer.rst | 25 +- classes/class_viewporttexture.rst | 17 +- classes/class_visibilityenabler.rst | 24 +- classes/class_visibilityenabler2d.rst | 56 +- classes/class_visibilitynotifier.rst | 30 +- classes/class_visibilitynotifier2d.rst | 30 +- classes/class_visualinstance.rst | 31 +- classes/class_visualscript.rst | 90 +- .../class_visualscriptbasictypeconstant.rst | 29 +- classes/class_visualscriptbuiltinfunc.rst | 20 +- classes/class_visualscriptclassconstant.rst | 29 +- classes/class_visualscriptcomment.rst | 41 +- classes/class_visualscriptcondition.rst | 1 + classes/class_visualscriptconstant.rst | 29 +- classes/class_visualscriptconstructor.rst | 10 +- classes/class_visualscriptcustomnode.rst | 34 +- classes/class_visualscriptdeconstruct.rst | 17 +- classes/class_visualscripteditor.rst | 9 +- classes/class_visualscriptemitsignal.rst | 17 +- classes/class_visualscriptenginesingleton.rst | 17 +- classes/class_visualscriptexpression.rst | 1 + classes/class_visualscriptfunction.rst | 1 + classes/class_visualscriptfunctioncall.rst | 90 +- classes/class_visualscriptfunctionstate.rst | 8 +- classes/class_visualscriptglobalconstant.rst | 13 + classes/class_visualscriptindexget.rst | 1 + classes/class_visualscriptindexset.rst | 1 + classes/class_visualscriptinputaction.rst | 24 +- classes/class_visualscriptiterator.rst | 1 + classes/class_visualscriptlocalvar.rst | 29 +- classes/class_visualscriptlocalvarset.rst | 29 +- classes/class_visualscriptmathconstant.rst | 20 +- classes/class_visualscriptnode.rst | 14 +- classes/class_visualscriptoperator.rst | 21 + classes/class_visualscriptpreload.rst | 17 +- classes/class_visualscriptpropertyget.rst | 64 +- classes/class_visualscriptpropertyset.rst | 74 +- classes/class_visualscriptresourcepath.rst | 13 + classes/class_visualscriptreturn.rst | 29 +- classes/class_visualscriptscenenode.rst | 17 +- classes/class_visualscriptscenetree.rst | 1 + classes/class_visualscriptselect.rst | 17 +- classes/class_visualscriptself.rst | 1 + classes/class_visualscriptsequence.rst | 17 +- classes/class_visualscriptsubcall.rst | 4 +- classes/class_visualscriptswitch.rst | 1 + classes/class_visualscripttypecast.rst | 21 + classes/class_visualscriptvariableget.rst | 17 +- classes/class_visualscriptvariableset.rst | 17 +- classes/class_visualscriptwhile.rst | 1 + classes/class_visualscriptyield.rst | 24 +- classes/class_visualscriptyieldsignal.rst | 40 +- classes/class_visualserver.rst | 797 ++-- classes/class_visualshader.rst | 44 +- classes/class_visualshadernode.rst | 24 +- .../class_visualshadernodecolorconstant.rst | 13 + classes/class_visualshadernodecolorop.rst | 16 +- .../class_visualshadernodecoloruniform.rst | 1 + classes/class_visualshadernodecubemap.rst | 24 +- .../class_visualshadernodecubemapuniform.rst | 1 + classes/class_visualshadernodedotproduct.rst | 1 + classes/class_visualshadernodeinput.rst | 16 +- classes/class_visualshadernodeoutput.rst | 1 + .../class_visualshadernodescalarconstant.rst | 13 + classes/class_visualshadernodescalarfunc.rst | 16 +- .../class_visualshadernodescalarinterp.rst | 1 + classes/class_visualshadernodescalarop.rst | 16 +- .../class_visualshadernodescalaruniform.rst | 1 + classes/class_visualshadernodetexture.rst | 34 +- .../class_visualshadernodetextureuniform.rst | 26 +- ...class_visualshadernodetransformcompose.rst | 1 + ...lass_visualshadernodetransformconstant.rst | 13 + ...ass_visualshadernodetransformdecompose.rst | 1 + .../class_visualshadernodetransformmult.rst | 16 +- ...class_visualshadernodetransformuniform.rst | 1 + ...class_visualshadernodetransformvecmult.rst | 16 +- classes/class_visualshadernodeuniform.rst | 14 + .../class_visualshadernodevec3constant.rst | 13 + classes/class_visualshadernodevec3uniform.rst | 1 + .../class_visualshadernodevectorcompose.rst | 1 + .../class_visualshadernodevectordecompose.rst | 1 + classes/class_visualshadernodevectorfunc.rst | 16 +- .../class_visualshadernodevectorinterp.rst | 1 + classes/class_visualshadernodevectorlen.rst | 1 + classes/class_visualshadernodevectorop.rst | 16 +- classes/class_vscrollbar.rst | 24 + classes/class_vseparator.rst | 10 + classes/class_vslider.rst | 24 + classes/class_vsplitcontainer.rst | 14 + classes/class_weakref.rst | 4 +- classes/class_websocketclient.rst | 33 +- classes/class_websocketmultiplayerpeer.rst | 8 +- classes/class_websocketpeer.rst | 19 +- classes/class_websocketserver.rst | 23 +- classes/class_windowdialog.rst | 56 +- classes/class_world.rst | 60 +- classes/class_world2d.rst | 36 +- classes/class_worldenvironment.rst | 18 +- classes/class_xmlparser.rst | 39 +- classes/class_ysort.rst | 13 + 578 files changed, 33831 insertions(+), 6706 deletions(-) diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 34a3c8b47..2e09e9326 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -194,7 +194,6 @@ Constants - **NAN** = **nan** --- Macro constant that expands to an expression of type float that represents a NaN. The NaN values are used to identify undefined or non-representable values for floating-point elements, such as the square root of negative numbers or the result of 0/0. - Description ----------- @@ -203,7 +202,7 @@ List of core built-in GDScript functions. Math functions and other utilities. Ev Method Descriptions ------------------- -.. _class_@GDScript_Color8: + .. _class_@GDScript_Color8: - :ref:`Color` **Color8** **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8=255 **)** @@ -221,7 +220,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_ColorN: - :ref:`Color` **ColorN** **(** :ref:`String` name, :ref:`float` alpha=1.0 **)** @@ -235,7 +234,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_abs: - :ref:`float` **abs** **(** :ref:`float` s **)** @@ -246,7 +245,7 @@ Returns the absolute value of parameter ``s`` (i.e. unsigned value, works for i # a is 1 a = abs(-1) -.. _class_@GDScript_acos: + .. _class_@GDScript_acos: - :ref:`float` **acos** **(** :ref:`float` s **)** @@ -257,7 +256,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_asin: - :ref:`float` **asin** **(** :ref:`float` s **)** @@ -268,7 +267,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_assert: - void **assert** **(** :ref:`bool` condition **)** @@ -282,7 +281,7 @@ 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_atan: - :ref:`float` **atan** **(** :ref:`float` s **)** @@ -294,7 +293,7 @@ The method cannot know in which quadrant the angle should fall. See :ref:`atan2< a = atan(0.5) # a is 0.463648 -.. _class_@GDScript_atan2: + .. _class_@GDScript_atan2: - :ref:`float` **atan2** **(** :ref:`float` x, :ref:`float` y **)** @@ -304,19 +303,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_bytes2var: - :ref:`Variant` **bytes2var** **(** :ref:`PoolByteArray` bytes **)** Decodes a byte array back to a value. -.. _class_@GDScript_cartesian2polar: + .. _class_@GDScript_cartesian2polar: - :ref:`Vector2` **cartesian2polar** **(** :ref:`float` x, :ref:`float` y **)** Converts a 2D point expressed in the cartesian coordinate system (x and y axis) to the polar coordinate system (a distance from the origin and an angle). -.. _class_@GDScript_ceil: + .. _class_@GDScript_ceil: - :ref:`float` **ceil** **(** :ref:`float` s **)** @@ -327,7 +326,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_char: - :ref:`String` **char** **(** :ref:`int` ascii **)** @@ -340,7 +339,7 @@ Returns a character as a String of the given ASCII code. # a is 'a' a = char(65+32) -.. _class_@GDScript_clamp: + .. _class_@GDScript_clamp: - :ref:`float` **clamp** **(** :ref:`float` value, :ref:`float` min, :ref:`float` max **)** @@ -356,7 +355,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_convert: - :ref:`Variant` **convert** **(** :ref:`Variant` what, :ref:`int` type **)** @@ -372,7 +371,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_cos: - :ref:`float` **cos** **(** :ref:`float` s **)** @@ -384,7 +383,7 @@ Returns the cosine of angle ``s`` in radians. print(cos(PI*2)) print(cos(PI)) -.. _class_@GDScript_cosh: + .. _class_@GDScript_cosh: - :ref:`float` **cosh** **(** :ref:`float` s **)** @@ -395,13 +394,13 @@ Returns the hyperbolic cosine of ``s`` in radians. # prints 1.543081 print(cosh(1)) -.. _class_@GDScript_db2linear: + .. _class_@GDScript_db2linear: - :ref:`float` **db2linear** **(** :ref:`float` db **)** Converts from decibels to linear energy (audio). -.. _class_@GDScript_decimals: + .. _class_@GDScript_decimals: - :ref:`float` **decimals** **(** :ref:`float` step **)** @@ -412,7 +411,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_dectime: - :ref:`float` **dectime** **(** :ref:`float` value, :ref:`float` amount, :ref:`float` step **)** @@ -423,7 +422,7 @@ Returns the result of ``value`` decreased by ``step`` \* ``amount``. # a = 59 a = dectime(60, 10, 0.1)) -.. _class_@GDScript_deg2rad: + .. _class_@GDScript_deg2rad: - :ref:`float` **deg2rad** **(** :ref:`float` deg **)** @@ -434,19 +433,19 @@ Returns degrees converted to radians. # r is 3.141593 r = deg2rad(180) -.. _class_@GDScript_dict2inst: + .. _class_@GDScript_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_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_exp: - :ref:`float` **exp** **(** :ref:`float` s **)** @@ -458,7 +457,7 @@ The natural exponential function. It raises the mathematical constant **e** to t a = exp(2) # approximately 7.39 -.. _class_@GDScript_floor: + .. _class_@GDScript_floor: - :ref:`float` **floor** **(** :ref:`float` s **)** @@ -471,7 +470,7 @@ Rounds ``s`` to the closest smaller integer and returns it. # a is -3 a = floor(-2.99) -.. _class_@GDScript_fmod: + .. _class_@GDScript_fmod: - :ref:`float` **fmod** **(** :ref:`float` x, :ref:`float` y **)** @@ -482,7 +481,7 @@ Returns the floating-point remainder of ``x/y``. # remainder is 1.5 var remainder = fmod(7, 5.5) -.. _class_@GDScript_fposmod: + .. _class_@GDScript_fposmod: - :ref:`float` **fposmod** **(** :ref:`float` x, :ref:`float` y **)** @@ -510,7 +509,7 @@ Produces: -2 8 -1 9 -.. _class_@GDScript_funcref: + .. _class_@GDScript_funcref: - :ref:`FuncRef` **funcref** **(** :ref:`Object` instance, :ref:`String` funcname **)** @@ -524,11 +523,11 @@ 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_get_stack: - :ref:`Array` **get_stack** **(** **)** -.. _class_@GDScript_hash: + .. _class_@GDScript_hash: - :ref:`int` **hash** **(** :ref:`Variant` var **)** @@ -538,7 +537,7 @@ Returns the integer hash of the variable passed. print(hash("a")) # prints 177670 -.. _class_@GDScript_inst2dict: + .. _class_@GDScript_inst2dict: - :ref:`Dictionary` **inst2dict** **(** :ref:`Object` inst **)** @@ -559,7 +558,7 @@ Prints out: [@subpath, @path, foo] [, res://test.gd, bar] -.. _class_@GDScript_instance_from_id: + .. _class_@GDScript_instance_from_id: - :ref:`Object` **instance_from_id** **(** :ref:`int` instance_id **)** @@ -573,7 +572,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_inverse_lerp: - :ref:`float` **inverse_lerp** **(** :ref:`float` from, :ref:`float` to, :ref:`float` weight **)** @@ -583,23 +582,23 @@ Returns a normalized value considering the given range. inverse_lerp(3, 5, 4) # returns 0.5 -.. _class_@GDScript_is_inf: + .. _class_@GDScript_is_inf: - :ref:`bool` **is_inf** **(** :ref:`float` s **)** Returns True/False whether ``s`` is an infinity value (either positive infinity or negative infinity). -.. _class_@GDScript_is_instance_valid: + .. _class_@GDScript_is_instance_valid: - :ref:`bool` **is_instance_valid** **(** :ref:`Object` instance **)** -.. _class_@GDScript_is_nan: + .. _class_@GDScript_is_nan: - :ref:`bool` **is_nan** **(** :ref:`float` s **)** Returns True/False whether ``s`` is a NaN (Not-A-Number) value. -.. _class_@GDScript_len: + .. _class_@GDScript_len: - :ref:`int` **len** **(** :ref:`Variant` var **)** @@ -612,7 +611,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_lerp: - :ref:`float` **lerp** **(** :ref:`Variant` from, :ref:`Variant` to, :ref:`float` weight **)** @@ -622,13 +621,13 @@ Linearly interpolates between two values by a normalized value. lerp(1, 3, 0.5) # returns 2 -.. _class_@GDScript_linear2db: + .. _class_@GDScript_linear2db: - :ref:`float` **linear2db** **(** :ref:`float` nrg **)** Converts from linear energy to decibels (audio). -.. _class_@GDScript_load: + .. _class_@GDScript_load: - :ref:`Resource` **load** **(** :ref:`String` path **)** @@ -641,7 +640,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_log: - :ref:`float` **log** **(** :ref:`float` s **)** @@ -653,7 +652,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_max: - :ref:`float` **max** **(** :ref:`float` a, :ref:`float` b **)** @@ -664,7 +663,7 @@ Returns the maximum of two values. max(1,2) # returns 2 max(-3.99, -4) # returns -3.99 -.. _class_@GDScript_min: + .. _class_@GDScript_min: - :ref:`float` **min** **(** :ref:`float` a, :ref:`float` b **)** @@ -675,7 +674,7 @@ Returns the minimum of two values. min(1,2) # returns 1 min(-3.99, -4) # returns -4 -.. _class_@GDScript_nearest_po2: + .. _class_@GDScript_nearest_po2: - :ref:`int` **nearest_po2** **(** :ref:`int` value **)** @@ -687,7 +686,7 @@ 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_parse_json: - :ref:`Variant` **parse_json** **(** :ref:`String` json **)** @@ -705,13 +704,13 @@ Note that JSON objects do not preserve key order like Godot dictionaries, thus y else: print("unexpected results") -.. _class_@GDScript_polar2cartesian: + .. _class_@GDScript_polar2cartesian: - :ref:`Vector2` **polar2cartesian** **(** :ref:`float` r, :ref:`float` th **)** Converts a 2D point expressed in the polar coordinate system (a distance from the origin ``r`` and an angle ``th``) to the cartesian coordinate system (x and y axis). -.. _class_@GDScript_pow: + .. _class_@GDScript_pow: - :ref:`float` **pow** **(** :ref:`float` x, :ref:`float` y **)** @@ -721,7 +720,7 @@ Returns the result of ``x`` raised to the power of ``y``. pow(2,5) # returns 32 -.. _class_@GDScript_preload: + .. _class_@GDScript_preload: - :ref:`Resource` **preload** **(** :ref:`String` path **)** @@ -734,7 +733,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_print: - void **print** **(** **)** vararg @@ -745,11 +744,11 @@ 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_print_debug: - void **print_debug** **(** **)** vararg -.. _class_@GDScript_print_stack: + .. _class_@GDScript_print_stack: - void **print_stack** **(** **)** @@ -761,7 +760,7 @@ Output in the console would look something like this: Frame 0 - res://test.gd:16 in function '_process' -.. _class_@GDScript_printerr: + .. _class_@GDScript_printerr: - void **printerr** **(** **)** vararg @@ -771,7 +770,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_printraw: - void **printraw** **(** **)** vararg @@ -783,7 +782,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_prints: - void **prints** **(** **)** vararg @@ -793,7 +792,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_printt: - void **printt** **(** **)** vararg @@ -803,7 +802,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_rad2deg: + .. _class_@GDScript_rad2deg: - :ref:`float` **rad2deg** **(** :ref:`float` rad **)** @@ -813,7 +812,7 @@ Converts from radians to degrees. rad2deg(0.523599) # returns 30 -.. _class_@GDScript_rand_range: + .. _class_@GDScript_rand_range: - :ref:`float` **rand_range** **(** :ref:`float` from, :ref:`float` to **)** @@ -823,13 +822,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_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_randf: - :ref:`float` **randf** **(** **)** @@ -839,7 +838,7 @@ Returns a random floating point value between 0 and 1. randf() # returns 0.375671 -.. _class_@GDScript_randi: + .. _class_@GDScript_randi: - :ref:`int` **randi** **(** **)** @@ -851,7 +850,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_randomize: - void **randomize** **(** **)** @@ -862,7 +861,7 @@ Randomizes the seed (or the internal state) of the random number generator. Curr func _ready(): randomize() -.. _class_@GDScript_range: + .. _class_@GDScript_range: - :ref:`Array` **range** **(** **)** vararg @@ -894,7 +893,7 @@ Output: 2 4 -.. _class_@GDScript_range_lerp: + .. _class_@GDScript_range_lerp: - :ref:`float` **range_lerp** **(** :ref:`float` value, :ref:`float` istart, :ref:`float` istop, :ref:`float` ostart, :ref:`float` ostop **)** @@ -904,7 +903,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_round: - :ref:`float` **round** **(** :ref:`float` s **)** @@ -914,7 +913,7 @@ Returns the integral value that is nearest to ``s``, with halfway cases rounded round(2.6) # returns 3 -.. _class_@GDScript_seed: + .. _class_@GDScript_seed: - void **seed** **(** :ref:`int` seed **)** @@ -925,7 +924,7 @@ Sets seed for the random number generator. my_seed = "Godot Rocks" seed(my_seed.hash()) -.. _class_@GDScript_sign: + .. _class_@GDScript_sign: - :ref:`float` **sign** **(** :ref:`float` s **)** @@ -937,7 +936,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_sin: - :ref:`float` **sin** **(** :ref:`float` s **)** @@ -947,7 +946,7 @@ Returns the sine of angle ``s`` in radians. sin(0.523599) # returns 0.5 -.. _class_@GDScript_sinh: + .. _class_@GDScript_sinh: - :ref:`float` **sinh** **(** :ref:`float` s **)** @@ -958,7 +957,7 @@ Returns the hyperbolic sine of ``s``. a = log(2.0) # returns 0.693147 sinh(a) # returns 0.75 -.. _class_@GDScript_sqrt: + .. _class_@GDScript_sqrt: - :ref:`float` **sqrt** **(** :ref:`float` s **)** @@ -968,13 +967,13 @@ Returns the square root of ``s``. sqrt(9) # returns 3 -.. _class_@GDScript_stepify: + .. _class_@GDScript_stepify: - :ref:`float` **stepify** **(** :ref:`float` s, :ref:`float` step **)** Snaps float value ``s`` to a given ``step``. -.. _class_@GDScript_str: + .. _class_@GDScript_str: - :ref:`String` **str** **(** **)** vararg @@ -987,7 +986,7 @@ 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_str2var: - :ref:`Variant` **str2var** **(** :ref:`String` string **)** @@ -999,7 +998,7 @@ Converts a formatted string that was returned by :ref:`var2str` **tan** **(** :ref:`float` s **)** @@ -1009,7 +1008,7 @@ Returns the tangent of angle ``s`` in radians. tan( deg2rad(45) ) # returns 1 -.. _class_@GDScript_tanh: + .. _class_@GDScript_tanh: - :ref:`float` **tanh** **(** :ref:`float` s **)** @@ -1020,7 +1019,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_to_json: - :ref:`String` **to_json** **(** :ref:`Variant` var **)** @@ -1032,7 +1031,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_type_exists: - :ref:`bool` **type_exists** **(** :ref:`String` type **)** @@ -1043,7 +1042,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_typeof: - :ref:`int` **typeof** **(** :ref:`Variant` what **)** @@ -1057,7 +1056,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_validate_json: - :ref:`String` **validate_json** **(** :ref:`String` json **)** @@ -1072,13 +1071,13 @@ Checks that ``json`` is valid JSON data. Returns empty string if valid. Returns else: prints("invalid", v) -.. _class_@GDScript_var2bytes: + .. _class_@GDScript_var2bytes: - :ref:`PoolByteArray` **var2bytes** **(** :ref:`Variant` var **)** Encodes a variable value to a byte array. -.. _class_@GDScript_var2str: + .. _class_@GDScript_var2str: - :ref:`String` **var2str** **(** :ref:`Variant` var **)** @@ -1098,7 +1097,7 @@ prints "b": 2 } -.. _class_@GDScript_weakref: + .. _class_@GDScript_weakref: - :ref:`WeakRef` **weakref** **(** :ref:`Object` obj **)** @@ -1106,7 +1105,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_wrapf: - :ref:`float` **wrapf** **(** :ref:`float` value, :ref:`float` min, :ref:`float` max **)** @@ -1129,7 +1128,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_wrapi: - :ref:`int` **wrapi** **(** :ref:`int` value, :ref:`int` min, :ref:`int` max **)** @@ -1152,7 +1151,7 @@ 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_yield: - :ref:`GDScriptFunctionState` **yield** **(** :ref:`Object` object=null, :ref:`String` signal="" **)** @@ -1162,4 +1161,3 @@ From the caller, call :ref:`GDScriptFunctionState.resume` | :ref:`ARVRServer` | ++-----------------------------------------------------+------------------------------------------------------------------+ +| :ref:`AudioServer` | :ref:`AudioServer` | ++-----------------------------------------------------+------------------------------------------------------------------+ +| :ref:`ClassDB` | :ref:`ClassDB` | ++-----------------------------------------------------+------------------------------------------------------------------+ +| :ref:`Engine` | :ref:`Engine` | ++-----------------------------------------------------+------------------------------------------------------------------+ +| :ref:`Geometry` | :ref:`Geometry` | ++-----------------------------------------------------+------------------------------------------------------------------+ +| :ref:`GodotSharp` | :ref:`GodotSharp` | ++-----------------------------------------------------+------------------------------------------------------------------+ +| :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_Variant.Operator: -enum **Variant.Operator** +enum **Variant.Operator**: - **OP_EQUAL** = **0** - **OP_NOT_EQUAL** = **1** @@ -50,7 +99,7 @@ enum **Variant.Operator** .. _enum_@GlobalScope_MethodFlags: -enum **MethodFlags** +enum **MethodFlags**: - **METHOD_FLAG_NORMAL** = **1** --- Flag for normal method - **METHOD_FLAG_EDITOR** = **2** --- Flag for editor method @@ -63,14 +112,14 @@ enum **MethodFlags** .. _enum_@GlobalScope_Orientation: -enum **Orientation** +enum **Orientation**: - **VERTICAL** = **1** --- General vertical alignment, used usually for :ref:`Separator`, :ref:`ScrollBar`, :ref:`Slider`, etc. - **HORIZONTAL** = **0** --- General horizontal alignment, used usually for :ref:`Separator`, :ref:`ScrollBar`, :ref:`Slider`, etc. .. _enum_@GlobalScope_PropertyUsageFlags: -enum **PropertyUsageFlags** +enum **PropertyUsageFlags**: - **PROPERTY_USAGE_STORAGE** = **1** --- Property will be used as storage (default). - **PROPERTY_USAGE_EDITOR** = **2** --- Property will be visible in editor (default). @@ -92,7 +141,7 @@ enum **PropertyUsageFlags** .. _enum_@GlobalScope_JoystickList: -enum **JoystickList** +enum **JoystickList**: - **JOY_BUTTON_0** = **0** --- Joypad Button 0 - **JOY_BUTTON_1** = **1** --- Joypad Button 1 @@ -155,7 +204,7 @@ enum **JoystickList** .. _enum_@GlobalScope_MidiMessageList: -enum **MidiMessageList** +enum **MidiMessageList**: - **MIDI_MESSAGE_NOTE_OFF** = **8** - **MIDI_MESSAGE_NOTE_ON** = **9** @@ -167,7 +216,7 @@ enum **MidiMessageList** .. _enum_@GlobalScope_KeyModifierMask: -enum **KeyModifierMask** +enum **KeyModifierMask**: - **KEY_CODE_MASK** = **33554431** --- Key Code Mask - **KEY_MODIFIER_MASK** = **-16777216** --- Modifier Key Mask @@ -181,7 +230,7 @@ enum **KeyModifierMask** .. _enum_@GlobalScope_HAlign: -enum **HAlign** +enum **HAlign**: - **HALIGN_LEFT** = **0** --- Horizontal left alignment, usually for text-derived classes. - **HALIGN_CENTER** = **1** --- Horizontal center alignment, usually for text-derived classes. @@ -189,7 +238,7 @@ enum **HAlign** .. _enum_@GlobalScope_Error: -enum **Error** +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. - **FAILED** = **1** --- Generic error. @@ -235,7 +284,7 @@ enum **Error** .. _enum_@GlobalScope_VAlign: -enum **VAlign** +enum **VAlign**: - **VALIGN_TOP** = **0** --- Vertical top alignment, usually for text-derived classes. - **VALIGN_CENTER** = **1** --- Vertical center alignment, usually for text-derived classes. @@ -243,7 +292,7 @@ enum **VAlign** .. _enum_@GlobalScope_PropertyHint: -enum **PropertyHint** +enum **PropertyHint**: - **PROPERTY_HINT_NONE** = **0** --- No hint for edited property. - **PROPERTY_HINT_RANGE** = **1** --- Hints that the string is a range, defined as "min,max" or "min,max,step". This is valid for integers and floats. @@ -270,7 +319,7 @@ enum **PropertyHint** .. _enum_@GlobalScope_Corner: -enum **Corner** +enum **Corner**: - **CORNER_TOP_LEFT** = **0** - **CORNER_TOP_RIGHT** = **1** @@ -279,7 +328,7 @@ enum **Corner** .. _enum_@GlobalScope_KeyList: -enum **KeyList** +enum **KeyList**: - **KEY_ESCAPE** = **16777217** --- Escape Key - **KEY_TAB** = **16777218** --- Tab Key @@ -526,7 +575,7 @@ enum **KeyList** .. _enum_@GlobalScope_Variant.Type: -enum **Variant.Type** +enum **Variant.Type**: - **TYPE_NIL** = **0** --- Variable is of type nil (only applied for null). - **TYPE_BOOL** = **1** --- Variable is of type :ref:`bool`. @@ -559,7 +608,7 @@ enum **Variant.Type** .. _enum_@GlobalScope_Margin: -enum **Margin** +enum **Margin**: - **MARGIN_LEFT** = **0** --- Left margin, used usually for :ref:`Control` or :ref:`StyleBox` derived classes. - **MARGIN_TOP** = **1** --- Top margin, used usually for :ref:`Control` or :ref:`StyleBox` derived classes. @@ -568,7 +617,7 @@ enum **Margin** .. _enum_@GlobalScope_ButtonList: -enum **ButtonList** +enum **ButtonList**: - **BUTTON_LEFT** = **1** --- Left Mouse Button - **BUTTON_RIGHT** = **2** --- Right Mouse Button @@ -585,12 +634,10 @@ enum **ButtonList** - **BUTTON_MASK_XBUTTON1** = **128** - **BUTTON_MASK_XBUTTON2** = **256** - Constants --------- - **SPKEY** = **16777216** --- Scancodes with this bit applied are non printable. - Description ----------- @@ -603,23 +650,33 @@ Property Descriptions .. _class_@GlobalScope_ARVRServer: -- :ref:`ARVRServer` **ARVRServer** - :ref:`ARVRServer` singleton +- :ref:`ARVRServer` **ARVRServer** + +:ref:`ARVRServer` singleton .. _class_@GlobalScope_AudioServer: -- :ref:`AudioServer` **AudioServer** - :ref:`AudioServer` singleton +- :ref:`AudioServer` **AudioServer** + +:ref:`AudioServer` singleton .. _class_@GlobalScope_ClassDB: -- :ref:`ClassDB` **ClassDB** - :ref:`ClassDB` singleton +- :ref:`ClassDB` **ClassDB** + +:ref:`ClassDB` singleton .. _class_@GlobalScope_Engine: -- :ref:`Engine` **Engine** - :ref:`Engine` singleton +- :ref:`Engine` **Engine** + +:ref:`Engine` singleton .. _class_@GlobalScope_Geometry: -- :ref:`Geometry` **Geometry** - :ref:`Geometry` singleton +- :ref:`Geometry` **Geometry** + +:ref:`Geometry` singleton .. _class_@GlobalScope_GodotSharp: @@ -627,66 +684,97 @@ Property Descriptions .. _class_@GlobalScope_IP: -- :ref:`IP` **IP** - :ref:`IP` singleton +- :ref:`IP` **IP** + +:ref:`IP` singleton .. _class_@GlobalScope_Input: -- :ref:`Input` **Input** - :ref:`Input` singleton +- :ref:`Input` **Input** + +:ref:`Input` singleton .. _class_@GlobalScope_InputMap: -- :ref:`InputMap` **InputMap** - :ref:`InputMap` singleton +- :ref:`InputMap` **InputMap** + +:ref:`InputMap` singleton .. _class_@GlobalScope_JSON: -- :ref:`JSON` **JSON** - :ref:`JSON` singleton +- :ref:`JSON` **JSON** + +:ref:`JSON` singleton .. _class_@GlobalScope_JavaScript: -- :ref:`JavaScript` **JavaScript** - :ref:`JavaScript` singleton +- :ref:`JavaScript` **JavaScript** + +:ref:`JavaScript` singleton .. _class_@GlobalScope_Marshalls: -- :ref:`Reference` **Marshalls** - :ref:`Marshalls` singleton +- :ref:`Reference` **Marshalls** + +:ref:`Marshalls` singleton .. _class_@GlobalScope_OS: -- :ref:`OS` **OS** - :ref:`OS` singleton +- :ref:`OS` **OS** + +:ref:`OS` singleton .. _class_@GlobalScope_Performance: -- :ref:`Performance` **Performance** - :ref:`Performance` singleton +- :ref:`Performance` **Performance** + +:ref:`Performance` singleton .. _class_@GlobalScope_Physics2DServer: -- :ref:`Physics2DServer` **Physics2DServer** - :ref:`Physics2DServer` singleton +- :ref:`Physics2DServer` **Physics2DServer** + +:ref:`Physics2DServer` singleton .. _class_@GlobalScope_PhysicsServer: -- :ref:`PhysicsServer` **PhysicsServer** - :ref:`PhysicsServer` singleton +- :ref:`PhysicsServer` **PhysicsServer** + +:ref:`PhysicsServer` singleton .. _class_@GlobalScope_ProjectSettings: -- :ref:`ProjectSettings` **ProjectSettings** - :ref:`ProjectSettings` singleton +- :ref:`ProjectSettings` **ProjectSettings** + +:ref:`ProjectSettings` singleton .. _class_@GlobalScope_ResourceLoader: -- :ref:`ResourceLoader` **ResourceLoader** - :ref:`ResourceLoader` singleton +- :ref:`ResourceLoader` **ResourceLoader** + +:ref:`ResourceLoader` singleton .. _class_@GlobalScope_ResourceSaver: -- :ref:`ResourceSaver` **ResourceSaver** - :ref:`ResourceSaver` singleton +- :ref:`ResourceSaver` **ResourceSaver** + +:ref:`ResourceSaver` singleton .. _class_@GlobalScope_TranslationServer: -- :ref:`TranslationServer` **TranslationServer** - :ref:`TranslationServer` singleton +- :ref:`TranslationServer` **TranslationServer** + +:ref:`TranslationServer` singleton .. _class_@GlobalScope_VisualScriptEditor: -- :ref:`VisualScriptEditor` **VisualScriptEditor** - :ref:`VisualScriptEditor` singleton +- :ref:`VisualScriptEditor` **VisualScriptEditor** + +:ref:`VisualScriptEditor` singleton .. _class_@GlobalScope_VisualServer: -- :ref:`VisualServer` **VisualServer** - :ref:`VisualServer` singleton +- :ref:`VisualServer` **VisualServer** +:ref:`VisualServer` singleton diff --git a/classes/class_aabb.rst b/classes/class_aabb.rst index 78ccfc449..336da5282 100644 --- a/classes/class_aabb.rst +++ b/classes/class_aabb.rst @@ -14,6 +14,17 @@ Brief Description Axis-Aligned Bounding Box. +Properties +---------- + ++-------------------------------+--------------------------------------+ +| :ref:`Vector3` | :ref:`end` | ++-------------------------------+--------------------------------------+ +| :ref:`Vector3` | :ref:`position` | ++-------------------------------+--------------------------------------+ +| :ref:`Vector3` | :ref:`size` | ++-------------------------------+--------------------------------------+ + Methods ------- @@ -70,150 +81,153 @@ Tutorials --------- - :doc:`../tutorials/math/index` - Property Descriptions --------------------- .. _class_AABB_end: -- :ref:`Vector3` **end** - Ending corner. +- :ref:`Vector3` **end** + +Ending corner. .. _class_AABB_position: -- :ref:`Vector3` **position** - Beginning corner. +- :ref:`Vector3` **position** + +Beginning corner. .. _class_AABB_size: -- :ref:`Vector3` **size** - Size from position to end. +- :ref:`Vector3` **size** +Size from position to end. Method Descriptions ------------------- -.. _class_AABB_AABB: + .. _class_AABB_AABB: - :ref:`AABB` **AABB** **(** :ref:`Vector3` position, :ref:`Vector3` size **)** Optional constructor, accepts position and size. -.. _class_AABB_encloses: + .. _class_AABB_encloses: - :ref:`bool` **encloses** **(** :ref:`AABB` with **)** Returns ``true`` if this ``AABB`` completely encloses another one. -.. _class_AABB_expand: + .. _class_AABB_expand: - :ref:`AABB` **expand** **(** :ref:`Vector3` to_point **)** Returns this ``AABB`` expanded to include a given point. -.. _class_AABB_get_area: + .. _class_AABB_get_area: - :ref:`float` **get_area** **(** **)** Gets the area of the ``AABB``. -.. _class_AABB_get_endpoint: + .. _class_AABB_get_endpoint: - :ref:`Vector3` **get_endpoint** **(** :ref:`int` idx **)** Gets the position of the 8 endpoints of the ``AABB`` in space. -.. _class_AABB_get_longest_axis: + .. _class_AABB_get_longest_axis: - :ref:`Vector3` **get_longest_axis** **(** **)** Returns the normalized longest axis of the ``AABB``. -.. _class_AABB_get_longest_axis_index: + .. _class_AABB_get_longest_axis_index: - :ref:`int` **get_longest_axis_index** **(** **)** Returns the index of the longest axis of the ``AABB`` (according to :ref:`Vector3`::AXIS\* enum). -.. _class_AABB_get_longest_axis_size: + .. _class_AABB_get_longest_axis_size: - :ref:`float` **get_longest_axis_size** **(** **)** Returns the scalar length of the longest axis of the ``AABB``. -.. _class_AABB_get_shortest_axis: + .. _class_AABB_get_shortest_axis: - :ref:`Vector3` **get_shortest_axis** **(** **)** Returns the normalized shortest axis of the ``AABB``. -.. _class_AABB_get_shortest_axis_index: + .. _class_AABB_get_shortest_axis_index: - :ref:`int` **get_shortest_axis_index** **(** **)** Returns the index of the shortest axis of the ``AABB`` (according to :ref:`Vector3`::AXIS\* enum). -.. _class_AABB_get_shortest_axis_size: + .. _class_AABB_get_shortest_axis_size: - :ref:`float` **get_shortest_axis_size** **(** **)** Returns the scalar length of the shortest axis of the ``AABB``. -.. _class_AABB_get_support: + .. _class_AABB_get_support: - :ref:`Vector3` **get_support** **(** :ref:`Vector3` dir **)** Returns the support point in a given direction. This is useful for collision detection algorithms. -.. _class_AABB_grow: + .. _class_AABB_grow: - :ref:`AABB` **grow** **(** :ref:`float` by **)** Returns a copy of the ``AABB`` grown a given amount of units towards all the sides. -.. _class_AABB_has_no_area: + .. _class_AABB_has_no_area: - :ref:`bool` **has_no_area** **(** **)** Returns ``true`` if the ``AABB`` is flat or empty. -.. _class_AABB_has_no_surface: + .. _class_AABB_has_no_surface: - :ref:`bool` **has_no_surface** **(** **)** Returns ``true`` if the ``AABB`` is empty. -.. _class_AABB_has_point: + .. _class_AABB_has_point: - :ref:`bool` **has_point** **(** :ref:`Vector3` point **)** Returns ``true`` if the ``AABB`` contains a point. -.. _class_AABB_intersection: + .. _class_AABB_intersection: - :ref:`AABB` **intersection** **(** :ref:`AABB` with **)** Returns the intersection between two ``AABB``. An empty AABB (size 0,0,0) is returned on failure. -.. _class_AABB_intersects: + .. _class_AABB_intersects: - :ref:`bool` **intersects** **(** :ref:`AABB` with **)** Returns ``true`` if the ``AABB`` overlaps with another. -.. _class_AABB_intersects_plane: + .. _class_AABB_intersects_plane: - :ref:`bool` **intersects_plane** **(** :ref:`Plane` plane **)** Returns ``true`` if the ``AABB`` is on both sides of a plane. -.. _class_AABB_intersects_segment: + .. _class_AABB_intersects_segment: - :ref:`bool` **intersects_segment** **(** :ref:`Vector3` from, :ref:`Vector3` to **)** Returns ``true`` if the ``AABB`` intersects the line segment between ``from`` and ``to``. -.. _class_AABB_merge: + .. _class_AABB_merge: - :ref:`AABB` **merge** **(** :ref:`AABB` with **)** Returns a larger AABB that contains this AABB and ``with``. - diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index 5f20ce270..994b9d703 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -8,7 +8,9 @@ AcceptDialog ============ **Inherits:** :ref:`WindowDialog` **<** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`ConfirmationDialog` + **Category:** Core Brief Description @@ -16,6 +18,15 @@ Brief Description Base dialog for user notification. +Properties +---------- + ++-----------------------------+----------------------------------------------------------------+ +| :ref:`bool` | :ref:`dialog_hide_on_ok` | ++-----------------------------+----------------------------------------------------------------+ +| :ref:`String` | :ref:`dialog_text` | ++-----------------------------+----------------------------------------------------------------+ + Methods ------- @@ -34,19 +45,18 @@ Methods Signals ------- -.. _class_AcceptDialog_confirmed: + .. _class_AcceptDialog_confirmed: - **confirmed** **(** **)** Emitted when the dialog is accepted, i.e. the OK button is pressed. -.. _class_AcceptDialog_custom_action: + .. _class_AcceptDialog_custom_action: - **custom_action** **(** :ref:`String` action **)** Emitted when a custom button is pressed. See :ref:`add_button`. - Description ----------- @@ -57,19 +67,34 @@ Property Descriptions .. _class_AcceptDialog_dialog_hide_on_ok: -- :ref:`bool` **dialog_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``. +- :ref:`bool` **dialog_hide_on_ok** + ++----------+-----------------------+ +| *Setter* | set_hide_on_ok(value) | ++----------+-----------------------+ +| *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``. 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: -- :ref:`String` **dialog_text** - The text displayed by this dialog. +- :ref:`String` **dialog_text** ++----------+-----------------+ +| *Setter* | set_text(value) | ++----------+-----------------+ +| *Getter* | get_text() | ++----------+-----------------+ + +The text displayed by this dialog. Method Descriptions ------------------- -.. _class_AcceptDialog_add_button: + .. _class_AcceptDialog_add_button: - :ref:`Button` **add_button** **(** :ref:`String` text, :ref:`bool` right=false, :ref:`String` action="" **)** @@ -77,28 +102,27 @@ Adds a button with label *text* and a custom *action* to the dialog and returns If ``true``, *right* will place the button to the right of any sibling buttons. Default value: ``false``. -.. _class_AcceptDialog_add_cancel: + .. _class_AcceptDialog_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_get_label: - :ref:`Label` **get_label** **(** **)** Return the label used for built-in text. -.. _class_AcceptDialog_get_ok: + .. _class_AcceptDialog_get_ok: - :ref:`Button` **get_ok** **(** **)** Return the OK Button. -.. _class_AcceptDialog_register_text_enter: + .. _class_AcceptDialog_register_text_enter: - void **register_text_enter** **(** :ref:`Node` line_edit **)** Registers a :ref:`LineEdit` in the dialog. When the enter key is pressed, the dialog will be accepted. - diff --git a/classes/class_animatedsprite.rst b/classes/class_animatedsprite.rst index 626eaae49..7cd94addd 100644 --- a/classes/class_animatedsprite.rst +++ b/classes/class_animatedsprite.rst @@ -8,6 +8,7 @@ AnimatedSprite ============== **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,29 @@ Brief Description 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` | ++-----------------------------------------+------------------------------------------------------+ + Methods ------- @@ -29,19 +53,18 @@ Methods Signals ------- -.. _class_AnimatedSprite_animation_finished: + .. _class_AnimatedSprite_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_frame_changed: - **frame_changed** **(** **)** Emitted when :ref:`frame` changed. - Description ----------- @@ -52,60 +75,122 @@ Property Descriptions .. _class_AnimatedSprite_animation: -- :ref:`String` **animation** - The current animation from the ``frames`` resource. If this value changes, the ``frame`` counter is reset. +- :ref:`String` **animation** + ++----------+----------------------+ +| *Setter* | set_animation(value) | ++----------+----------------------+ +| *Getter* | get_animation() | ++----------+----------------------+ + +The current animation from the ``frames`` resource. If this value changes, the ``frame`` counter is reset. .. _class_AnimatedSprite_centered: -- :ref:`bool` **centered** - If ``true`` texture will be centered. Default value: ``true``. +- :ref:`bool` **centered** + ++----------+---------------------+ +| *Setter* | set_centered(value) | ++----------+---------------------+ +| *Getter* | is_centered() | ++----------+---------------------+ + +If ``true`` texture will be centered. Default value: ``true``. .. _class_AnimatedSprite_flip_h: -- :ref:`bool` **flip_h** - If ``true`` texture is flipped horizontally. Default value: ``false``. +- :ref:`bool` **flip_h** + ++----------+-------------------+ +| *Setter* | set_flip_h(value) | ++----------+-------------------+ +| *Getter* | is_flipped_h() | ++----------+-------------------+ + +If ``true`` texture is flipped horizontally. Default value: ``false``. .. _class_AnimatedSprite_flip_v: -- :ref:`bool` **flip_v** - If ``true`` texture is flipped vertically. Default value: ``false``. +- :ref:`bool` **flip_v** + ++----------+-------------------+ +| *Setter* | set_flip_v(value) | ++----------+-------------------+ +| *Getter* | is_flipped_v() | ++----------+-------------------+ + +If ``true`` texture is flipped vertically. Default value: ``false``. .. _class_AnimatedSprite_frame: -- :ref:`int` **frame** - The displayed animation frame's index. +- :ref:`int` **frame** + ++----------+------------------+ +| *Setter* | set_frame(value) | ++----------+------------------+ +| *Getter* | get_frame() | ++----------+------------------+ + +The displayed animation frame's index. .. _class_AnimatedSprite_frames: -- :ref:`SpriteFrames` **frames** - The :ref:`SpriteFrames` resource containing the animation(s). +- :ref:`SpriteFrames` **frames** + ++----------+--------------------------+ +| *Setter* | set_sprite_frames(value) | ++----------+--------------------------+ +| *Getter* | get_sprite_frames() | ++----------+--------------------------+ + +The :ref:`SpriteFrames` resource containing the animation(s). .. _class_AnimatedSprite_offset: -- :ref:`Vector2` **offset** - The texture's drawing offset. +- :ref:`Vector2` **offset** + ++----------+-------------------+ +| *Setter* | set_offset(value) | ++----------+-------------------+ +| *Getter* | get_offset() | ++----------+-------------------+ + +The texture's drawing offset. .. _class_AnimatedSprite_playing: -- :ref:`bool` **playing** - If ``true`` the :ref:`animation` is currently playing. +- :ref:`bool` **playing** + +If ``true`` the :ref:`animation` is currently playing. .. _class_AnimatedSprite_speed_scale: - :ref:`float` **speed_scale** ++----------+------------------------+ +| *Setter* | set_speed_scale(value) | ++----------+------------------------+ +| *Getter* | get_speed_scale() | ++----------+------------------------+ Method Descriptions ------------------- -.. _class_AnimatedSprite_is_playing: + .. _class_AnimatedSprite_is_playing: - :ref:`bool` **is_playing** **(** **)** const Return true if an animation if currently being played. -.. _class_AnimatedSprite_play: + .. _class_AnimatedSprite_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_stop: - void **stop** **(** **)** Stop the current animation (does not reset the frame counter). - diff --git a/classes/class_animatedsprite3d.rst b/classes/class_animatedsprite3d.rst index 75ab61fe9..ca152aff6 100644 --- a/classes/class_animatedsprite3d.rst +++ b/classes/class_animatedsprite3d.rst @@ -8,6 +8,7 @@ AnimatedSprite3D ================ **Inherits:** :ref:`SpriteBase3D` **<** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,19 @@ Brief Description 2D sprite node in 3D world, that can use multiple 2D textures for animation. +Properties +---------- + ++-----------------------------------------+----------------------------------------------------+ +| :ref:`String` | :ref:`animation` | ++-----------------------------------------+----------------------------------------------------+ +| :ref:`int` | :ref:`frame` | ++-----------------------------------------+----------------------------------------------------+ +| :ref:`SpriteFrames` | :ref:`frames` | ++-----------------------------------------+----------------------------------------------------+ +| :ref:`bool` | :ref:`playing` | ++-----------------------------------------+----------------------------------------------------+ + Methods ------- @@ -29,13 +43,12 @@ Methods Signals ------- -.. _class_AnimatedSprite3D_frame_changed: + .. _class_AnimatedSprite3D_frame_changed: - **frame_changed** **(** **)** Emitted when :ref:`frame` changed. - Description ----------- @@ -46,40 +59,64 @@ Property Descriptions .. _class_AnimatedSprite3D_animation: -- :ref:`String` **animation** - The current animation from the ``frames`` resource. If this value changes, the ``frame`` counter is reset. +- :ref:`String` **animation** + ++----------+----------------------+ +| *Setter* | set_animation(value) | ++----------+----------------------+ +| *Getter* | get_animation() | ++----------+----------------------+ + +The current animation from the ``frames`` resource. If this value changes, the ``frame`` counter is reset. .. _class_AnimatedSprite3D_frame: -- :ref:`int` **frame** - The displayed animation frame's index. +- :ref:`int` **frame** + ++----------+------------------+ +| *Setter* | set_frame(value) | ++----------+------------------+ +| *Getter* | get_frame() | ++----------+------------------+ + +The displayed animation frame's index. .. _class_AnimatedSprite3D_frames: -- :ref:`SpriteFrames` **frames** - The :ref:`SpriteFrames` resource containing the animation(s). +- :ref:`SpriteFrames` **frames** + ++----------+--------------------------+ +| *Setter* | set_sprite_frames(value) | ++----------+--------------------------+ +| *Getter* | get_sprite_frames() | ++----------+--------------------------+ + +The :ref:`SpriteFrames` resource containing the animation(s). .. _class_AnimatedSprite3D_playing: -- :ref:`bool` **playing** - If ``true`` the :ref:`animation` is currently playing. +- :ref:`bool` **playing** +If ``true`` the :ref:`animation` is currently playing. Method Descriptions ------------------- -.. _class_AnimatedSprite3D_is_playing: + .. _class_AnimatedSprite3D_is_playing: - :ref:`bool` **is_playing** **(** **)** const Return true if an animation if currently being played. -.. _class_AnimatedSprite3D_play: + .. _class_AnimatedSprite3D_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_stop: - void **stop** **(** **)** Stop the current animation (does not reset the frame counter). - diff --git a/classes/class_animatedtexture.rst b/classes/class_animatedtexture.rst index 0351df64e..76084fc1f 100644 --- a/classes/class_animatedtexture.rst +++ b/classes/class_animatedtexture.rst @@ -8,6 +8,7 @@ AnimatedTexture =============== **Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,1039 @@ Brief Description +Properties +---------- + ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`fps` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_0/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_0/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_1/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_1/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_10/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_10/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_100/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_100/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_101/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_101/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_102/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_102/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_103/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_103/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_104/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_104/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_105/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_105/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_106/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_106/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_107/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_107/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_108/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_108/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_109/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_109/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_11/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_11/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_110/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_110/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_111/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_111/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_112/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_112/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_113/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_113/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_114/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_114/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_115/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_115/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_116/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_116/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_117/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_117/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_118/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_118/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_119/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_119/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_12/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_12/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_120/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_120/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_121/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_121/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_122/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_122/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_123/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_123/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_124/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_124/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_125/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_125/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_126/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_126/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_127/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_127/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_128/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_128/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_129/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_129/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_13/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_13/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_130/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_130/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_131/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_131/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_132/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_132/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_133/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_133/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_134/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_134/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_135/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_135/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_136/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_136/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_137/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_137/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_138/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_138/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_139/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_139/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_14/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_14/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_140/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_140/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_141/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_141/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_142/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_142/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_143/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_143/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_144/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_144/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_145/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_145/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_146/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_146/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_147/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_147/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_148/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_148/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_149/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_149/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_15/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_15/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_150/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_150/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_151/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_151/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_152/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_152/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_153/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_153/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_154/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_154/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_155/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_155/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_156/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_156/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_157/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_157/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_158/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_158/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_159/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_159/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_16/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_16/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_160/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_160/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_161/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_161/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_162/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_162/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_163/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_163/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_164/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_164/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_165/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_165/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_166/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_166/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_167/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_167/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_168/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_168/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_169/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_169/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_17/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_17/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_170/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_170/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_171/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_171/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_172/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_172/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_173/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_173/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_174/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_174/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_175/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_175/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_176/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_176/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_177/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_177/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_178/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_178/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_179/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_179/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_18/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_18/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_180/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_180/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_181/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_181/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_182/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_182/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_183/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_183/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_184/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_184/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_185/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_185/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_186/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_186/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_187/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_187/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_188/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_188/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_189/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_189/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_19/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_19/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_190/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_190/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_191/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_191/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_192/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_192/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_193/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_193/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_194/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_194/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_195/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_195/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_196/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_196/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_197/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_197/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_198/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_198/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_199/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_199/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_2/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_2/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_20/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_20/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_200/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_200/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_201/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_201/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_202/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_202/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_203/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_203/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_204/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_204/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_205/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_205/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_206/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_206/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_207/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_207/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_208/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_208/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_209/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_209/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_21/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_21/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_210/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_210/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_211/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_211/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_212/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_212/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_213/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_213/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_214/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_214/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_215/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_215/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_216/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_216/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_217/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_217/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_218/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_218/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_219/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_219/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_22/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_22/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_220/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_220/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_221/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_221/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_222/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_222/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_223/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_223/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_224/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_224/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_225/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_225/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_226/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_226/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_227/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_227/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_228/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_228/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_229/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_229/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_23/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_23/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_230/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_230/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_231/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_231/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_232/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_232/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_233/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_233/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_234/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_234/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_235/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_235/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_236/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_236/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_237/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_237/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_238/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_238/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_239/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_239/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_24/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_24/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_240/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_240/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_241/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_241/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_242/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_242/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_243/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_243/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_244/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_244/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_245/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_245/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_246/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_246/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_247/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_247/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_248/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_248/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_249/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_249/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_25/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_25/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_250/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_250/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_251/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_251/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_252/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_252/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_253/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_253/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_254/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_254/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_255/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_255/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_26/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_26/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_27/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_27/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_28/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_28/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_29/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_29/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_3/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_3/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_30/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_30/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_31/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_31/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_32/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_32/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_33/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_33/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_34/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_34/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_35/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_35/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_36/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_36/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_37/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_37/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_38/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_38/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_39/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_39/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_4/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_4/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_40/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_40/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_41/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_41/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_42/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_42/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_43/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_43/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_44/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_44/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_45/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_45/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_46/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_46/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_47/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_47/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_48/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_48/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_49/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_49/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_5/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_5/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_50/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_50/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_51/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_51/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_52/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_52/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_53/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_53/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_54/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_54/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_55/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_55/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_56/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_56/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_57/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_57/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_58/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_58/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_59/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_59/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_6/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_6/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_60/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_60/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_61/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_61/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_62/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_62/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_63/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_63/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_64/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_64/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_65/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_65/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_66/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_66/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_67/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_67/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_68/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_68/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_69/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_69/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_7/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_7/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_70/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_70/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_71/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_71/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_72/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_72/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_73/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_73/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_74/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_74/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_75/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_75/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_76/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_76/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_77/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_77/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_78/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_78/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_79/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_79/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_8/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_8/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_80/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_80/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_81/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_81/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_82/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_82/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_83/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_83/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_84/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_84/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_85/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_85/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_86/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_86/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_87/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_87/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_88/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_88/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_89/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_89/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_9/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_9/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_90/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_90/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_91/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_91/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_92/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_92/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_93/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_93/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_94/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_94/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_95/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_95/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_96/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_96/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_97/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_97/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_98/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_98/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`float` | :ref:`frame_99/delay_sec` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`frame_99/texture` | ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`int` | :ref:`frames` | ++-------------------------------+-----------------------------------------------------------------------+ + Property Descriptions --------------------- @@ -22,2056 +1056,5139 @@ Property Descriptions - :ref:`float` **fps** ++----------+----------------+ +| *Setter* | set_fps(value) | ++----------+----------------+ +| *Getter* | get_fps() | ++----------+----------------+ + .. _class_AnimatedTexture_frame_0/delay_sec: - :ref:`float` **frame_0/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_0/texture: - :ref:`Texture` **frame_0/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_1/delay_sec: - :ref:`float` **frame_1/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_1/texture: - :ref:`Texture` **frame_1/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_10/delay_sec: - :ref:`float` **frame_10/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_10/texture: - :ref:`Texture` **frame_10/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_100/delay_sec: - :ref:`float` **frame_100/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_100/texture: - :ref:`Texture` **frame_100/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_101/delay_sec: - :ref:`float` **frame_101/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_101/texture: - :ref:`Texture` **frame_101/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_102/delay_sec: - :ref:`float` **frame_102/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_102/texture: - :ref:`Texture` **frame_102/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_103/delay_sec: - :ref:`float` **frame_103/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_103/texture: - :ref:`Texture` **frame_103/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_104/delay_sec: - :ref:`float` **frame_104/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_104/texture: - :ref:`Texture` **frame_104/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_105/delay_sec: - :ref:`float` **frame_105/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_105/texture: - :ref:`Texture` **frame_105/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_106/delay_sec: - :ref:`float` **frame_106/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_106/texture: - :ref:`Texture` **frame_106/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_107/delay_sec: - :ref:`float` **frame_107/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_107/texture: - :ref:`Texture` **frame_107/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_108/delay_sec: - :ref:`float` **frame_108/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_108/texture: - :ref:`Texture` **frame_108/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_109/delay_sec: - :ref:`float` **frame_109/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_109/texture: - :ref:`Texture` **frame_109/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_11/delay_sec: - :ref:`float` **frame_11/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_11/texture: - :ref:`Texture` **frame_11/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_110/delay_sec: - :ref:`float` **frame_110/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_110/texture: - :ref:`Texture` **frame_110/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_111/delay_sec: - :ref:`float` **frame_111/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_111/texture: - :ref:`Texture` **frame_111/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_112/delay_sec: - :ref:`float` **frame_112/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_112/texture: - :ref:`Texture` **frame_112/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_113/delay_sec: - :ref:`float` **frame_113/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_113/texture: - :ref:`Texture` **frame_113/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_114/delay_sec: - :ref:`float` **frame_114/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_114/texture: - :ref:`Texture` **frame_114/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_115/delay_sec: - :ref:`float` **frame_115/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_115/texture: - :ref:`Texture` **frame_115/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_116/delay_sec: - :ref:`float` **frame_116/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_116/texture: - :ref:`Texture` **frame_116/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_117/delay_sec: - :ref:`float` **frame_117/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_117/texture: - :ref:`Texture` **frame_117/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_118/delay_sec: - :ref:`float` **frame_118/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_118/texture: - :ref:`Texture` **frame_118/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_119/delay_sec: - :ref:`float` **frame_119/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_119/texture: - :ref:`Texture` **frame_119/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_12/delay_sec: - :ref:`float` **frame_12/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_12/texture: - :ref:`Texture` **frame_12/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_120/delay_sec: - :ref:`float` **frame_120/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_120/texture: - :ref:`Texture` **frame_120/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_121/delay_sec: - :ref:`float` **frame_121/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_121/texture: - :ref:`Texture` **frame_121/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_122/delay_sec: - :ref:`float` **frame_122/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_122/texture: - :ref:`Texture` **frame_122/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_123/delay_sec: - :ref:`float` **frame_123/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_123/texture: - :ref:`Texture` **frame_123/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_124/delay_sec: - :ref:`float` **frame_124/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_124/texture: - :ref:`Texture` **frame_124/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_125/delay_sec: - :ref:`float` **frame_125/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_125/texture: - :ref:`Texture` **frame_125/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_126/delay_sec: - :ref:`float` **frame_126/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_126/texture: - :ref:`Texture` **frame_126/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_127/delay_sec: - :ref:`float` **frame_127/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_127/texture: - :ref:`Texture` **frame_127/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_128/delay_sec: - :ref:`float` **frame_128/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_128/texture: - :ref:`Texture` **frame_128/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_129/delay_sec: - :ref:`float` **frame_129/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_129/texture: - :ref:`Texture` **frame_129/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_13/delay_sec: - :ref:`float` **frame_13/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_13/texture: - :ref:`Texture` **frame_13/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_130/delay_sec: - :ref:`float` **frame_130/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_130/texture: - :ref:`Texture` **frame_130/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_131/delay_sec: - :ref:`float` **frame_131/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_131/texture: - :ref:`Texture` **frame_131/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_132/delay_sec: - :ref:`float` **frame_132/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_132/texture: - :ref:`Texture` **frame_132/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_133/delay_sec: - :ref:`float` **frame_133/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_133/texture: - :ref:`Texture` **frame_133/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_134/delay_sec: - :ref:`float` **frame_134/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_134/texture: - :ref:`Texture` **frame_134/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_135/delay_sec: - :ref:`float` **frame_135/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_135/texture: - :ref:`Texture` **frame_135/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_136/delay_sec: - :ref:`float` **frame_136/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_136/texture: - :ref:`Texture` **frame_136/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_137/delay_sec: - :ref:`float` **frame_137/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_137/texture: - :ref:`Texture` **frame_137/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_138/delay_sec: - :ref:`float` **frame_138/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_138/texture: - :ref:`Texture` **frame_138/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_139/delay_sec: - :ref:`float` **frame_139/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_139/texture: - :ref:`Texture` **frame_139/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_14/delay_sec: - :ref:`float` **frame_14/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_14/texture: - :ref:`Texture` **frame_14/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_140/delay_sec: - :ref:`float` **frame_140/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_140/texture: - :ref:`Texture` **frame_140/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_141/delay_sec: - :ref:`float` **frame_141/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_141/texture: - :ref:`Texture` **frame_141/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_142/delay_sec: - :ref:`float` **frame_142/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_142/texture: - :ref:`Texture` **frame_142/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_143/delay_sec: - :ref:`float` **frame_143/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_143/texture: - :ref:`Texture` **frame_143/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_144/delay_sec: - :ref:`float` **frame_144/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_144/texture: - :ref:`Texture` **frame_144/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_145/delay_sec: - :ref:`float` **frame_145/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_145/texture: - :ref:`Texture` **frame_145/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_146/delay_sec: - :ref:`float` **frame_146/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_146/texture: - :ref:`Texture` **frame_146/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_147/delay_sec: - :ref:`float` **frame_147/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_147/texture: - :ref:`Texture` **frame_147/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_148/delay_sec: - :ref:`float` **frame_148/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_148/texture: - :ref:`Texture` **frame_148/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_149/delay_sec: - :ref:`float` **frame_149/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_149/texture: - :ref:`Texture` **frame_149/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_15/delay_sec: - :ref:`float` **frame_15/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_15/texture: - :ref:`Texture` **frame_15/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_150/delay_sec: - :ref:`float` **frame_150/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_150/texture: - :ref:`Texture` **frame_150/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_151/delay_sec: - :ref:`float` **frame_151/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_151/texture: - :ref:`Texture` **frame_151/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_152/delay_sec: - :ref:`float` **frame_152/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_152/texture: - :ref:`Texture` **frame_152/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_153/delay_sec: - :ref:`float` **frame_153/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_153/texture: - :ref:`Texture` **frame_153/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_154/delay_sec: - :ref:`float` **frame_154/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_154/texture: - :ref:`Texture` **frame_154/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_155/delay_sec: - :ref:`float` **frame_155/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_155/texture: - :ref:`Texture` **frame_155/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_156/delay_sec: - :ref:`float` **frame_156/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_156/texture: - :ref:`Texture` **frame_156/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_157/delay_sec: - :ref:`float` **frame_157/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_157/texture: - :ref:`Texture` **frame_157/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_158/delay_sec: - :ref:`float` **frame_158/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_158/texture: - :ref:`Texture` **frame_158/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_159/delay_sec: - :ref:`float` **frame_159/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_159/texture: - :ref:`Texture` **frame_159/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_16/delay_sec: - :ref:`float` **frame_16/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_16/texture: - :ref:`Texture` **frame_16/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_160/delay_sec: - :ref:`float` **frame_160/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_160/texture: - :ref:`Texture` **frame_160/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_161/delay_sec: - :ref:`float` **frame_161/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_161/texture: - :ref:`Texture` **frame_161/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_162/delay_sec: - :ref:`float` **frame_162/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_162/texture: - :ref:`Texture` **frame_162/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_163/delay_sec: - :ref:`float` **frame_163/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_163/texture: - :ref:`Texture` **frame_163/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_164/delay_sec: - :ref:`float` **frame_164/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_164/texture: - :ref:`Texture` **frame_164/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_165/delay_sec: - :ref:`float` **frame_165/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_165/texture: - :ref:`Texture` **frame_165/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_166/delay_sec: - :ref:`float` **frame_166/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_166/texture: - :ref:`Texture` **frame_166/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_167/delay_sec: - :ref:`float` **frame_167/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_167/texture: - :ref:`Texture` **frame_167/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_168/delay_sec: - :ref:`float` **frame_168/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_168/texture: - :ref:`Texture` **frame_168/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_169/delay_sec: - :ref:`float` **frame_169/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_169/texture: - :ref:`Texture` **frame_169/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_17/delay_sec: - :ref:`float` **frame_17/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_17/texture: - :ref:`Texture` **frame_17/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_170/delay_sec: - :ref:`float` **frame_170/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_170/texture: - :ref:`Texture` **frame_170/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_171/delay_sec: - :ref:`float` **frame_171/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_171/texture: - :ref:`Texture` **frame_171/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_172/delay_sec: - :ref:`float` **frame_172/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_172/texture: - :ref:`Texture` **frame_172/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_173/delay_sec: - :ref:`float` **frame_173/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_173/texture: - :ref:`Texture` **frame_173/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_174/delay_sec: - :ref:`float` **frame_174/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_174/texture: - :ref:`Texture` **frame_174/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_175/delay_sec: - :ref:`float` **frame_175/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_175/texture: - :ref:`Texture` **frame_175/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_176/delay_sec: - :ref:`float` **frame_176/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_176/texture: - :ref:`Texture` **frame_176/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_177/delay_sec: - :ref:`float` **frame_177/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_177/texture: - :ref:`Texture` **frame_177/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_178/delay_sec: - :ref:`float` **frame_178/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_178/texture: - :ref:`Texture` **frame_178/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_179/delay_sec: - :ref:`float` **frame_179/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_179/texture: - :ref:`Texture` **frame_179/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_18/delay_sec: - :ref:`float` **frame_18/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_18/texture: - :ref:`Texture` **frame_18/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_180/delay_sec: - :ref:`float` **frame_180/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_180/texture: - :ref:`Texture` **frame_180/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_181/delay_sec: - :ref:`float` **frame_181/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_181/texture: - :ref:`Texture` **frame_181/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_182/delay_sec: - :ref:`float` **frame_182/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_182/texture: - :ref:`Texture` **frame_182/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_183/delay_sec: - :ref:`float` **frame_183/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_183/texture: - :ref:`Texture` **frame_183/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_184/delay_sec: - :ref:`float` **frame_184/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_184/texture: - :ref:`Texture` **frame_184/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_185/delay_sec: - :ref:`float` **frame_185/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_185/texture: - :ref:`Texture` **frame_185/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_186/delay_sec: - :ref:`float` **frame_186/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_186/texture: - :ref:`Texture` **frame_186/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_187/delay_sec: - :ref:`float` **frame_187/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_187/texture: - :ref:`Texture` **frame_187/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_188/delay_sec: - :ref:`float` **frame_188/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_188/texture: - :ref:`Texture` **frame_188/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_189/delay_sec: - :ref:`float` **frame_189/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_189/texture: - :ref:`Texture` **frame_189/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_19/delay_sec: - :ref:`float` **frame_19/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_19/texture: - :ref:`Texture` **frame_19/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_190/delay_sec: - :ref:`float` **frame_190/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_190/texture: - :ref:`Texture` **frame_190/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_191/delay_sec: - :ref:`float` **frame_191/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_191/texture: - :ref:`Texture` **frame_191/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_192/delay_sec: - :ref:`float` **frame_192/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_192/texture: - :ref:`Texture` **frame_192/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_193/delay_sec: - :ref:`float` **frame_193/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_193/texture: - :ref:`Texture` **frame_193/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_194/delay_sec: - :ref:`float` **frame_194/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_194/texture: - :ref:`Texture` **frame_194/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_195/delay_sec: - :ref:`float` **frame_195/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_195/texture: - :ref:`Texture` **frame_195/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_196/delay_sec: - :ref:`float` **frame_196/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_196/texture: - :ref:`Texture` **frame_196/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_197/delay_sec: - :ref:`float` **frame_197/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_197/texture: - :ref:`Texture` **frame_197/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_198/delay_sec: - :ref:`float` **frame_198/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_198/texture: - :ref:`Texture` **frame_198/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_199/delay_sec: - :ref:`float` **frame_199/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_199/texture: - :ref:`Texture` **frame_199/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_2/delay_sec: - :ref:`float` **frame_2/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_2/texture: - :ref:`Texture` **frame_2/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_20/delay_sec: - :ref:`float` **frame_20/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_20/texture: - :ref:`Texture` **frame_20/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_200/delay_sec: - :ref:`float` **frame_200/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_200/texture: - :ref:`Texture` **frame_200/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_201/delay_sec: - :ref:`float` **frame_201/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_201/texture: - :ref:`Texture` **frame_201/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_202/delay_sec: - :ref:`float` **frame_202/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_202/texture: - :ref:`Texture` **frame_202/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_203/delay_sec: - :ref:`float` **frame_203/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_203/texture: - :ref:`Texture` **frame_203/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_204/delay_sec: - :ref:`float` **frame_204/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_204/texture: - :ref:`Texture` **frame_204/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_205/delay_sec: - :ref:`float` **frame_205/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_205/texture: - :ref:`Texture` **frame_205/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_206/delay_sec: - :ref:`float` **frame_206/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_206/texture: - :ref:`Texture` **frame_206/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_207/delay_sec: - :ref:`float` **frame_207/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_207/texture: - :ref:`Texture` **frame_207/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_208/delay_sec: - :ref:`float` **frame_208/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_208/texture: - :ref:`Texture` **frame_208/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_209/delay_sec: - :ref:`float` **frame_209/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_209/texture: - :ref:`Texture` **frame_209/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_21/delay_sec: - :ref:`float` **frame_21/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_21/texture: - :ref:`Texture` **frame_21/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_210/delay_sec: - :ref:`float` **frame_210/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_210/texture: - :ref:`Texture` **frame_210/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_211/delay_sec: - :ref:`float` **frame_211/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_211/texture: - :ref:`Texture` **frame_211/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_212/delay_sec: - :ref:`float` **frame_212/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_212/texture: - :ref:`Texture` **frame_212/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_213/delay_sec: - :ref:`float` **frame_213/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_213/texture: - :ref:`Texture` **frame_213/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_214/delay_sec: - :ref:`float` **frame_214/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_214/texture: - :ref:`Texture` **frame_214/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_215/delay_sec: - :ref:`float` **frame_215/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_215/texture: - :ref:`Texture` **frame_215/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_216/delay_sec: - :ref:`float` **frame_216/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_216/texture: - :ref:`Texture` **frame_216/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_217/delay_sec: - :ref:`float` **frame_217/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_217/texture: - :ref:`Texture` **frame_217/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_218/delay_sec: - :ref:`float` **frame_218/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_218/texture: - :ref:`Texture` **frame_218/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_219/delay_sec: - :ref:`float` **frame_219/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_219/texture: - :ref:`Texture` **frame_219/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_22/delay_sec: - :ref:`float` **frame_22/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_22/texture: - :ref:`Texture` **frame_22/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_220/delay_sec: - :ref:`float` **frame_220/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_220/texture: - :ref:`Texture` **frame_220/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_221/delay_sec: - :ref:`float` **frame_221/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_221/texture: - :ref:`Texture` **frame_221/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_222/delay_sec: - :ref:`float` **frame_222/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_222/texture: - :ref:`Texture` **frame_222/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_223/delay_sec: - :ref:`float` **frame_223/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_223/texture: - :ref:`Texture` **frame_223/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_224/delay_sec: - :ref:`float` **frame_224/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_224/texture: - :ref:`Texture` **frame_224/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_225/delay_sec: - :ref:`float` **frame_225/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_225/texture: - :ref:`Texture` **frame_225/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_226/delay_sec: - :ref:`float` **frame_226/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_226/texture: - :ref:`Texture` **frame_226/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_227/delay_sec: - :ref:`float` **frame_227/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_227/texture: - :ref:`Texture` **frame_227/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_228/delay_sec: - :ref:`float` **frame_228/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_228/texture: - :ref:`Texture` **frame_228/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_229/delay_sec: - :ref:`float` **frame_229/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_229/texture: - :ref:`Texture` **frame_229/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_23/delay_sec: - :ref:`float` **frame_23/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_23/texture: - :ref:`Texture` **frame_23/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_230/delay_sec: - :ref:`float` **frame_230/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_230/texture: - :ref:`Texture` **frame_230/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_231/delay_sec: - :ref:`float` **frame_231/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_231/texture: - :ref:`Texture` **frame_231/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_232/delay_sec: - :ref:`float` **frame_232/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_232/texture: - :ref:`Texture` **frame_232/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_233/delay_sec: - :ref:`float` **frame_233/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_233/texture: - :ref:`Texture` **frame_233/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_234/delay_sec: - :ref:`float` **frame_234/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_234/texture: - :ref:`Texture` **frame_234/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_235/delay_sec: - :ref:`float` **frame_235/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_235/texture: - :ref:`Texture` **frame_235/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_236/delay_sec: - :ref:`float` **frame_236/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_236/texture: - :ref:`Texture` **frame_236/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_237/delay_sec: - :ref:`float` **frame_237/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_237/texture: - :ref:`Texture` **frame_237/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_238/delay_sec: - :ref:`float` **frame_238/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_238/texture: - :ref:`Texture` **frame_238/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_239/delay_sec: - :ref:`float` **frame_239/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_239/texture: - :ref:`Texture` **frame_239/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_24/delay_sec: - :ref:`float` **frame_24/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_24/texture: - :ref:`Texture` **frame_24/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_240/delay_sec: - :ref:`float` **frame_240/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_240/texture: - :ref:`Texture` **frame_240/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_241/delay_sec: - :ref:`float` **frame_241/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_241/texture: - :ref:`Texture` **frame_241/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_242/delay_sec: - :ref:`float` **frame_242/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_242/texture: - :ref:`Texture` **frame_242/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_243/delay_sec: - :ref:`float` **frame_243/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_243/texture: - :ref:`Texture` **frame_243/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_244/delay_sec: - :ref:`float` **frame_244/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_244/texture: - :ref:`Texture` **frame_244/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_245/delay_sec: - :ref:`float` **frame_245/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_245/texture: - :ref:`Texture` **frame_245/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_246/delay_sec: - :ref:`float` **frame_246/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_246/texture: - :ref:`Texture` **frame_246/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_247/delay_sec: - :ref:`float` **frame_247/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_247/texture: - :ref:`Texture` **frame_247/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_248/delay_sec: - :ref:`float` **frame_248/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_248/texture: - :ref:`Texture` **frame_248/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_249/delay_sec: - :ref:`float` **frame_249/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_249/texture: - :ref:`Texture` **frame_249/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_25/delay_sec: - :ref:`float` **frame_25/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_25/texture: - :ref:`Texture` **frame_25/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_250/delay_sec: - :ref:`float` **frame_250/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_250/texture: - :ref:`Texture` **frame_250/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_251/delay_sec: - :ref:`float` **frame_251/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_251/texture: - :ref:`Texture` **frame_251/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_252/delay_sec: - :ref:`float` **frame_252/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_252/texture: - :ref:`Texture` **frame_252/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_253/delay_sec: - :ref:`float` **frame_253/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_253/texture: - :ref:`Texture` **frame_253/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_254/delay_sec: - :ref:`float` **frame_254/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_254/texture: - :ref:`Texture` **frame_254/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_255/delay_sec: - :ref:`float` **frame_255/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_255/texture: - :ref:`Texture` **frame_255/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_26/delay_sec: - :ref:`float` **frame_26/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_26/texture: - :ref:`Texture` **frame_26/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_27/delay_sec: - :ref:`float` **frame_27/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_27/texture: - :ref:`Texture` **frame_27/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_28/delay_sec: - :ref:`float` **frame_28/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_28/texture: - :ref:`Texture` **frame_28/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_29/delay_sec: - :ref:`float` **frame_29/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_29/texture: - :ref:`Texture` **frame_29/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_3/delay_sec: - :ref:`float` **frame_3/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_3/texture: - :ref:`Texture` **frame_3/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_30/delay_sec: - :ref:`float` **frame_30/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_30/texture: - :ref:`Texture` **frame_30/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_31/delay_sec: - :ref:`float` **frame_31/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_31/texture: - :ref:`Texture` **frame_31/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_32/delay_sec: - :ref:`float` **frame_32/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_32/texture: - :ref:`Texture` **frame_32/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_33/delay_sec: - :ref:`float` **frame_33/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_33/texture: - :ref:`Texture` **frame_33/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_34/delay_sec: - :ref:`float` **frame_34/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_34/texture: - :ref:`Texture` **frame_34/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_35/delay_sec: - :ref:`float` **frame_35/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_35/texture: - :ref:`Texture` **frame_35/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_36/delay_sec: - :ref:`float` **frame_36/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_36/texture: - :ref:`Texture` **frame_36/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_37/delay_sec: - :ref:`float` **frame_37/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_37/texture: - :ref:`Texture` **frame_37/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_38/delay_sec: - :ref:`float` **frame_38/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_38/texture: - :ref:`Texture` **frame_38/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_39/delay_sec: - :ref:`float` **frame_39/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_39/texture: - :ref:`Texture` **frame_39/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_4/delay_sec: - :ref:`float` **frame_4/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_4/texture: - :ref:`Texture` **frame_4/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_40/delay_sec: - :ref:`float` **frame_40/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_40/texture: - :ref:`Texture` **frame_40/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_41/delay_sec: - :ref:`float` **frame_41/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_41/texture: - :ref:`Texture` **frame_41/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_42/delay_sec: - :ref:`float` **frame_42/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_42/texture: - :ref:`Texture` **frame_42/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_43/delay_sec: - :ref:`float` **frame_43/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_43/texture: - :ref:`Texture` **frame_43/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_44/delay_sec: - :ref:`float` **frame_44/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_44/texture: - :ref:`Texture` **frame_44/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_45/delay_sec: - :ref:`float` **frame_45/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_45/texture: - :ref:`Texture` **frame_45/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_46/delay_sec: - :ref:`float` **frame_46/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_46/texture: - :ref:`Texture` **frame_46/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_47/delay_sec: - :ref:`float` **frame_47/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_47/texture: - :ref:`Texture` **frame_47/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_48/delay_sec: - :ref:`float` **frame_48/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_48/texture: - :ref:`Texture` **frame_48/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_49/delay_sec: - :ref:`float` **frame_49/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_49/texture: - :ref:`Texture` **frame_49/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_5/delay_sec: - :ref:`float` **frame_5/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_5/texture: - :ref:`Texture` **frame_5/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_50/delay_sec: - :ref:`float` **frame_50/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_50/texture: - :ref:`Texture` **frame_50/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_51/delay_sec: - :ref:`float` **frame_51/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_51/texture: - :ref:`Texture` **frame_51/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_52/delay_sec: - :ref:`float` **frame_52/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_52/texture: - :ref:`Texture` **frame_52/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_53/delay_sec: - :ref:`float` **frame_53/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_53/texture: - :ref:`Texture` **frame_53/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_54/delay_sec: - :ref:`float` **frame_54/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_54/texture: - :ref:`Texture` **frame_54/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_55/delay_sec: - :ref:`float` **frame_55/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_55/texture: - :ref:`Texture` **frame_55/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_56/delay_sec: - :ref:`float` **frame_56/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_56/texture: - :ref:`Texture` **frame_56/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_57/delay_sec: - :ref:`float` **frame_57/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_57/texture: - :ref:`Texture` **frame_57/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_58/delay_sec: - :ref:`float` **frame_58/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_58/texture: - :ref:`Texture` **frame_58/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_59/delay_sec: - :ref:`float` **frame_59/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_59/texture: - :ref:`Texture` **frame_59/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_6/delay_sec: - :ref:`float` **frame_6/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_6/texture: - :ref:`Texture` **frame_6/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_60/delay_sec: - :ref:`float` **frame_60/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_60/texture: - :ref:`Texture` **frame_60/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_61/delay_sec: - :ref:`float` **frame_61/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_61/texture: - :ref:`Texture` **frame_61/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_62/delay_sec: - :ref:`float` **frame_62/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_62/texture: - :ref:`Texture` **frame_62/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_63/delay_sec: - :ref:`float` **frame_63/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_63/texture: - :ref:`Texture` **frame_63/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_64/delay_sec: - :ref:`float` **frame_64/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_64/texture: - :ref:`Texture` **frame_64/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_65/delay_sec: - :ref:`float` **frame_65/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_65/texture: - :ref:`Texture` **frame_65/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_66/delay_sec: - :ref:`float` **frame_66/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_66/texture: - :ref:`Texture` **frame_66/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_67/delay_sec: - :ref:`float` **frame_67/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_67/texture: - :ref:`Texture` **frame_67/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_68/delay_sec: - :ref:`float` **frame_68/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_68/texture: - :ref:`Texture` **frame_68/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_69/delay_sec: - :ref:`float` **frame_69/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_69/texture: - :ref:`Texture` **frame_69/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_7/delay_sec: - :ref:`float` **frame_7/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_7/texture: - :ref:`Texture` **frame_7/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_70/delay_sec: - :ref:`float` **frame_70/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_70/texture: - :ref:`Texture` **frame_70/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_71/delay_sec: - :ref:`float` **frame_71/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_71/texture: - :ref:`Texture` **frame_71/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_72/delay_sec: - :ref:`float` **frame_72/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_72/texture: - :ref:`Texture` **frame_72/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_73/delay_sec: - :ref:`float` **frame_73/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_73/texture: - :ref:`Texture` **frame_73/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_74/delay_sec: - :ref:`float` **frame_74/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_74/texture: - :ref:`Texture` **frame_74/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_75/delay_sec: - :ref:`float` **frame_75/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_75/texture: - :ref:`Texture` **frame_75/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_76/delay_sec: - :ref:`float` **frame_76/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_76/texture: - :ref:`Texture` **frame_76/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_77/delay_sec: - :ref:`float` **frame_77/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_77/texture: - :ref:`Texture` **frame_77/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_78/delay_sec: - :ref:`float` **frame_78/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_78/texture: - :ref:`Texture` **frame_78/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_79/delay_sec: - :ref:`float` **frame_79/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_79/texture: - :ref:`Texture` **frame_79/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_8/delay_sec: - :ref:`float` **frame_8/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_8/texture: - :ref:`Texture` **frame_8/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_80/delay_sec: - :ref:`float` **frame_80/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_80/texture: - :ref:`Texture` **frame_80/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_81/delay_sec: - :ref:`float` **frame_81/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_81/texture: - :ref:`Texture` **frame_81/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_82/delay_sec: - :ref:`float` **frame_82/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_82/texture: - :ref:`Texture` **frame_82/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_83/delay_sec: - :ref:`float` **frame_83/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_83/texture: - :ref:`Texture` **frame_83/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_84/delay_sec: - :ref:`float` **frame_84/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_84/texture: - :ref:`Texture` **frame_84/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_85/delay_sec: - :ref:`float` **frame_85/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_85/texture: - :ref:`Texture` **frame_85/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_86/delay_sec: - :ref:`float` **frame_86/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_86/texture: - :ref:`Texture` **frame_86/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_87/delay_sec: - :ref:`float` **frame_87/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_87/texture: - :ref:`Texture` **frame_87/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_88/delay_sec: - :ref:`float` **frame_88/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_88/texture: - :ref:`Texture` **frame_88/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_89/delay_sec: - :ref:`float` **frame_89/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_89/texture: - :ref:`Texture` **frame_89/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_9/delay_sec: - :ref:`float` **frame_9/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_9/texture: - :ref:`Texture` **frame_9/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_90/delay_sec: - :ref:`float` **frame_90/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_90/texture: - :ref:`Texture` **frame_90/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_91/delay_sec: - :ref:`float` **frame_91/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_91/texture: - :ref:`Texture` **frame_91/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_92/delay_sec: - :ref:`float` **frame_92/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_92/texture: - :ref:`Texture` **frame_92/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_93/delay_sec: - :ref:`float` **frame_93/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_93/texture: - :ref:`Texture` **frame_93/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_94/delay_sec: - :ref:`float` **frame_94/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_94/texture: - :ref:`Texture` **frame_94/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_95/delay_sec: - :ref:`float` **frame_95/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_95/texture: - :ref:`Texture` **frame_95/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_96/delay_sec: - :ref:`float` **frame_96/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_96/texture: - :ref:`Texture` **frame_96/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_97/delay_sec: - :ref:`float` **frame_97/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_97/texture: - :ref:`Texture` **frame_97/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_98/delay_sec: - :ref:`float` **frame_98/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_98/texture: - :ref:`Texture` **frame_98/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frame_99/delay_sec: - :ref:`float` **frame_99/delay_sec** ++----------+------------------------+ +| *Setter* | set_frame_delay(value) | ++----------+------------------------+ +| *Getter* | get_frame_delay() | ++----------+------------------------+ + .. _class_AnimatedTexture_frame_99/texture: - :ref:`Texture` **frame_99/texture** ++----------+--------------------------+ +| *Setter* | set_frame_texture(value) | ++----------+--------------------------+ +| *Getter* | get_frame_texture() | ++----------+--------------------------+ + .. _class_AnimatedTexture_frames: - :ref:`int` **frames** ++----------+-------------------+ +| *Setter* | set_frames(value) | ++----------+-------------------+ +| *Getter* | get_frames() | ++----------+-------------------+ diff --git a/classes/class_animation.rst b/classes/class_animation.rst index e0b0eeb22..31ad273aa 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -8,6 +8,7 @@ Animation ========= **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,17 @@ Brief Description Contains data used to animate everything in the engine. +Properties +---------- + ++---------------------------+---------------------------------------+ +| :ref:`float` | :ref:`length` | ++---------------------------+---------------------------------------+ +| :ref:`bool` | :ref:`loop` | ++---------------------------+---------------------------------------+ +| :ref:`float` | :ref:`step` | ++---------------------------+---------------------------------------+ + Methods ------- @@ -137,7 +149,7 @@ Enumerations .. _enum_Animation_UpdateMode: -enum **UpdateMode** +enum **UpdateMode**: - **UPDATE_CONTINUOUS** = **0** --- Update between keyframes. - **UPDATE_DISCRETE** = **1** --- Update at the keyframes and hold the value. @@ -146,7 +158,7 @@ enum **UpdateMode** .. _enum_Animation_InterpolationType: -enum **InterpolationType** +enum **InterpolationType**: - **INTERPOLATION_NEAREST** = **0** --- No interpolation (nearest value). - **INTERPOLATION_LINEAR** = **1** --- Linear interpolation. @@ -154,7 +166,7 @@ enum **InterpolationType** .. _enum_Animation_TrackType: -enum **TrackType** +enum **TrackType**: - **TYPE_VALUE** = **0** --- Value tracks set values in node properties, but only those which can be Interpolated. - **TYPE_TRANSFORM** = **1** --- Transform tracks are used to change node local transforms or skeleton pose bones. Transitions are Interpolated. @@ -163,7 +175,6 @@ enum **TrackType** - **TYPE_AUDIO** = **4** - **TYPE_ANIMATION** = **5** - Description ----------- @@ -175,285 +186,307 @@ Tutorials --------- - :doc:`../tutorials/animation/index` - Property Descriptions --------------------- .. _class_Animation_length: -- :ref:`float` **length** - 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. +- :ref:`float` **length** + ++----------+-------------------+ +| *Setter* | set_length(value) | ++----------+-------------------+ +| *Getter* | get_length() | ++----------+-------------------+ + +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: -- :ref:`bool` **loop** - 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. +- :ref:`bool` **loop** + ++----------+-----------------+ +| *Setter* | set_loop(value) | ++----------+-----------------+ +| *Getter* | has_loop() | ++----------+-----------------+ + +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: -- :ref:`float` **step** - The animation step value. +- :ref:`float` **step** ++----------+-----------------+ +| *Setter* | set_step(value) | ++----------+-----------------+ +| *Getter* | get_step() | ++----------+-----------------+ + +The animation step value. Method Descriptions ------------------- -.. _class_Animation_add_track: + .. _class_Animation_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_clear: - void **clear** **(** **)** Clear the animation (clear all tracks and reset all). -.. _class_Animation_copy_track: + .. _class_Animation_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_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_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_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_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_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_remove_track: - void **remove_track** **(** :ref:`int` idx **)** Remove a track by specifying the track index. -.. _class_Animation_track_find_key: + .. _class_Animation_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_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_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_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_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_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_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_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` -.. _class_Animation_track_get_type: + .. _class_Animation_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_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_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_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_track_move_down: - void **track_move_down** **(** :ref:`int` idx **)** Move a track down. -.. _class_Animation_track_move_up: + .. _class_Animation_track_move_up: - void **track_move_up** **(** :ref:`int` idx **)** Move a track up. -.. _class_Animation_track_remove_key: + .. _class_Animation_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_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_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_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_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_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_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_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_track_set_path: - void **track_set_path** **(** :ref:`int` idx, :ref:`NodePath` path **)** @@ -461,38 +494,37 @@ 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_track_swap: - void **track_swap** **(** :ref:`int` idx, :ref:`int` with_idx **)** -.. _class_Animation_transform_track_insert_key: + .. _class_Animation_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_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_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_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_value_track_set_update_mode: - void **value_track_set_update_mode** **(** :ref:`int` idx, :ref:`UpdateMode` mode **)** Set the update mode (UPDATE\_\*) of a value track. - diff --git a/classes/class_animationnode.rst b/classes/class_animationnode.rst index 7887cb046..694fba07f 100644 --- a/classes/class_animationnode.rst +++ b/classes/class_animationnode.rst @@ -8,7 +8,9 @@ AnimationNode ============= **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`AnimationNodeAdd2`, :ref:`AnimationNodeAdd3`, :ref:`AnimationNodeTimeScale`, :ref:`AnimationRootNode`, :ref:`AnimationNodeBlend2`, :ref:`AnimationNodeBlend3`, :ref:`AnimationNodeTimeSeek`, :ref:`AnimationNodeOneShot`, :ref:`AnimationNodeTransition`, :ref:`AnimationNodeOutput` + **Category:** Core Brief Description @@ -16,6 +18,13 @@ Brief Description +Properties +---------- + ++-------------------------+-----------------------------------------------------------+ +| :ref:`bool` | :ref:`filter_enabled` | ++-------------------------+-----------------------------------------------------------+ + Methods ------- @@ -52,28 +61,26 @@ Methods Signals ------- -.. _class_AnimationNode_removed_from_graph: + .. _class_AnimationNode_removed_from_graph: - **removed_from_graph** **(** **)** -.. _class_AnimationNode_tree_changed: + .. _class_AnimationNode_tree_changed: - **tree_changed** **(** **)** - Enumerations ------------ .. _enum_AnimationNode_FilterAction: -enum **FilterAction** +enum **FilterAction**: - **FILTER_IGNORE** = **0** - **FILTER_PASS** = **1** - **FILTER_STOP** = **2** - **FILTER_BLEND** = **3** - Property Descriptions --------------------- @@ -81,64 +88,68 @@ Property Descriptions - :ref:`bool` **filter_enabled** ++----------+---------------------------+ +| *Setter* | set_filter_enabled(value) | ++----------+---------------------------+ +| *Getter* | is_filter_enabled() | ++----------+---------------------------+ Method Descriptions ------------------- -.. _class_AnimationNode_add_input: + .. _class_AnimationNode_add_input: - void **add_input** **(** :ref:`String` name **)** -.. _class_AnimationNode_blend_animation: + .. _class_AnimationNode_blend_animation: - void **blend_animation** **(** :ref:`String` animation, :ref:`float` time, :ref:`float` delta, :ref:`bool` seeked, :ref:`float` blend **)** -.. _class_AnimationNode_blend_input: + .. _class_AnimationNode_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 **)** -.. _class_AnimationNode_blend_node: + .. _class_AnimationNode_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 **)** -.. _class_AnimationNode_get_caption: + .. _class_AnimationNode_get_caption: - :ref:`String` **get_caption** **(** **)** virtual -.. _class_AnimationNode_get_input_count: + .. _class_AnimationNode_get_input_count: - :ref:`int` **get_input_count** **(** **)** const -.. _class_AnimationNode_get_input_name: + .. _class_AnimationNode_get_input_name: - :ref:`String` **get_input_name** **(** :ref:`int` input **)** -.. _class_AnimationNode_get_parameter: + .. _class_AnimationNode_get_parameter: - :ref:`Variant` **get_parameter** **(** :ref:`String` name **)** const -.. _class_AnimationNode_has_filter: + .. _class_AnimationNode_has_filter: - :ref:`String` **has_filter** **(** **)** virtual -.. _class_AnimationNode_is_path_filtered: + .. _class_AnimationNode_is_path_filtered: - :ref:`bool` **is_path_filtered** **(** :ref:`NodePath` path **)** const -.. _class_AnimationNode_process: + .. _class_AnimationNode_process: - void **process** **(** :ref:`float` time, :ref:`bool` seek **)** virtual -.. _class_AnimationNode_remove_input: + .. _class_AnimationNode_remove_input: - void **remove_input** **(** :ref:`int` index **)** -.. _class_AnimationNode_set_filter_path: + .. _class_AnimationNode_set_filter_path: - void **set_filter_path** **(** :ref:`NodePath` path, :ref:`bool` enable **)** -.. _class_AnimationNode_set_parameter: + .. _class_AnimationNode_set_parameter: - void **set_parameter** **(** :ref:`String` name, :ref:`Variant` value **)** - diff --git a/classes/class_animationnodeadd2.rst b/classes/class_animationnodeadd2.rst index 5c6168a6e..180f98326 100644 --- a/classes/class_animationnodeadd2.rst +++ b/classes/class_animationnodeadd2.rst @@ -8,6 +8,7 @@ AnimationNodeAdd2 ================= **Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description +Properties +---------- + ++-------------------------+-------------------------------------------+ +| :ref:`bool` | :ref:`sync` | ++-------------------------+-------------------------------------------+ + Property Descriptions --------------------- @@ -22,4 +30,9 @@ Property Descriptions - :ref:`bool` **sync** ++----------+---------------------+ +| *Setter* | set_use_sync(value) | ++----------+---------------------+ +| *Getter* | is_using_sync() | ++----------+---------------------+ diff --git a/classes/class_animationnodeadd3.rst b/classes/class_animationnodeadd3.rst index 987535670..8e000e76b 100644 --- a/classes/class_animationnodeadd3.rst +++ b/classes/class_animationnodeadd3.rst @@ -8,6 +8,7 @@ AnimationNodeAdd3 ================= **Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description +Properties +---------- + ++-------------------------+-------------------------------------------+ +| :ref:`bool` | :ref:`sync` | ++-------------------------+-------------------------------------------+ + Property Descriptions --------------------- @@ -22,4 +30,9 @@ Property Descriptions - :ref:`bool` **sync** ++----------+---------------------+ +| *Setter* | set_use_sync(value) | ++----------+---------------------+ +| *Getter* | is_using_sync() | ++----------+---------------------+ diff --git a/classes/class_animationnodeanimation.rst b/classes/class_animationnodeanimation.rst index abb95c0fa..f6efdd493 100644 --- a/classes/class_animationnodeanimation.rst +++ b/classes/class_animationnodeanimation.rst @@ -8,6 +8,7 @@ AnimationNodeAnimation ====================== **Inherits:** :ref:`AnimationRootNode` **<** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description +Properties +---------- + ++-----------------------------+----------------------------------------------------------+ +| :ref:`String` | :ref:`animation` | ++-----------------------------+----------------------------------------------------------+ + Methods ------- @@ -29,12 +37,16 @@ Property Descriptions - :ref:`String` **animation** ++----------+----------------------+ +| *Setter* | set_animation(value) | ++----------+----------------------+ +| *Getter* | get_animation() | ++----------+----------------------+ Method Descriptions ------------------- -.. _class_AnimationNodeAnimation_get_playback_time: + .. _class_AnimationNodeAnimation_get_playback_time: - :ref:`float` **get_playback_time** **(** **)** const - diff --git a/classes/class_animationnodeblend2.rst b/classes/class_animationnodeblend2.rst index 0c12a36d5..98302aa4d 100644 --- a/classes/class_animationnodeblend2.rst +++ b/classes/class_animationnodeblend2.rst @@ -8,6 +8,7 @@ AnimationNodeBlend2 =================== **Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description +Properties +---------- + ++-------------------------+---------------------------------------------+ +| :ref:`bool` | :ref:`sync` | ++-------------------------+---------------------------------------------+ + Property Descriptions --------------------- @@ -22,4 +30,9 @@ Property Descriptions - :ref:`bool` **sync** ++----------+---------------------+ +| *Setter* | set_use_sync(value) | ++----------+---------------------+ +| *Getter* | is_using_sync() | ++----------+---------------------+ diff --git a/classes/class_animationnodeblend3.rst b/classes/class_animationnodeblend3.rst index c8908f181..5c171280e 100644 --- a/classes/class_animationnodeblend3.rst +++ b/classes/class_animationnodeblend3.rst @@ -8,6 +8,7 @@ AnimationNodeBlend3 =================== **Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description +Properties +---------- + ++-------------------------+---------------------------------------------+ +| :ref:`bool` | :ref:`sync` | ++-------------------------+---------------------------------------------+ + Property Descriptions --------------------- @@ -22,4 +30,9 @@ Property Descriptions - :ref:`bool` **sync** ++----------+---------------------+ +| *Setter* | set_use_sync(value) | ++----------+---------------------+ +| *Getter* | is_using_sync() | ++----------+---------------------+ diff --git a/classes/class_animationnodeblendspace1d.rst b/classes/class_animationnodeblendspace1d.rst index 190373ad4..5346c6aa5 100644 --- a/classes/class_animationnodeblendspace1d.rst +++ b/classes/class_animationnodeblendspace1d.rst @@ -8,6 +8,7 @@ AnimationNodeBlendSpace1D ========================= **Inherits:** :ref:`AnimationRootNode` **<** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,19 @@ Brief Description +Properties +---------- + ++-----------------------------+-----------------------------------------------------------------+ +| :ref:`float` | :ref:`max_space` | ++-----------------------------+-----------------------------------------------------------------+ +| :ref:`float` | :ref:`min_space` | ++-----------------------------+-----------------------------------------------------------------+ +| :ref:`float` | :ref:`snap` | ++-----------------------------+-----------------------------------------------------------------+ +| :ref:`String` | :ref:`value_label` | ++-----------------------------+-----------------------------------------------------------------+ + Methods ------- @@ -41,48 +55,70 @@ Property Descriptions - :ref:`float` **max_space** ++----------+----------------------+ +| *Setter* | set_max_space(value) | ++----------+----------------------+ +| *Getter* | get_max_space() | ++----------+----------------------+ + .. _class_AnimationNodeBlendSpace1D_min_space: - :ref:`float` **min_space** ++----------+----------------------+ +| *Setter* | set_min_space(value) | ++----------+----------------------+ +| *Getter* | get_min_space() | ++----------+----------------------+ + .. _class_AnimationNodeBlendSpace1D_snap: - :ref:`float` **snap** ++----------+-----------------+ +| *Setter* | set_snap(value) | ++----------+-----------------+ +| *Getter* | get_snap() | ++----------+-----------------+ + .. _class_AnimationNodeBlendSpace1D_value_label: - :ref:`String` **value_label** ++----------+------------------------+ +| *Setter* | set_value_label(value) | ++----------+------------------------+ +| *Getter* | get_value_label() | ++----------+------------------------+ Method Descriptions ------------------- -.. _class_AnimationNodeBlendSpace1D_add_blend_point: + .. _class_AnimationNodeBlendSpace1D_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_get_blend_point_count: - :ref:`int` **get_blend_point_count** **(** **)** const -.. _class_AnimationNodeBlendSpace1D_get_blend_point_node: + .. _class_AnimationNodeBlendSpace1D_get_blend_point_node: - :ref:`AnimationRootNode` **get_blend_point_node** **(** :ref:`int` point **)** const -.. _class_AnimationNodeBlendSpace1D_get_blend_point_position: + .. _class_AnimationNodeBlendSpace1D_get_blend_point_position: - :ref:`float` **get_blend_point_position** **(** :ref:`int` point **)** const -.. _class_AnimationNodeBlendSpace1D_remove_blend_point: + .. _class_AnimationNodeBlendSpace1D_remove_blend_point: - void **remove_blend_point** **(** :ref:`int` point **)** -.. _class_AnimationNodeBlendSpace1D_set_blend_point_node: + .. _class_AnimationNodeBlendSpace1D_set_blend_point_node: - void **set_blend_point_node** **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** -.. _class_AnimationNodeBlendSpace1D_set_blend_point_position: + .. _class_AnimationNodeBlendSpace1D_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 47244b4e9..0a7406c89 100644 --- a/classes/class_animationnodeblendspace2d.rst +++ b/classes/class_animationnodeblendspace2d.rst @@ -8,6 +8,7 @@ AnimationNodeBlendSpace2D ========================= **Inherits:** :ref:`AnimationRootNode` **<** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,23 @@ Brief Description +Properties +---------- + ++-------------------------------+-----------------------------------------------------------------------+ +| :ref:`bool` | :ref:`auto_triangles` | ++-------------------------------+-----------------------------------------------------------------------+ +| :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 ------- @@ -49,72 +67,106 @@ Property Descriptions - :ref:`bool` **auto_triangles** ++----------+---------------------------+ +| *Setter* | set_auto_triangles(value) | ++----------+---------------------------+ +| *Getter* | get_auto_triangles() | ++----------+---------------------------+ + .. _class_AnimationNodeBlendSpace2D_max_space: - :ref:`Vector2` **max_space** ++----------+----------------------+ +| *Setter* | set_max_space(value) | ++----------+----------------------+ +| *Getter* | get_max_space() | ++----------+----------------------+ + .. _class_AnimationNodeBlendSpace2D_min_space: - :ref:`Vector2` **min_space** ++----------+----------------------+ +| *Setter* | set_min_space(value) | ++----------+----------------------+ +| *Getter* | get_min_space() | ++----------+----------------------+ + .. _class_AnimationNodeBlendSpace2D_snap: - :ref:`Vector2` **snap** ++----------+-----------------+ +| *Setter* | set_snap(value) | ++----------+-----------------+ +| *Getter* | get_snap() | ++----------+-----------------+ + .. _class_AnimationNodeBlendSpace2D_x_label: - :ref:`String` **x_label** ++----------+--------------------+ +| *Setter* | set_x_label(value) | ++----------+--------------------+ +| *Getter* | get_x_label() | ++----------+--------------------+ + .. _class_AnimationNodeBlendSpace2D_y_label: - :ref:`String` **y_label** ++----------+--------------------+ +| *Setter* | set_y_label(value) | ++----------+--------------------+ +| *Getter* | get_y_label() | ++----------+--------------------+ Method Descriptions ------------------- -.. _class_AnimationNodeBlendSpace2D_add_blend_point: + .. _class_AnimationNodeBlendSpace2D_add_blend_point: - void **add_blend_point** **(** :ref:`AnimationRootNode` node, :ref:`Vector2` pos, :ref:`int` at_index=-1 **)** -.. _class_AnimationNodeBlendSpace2D_add_triangle: + .. _class_AnimationNodeBlendSpace2D_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_get_blend_point_count: - :ref:`int` **get_blend_point_count** **(** **)** const -.. _class_AnimationNodeBlendSpace2D_get_blend_point_node: + .. _class_AnimationNodeBlendSpace2D_get_blend_point_node: - :ref:`AnimationRootNode` **get_blend_point_node** **(** :ref:`int` point **)** const -.. _class_AnimationNodeBlendSpace2D_get_blend_point_position: + .. _class_AnimationNodeBlendSpace2D_get_blend_point_position: - :ref:`Vector2` **get_blend_point_position** **(** :ref:`int` point **)** const -.. _class_AnimationNodeBlendSpace2D_get_triangle_count: + .. _class_AnimationNodeBlendSpace2D_get_triangle_count: - :ref:`int` **get_triangle_count** **(** **)** const -.. _class_AnimationNodeBlendSpace2D_get_triangle_point: + .. _class_AnimationNodeBlendSpace2D_get_triangle_point: - :ref:`int` **get_triangle_point** **(** :ref:`int` triangle, :ref:`int` point **)** -.. _class_AnimationNodeBlendSpace2D_remove_blend_point: + .. _class_AnimationNodeBlendSpace2D_remove_blend_point: - void **remove_blend_point** **(** :ref:`int` point **)** -.. _class_AnimationNodeBlendSpace2D_remove_triangle: + .. _class_AnimationNodeBlendSpace2D_remove_triangle: - void **remove_triangle** **(** :ref:`int` triangle **)** -.. _class_AnimationNodeBlendSpace2D_set_blend_point_node: + .. _class_AnimationNodeBlendSpace2D_set_blend_point_node: - void **set_blend_point_node** **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** -.. _class_AnimationNodeBlendSpace2D_set_blend_point_position: + .. _class_AnimationNodeBlendSpace2D_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 2e3b8d970..27605216a 100644 --- a/classes/class_animationnodeblendtree.rst +++ b/classes/class_animationnodeblendtree.rst @@ -8,6 +8,7 @@ AnimationNodeBlendTree ====================== **Inherits:** :ref:`AnimationRootNode` **<** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description +Properties +---------- + ++-------------------------------+----------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`graph_offset` | ++-------------------------------+----------------------------------------------------------------+ + Methods ------- @@ -47,7 +55,6 @@ Constants - **CONNECTION_ERROR_NO_OUTPUT** = **3** - **CONNECTION_ERROR_SAME_NODE** = **4** - **CONNECTION_ERROR_CONNECTION_EXISTS** = **5** - Property Descriptions --------------------- @@ -55,44 +62,48 @@ Property Descriptions - :ref:`Vector2` **graph_offset** ++----------+-------------------------+ +| *Setter* | set_graph_offset(value) | ++----------+-------------------------+ +| *Getter* | get_graph_offset() | ++----------+-------------------------+ Method Descriptions ------------------- -.. _class_AnimationNodeBlendTree_add_node: + .. _class_AnimationNodeBlendTree_add_node: - void **add_node** **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** -.. _class_AnimationNodeBlendTree_connect_node: + .. _class_AnimationNodeBlendTree_connect_node: - void **connect_node** **(** :ref:`String` input_node, :ref:`int` input_index, :ref:`String` output_node **)** -.. _class_AnimationNodeBlendTree_disconnect_node: + .. _class_AnimationNodeBlendTree_disconnect_node: - void **disconnect_node** **(** :ref:`String` input_node, :ref:`int` input_index **)** -.. _class_AnimationNodeBlendTree_get_node: + .. _class_AnimationNodeBlendTree_get_node: - :ref:`AnimationNode` **get_node** **(** :ref:`String` name **)** const -.. _class_AnimationNodeBlendTree_get_node_position: + .. _class_AnimationNodeBlendTree_get_node_position: - :ref:`Vector2` **get_node_position** **(** :ref:`String` name **)** const -.. _class_AnimationNodeBlendTree_has_node: + .. _class_AnimationNodeBlendTree_has_node: - :ref:`bool` **has_node** **(** :ref:`String` name **)** const -.. _class_AnimationNodeBlendTree_remove_node: + .. _class_AnimationNodeBlendTree_remove_node: - void **remove_node** **(** :ref:`String` name **)** -.. _class_AnimationNodeBlendTree_rename_node: + .. _class_AnimationNodeBlendTree_rename_node: - void **rename_node** **(** :ref:`String` name, :ref:`String` new_name **)** -.. _class_AnimationNodeBlendTree_set_node_position: + .. _class_AnimationNodeBlendTree_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 8dbdfc95c..e082258fd 100644 --- a/classes/class_animationnodeoneshot.rst +++ b/classes/class_animationnodeoneshot.rst @@ -8,6 +8,7 @@ AnimationNodeOneShot ==================== **Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,23 @@ 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` | ++---------------------------+--------------------------------------------------------------------------------------+ + Methods ------- @@ -29,12 +47,11 @@ Enumerations .. _enum_AnimationNodeOneShot_MixMode: -enum **MixMode** +enum **MixMode**: - **MIX_MODE_BLEND** = **0** - **MIX_MODE_ADD** = **1** - Property Descriptions --------------------- @@ -42,36 +59,70 @@ Property Descriptions - :ref:`bool` **autorestart** ++----------+------------------------+ +| *Setter* | set_autorestart(value) | ++----------+------------------------+ +| *Getter* | has_autorestart() | ++----------+------------------------+ + .. _class_AnimationNodeOneShot_autorestart_delay: - :ref:`float` **autorestart_delay** ++----------+------------------------------+ +| *Setter* | set_autorestart_delay(value) | ++----------+------------------------------+ +| *Getter* | get_autorestart_delay() | ++----------+------------------------------+ + .. _class_AnimationNodeOneShot_autorestart_random_delay: - :ref:`float` **autorestart_random_delay** ++----------+-------------------------------------+ +| *Setter* | set_autorestart_random_delay(value) | ++----------+-------------------------------------+ +| *Getter* | get_autorestart_random_delay() | ++----------+-------------------------------------+ + .. _class_AnimationNodeOneShot_fadein_time: - :ref:`float` **fadein_time** ++----------+------------------------+ +| *Setter* | set_fadein_time(value) | ++----------+------------------------+ +| *Getter* | get_fadein_time() | ++----------+------------------------+ + .. _class_AnimationNodeOneShot_fadeout_time: - :ref:`float` **fadeout_time** ++----------+-------------------------+ +| *Setter* | set_fadeout_time(value) | ++----------+-------------------------+ +| *Getter* | get_fadeout_time() | ++----------+-------------------------+ + .. _class_AnimationNodeOneShot_sync: - :ref:`bool` **sync** ++----------+---------------------+ +| *Setter* | set_use_sync(value) | ++----------+---------------------+ +| *Getter* | is_using_sync() | ++----------+---------------------+ Method Descriptions ------------------- -.. _class_AnimationNodeOneShot_get_mix_mode: + .. _class_AnimationNodeOneShot_get_mix_mode: - :ref:`MixMode` **get_mix_mode** **(** **)** const -.. _class_AnimationNodeOneShot_set_mix_mode: + .. _class_AnimationNodeOneShot_set_mix_mode: - void **set_mix_mode** **(** :ref:`MixMode` mode **)** - diff --git a/classes/class_animationnodeoutput.rst b/classes/class_animationnodeoutput.rst index 921918eec..39e2be144 100644 --- a/classes/class_animationnodeoutput.rst +++ b/classes/class_animationnodeoutput.rst @@ -8,6 +8,7 @@ AnimationNodeOutput =================== **Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_animationnodestatemachine.rst b/classes/class_animationnodestatemachine.rst index 7f2a3a0f1..84464ba99 100644 --- a/classes/class_animationnodestatemachine.rst +++ b/classes/class_animationnodestatemachine.rst @@ -8,6 +8,7 @@ AnimationNodeStateMachine ========================= **Inherits:** :ref:`AnimationRootNode` **<** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -67,92 +68,91 @@ Methods Method Descriptions ------------------- -.. _class_AnimationNodeStateMachine_add_node: + .. _class_AnimationNodeStateMachine_add_node: - void **add_node** **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** -.. _class_AnimationNodeStateMachine_add_transition: + .. _class_AnimationNodeStateMachine_add_transition: - void **add_transition** **(** :ref:`String` from, :ref:`String` to, :ref:`AnimationNodeStateMachineTransition` transition **)** -.. _class_AnimationNodeStateMachine_get_end_node: + .. _class_AnimationNodeStateMachine_get_end_node: - :ref:`String` **get_end_node** **(** **)** const -.. _class_AnimationNodeStateMachine_get_graph_offset: + .. _class_AnimationNodeStateMachine_get_graph_offset: - :ref:`Vector2` **get_graph_offset** **(** **)** const -.. _class_AnimationNodeStateMachine_get_node: + .. _class_AnimationNodeStateMachine_get_node: - :ref:`AnimationNode` **get_node** **(** :ref:`String` name **)** const -.. _class_AnimationNodeStateMachine_get_node_name: + .. _class_AnimationNodeStateMachine_get_node_name: - :ref:`String` **get_node_name** **(** :ref:`AnimationNode` node **)** const -.. _class_AnimationNodeStateMachine_get_node_position: + .. _class_AnimationNodeStateMachine_get_node_position: - :ref:`Vector2` **get_node_position** **(** :ref:`String` name **)** const -.. _class_AnimationNodeStateMachine_get_start_node: + .. _class_AnimationNodeStateMachine_get_start_node: - :ref:`String` **get_start_node** **(** **)** const -.. _class_AnimationNodeStateMachine_get_transition: + .. _class_AnimationNodeStateMachine_get_transition: - :ref:`AnimationNodeStateMachineTransition` **get_transition** **(** :ref:`int` idx **)** const -.. _class_AnimationNodeStateMachine_get_transition_count: + .. _class_AnimationNodeStateMachine_get_transition_count: - :ref:`int` **get_transition_count** **(** **)** const -.. _class_AnimationNodeStateMachine_get_transition_from: + .. _class_AnimationNodeStateMachine_get_transition_from: - :ref:`String` **get_transition_from** **(** :ref:`int` idx **)** const -.. _class_AnimationNodeStateMachine_get_transition_to: + .. _class_AnimationNodeStateMachine_get_transition_to: - :ref:`String` **get_transition_to** **(** :ref:`int` idx **)** const -.. _class_AnimationNodeStateMachine_has_node: + .. _class_AnimationNodeStateMachine_has_node: - :ref:`bool` **has_node** **(** :ref:`String` name **)** const -.. _class_AnimationNodeStateMachine_has_transition: + .. _class_AnimationNodeStateMachine_has_transition: - :ref:`bool` **has_transition** **(** :ref:`String` from, :ref:`String` to **)** const -.. _class_AnimationNodeStateMachine_remove_node: + .. _class_AnimationNodeStateMachine_remove_node: - void **remove_node** **(** :ref:`String` name **)** -.. _class_AnimationNodeStateMachine_remove_transition: + .. _class_AnimationNodeStateMachine_remove_transition: - void **remove_transition** **(** :ref:`String` from, :ref:`String` to **)** -.. _class_AnimationNodeStateMachine_remove_transition_by_index: + .. _class_AnimationNodeStateMachine_remove_transition_by_index: - void **remove_transition_by_index** **(** :ref:`int` idx **)** -.. _class_AnimationNodeStateMachine_rename_node: + .. _class_AnimationNodeStateMachine_rename_node: - void **rename_node** **(** :ref:`String` name, :ref:`String` new_name **)** -.. _class_AnimationNodeStateMachine_set_end_node: + .. _class_AnimationNodeStateMachine_set_end_node: - void **set_end_node** **(** :ref:`String` name **)** -.. _class_AnimationNodeStateMachine_set_graph_offset: + .. _class_AnimationNodeStateMachine_set_graph_offset: - void **set_graph_offset** **(** :ref:`Vector2` name **)** -.. _class_AnimationNodeStateMachine_set_node_position: + .. _class_AnimationNodeStateMachine_set_node_position: - void **set_node_position** **(** :ref:`String` name, :ref:`Vector2` position **)** -.. _class_AnimationNodeStateMachine_set_start_node: + .. _class_AnimationNodeStateMachine_set_start_node: - void **set_start_node** **(** :ref:`String` name **)** - diff --git a/classes/class_animationnodestatemachineplayback.rst b/classes/class_animationnodestatemachineplayback.rst index b5d1449cd..e10f434dc 100644 --- a/classes/class_animationnodestatemachineplayback.rst +++ b/classes/class_animationnodestatemachineplayback.rst @@ -8,6 +8,7 @@ AnimationNodeStateMachinePlayback ================================= **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -35,28 +36,27 @@ Methods Method Descriptions ------------------- -.. _class_AnimationNodeStateMachinePlayback_get_current_node: + .. _class_AnimationNodeStateMachinePlayback_get_current_node: - :ref:`String` **get_current_node** **(** **)** const -.. _class_AnimationNodeStateMachinePlayback_get_travel_path: + .. _class_AnimationNodeStateMachinePlayback_get_travel_path: - :ref:`PoolStringArray` **get_travel_path** **(** **)** const -.. _class_AnimationNodeStateMachinePlayback_is_playing: + .. _class_AnimationNodeStateMachinePlayback_is_playing: - :ref:`bool` **is_playing** **(** **)** const -.. _class_AnimationNodeStateMachinePlayback_start: + .. _class_AnimationNodeStateMachinePlayback_start: - void **start** **(** :ref:`String` node **)** -.. _class_AnimationNodeStateMachinePlayback_stop: + .. _class_AnimationNodeStateMachinePlayback_stop: - void **stop** **(** **)** -.. _class_AnimationNodeStateMachinePlayback_travel: + .. _class_AnimationNodeStateMachinePlayback_travel: - void **travel** **(** :ref:`String` to_node **)** - diff --git a/classes/class_animationnodestatemachinetransition.rst b/classes/class_animationnodestatemachinetransition.rst index 4db449f7c..886ea5305 100644 --- a/classes/class_animationnodestatemachinetransition.rst +++ b/classes/class_animationnodestatemachinetransition.rst @@ -8,6 +8,7 @@ AnimationNodeStateMachineTransition =================================== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,26 +16,41 @@ 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` | ++------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ + Signals ------- -.. _class_AnimationNodeStateMachineTransition_advance_condition_changed: + .. _class_AnimationNodeStateMachineTransition_advance_condition_changed: - **advance_condition_changed** **(** **)** - Enumerations ------------ .. _enum_AnimationNodeStateMachineTransition_SwitchMode: -enum **SwitchMode** +enum **SwitchMode**: - **SWITCH_MODE_IMMEDIATE** = **0** - **SWITCH_MODE_SYNC** = **1** - **SWITCH_MODE_AT_END** = **2** - Property Descriptions --------------------- @@ -42,24 +58,59 @@ Property Descriptions - :ref:`String` **advance_condition** ++----------+------------------------------+ +| *Setter* | set_advance_condition(value) | ++----------+------------------------------+ +| *Getter* | get_advance_condition() | ++----------+------------------------------+ + .. _class_AnimationNodeStateMachineTransition_auto_advance: - :ref:`bool` **auto_advance** ++----------+-------------------------+ +| *Setter* | set_auto_advance(value) | ++----------+-------------------------+ +| *Getter* | has_auto_advance() | ++----------+-------------------------+ + .. _class_AnimationNodeStateMachineTransition_disabled: - :ref:`bool` **disabled** ++----------+---------------------+ +| *Setter* | set_disabled(value) | ++----------+---------------------+ +| *Getter* | is_disabled() | ++----------+---------------------+ + .. _class_AnimationNodeStateMachineTransition_priority: - :ref:`int` **priority** ++----------+---------------------+ +| *Setter* | set_priority(value) | ++----------+---------------------+ +| *Getter* | get_priority() | ++----------+---------------------+ + .. _class_AnimationNodeStateMachineTransition_switch_mode: - :ref:`SwitchMode` **switch_mode** ++----------+------------------------+ +| *Setter* | set_switch_mode(value) | ++----------+------------------------+ +| *Getter* | get_switch_mode() | ++----------+------------------------+ + .. _class_AnimationNodeStateMachineTransition_xfade_time: - :ref:`float` **xfade_time** ++----------+-----------------------+ +| *Setter* | set_xfade_time(value) | ++----------+-----------------------+ +| *Getter* | get_xfade_time() | ++----------+-----------------------+ diff --git a/classes/class_animationnodetimescale.rst b/classes/class_animationnodetimescale.rst index 720a657b7..1fe46100b 100644 --- a/classes/class_animationnodetimescale.rst +++ b/classes/class_animationnodetimescale.rst @@ -8,6 +8,7 @@ AnimationNodeTimeScale ====================== **Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_animationnodetimeseek.rst b/classes/class_animationnodetimeseek.rst index dad6205dd..1fd3020e2 100644 --- a/classes/class_animationnodetimeseek.rst +++ b/classes/class_animationnodetimeseek.rst @@ -8,6 +8,7 @@ AnimationNodeTimeSeek ===================== **Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_animationnodetransition.rst b/classes/class_animationnodetransition.rst index d15b48bd3..e1e7dbd0e 100644 --- a/classes/class_animationnodetransition.rst +++ b/classes/class_animationnodetransition.rst @@ -8,6 +8,7 @@ AnimationNodeTransition ======================= **Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,143 @@ 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` | ++-----------------------------+-----------------------------------------------------------------------------------+ + Property Descriptions --------------------- @@ -22,264 +160,659 @@ Property Descriptions - :ref:`bool` **input_0/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_0/name: - :ref:`String` **input_0/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_1/auto_advance: - :ref:`bool` **input_1/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_1/name: - :ref:`String` **input_1/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_10/auto_advance: - :ref:`bool` **input_10/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_10/name: - :ref:`String` **input_10/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_11/auto_advance: - :ref:`bool` **input_11/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_11/name: - :ref:`String` **input_11/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_12/auto_advance: - :ref:`bool` **input_12/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_12/name: - :ref:`String` **input_12/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_13/auto_advance: - :ref:`bool` **input_13/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_13/name: - :ref:`String` **input_13/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_14/auto_advance: - :ref:`bool` **input_14/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_14/name: - :ref:`String` **input_14/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_15/auto_advance: - :ref:`bool` **input_15/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_15/name: - :ref:`String` **input_15/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_16/auto_advance: - :ref:`bool` **input_16/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_16/name: - :ref:`String` **input_16/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_17/auto_advance: - :ref:`bool` **input_17/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_17/name: - :ref:`String` **input_17/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_18/auto_advance: - :ref:`bool` **input_18/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_18/name: - :ref:`String` **input_18/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_19/auto_advance: - :ref:`bool` **input_19/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_19/name: - :ref:`String` **input_19/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_2/auto_advance: - :ref:`bool` **input_2/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_2/name: - :ref:`String` **input_2/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_20/auto_advance: - :ref:`bool` **input_20/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_20/name: - :ref:`String` **input_20/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_21/auto_advance: - :ref:`bool` **input_21/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_21/name: - :ref:`String` **input_21/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_22/auto_advance: - :ref:`bool` **input_22/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_22/name: - :ref:`String` **input_22/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_23/auto_advance: - :ref:`bool` **input_23/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_23/name: - :ref:`String` **input_23/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_24/auto_advance: - :ref:`bool` **input_24/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_24/name: - :ref:`String` **input_24/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_25/auto_advance: - :ref:`bool` **input_25/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_25/name: - :ref:`String` **input_25/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_26/auto_advance: - :ref:`bool` **input_26/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_26/name: - :ref:`String` **input_26/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_27/auto_advance: - :ref:`bool` **input_27/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_27/name: - :ref:`String` **input_27/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_28/auto_advance: - :ref:`bool` **input_28/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_28/name: - :ref:`String` **input_28/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_29/auto_advance: - :ref:`bool` **input_29/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_29/name: - :ref:`String` **input_29/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_3/auto_advance: - :ref:`bool` **input_3/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_3/name: - :ref:`String` **input_3/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_30/auto_advance: - :ref:`bool` **input_30/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_30/name: - :ref:`String` **input_30/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_31/auto_advance: - :ref:`bool` **input_31/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_31/name: - :ref:`String` **input_31/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_4/auto_advance: - :ref:`bool` **input_4/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_4/name: - :ref:`String` **input_4/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_5/auto_advance: - :ref:`bool` **input_5/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_5/name: - :ref:`String` **input_5/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_6/auto_advance: - :ref:`bool` **input_6/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_6/name: - :ref:`String` **input_6/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_7/auto_advance: - :ref:`bool` **input_7/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_7/name: - :ref:`String` **input_7/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_8/auto_advance: - :ref:`bool` **input_8/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_8/name: - :ref:`String` **input_8/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_9/auto_advance: - :ref:`bool` **input_9/auto_advance** ++----------+----------------------------------+ +| *Setter* | set_input_as_auto_advance(value) | ++----------+----------------------------------+ +| *Getter* | is_input_set_as_auto_advance() | ++----------+----------------------------------+ + .. _class_AnimationNodeTransition_input_9/name: - :ref:`String` **input_9/name** ++----------+--------------------------+ +| *Setter* | set_input_caption(value) | ++----------+--------------------------+ +| *Getter* | get_input_caption() | ++----------+--------------------------+ + .. _class_AnimationNodeTransition_input_count: - :ref:`int` **input_count** ++----------+---------------------------+ +| *Setter* | set_enabled_inputs(value) | ++----------+---------------------------+ +| *Getter* | get_enabled_inputs() | ++----------+---------------------------+ + .. _class_AnimationNodeTransition_xfade_time: - :ref:`float` **xfade_time** ++----------+----------------------------+ +| *Setter* | set_cross_fade_time(value) | ++----------+----------------------------+ +| *Getter* | get_cross_fade_time() | ++----------+----------------------------+ diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index 707dc518d..ee1e103ba 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -8,6 +8,7 @@ AnimationPlayer =============== **Inherits:** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,31 @@ Brief Description 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` | ++------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ + Methods ------- @@ -65,41 +91,39 @@ Methods Signals ------- -.. _class_AnimationPlayer_animation_changed: + .. _class_AnimationPlayer_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_animation_finished: - **animation_finished** **(** :ref:`String` anim_name **)** Notifies when an animation finished playing. -.. _class_AnimationPlayer_animation_started: + .. _class_AnimationPlayer_animation_started: - **animation_started** **(** :ref:`String` anim_name **)** Notifies when an animation starts playing. -.. _class_AnimationPlayer_caches_cleared: + .. _class_AnimationPlayer_caches_cleared: - **caches_cleared** **(** **)** - Enumerations ------------ .. _enum_AnimationPlayer_AnimationProcessMode: -enum **AnimationProcessMode** +enum **AnimationProcessMode**: - **ANIMATION_PROCESS_PHYSICS** = **0** --- Process animation during the physics process. This is especially useful when animating physics bodies. - **ANIMATION_PROCESS_IDLE** = **1** --- Process animation during the idle process. - **ANIMATION_PROCESS_MANUAL** = **2** --- Do not process animation. Use the 'advance' method to process the animation manually. - Description ----------- @@ -110,178 +134,251 @@ Tutorials - :doc:`../getting_started/step_by_step/animations` - :doc:`../tutorials/animation/index` - Property Descriptions --------------------- .. _class_AnimationPlayer_assigned_animation: -- :ref:`String` **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`. +- :ref:`String` **assigned_animation** + ++----------+-------------------------------+ +| *Setter* | set_assigned_animation(value) | ++----------+-------------------------------+ +| *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`. .. _class_AnimationPlayer_autoplay: -- :ref:`String` **autoplay** - The name of the animation to play when the scene loads. Default value: ``""``. +- :ref:`String` **autoplay** + ++----------+---------------------+ +| *Setter* | set_autoplay(value) | ++----------+---------------------+ +| *Getter* | get_autoplay() | ++----------+---------------------+ + +The name of the animation to play when the scene loads. Default value: ``""``. .. _class_AnimationPlayer_current_animation: -- :ref:`String` **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: ``""``. +- :ref:`String` **current_animation** + ++----------+------------------------------+ +| *Setter* | set_current_animation(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: ``""``. .. _class_AnimationPlayer_current_animation_length: -- :ref:`float` **current_animation_length** - The length (in seconds) of the currently being played animation. +- :ref:`float` **current_animation_length** + ++----------+--------------------------------+ +| *Getter* | get_current_animation_length() | ++----------+--------------------------------+ + +The length (in seconds) of the currently being played animation. .. _class_AnimationPlayer_current_animation_position: -- :ref:`float` **current_animation_position** - The position (in seconds) of the currently playing animation. +- :ref:`float` **current_animation_position** + ++----------+----------------------------------+ +| *Getter* | get_current_animation_position() | ++----------+----------------------------------+ + +The position (in seconds) of the currently playing animation. .. _class_AnimationPlayer_playback_active: -- :ref:`bool` **playback_active** - If ``true``, updates animations in response to process-related notifications. Default value: ``true``. +- :ref:`bool` **playback_active** + ++----------+-------------------+ +| *Setter* | set_active(value) | ++----------+-------------------+ +| *Getter* | is_active() | ++----------+-------------------+ + +If ``true``, updates animations in response to process-related notifications. Default value: ``true``. .. _class_AnimationPlayer_playback_default_blend_time: -- :ref:`float` **playback_default_blend_time** - The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision. Default value: ``0``. +- :ref:`float` **playback_default_blend_time** + ++----------+-------------------------------+ +| *Setter* | set_default_blend_time(value) | ++----------+-------------------------------+ +| *Getter* | get_default_blend_time() | ++----------+-------------------------------+ + +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: -- :ref:`AnimationProcessMode` **playback_process_mode** - The process notification in which to update animations. Default value: :ref:`ANIMATION_PROCESS_IDLE`. +- :ref:`AnimationProcessMode` **playback_process_mode** + ++----------+-----------------------------------+ +| *Setter* | set_animation_process_mode(value) | ++----------+-----------------------------------+ +| *Getter* | get_animation_process_mode() | ++----------+-----------------------------------+ + +The process notification in which to update animations. Default value: :ref:`ANIMATION_PROCESS_IDLE`. .. _class_AnimationPlayer_playback_speed: -- :ref:`float` **playback_speed** - 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``. +- :ref:`float` **playback_speed** + ++----------+------------------------+ +| *Setter* | set_speed_scale(value) | ++----------+------------------------+ +| *Getter* | get_speed_scale() | ++----------+------------------------+ + +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: -- :ref:`NodePath` **root_node** - The node from which node path references will travel. Default value: ``".."``. +- :ref:`NodePath` **root_node** ++----------+-----------------+ +| *Setter* | set_root(value) | ++----------+-----------------+ +| *Getter* | get_root() | ++----------+-----------------+ + +The node from which node path references will travel. Default value: ``".."``. Method Descriptions ------------------- -.. _class_AnimationPlayer_add_animation: + .. _class_AnimationPlayer_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_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_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_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_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_clear_queue: - void **clear_queue** **(** **)** Clears all queued, unplayed animations. -.. _class_AnimationPlayer_find_animation: + .. _class_AnimationPlayer_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_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_get_animation_list: - :ref:`PoolStringArray` **get_animation_list** **(** **)** const Returns the list of stored animation names. -.. _class_AnimationPlayer_get_blend_time: + .. _class_AnimationPlayer_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_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_has_animation: + .. _class_AnimationPlayer_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_is_playing: - :ref:`bool` **is_playing** **(** **)** const Returns ``true`` if playing an animation. -.. _class_AnimationPlayer_play: + .. _class_AnimationPlayer_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_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_queue: - void **queue** **(** :ref:`String` name **)** Queue an animation for playback once the current one is done. -.. _class_AnimationPlayer_remove_animation: + .. _class_AnimationPlayer_remove_animation: - void **remove_animation** **(** :ref:`String` name **)** Remove the animation with key ``name``. -.. _class_AnimationPlayer_rename_animation: + .. _class_AnimationPlayer_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_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_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_stop: - void **stop** **(** :ref:`bool` reset=true **)** Stop the currently playing animation. If ``reset`` is ``true``, the anim position is reset to ``0``. - diff --git a/classes/class_animationrootnode.rst b/classes/class_animationrootnode.rst index ac24ca93c..6c4bda15f 100644 --- a/classes/class_animationrootnode.rst +++ b/classes/class_animationrootnode.rst @@ -8,7 +8,9 @@ AnimationRootNode ================= **Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`AnimationNodeAnimation`, :ref:`AnimationNodeBlendSpace2D`, :ref:`AnimationNodeStateMachine`, :ref:`AnimationNodeBlendSpace1D`, :ref:`AnimationNodeBlendTree` + **Category:** Core Brief Description diff --git a/classes/class_animationtrackeditplugin.rst b/classes/class_animationtrackeditplugin.rst index ca8c95f12..9186ecf97 100644 --- a/classes/class_animationtrackeditplugin.rst +++ b/classes/class_animationtrackeditplugin.rst @@ -8,6 +8,7 @@ AnimationTrackEditPlugin ======================== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_animationtree.rst b/classes/class_animationtree.rst index 1a642e0db..74fdc6a72 100644 --- a/classes/class_animationtree.rst +++ b/classes/class_animationtree.rst @@ -8,6 +8,7 @@ AnimationTree ============= **Inherits:** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,21 @@ 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` | ++----------------------------------------------------------------------+-----------------------------------------------------------------+ + Methods ------- @@ -31,13 +47,12 @@ Enumerations .. _enum_AnimationTree_AnimationProcessMode: -enum **AnimationProcessMode** +enum **AnimationProcessMode**: - **ANIMATION_PROCESS_PHYSICS** = **0** - **ANIMATION_PROCESS_IDLE** = **1** - **ANIMATION_PROCESS_MANUAL** = **2** - Property Descriptions --------------------- @@ -45,36 +60,64 @@ Property Descriptions - :ref:`bool` **active** ++----------+-------------------+ +| *Setter* | set_active(value) | ++----------+-------------------+ +| *Getter* | is_active() | ++----------+-------------------+ + .. _class_AnimationTree_anim_player: - :ref:`NodePath` **anim_player** ++----------+-----------------------------+ +| *Setter* | set_animation_player(value) | ++----------+-----------------------------+ +| *Getter* | get_animation_player() | ++----------+-----------------------------+ + .. _class_AnimationTree_process_mode: - :ref:`AnimationProcessMode` **process_mode** ++----------+-------------------------+ +| *Setter* | set_process_mode(value) | ++----------+-------------------------+ +| *Getter* | get_process_mode() | ++----------+-------------------------+ + .. _class_AnimationTree_root_motion_track: - :ref:`NodePath` **root_motion_track** ++----------+------------------------------+ +| *Setter* | set_root_motion_track(value) | ++----------+------------------------------+ +| *Getter* | get_root_motion_track() | ++----------+------------------------------+ + .. _class_AnimationTree_tree_root: - :ref:`AnimationNode` **tree_root** ++----------+----------------------+ +| *Setter* | set_tree_root(value) | ++----------+----------------------+ +| *Getter* | get_tree_root() | ++----------+----------------------+ Method Descriptions ------------------- -.. _class_AnimationTree_advance: + .. _class_AnimationTree_advance: - void **advance** **(** :ref:`float` delta **)** -.. _class_AnimationTree_get_root_motion_transform: + .. _class_AnimationTree_get_root_motion_transform: - :ref:`Transform` **get_root_motion_transform** **(** **)** const -.. _class_AnimationTree_rename_parameter: + .. _class_AnimationTree_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 6e6c32c7d..1d1c8dac8 100644 --- a/classes/class_animationtreeplayer.rst +++ b/classes/class_animationtreeplayer.rst @@ -8,6 +8,7 @@ AnimationTreePlayer =================== **Inherits:** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,19 @@ Brief Description 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` | ++----------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + Methods ------- @@ -139,14 +153,14 @@ Enumerations .. _enum_AnimationTreePlayer_AnimationProcessMode: -enum **AnimationProcessMode** +enum **AnimationProcessMode**: - **ANIMATION_PROCESS_PHYSICS** = **0** --- Process animation during the physics process. This is especially useful when animating physics bodies. - **ANIMATION_PROCESS_IDLE** = **1** --- Process animation during the idle process. .. _enum_AnimationTreePlayer_NodeType: -enum **NodeType** +enum **NodeType**: - **NODE_OUTPUT** = **0** --- Output node. - **NODE_ANIMATION** = **1** --- Animation node. @@ -159,7 +173,6 @@ enum **NodeType** - **NODE_TIMESEEK** = **8** --- TimeSeek node. - **NODE_TRANSITION** = **9** --- Transition node. - Description ----------- @@ -172,87 +185,118 @@ Property Descriptions .. _class_AnimationTreePlayer_active: -- :ref:`bool` **active** - If ``true`` the ``AnimationTreePlayer`` is able to play animations. Default value: ``false``. +- :ref:`bool` **active** + ++----------+-------------------+ +| *Setter* | set_active(value) | ++----------+-------------------+ +| *Getter* | is_active() | ++----------+-------------------+ + +If ``true`` the ``AnimationTreePlayer`` is able to play animations. Default value: ``false``. .. _class_AnimationTreePlayer_base_path: -- :ref:`NodePath` **base_path** - The node from which to relatively access other nodes. Default value: ``".."``. +- :ref:`NodePath` **base_path** + ++----------+----------------------+ +| *Setter* | set_base_path(value) | ++----------+----------------------+ +| *Getter* | get_base_path() | ++----------+----------------------+ + +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: -- :ref:`NodePath` **master_player** - The path to the :ref:`AnimationPlayer` from which this ``AnimationTreePlayer`` binds animations to animation nodes. +- :ref:`NodePath` **master_player** + ++----------+--------------------------+ +| *Setter* | set_master_player(value) | ++----------+--------------------------+ +| *Getter* | get_master_player() | ++----------+--------------------------+ + +The path to the :ref:`AnimationPlayer` from which this ``AnimationTreePlayer`` binds animations to animation nodes. Once set, Animation nodes can be added to the AnimationTreePlayer. .. _class_AnimationTreePlayer_playback_process_mode: -- :ref:`AnimationProcessMode` **playback_process_mode** - The thread in which to update animations. Default value: :ref:`ANIMATION_PROCESS_IDLE`. +- :ref:`AnimationProcessMode` **playback_process_mode** ++----------+-----------------------------------+ +| *Setter* | set_animation_process_mode(value) | ++----------+-----------------------------------+ +| *Getter* | get_animation_process_mode() | ++----------+-----------------------------------+ + +The thread in which to update animations. Default value: :ref:`ANIMATION_PROCESS_IDLE`. Method Descriptions ------------------- -.. _class_AnimationTreePlayer_add_node: + .. _class_AnimationTreePlayer_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_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_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_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. -.. _class_AnimationTreePlayer_animation_node_get_position: + .. _class_AnimationTreePlayer_animation_node_get_position: - :ref:`float` **animation_node_get_position** **(** :ref:`String` id **)** const -.. _class_AnimationTreePlayer_animation_node_set_animation: + .. _class_AnimationTreePlayer_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``. -.. _class_AnimationTreePlayer_animation_node_set_filter_path: + .. _class_AnimationTreePlayer_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_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. -.. _class_AnimationTreePlayer_are_nodes_connected: + .. _class_AnimationTreePlayer_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_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_blend2_node_set_amount: - void **blend2_node_set_amount** **(** :ref:`String` id, :ref:`float` blend **)** @@ -266,19 +310,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_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_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_blend3_node_set_amount: - void **blend3_node_set_amount** **(** :ref:`String` id, :ref:`float` blend **)** @@ -296,13 +340,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_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_blend4_node_set_amount: - void **blend4_node_set_amount** **(** :ref:`String` id, :ref:`Vector2` blend **)** @@ -312,31 +356,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_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_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_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_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_mix_node_set_amount: - void **mix_node_set_amount** **(** :ref:`String` id, :ref:`float` ratio **)** @@ -344,157 +388,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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_oneshot_node_start: - void **oneshot_node_start** **(** :ref:`String` id **)** Starts a OneShot node given its name. -.. _class_AnimationTreePlayer_oneshot_node_stop: + .. _class_AnimationTreePlayer_oneshot_node_stop: - void **oneshot_node_stop** **(** :ref:`String` id **)** Stops the OneShot node with name ``id``. -.. _class_AnimationTreePlayer_recompute_caches: + .. _class_AnimationTreePlayer_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_remove_node: - void **remove_node** **(** :ref:`String` id **)** Removes the animation node with name ``id``. -.. _class_AnimationTreePlayer_reset: + .. _class_AnimationTreePlayer_reset: - void **reset** **(** **)** Resets this ``AnimationTreePlayer``. -.. _class_AnimationTreePlayer_timescale_node_get_scale: + .. _class_AnimationTreePlayer_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_timescale_node_set_scale: - void **timescale_node_set_scale** **(** :ref:`String` id, :ref:`float` scale **)** @@ -504,7 +548,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_timeseek_node_seek: - void **timeseek_node_seek** **(** :ref:`String` id, :ref:`float` seconds **)** @@ -512,58 +556,57 @@ 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_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_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_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_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_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_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_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_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_transition_node_set_xfade_time: - void **transition_node_set_xfade_time** **(** :ref:`String` id, :ref:`float` time_sec **)** The transition node with name ``id`` sets its cross fade time to ``time_sec``. - diff --git a/classes/class_area.rst b/classes/class_area.rst index a905de094..f902b2edd 100644 --- a/classes/class_area.rst +++ b/classes/class_area.rst @@ -8,6 +8,7 @@ Area ==== **Inherits:** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,47 @@ Brief Description 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` | ++-----------------------------------------------+------------------------------------------------------------------+ + Methods ------- @@ -39,61 +81,60 @@ Methods Signals ------- -.. _class_Area_area_entered: + .. _class_Area_area_entered: - **area_entered** **(** :ref:`Area` area **)** Emitted when another area enters. -.. _class_Area_area_exited: + .. _class_Area_area_exited: - **area_exited** **(** :ref:`Area` area **)** Emitted when another area exits. -.. _class_Area_area_shape_entered: + .. _class_Area_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_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_body_entered: - **body_entered** **(** :ref:`Node` body **)** Emitted when a :ref:`PhysicsBody` object enters. -.. _class_Area_body_exited: + .. _class_Area_body_exited: - **body_exited** **(** :ref:`Node` body **)** Emitted when a :ref:`PhysicsBody` object exits. -.. _class_Area_body_shape_entered: + .. _class_Area_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_body_shape_exited: - **body_shape_exited** **(** :ref:`int` body_id, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` area_shape **)** Emitted when a :ref:`PhysicsBody` object exits, reporting which shapes were overlapping. - Enumerations ------------ .. _enum_Area_SpaceOverride: -enum **SpaceOverride** +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 ``priority`` order). @@ -101,7 +142,6 @@ enum **SpaceOverride** - **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 ``priority`` order), but keeps calculating the rest of the areas. - Description ----------- @@ -112,126 +152,268 @@ Property Descriptions .. _class_Area_angular_damp: -- :ref:`float` **angular_damp** - 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). +- :ref:`float` **angular_damp** + ++----------+-------------------------+ +| *Setter* | set_angular_damp(value) | ++----------+-------------------------+ +| *Getter* | get_angular_damp() | ++----------+-------------------------+ + +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: -- :ref:`String` **audio_bus_name** - The name of the area's audio bus. +- :ref:`String` **audio_bus_name** + ++----------+----------------------+ +| *Setter* | set_audio_bus(value) | ++----------+----------------------+ +| *Getter* | get_audio_bus() | ++----------+----------------------+ + +The name of the area's audio bus. .. _class_Area_audio_bus_override: -- :ref:`bool` **audio_bus_override** - If ``true`` the area's audio bus overrides the default audio bus. Default value: ``false``. +- :ref:`bool` **audio_bus_override** + ++----------+-------------------------------+ +| *Setter* | set_audio_bus_override(value) | ++----------+-------------------------------+ +| *Getter* | is_overriding_audio_bus() | ++----------+-------------------------------+ + +If ``true`` the area's audio bus overrides the default audio bus. Default value: ``false``. .. _class_Area_collision_layer: -- :ref:`int` **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 ``collision_mask``. +- :ref:`int` **collision_layer** + ++----------+----------------------------+ +| *Setter* | set_collision_layer(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 ``collision_mask``. .. _class_Area_collision_mask: -- :ref:`int` **collision_mask** - The physics layers this area scans to determine collision detection. +- :ref:`int` **collision_mask** + ++----------+---------------------------+ +| *Setter* | set_collision_mask(value) | ++----------+---------------------------+ +| *Getter* | get_collision_mask() | ++----------+---------------------------+ + +The physics layers this area scans to determine collision detection. .. _class_Area_gravity: -- :ref:`float` **gravity** - 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. +- :ref:`float` **gravity** + ++----------+--------------------+ +| *Setter* | set_gravity(value) | ++----------+--------------------+ +| *Getter* | get_gravity() | ++----------+--------------------+ + +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: -- :ref:`float` **gravity_distance_scale** - The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. +- :ref:`float` **gravity_distance_scale** + ++----------+-----------------------------------+ +| *Setter* | set_gravity_distance_scale(value) | ++----------+-----------------------------------+ +| *Getter* | get_gravity_distance_scale() | ++----------+-----------------------------------+ + +The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. .. _class_Area_gravity_point: -- :ref:`bool` **gravity_point** - If ``true`` gravity is calculated from a point (set via ``gravity_vec``). Also see ``space_override``. Default value: ``false``. +- :ref:`bool` **gravity_point** + ++----------+-----------------------------+ +| *Setter* | set_gravity_is_point(value) | ++----------+-----------------------------+ +| *Getter* | is_gravity_a_point() | ++----------+-----------------------------+ + +If ``true`` gravity is calculated from a point (set via ``gravity_vec``). Also see ``space_override``. Default value: ``false``. .. _class_Area_gravity_vec: -- :ref:`Vector3` **gravity_vec** - The area's gravity vector (not normalized). If gravity is a point (see :ref:`is_gravity_a_point`), this will be the point of attraction. +- :ref:`Vector3` **gravity_vec** + ++----------+---------------------------+ +| *Setter* | set_gravity_vector(value) | ++----------+---------------------------+ +| *Getter* | get_gravity_vector() | ++----------+---------------------------+ + +The area's gravity vector (not normalized). If gravity is a point (see :ref:`is_gravity_a_point`), this will be the point of attraction. .. _class_Area_linear_damp: -- :ref:`float` **linear_damp** - 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). +- :ref:`float` **linear_damp** + ++----------+------------------------+ +| *Setter* | set_linear_damp(value) | ++----------+------------------------+ +| *Getter* | get_linear_damp() | ++----------+------------------------+ + +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: -- :ref:`bool` **monitorable** - If ``true`` other monitoring areas can detect this area. Default value: ``true``. +- :ref:`bool` **monitorable** + ++----------+------------------------+ +| *Setter* | set_monitorable(value) | ++----------+------------------------+ +| *Getter* | is_monitorable() | ++----------+------------------------+ + +If ``true`` other monitoring areas can detect this area. Default value: ``true``. .. _class_Area_monitoring: -- :ref:`bool` **monitoring** - If ``true`` the area detects bodies or areas entering and exiting it. Default value: ``true``. +- :ref:`bool` **monitoring** + ++----------+-----------------------+ +| *Setter* | set_monitoring(value) | ++----------+-----------------------+ +| *Getter* | is_monitoring() | ++----------+-----------------------+ + +If ``true`` the area detects bodies or areas entering and exiting it. Default value: ``true``. .. _class_Area_priority: -- :ref:`float` **priority** - The area's priority. Higher priority areas are processed first. Default value: 0. +- :ref:`float` **priority** + ++----------+---------------------+ +| *Setter* | set_priority(value) | ++----------+---------------------+ +| *Getter* | get_priority() | ++----------+---------------------+ + +The area's priority. Higher priority areas are processed first. Default value: 0. .. _class_Area_reverb_bus_amount: -- :ref:`float` **reverb_bus_amount** - The degree to which this area applies reverb to its associated audio. Ranges from ``0`` to ``1`` with ``0.1`` precision. +- :ref:`float` **reverb_bus_amount** + ++----------+--------------------------+ +| *Setter* | set_reverb_amount(value) | ++----------+--------------------------+ +| *Getter* | get_reverb_amount() | ++----------+--------------------------+ + +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: -- :ref:`bool` **reverb_bus_enable** - If ``true`` the area applies reverb to its associated audio. +- :ref:`bool` **reverb_bus_enable** + ++----------+---------------------------+ +| *Setter* | set_use_reverb_bus(value) | ++----------+---------------------------+ +| *Getter* | is_using_reverb_bus() | ++----------+---------------------------+ + +If ``true`` the area applies reverb to its associated audio. .. _class_Area_reverb_bus_name: -- :ref:`String` **reverb_bus_name** - The reverb bus name to use for this area's associated audio. +- :ref:`String` **reverb_bus_name** + ++----------+-----------------------+ +| *Setter* | set_reverb_bus(value) | ++----------+-----------------------+ +| *Getter* | get_reverb_bus() | ++----------+-----------------------+ + +The reverb bus name to use for this area's associated audio. .. _class_Area_reverb_bus_uniformity: -- :ref:`float` **reverb_bus_uniformity** - The degree to which this area's reverb is a uniform effect. Ranges from ``0`` to ``1`` with ``0.1`` precision. +- :ref:`float` **reverb_bus_uniformity** + ++----------+------------------------------+ +| *Setter* | set_reverb_uniformity(value) | ++----------+------------------------------+ +| *Getter* | get_reverb_uniformity() | ++----------+------------------------------+ + +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: -- :ref:`SpaceOverride` **space_override** - Override mode for gravity and damping calculations within this area. See the SPACE_OVERRIDE\_\* constants for values. +- :ref:`SpaceOverride` **space_override** ++----------+--------------------------------+ +| *Setter* | set_space_override_mode(value) | ++----------+--------------------------------+ +| *Getter* | get_space_override_mode() | ++----------+--------------------------------+ + +Override mode for gravity and damping calculations within this area. See the SPACE_OVERRIDE\_\* constants for values. Method Descriptions ------------------- -.. _class_Area_get_collision_layer_bit: + .. _class_Area_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_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_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_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_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_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_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_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Set/clear individual bits on the collision mask. This simplifies editing which ``Area`` layers this ``Area`` scans. - diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index a139f16f3..eabc871dd 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -8,6 +8,7 @@ Area2D ====== **Inherits:** :ref:`CollisionObject2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,39 @@ Brief Description 2D area for detection and 2D 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:`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 ------- @@ -39,61 +73,60 @@ Methods Signals ------- -.. _class_Area2D_area_entered: + .. _class_Area2D_area_entered: - **area_entered** **(** :ref:`Area2D` area **)** Emitted when another area enters. -.. _class_Area2D_area_exited: + .. _class_Area2D_area_exited: - **area_exited** **(** :ref:`Area2D` area **)** Emitted when another area exits. -.. _class_Area2D_area_shape_entered: + .. _class_Area2D_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_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_body_entered: - **body_entered** **(** :ref:`PhysicsBody2D` body **)** Emitted when a :ref:`PhysicsBody2D` object enters. -.. _class_Area2D_body_exited: + .. _class_Area2D_body_exited: - **body_exited** **(** :ref:`PhysicsBody2D` body **)** Emitted when a :ref:`PhysicsBody2D` object exits. -.. _class_Area2D_body_shape_entered: + .. _class_Area2D_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_body_shape_exited: - **body_shape_exited** **(** :ref:`int` body_id, :ref:`PhysicsBody2D` body, :ref:`int` body_shape, :ref:`int` area_shape **)** Emitted when a :ref:`PhysicsBody2D` object exits, reporting which shapes were overlapping. - Enumerations ------------ .. _enum_Area2D_SpaceOverride: -enum **SpaceOverride** +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 ``priority`` order). @@ -101,7 +134,6 @@ enum **SpaceOverride** - **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 ``priority`` order), but keeps calculating the rest of the areas. - Description ----------- @@ -112,110 +144,220 @@ Property Descriptions .. _class_Area2D_angular_damp: -- :ref:`float` **angular_damp** - 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). +- :ref:`float` **angular_damp** + ++----------+-------------------------+ +| *Setter* | set_angular_damp(value) | ++----------+-------------------------+ +| *Getter* | get_angular_damp() | ++----------+-------------------------+ + +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: -- :ref:`String` **audio_bus_name** - The name of the area's audio bus. +- :ref:`String` **audio_bus_name** + ++----------+---------------------------+ +| *Setter* | set_audio_bus_name(value) | ++----------+---------------------------+ +| *Getter* | get_audio_bus_name() | ++----------+---------------------------+ + +The name of the area's audio bus. .. _class_Area2D_audio_bus_override: -- :ref:`bool` **audio_bus_override** - If ``true`` the area's audio bus overrides the default audio bus. Default value: ``false``. +- :ref:`bool` **audio_bus_override** + ++----------+-------------------------------+ +| *Setter* | set_audio_bus_override(value) | ++----------+-------------------------------+ +| *Getter* | is_overriding_audio_bus() | ++----------+-------------------------------+ + +If ``true`` the area's audio bus overrides the default audio bus. Default value: ``false``. .. _class_Area2D_collision_layer: -- :ref:`int` **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 ``collision_mask``. +- :ref:`int` **collision_layer** + ++----------+----------------------------+ +| *Setter* | set_collision_layer(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 ``collision_mask``. .. _class_Area2D_collision_mask: -- :ref:`int` **collision_mask** - The physics layers this area scans to determine collision detection. +- :ref:`int` **collision_mask** + ++----------+---------------------------+ +| *Setter* | set_collision_mask(value) | ++----------+---------------------------+ +| *Getter* | get_collision_mask() | ++----------+---------------------------+ + +The physics layers this area scans to determine collision detection. .. _class_Area2D_gravity: -- :ref:`float` **gravity** - 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. +- :ref:`float` **gravity** + ++----------+--------------------+ +| *Setter* | set_gravity(value) | ++----------+--------------------+ +| *Getter* | get_gravity() | ++----------+--------------------+ + +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: -- :ref:`float` **gravity_distance_scale** - The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. +- :ref:`float` **gravity_distance_scale** + ++----------+-----------------------------------+ +| *Setter* | set_gravity_distance_scale(value) | ++----------+-----------------------------------+ +| *Getter* | get_gravity_distance_scale() | ++----------+-----------------------------------+ + +The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. .. _class_Area2D_gravity_point: -- :ref:`bool` **gravity_point** - If ``true`` gravity is calculated from a point (set via ``gravity_vec``). Also see ``space_override``. Default value: ``false``. +- :ref:`bool` **gravity_point** + ++----------+-----------------------------+ +| *Setter* | set_gravity_is_point(value) | ++----------+-----------------------------+ +| *Getter* | is_gravity_a_point() | ++----------+-----------------------------+ + +If ``true`` gravity is calculated from a point (set via ``gravity_vec``). Also see ``space_override``. Default value: ``false``. .. _class_Area2D_gravity_vec: -- :ref:`Vector2` **gravity_vec** - The area's gravity vector (not normalized). If gravity is a point (see :ref:`is_gravity_a_point`), this will be the point of attraction. +- :ref:`Vector2` **gravity_vec** + ++----------+---------------------------+ +| *Setter* | set_gravity_vector(value) | ++----------+---------------------------+ +| *Getter* | get_gravity_vector() | ++----------+---------------------------+ + +The area's gravity vector (not normalized). If gravity is a point (see :ref:`is_gravity_a_point`), this will be the point of attraction. .. _class_Area2D_linear_damp: -- :ref:`float` **linear_damp** - 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). +- :ref:`float` **linear_damp** + ++----------+------------------------+ +| *Setter* | set_linear_damp(value) | ++----------+------------------------+ +| *Getter* | get_linear_damp() | ++----------+------------------------+ + +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: -- :ref:`bool` **monitorable** - If ``true`` other monitoring areas can detect this area. Default value: ``true``. +- :ref:`bool` **monitorable** + ++----------+------------------------+ +| *Setter* | set_monitorable(value) | ++----------+------------------------+ +| *Getter* | is_monitorable() | ++----------+------------------------+ + +If ``true`` other monitoring areas can detect this area. Default value: ``true``. .. _class_Area2D_monitoring: -- :ref:`bool` **monitoring** - If ``true`` the area detects bodies or areas entering and exiting it. Default value: ``true``. +- :ref:`bool` **monitoring** + ++----------+-----------------------+ +| *Setter* | set_monitoring(value) | ++----------+-----------------------+ +| *Getter* | is_monitoring() | ++----------+-----------------------+ + +If ``true`` the area detects bodies or areas entering and exiting it. Default value: ``true``. .. _class_Area2D_priority: -- :ref:`float` **priority** - The area's priority. Higher priority areas are processed first. Default value: 0. +- :ref:`float` **priority** + ++----------+---------------------+ +| *Setter* | set_priority(value) | ++----------+---------------------+ +| *Getter* | get_priority() | ++----------+---------------------+ + +The area's priority. Higher priority areas are processed first. Default value: 0. .. _class_Area2D_space_override: -- :ref:`SpaceOverride` **space_override** - Override mode for gravity and damping calculations within this area. See the SPACE_OVERRIDE\_\* constants for values. +- :ref:`SpaceOverride` **space_override** ++----------+--------------------------------+ +| *Setter* | set_space_override_mode(value) | ++----------+--------------------------------+ +| *Getter* | get_space_override_mode() | ++----------+--------------------------------+ + +Override mode for gravity and damping calculations within this area. See the SPACE_OVERRIDE\_\* constants for values. Method Descriptions ------------------- -.. _class_Area2D_get_collision_layer_bit: + .. _class_Area2D_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const Return an individual bit on the layer mask. Describes whether other areas will collide with this one on the given layer. -.. _class_Area2D_get_collision_mask_bit: + .. _class_Area2D_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Return an individual bit on the collision mask. Describes whether this area will collide with others on the given layer. -.. _class_Area2D_get_overlapping_areas: + .. _class_Area2D_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_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_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_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_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_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. - diff --git a/classes/class_array.rst b/classes/class_array.rst index fb8913fb2..db3e75b37 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -110,85 +110,85 @@ Arrays are always passed by reference. Method Descriptions ------------------- -.. _class_Array_Array: + .. _class_Array_Array: - :ref:`Array` **Array** **(** :ref:`PoolColorArray` from **)** Construct an array from a :ref:`PoolColorArray`. -.. _class_Array_Array: + .. _class_Array_Array: - :ref:`Array` **Array** **(** :ref:`PoolVector3Array` from **)** Construct an array from a :ref:`PoolVector3Array`. -.. _class_Array_Array: + .. _class_Array_Array: - :ref:`Array` **Array** **(** :ref:`PoolVector2Array` from **)** Construct an array from a :ref:`PoolVector2Array`. -.. _class_Array_Array: + .. _class_Array_Array: - :ref:`Array` **Array** **(** :ref:`PoolStringArray` from **)** Construct an array from a :ref:`PoolStringArray`. -.. _class_Array_Array: + .. _class_Array_Array: - :ref:`Array` **Array** **(** :ref:`PoolRealArray` from **)** Construct an array from a :ref:`PoolRealArray`. -.. _class_Array_Array: + .. _class_Array_Array: - :ref:`Array` **Array** **(** :ref:`PoolIntArray` from **)** Construct an array from a :ref:`PoolIntArray`. -.. _class_Array_Array: + .. _class_Array_Array: - :ref:`Array` **Array** **(** :ref:`PoolByteArray` from **)** Construct an array from a :ref:`PoolByteArray`. -.. _class_Array_append: + .. _class_Array_append: - void **append** **(** :ref:`Variant` value **)** Append an element at the end of the array (alias of :ref:`push_back`). -.. _class_Array_back: + .. _class_Array_back: - :ref:`Variant` **back** **(** **)** Returns the last element of the array if the array is not empty (size>0). -.. _class_Array_bsearch: + .. _class_Array_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_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_clear: - void **clear** **(** **)** Clear the array (resize to 0). -.. _class_Array_count: + .. _class_Array_count: - :ref:`int` **count** **(** :ref:`Variant` value **)** Return the amount of times an element is in the array. -.. _class_Array_duplicate: + .. _class_Array_duplicate: - :ref:`Array` **duplicate** **(** :ref:`bool` deep=False **)** @@ -196,37 +196,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_empty: - :ref:`bool` **empty** **(** **)** Return true if the array is empty (size==0). -.. _class_Array_erase: + .. _class_Array_erase: - void **erase** **(** :ref:`Variant` value **)** Remove the first occurrence of a value from the array. -.. _class_Array_find: + .. _class_Array_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_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_front: - :ref:`Variant` **front** **(** **)** Returns the first element of the array if the array is not empty (size>0). -.. _class_Array_has: + .. _class_Array_has: - :ref:`bool` **has** **(** :ref:`Variant` value **)** @@ -239,97 +239,97 @@ Return true if the array contains given value. [ "inside", 7 ].has(7) == true [ "inside", 7 ].has("7") == false -.. _class_Array_hash: + .. _class_Array_hash: - :ref:`int` **hash** **(** **)** Return a hashed integer value representing the array contents. -.. _class_Array_insert: + .. _class_Array_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_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. -.. _class_Array_max: + .. _class_Array_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_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_pop_back: - :ref:`Variant` **pop_back** **(** **)** Remove the last element of the array. -.. _class_Array_pop_front: + .. _class_Array_pop_front: - :ref:`Variant` **pop_front** **(** **)** Remove the first element of the array. -.. _class_Array_push_back: + .. _class_Array_push_back: - void **push_back** **(** :ref:`Variant` value **)** Append an element at the end of the array. -.. _class_Array_push_front: + .. _class_Array_push_front: - void **push_front** **(** :ref:`Variant` value **)** Add an element at the beginning of the array. -.. _class_Array_remove: + .. _class_Array_remove: - void **remove** **(** :ref:`int` position **)** Remove an element from the array by index. -.. _class_Array_resize: + .. _class_Array_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_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_shuffle: - void **shuffle** **(** **)** Shuffle the array such that the items will have a random order. -.. _class_Array_size: + .. _class_Array_size: - :ref:`int` **size** **(** **)** Return the amount of elements in the array. -.. _class_Array_sort: + .. _class_Array_sort: - void **sort** **(** **)** Sort the array using natural order. -.. _class_Array_sort_custom: + .. _class_Array_sort_custom: - void **sort_custom** **(** :ref:`Object` obj, :ref:`String` func **)** @@ -348,4 +348,3 @@ Sort the array using a custom method. The arguments are an object that holds the var my_items = [[5, "Potato"], [9, "Rice"], [4, "Tomato"]] my_items.sort_custom(MyCustomSorter, "sort") - diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index 5130d8a0e..b681d7a73 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -8,6 +8,7 @@ ArrayMesh ========= **Inherits:** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description +Properties +---------- + ++-------------------------------------------------+-----------------------------------------------------------+ +| :ref:`BlendShapeMode` | :ref:`blend_shape_mode` | ++-------------------------------------------------+-----------------------------------------------------------+ +| :ref:`AABB` | :ref:`custom_aabb` | ++-------------------------------------------------+-----------------------------------------------------------+ + Methods ------- @@ -61,7 +71,7 @@ Enumerations .. _enum_ArrayMesh_ArrayFormat: -enum **ArrayFormat** +enum **ArrayFormat**: - **ARRAY_FORMAT_VERTEX** = **1** --- Array format will include vertices (mandatory). - **ARRAY_FORMAT_NORMAL** = **2** --- Array format will include normals @@ -75,7 +85,7 @@ enum **ArrayFormat** .. _enum_ArrayMesh_ArrayType: -enum **ArrayType** +enum **ArrayType**: - **ARRAY_VERTEX** = **0** --- Vertex array (array of :ref:`Vector3` vertices). - **ARRAY_NORMAL** = **1** --- Normal array (array of :ref:`Vector3` normals). @@ -90,13 +100,11 @@ enum **ArrayType** For triangles, the index array is interpreted as triples, referring to the vertices of each triangle. For lines, the index array is in pairs indicating the start and end of each line. - **ARRAY_MAX** = **9** - Constants --------- - **NO_INDEX_ARRAY** = **-1** --- Default value used for index_array_len when no indices are present. - **ARRAY_WEIGHTS_SIZE** = **4** --- Amount of weights/bone indices per vertex (always 4). - Property Descriptions --------------------- @@ -104,19 +112,32 @@ Property Descriptions - :ref:`BlendShapeMode` **blend_shape_mode** ++----------+-----------------------------+ +| *Setter* | set_blend_shape_mode(value) | ++----------+-----------------------------+ +| *Getter* | get_blend_shape_mode() | ++----------+-----------------------------+ + .. _class_ArrayMesh_custom_aabb: -- :ref:`AABB` **custom_aabb** - An overriding bounding box for this mesh. +- :ref:`AABB` **custom_aabb** ++----------+------------------------+ +| *Setter* | set_custom_aabb(value) | ++----------+------------------------+ +| *Getter* | get_custom_aabb() | ++----------+------------------------+ + +An overriding bounding box for this mesh. Method Descriptions ------------------- -.. _class_ArrayMesh_add_blend_shape: + .. _class_ArrayMesh_add_blend_shape: - void **add_blend_shape** **(** :ref:`String` name **)** -.. _class_ArrayMesh_add_surface_from_arrays: + .. _class_ArrayMesh_add_surface_from_arrays: - void **add_surface_from_arrays** **(** :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_flags=97280 **)** @@ -130,98 +151,97 @@ Adding an index array puts this function into "index mode" where the vertex and Godot uses clockwise winding order for front faces of triangle primitive modes. -.. _class_ArrayMesh_center_geometry: + .. _class_ArrayMesh_center_geometry: - void **center_geometry** **(** **)** Centers the geometry. -.. _class_ArrayMesh_clear_blend_shapes: + .. _class_ArrayMesh_clear_blend_shapes: - void **clear_blend_shapes** **(** **)** Remove all blend shapes from this ``ArrayMesh``. -.. _class_ArrayMesh_get_blend_shape_count: + .. _class_ArrayMesh_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_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_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_regen_normalmaps: - void **regen_normalmaps** **(** **)** Will regenerate normal maps for the ``ArrayMesh``. -.. _class_ArrayMesh_surface_find_by_name: + .. _class_ArrayMesh_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_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`). -.. _class_ArrayMesh_surface_get_array_len: + .. _class_ArrayMesh_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`). -.. _class_ArrayMesh_surface_get_format: + .. _class_ArrayMesh_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`). -.. _class_ArrayMesh_surface_get_name: + .. _class_ArrayMesh_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_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`). -.. _class_ArrayMesh_surface_remove: + .. _class_ArrayMesh_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_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_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_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 925b9d4eb..83673750d 100644 --- a/classes/class_arvranchor.rst +++ b/classes/class_arvranchor.rst @@ -8,6 +8,7 @@ ARVRAnchor ========== **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Anchor point in AR Space. +Properties +---------- + ++-----------------------+----------------------------------------------+ +| :ref:`int` | :ref:`anchor_id` | ++-----------------------+----------------------------------------------+ + Methods ------- @@ -42,34 +50,40 @@ Property Descriptions .. _class_ARVRAnchor_anchor_id: -- :ref:`int` **anchor_id** - The anchor's id. You can set this before the anchor itself exists. The first anchor gets an id of ``1``, the second an id of ``2``, etc. When anchors get removed, the engine can then assign the corresponding id to new anchors. The most common situation where anchors 'disappear' is when the AR server identifies that two anchors represent different parts of the same plane and merges them. +- :ref:`int` **anchor_id** ++----------+----------------------+ +| *Setter* | set_anchor_id(value) | ++----------+----------------------+ +| *Getter* | get_anchor_id() | ++----------+----------------------+ + +The anchor's id. You can set this before the anchor itself exists. The first anchor gets an id of ``1``, the second an id of ``2``, etc. When anchors get removed, the engine can then assign the corresponding id to new anchors. The most common situation where anchors 'disappear' is when the AR server identifies that two anchors represent different parts of the same plane and merges them. Method Descriptions ------------------- -.. _class_ARVRAnchor_get_anchor_name: + .. _class_ARVRAnchor_get_anchor_name: - :ref:`String` **get_anchor_name** **(** **)** const Returns the name given to this anchor. -.. _class_ARVRAnchor_get_is_active: + .. _class_ARVRAnchor_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_get_plane: - :ref:`Plane` **get_plane** **(** **)** const Returns a plane aligned with our anchor, handy for intersection testing -.. _class_ARVRAnchor_get_size: + .. _class_ARVRAnchor_get_size: - :ref:`Vector3` **get_size** **(** **)** const Returns the estimated size of the plane that was detected. Say when the anchor relates to a table in the real world, this is the estimated size of the surface of that table. - diff --git a/classes/class_arvrcamera.rst b/classes/class_arvrcamera.rst index eaa4cc1f8..bfb1a1fb4 100644 --- a/classes/class_arvrcamera.rst +++ b/classes/class_arvrcamera.rst @@ -8,6 +8,7 @@ ARVRCamera ========== **Inherits:** :ref:`Camera` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_arvrcontroller.rst b/classes/class_arvrcontroller.rst index 2d62dbad5..8e45d8174 100644 --- a/classes/class_arvrcontroller.rst +++ b/classes/class_arvrcontroller.rst @@ -8,6 +8,7 @@ ARVRController ============== **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description A spatial node representing a spatially tracked controller. +Properties +---------- + ++---------------------------+----------------------------------------------------------+ +| :ref:`int` | :ref:`controller_id` | ++---------------------------+----------------------------------------------------------+ +| :ref:`float` | :ref:`rumble` | ++---------------------------+----------------------------------------------------------+ + Methods ------- @@ -35,19 +45,18 @@ Methods Signals ------- -.. _class_ARVRController_button_pressed: + .. _class_ARVRController_button_pressed: - **button_pressed** **(** :ref:`int` button **)** Emitted when a button on this controller is pressed. -.. _class_ARVRController_button_release: + .. _class_ARVRController_button_release: - **button_release** **(** :ref:`int` button **)** Emitted when a button on this controller is released. - Description ----------- @@ -62,7 +71,15 @@ Property Descriptions .. _class_ARVRController_controller_id: -- :ref:`int` **controller_id** - The controller's id. +- :ref:`int` **controller_id** + ++----------+--------------------------+ +| *Setter* | set_controller_id(value) | ++----------+--------------------------+ +| *Getter* | get_controller_id() | ++----------+--------------------------+ + +The controller's id. A controller id of 0 is unbound and will always result in an inactive node. Controller id 1 is reserved for the first controller that identifies itself as the left hand controller and id 2 is reserved for the first controller that identifies itself as the right hand controller. @@ -72,46 +89,52 @@ When a controller is turned off, its slot is freed. This ensures controllers wil .. _class_ARVRController_rumble: -- :ref:`float` **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. +- :ref:`float` **rumble** ++----------+-------------------+ +| *Setter* | set_rumble(value) | ++----------+-------------------+ +| *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. Method Descriptions ------------------- -.. _class_ARVRController_get_controller_name: + .. _class_ARVRController_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_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_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_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_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_is_button_pressed: - :ref:`int` **is_button_pressed** **(** :ref:`int` button **)** const Returns ``true`` if the button at index ``button`` is pressed. - diff --git a/classes/class_arvrinterface.rst b/classes/class_arvrinterface.rst index 4073e885d..3e21d27ed 100644 --- a/classes/class_arvrinterface.rst +++ b/classes/class_arvrinterface.rst @@ -8,7 +8,9 @@ ARVRInterface ============= **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`ARVRInterfaceGDNative`, :ref:`MobileVRInterface` + **Category:** Core Brief Description @@ -16,6 +18,17 @@ Brief Description 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` | ++-------------------------+-------------------------------------------------------------------------------------------+ + Methods ------- @@ -40,7 +53,7 @@ Enumerations .. _enum_ARVRInterface_Eyes: -enum **Eyes** +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. - **EYE_LEFT** = **1** --- Left eye output, this is mostly used internally when rendering the image for the left eye and obtaining positioning and projection information. @@ -48,7 +61,7 @@ enum **Eyes** .. _enum_ARVRInterface_Tracking_status: -enum **Tracking_status** +enum **Tracking_status**: - **ARVR_NORMAL_TRACKING** = **0** --- Tracking is behaving as expected. - **ARVR_EXCESSIVE_MOTION** = **1** --- Tracking is hindered by excessive motion, player is moving faster then tracking can keep up. @@ -58,7 +71,7 @@ enum **Tracking_status** .. _enum_ARVRInterface_Capabilities: -enum **Capabilities** +enum **Capabilities**: - **ARVR_NONE** = **0** --- No ARVR capabilities. - **ARVR_MONO** = **1** --- This interface can work with normal rendering output (non-HMD based AR). @@ -66,7 +79,6 @@ enum **Capabilities** - **ARVR_AR** = **4** --- This interface support AR (video background and real world tracking). - **ARVR_EXTERNAL** = **8** --- This interface outputs to an external device, if the main viewport is used the on screen output is an unmodified buffer of either the left or right eye (stretched if the viewport size is not changed to the same aspect ratio of get_render_targetsize. Using a separate viewport node frees up the main viewport for other purposes. - Description ----------- @@ -79,45 +91,68 @@ Property Descriptions .. _class_ARVRInterface_ar_is_anchor_detection_enabled: -- :ref:`bool` **ar_is_anchor_detection_enabled** - On an AR interface, is our anchor detection enabled? +- :ref:`bool` **ar_is_anchor_detection_enabled** + ++----------+----------------------------------------+ +| *Setter* | set_anchor_detection_is_enabled(value) | ++----------+----------------------------------------+ +| *Getter* | get_anchor_detection_is_enabled() | ++----------+----------------------------------------+ + +On an AR interface, is our anchor detection enabled? .. _class_ARVRInterface_interface_is_initialized: -- :ref:`bool` **interface_is_initialized** - Has this interface been initialized? +- :ref:`bool` **interface_is_initialized** + ++----------+---------------------------+ +| *Setter* | set_is_initialized(value) | ++----------+---------------------------+ +| *Getter* | is_initialized() | ++----------+---------------------------+ + +Has this interface been initialized? .. _class_ARVRInterface_interface_is_primary: -- :ref:`bool` **interface_is_primary** - Is this our primary interface? +- :ref:`bool` **interface_is_primary** ++----------+-----------------------+ +| *Setter* | set_is_primary(value) | ++----------+-----------------------+ +| *Getter* | is_primary() | ++----------+-----------------------+ + +Is this our primary interface? Method Descriptions ------------------- -.. _class_ARVRInterface_get_capabilities: + .. _class_ARVRInterface_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_get_name: - :ref:`String` **get_name** **(** **)** const Returns the name of this interface (OpenVR, OpenHMD, ARKit, etc). -.. _class_ARVRInterface_get_render_targetsize: + .. _class_ARVRInterface_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_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_initialize: - :ref:`bool` **initialize** **(** **)** @@ -131,16 +166,15 @@ 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_is_stereo: - :ref:`bool` **is_stereo** **(** **)** Returns true if the current output of this interface is in stereo. -.. _class_ARVRInterface_uninitialize: + .. _class_ARVRInterface_uninitialize: - void **uninitialize** **(** **)** Turns the interface off. - diff --git a/classes/class_arvrinterfacegdnative.rst b/classes/class_arvrinterfacegdnative.rst index 3c1944e6c..168c2a1c9 100644 --- a/classes/class_arvrinterfacegdnative.rst +++ b/classes/class_arvrinterfacegdnative.rst @@ -8,6 +8,7 @@ ARVRInterfaceGDNative ===================== **Inherits:** :ref:`ARVRInterface` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_arvrorigin.rst b/classes/class_arvrorigin.rst index d7b46175a..9b5cbba08 100644 --- a/classes/class_arvrorigin.rst +++ b/classes/class_arvrorigin.rst @@ -8,6 +8,7 @@ ARVROrigin ========== **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Our origin point in AR/VR. +Properties +---------- + ++---------------------------+--------------------------------------------------+ +| :ref:`float` | :ref:`world_scale` | ++---------------------------+--------------------------------------------------+ + Description ----------- @@ -31,8 +39,15 @@ Property Descriptions .. _class_ARVROrigin_world_scale: -- :ref:`float` **world_scale** - Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 meter in the real world. +- :ref:`float` **world_scale** + ++----------+------------------------+ +| *Setter* | set_world_scale(value) | ++----------+------------------------+ +| *Getter* | get_world_scale() | ++----------+------------------------+ + +Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 meter in the real world. Note that this method is a passthrough to the :ref:`ARVRServer` itself. - diff --git a/classes/class_arvrpositionaltracker.rst b/classes/class_arvrpositionaltracker.rst index 8e76db00f..c406356a6 100644 --- a/classes/class_arvrpositionaltracker.rst +++ b/classes/class_arvrpositionaltracker.rst @@ -8,6 +8,7 @@ ARVRPositionalTracker ===================== **Inherits:** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description A tracked object +Properties +---------- + ++---------------------------+---------------------------------------------------+ +| :ref:`float` | :ref:`rumble` | ++---------------------------+---------------------------------------------------+ + Methods ------- @@ -43,13 +51,12 @@ Enumerations .. _enum_ARVRPositionalTracker_TrackerHand: -enum **TrackerHand** +enum **TrackerHand**: - **TRACKER_HAND_UNKNOWN** = **0** --- The hand this tracker is held in is unknown or not applicable. - **TRACKER_LEFT_HAND** = **1** --- This tracker is the left hand controller. - **TRACKER_RIGHT_HAND** = **2** --- This tracker is the right hand controller. - Description ----------- @@ -64,64 +71,70 @@ Property Descriptions .. _class_ARVRPositionalTracker_rumble: -- :ref:`float` **rumble** - The degree to which the tracker rumbles. Ranges from ``0.0`` to ``1.0`` with precision ``.01``. +- :ref:`float` **rumble** ++----------+-------------------+ +| *Setter* | set_rumble(value) | ++----------+-------------------+ +| *Getter* | get_rumble() | ++----------+-------------------+ + +The degree to which the tracker rumbles. Ranges from ``0.0`` to ``1.0`` with precision ``.01``. Method Descriptions ------------------- -.. _class_ARVRPositionalTracker_get_hand: + .. _class_ARVRPositionalTracker_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_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_get_name: - :ref:`String` **get_name** **(** **)** const Returns the controller or anchor point's name if available. -.. _class_ARVRPositionalTracker_get_orientation: + .. _class_ARVRPositionalTracker_get_orientation: - :ref:`Basis` **get_orientation** **(** **)** const Returns the controller's orientation matrix. -.. _class_ARVRPositionalTracker_get_position: + .. _class_ARVRPositionalTracker_get_position: - :ref:`Vector3` **get_position** **(** **)** const Returns the world-space controller position. -.. _class_ARVRPositionalTracker_get_tracks_orientation: + .. _class_ARVRPositionalTracker_get_tracks_orientation: - :ref:`bool` **get_tracks_orientation** **(** **)** const Returns ``true`` if this device tracks orientation. -.. _class_ARVRPositionalTracker_get_tracks_position: + .. _class_ARVRPositionalTracker_get_tracks_position: - :ref:`bool` **get_tracks_position** **(** **)** const Returns ``true`` if this device tracks position. -.. _class_ARVRPositionalTracker_get_transform: + .. _class_ARVRPositionalTracker_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_get_type: - :ref:`TrackerType` **get_type** **(** **)** const Returns the tracker's type. - diff --git a/classes/class_arvrserver.rst b/classes/class_arvrserver.rst index c5e4bcd50..728d8ccde 100644 --- a/classes/class_arvrserver.rst +++ b/classes/class_arvrserver.rst @@ -8,6 +8,7 @@ ARVRServer ========== **Inherits:** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description This is our AR/VR Server. +Properties +---------- + ++-------------------------------------------+--------------------------------------------------------------+ +| :ref:`ARVRInterface` | :ref:`primary_interface` | ++-------------------------------------------+--------------------------------------------------------------+ +| :ref:`float` | :ref:`world_scale` | ++-------------------------------------------+--------------------------------------------------------------+ + Methods ------- @@ -47,37 +57,36 @@ Methods Signals ------- -.. _class_ARVRServer_interface_added: + .. _class_ARVRServer_interface_added: - **interface_added** **(** :ref:`String` interface_name **)** Signal send when a new interface has been added. -.. _class_ARVRServer_interface_removed: + .. _class_ARVRServer_interface_removed: - **interface_removed** **(** :ref:`String` interface_name **)** Signal send when an interface is removed. -.. _class_ARVRServer_tracker_added: + .. _class_ARVRServer_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_tracker_removed: - **tracker_removed** **(** :ref:`String` tracker_name, :ref:`int` type, :ref:`int` id **)** Signal send when a tracker is removed, you should remove any ARVRController or ARVRAnchor points if applicable. This is not mandatory, the nodes simply become inactive and will be made active again when a new tracker becomes available (i.e. a new controller is switched on that takes the place of the previous one). - Enumerations ------------ .. _enum_ARVRServer_RotationMode: -enum **RotationMode** +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. - **RESET_BUT_KEEP_TILT** = **1** --- Resets the orientation but keeps the tilt of the device. So if we're looking down, we keep looking down but heading will be reset. @@ -85,7 +94,7 @@ enum **RotationMode** .. _enum_ARVRServer_TrackerType: -enum **TrackerType** +enum **TrackerType**: - **TRACKER_CONTROLLER** = **1** --- Our tracker tracks the location of a controller. - **TRACKER_BASESTATION** = **2** --- Our tracker tracks the location of a base station. @@ -94,7 +103,6 @@ enum **TrackerType** - **TRACKER_UNKNOWN** = **128** --- Used internally if we haven't set the tracker type yet. - **TRACKER_ANY** = **255** --- Used internally to select all trackers. - Description ----------- @@ -107,15 +115,28 @@ Property Descriptions - :ref:`ARVRInterface` **primary_interface** ++----------+------------------------------+ +| *Setter* | set_primary_interface(value) | ++----------+------------------------------+ +| *Getter* | get_primary_interface() | ++----------+------------------------------+ + .. _class_ARVRServer_world_scale: -- :ref:`float` **world_scale** - Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 meter in the real world. +- :ref:`float` **world_scale** ++----------+------------------------+ +| *Setter* | set_world_scale(value) | ++----------+------------------------+ +| *Getter* | get_world_scale() | ++----------+------------------------+ + +Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 meter in the real world. Method Descriptions ------------------- -.. _class_ARVRServer_center_on_hmd: + .. _class_ARVRServer_center_on_hmd: - void **center_on_hmd** **(** :ref:`RotationMode` rotation_mode, :ref:`bool` keep_height **)** @@ -131,64 +152,63 @@ 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_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_get_hmd_transform: - :ref:`Transform` **get_hmd_transform** **(** **)** Returns the primary interface's transformation. -.. _class_ARVRServer_get_interface: + .. _class_ARVRServer_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_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_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_get_last_commit_usec: - :ref:`int` **get_last_commit_usec** **(** **)** -.. _class_ARVRServer_get_last_frame_usec: + .. _class_ARVRServer_get_last_frame_usec: - :ref:`int` **get_last_frame_usec** **(** **)** -.. _class_ARVRServer_get_last_process_usec: + .. _class_ARVRServer_get_last_process_usec: - :ref:`int` **get_last_process_usec** **(** **)** -.. _class_ARVRServer_get_reference_frame: + .. _class_ARVRServer_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_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_get_tracker_count: - :ref:`int` **get_tracker_count** **(** **)** const Get the number of trackers currently registered. - diff --git a/classes/class_astar.rst b/classes/class_astar.rst index 3d5ec2456..5ea3e6b47 100644 --- a/classes/class_astar.rst +++ b/classes/class_astar.rst @@ -8,6 +8,7 @@ AStar ===== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -70,19 +71,19 @@ You must add points manually with :ref:`AStar.add_point` Method Descriptions ------------------- -.. _class_AStar__compute_cost: + .. _class_AStar__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__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_add_point: - void **add_point** **(** :ref:`int` id, :ref:`Vector3` position, :ref:`float` weight_scale=1.0 **)** @@ -96,19 +97,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_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_clear: - void **clear** **(** **)** Clears all the points and segments. -.. _class_AStar_connect_points: + .. _class_AStar_connect_points: - void **connect_points** **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** @@ -124,25 +125,25 @@ Creates a segment between the given points. as.connect_points(1, 2, false) # If bidirectional=false it's only possible to go from point 1 to point 2 # and not from point 2 to point 1. -.. _class_AStar_disconnect_points: + .. _class_AStar_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_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_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_get_closest_position_in_segment: - :ref:`Vector3` **get_closest_position_in_segment** **(** :ref:`Vector3` to_position **)** const @@ -161,7 +162,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_get_id_path: - :ref:`PoolIntArray` **get_id_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** @@ -186,7 +187,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_get_point_connections: - :ref:`PoolIntArray` **get_point_connections** **(** :ref:`int` id **)** @@ -206,52 +207,51 @@ 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_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_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_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_get_points: - :ref:`Array` **get_points** **(** **)** Returns an array of all points. -.. _class_AStar_has_point: + .. _class_AStar_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_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_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_set_point_weight_scale: - void **set_point_weight_scale** **(** :ref:`int` id, :ref:`float` weight_scale **)** Sets the ``weight_scale`` for the point with the given id. - diff --git a/classes/class_atlastexture.rst b/classes/class_atlastexture.rst index 596e5974b..959d4087d 100644 --- a/classes/class_atlastexture.rst +++ b/classes/class_atlastexture.rst @@ -8,6 +8,7 @@ AtlasTexture ============ **Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,19 @@ Brief Description Packs multiple small textures in a single, bigger one. Helps to optimize video memory costs and render calls. +Properties +---------- + ++-------------------------------+----------------------------------------------------+ +| :ref:`Texture` | :ref:`atlas` | ++-------------------------------+----------------------------------------------------+ +| :ref:`bool` | :ref:`filter_clip` | ++-------------------------------+----------------------------------------------------+ +| :ref:`Rect2` | :ref:`margin` | ++-------------------------------+----------------------------------------------------+ +| :ref:`Rect2` | :ref:`region` | ++-------------------------------+----------------------------------------------------+ + Description ----------- @@ -27,18 +41,49 @@ Property Descriptions .. _class_AtlasTexture_atlas: -- :ref:`Texture` **atlas** - The texture that contains the atlas. Can be any :ref:`Texture` subtype. +- :ref:`Texture` **atlas** + ++----------+------------------+ +| *Setter* | set_atlas(value) | ++----------+------------------+ +| *Getter* | get_atlas() | ++----------+------------------+ + +The texture that contains the atlas. Can be any :ref:`Texture` subtype. .. _class_AtlasTexture_filter_clip: -- :ref:`bool` **filter_clip** - If ``true`` clips the area outside of the region to avoid bleeding of the surrounding texture pixels. +- :ref:`bool` **filter_clip** + ++----------+------------------------+ +| *Setter* | set_filter_clip(value) | ++----------+------------------------+ +| *Getter* | has_filter_clip() | ++----------+------------------------+ + +If ``true`` clips the area outside of the region to avoid bleeding of the surrounding texture pixels. .. _class_AtlasTexture_margin: -- :ref:`Rect2` **margin** - 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. +- :ref:`Rect2` **margin** + ++----------+-------------------+ +| *Setter* | set_margin(value) | ++----------+-------------------+ +| *Getter* | get_margin() | ++----------+-------------------+ + +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: -- :ref:`Rect2` **region** - The AtlasTexture's used region. +- :ref:`Rect2` **region** ++----------+-------------------+ +| *Setter* | set_region(value) | ++----------+-------------------+ +| *Getter* | get_region() | ++----------+-------------------+ + +The AtlasTexture's used region. diff --git a/classes/class_audiobuslayout.rst b/classes/class_audiobuslayout.rst index c9ec247ce..6d0aa6d83 100644 --- a/classes/class_audiobuslayout.rst +++ b/classes/class_audiobuslayout.rst @@ -8,6 +8,7 @@ AudioBusLayout ============== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_audioeffect.rst b/classes/class_audioeffect.rst index 830085e21..ef247e644 100644 --- a/classes/class_audioeffect.rst +++ b/classes/class_audioeffect.rst @@ -8,7 +8,9 @@ AudioEffect =========== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`AudioEffectCompressor`, :ref:`AudioEffectLimiter`, :ref:`AudioEffectAmplify`, :ref:`AudioEffectFilter`, :ref:`AudioEffectDistortion`, :ref:`AudioEffectDelay`, :ref:`AudioEffectStereoEnhance`, :ref:`AudioEffectReverb`, :ref:`AudioEffectPanner`, :ref:`AudioEffectEQ`, :ref:`AudioEffectPitchShift`, :ref:`AudioEffectRecord`, :ref:`AudioEffectChorus`, :ref:`AudioEffectPhaser` + **Category:** Core Brief Description diff --git a/classes/class_audioeffectamplify.rst b/classes/class_audioeffectamplify.rst index 7fe22c704..cde6ca060 100644 --- a/classes/class_audioeffectamplify.rst +++ b/classes/class_audioeffectamplify.rst @@ -8,6 +8,7 @@ AudioEffectAmplify ================== **Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -17,6 +18,13 @@ Adds a Amplify audio effect to an Audio bus. Increases or decreases the volume of the selected audio bus. +Properties +---------- + ++---------------------------+------------------------------------------------------+ +| :ref:`float` | :ref:`volume_db` | ++---------------------------+------------------------------------------------------+ + Description ----------- @@ -27,6 +35,13 @@ Property Descriptions .. _class_AudioEffectAmplify_volume_db: -- :ref:`float` **volume_db** - Amount of amplification. Positive values make the sound louder, negative values make it quieter. Value can range from -80 to 24. Default value: ``0``. +- :ref:`float` **volume_db** ++----------+----------------------+ +| *Setter* | set_volume_db(value) | ++----------+----------------------+ +| *Getter* | get_volume_db() | ++----------+----------------------+ + +Amount of amplification. Positive values make the sound louder, negative values make it quieter. Value can range from -80 to 24. Default value: ``0``. diff --git a/classes/class_audioeffectbandlimitfilter.rst b/classes/class_audioeffectbandlimitfilter.rst index 9ff8d45d7..7a517ba68 100644 --- a/classes/class_audioeffectbandlimitfilter.rst +++ b/classes/class_audioeffectbandlimitfilter.rst @@ -8,6 +8,7 @@ AudioEffectBandLimitFilter ========================== **Inherits:** :ref:`AudioEffectFilter` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_audioeffectbandpassfilter.rst b/classes/class_audioeffectbandpassfilter.rst index 565cb0d8d..0a285afad 100644 --- a/classes/class_audioeffectbandpassfilter.rst +++ b/classes/class_audioeffectbandpassfilter.rst @@ -8,6 +8,7 @@ AudioEffectBandPassFilter ========================= **Inherits:** :ref:`AudioEffectFilter` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_audioeffectchorus.rst b/classes/class_audioeffectchorus.rst index 37abe6b0e..08f31fcd6 100644 --- a/classes/class_audioeffectchorus.rst +++ b/classes/class_audioeffectchorus.rst @@ -8,6 +8,7 @@ AudioEffectChorus ================= **Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,65 @@ Brief Description 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` | ++---------------------------+---------------------------------------------------------------------+ + Description ----------- @@ -25,110 +85,325 @@ Property Descriptions .. _class_AudioEffectChorus_dry: -- :ref:`float` **dry** - The effect's raw signal. +- :ref:`float` **dry** + ++----------+----------------+ +| *Setter* | set_dry(value) | ++----------+----------------+ +| *Getter* | get_dry() | ++----------+----------------+ + +The effect's raw signal. .. _class_AudioEffectChorus_voice/1/cutoff_hz: -- :ref:`float` **voice/1/cutoff_hz** - The voice's cutoff frequency. +- :ref:`float` **voice/1/cutoff_hz** + ++----------+----------------------------+ +| *Setter* | set_voice_cutoff_hz(value) | ++----------+----------------------------+ +| *Getter* | get_voice_cutoff_hz() | ++----------+----------------------------+ + +The voice's cutoff frequency. .. _class_AudioEffectChorus_voice/1/delay_ms: -- :ref:`float` **voice/1/delay_ms** - The voice's signal delay. +- :ref:`float` **voice/1/delay_ms** + ++----------+---------------------------+ +| *Setter* | set_voice_delay_ms(value) | ++----------+---------------------------+ +| *Getter* | get_voice_delay_ms() | ++----------+---------------------------+ + +The voice's signal delay. .. _class_AudioEffectChorus_voice/1/depth_ms: -- :ref:`float` **voice/1/depth_ms** - The voice filter's depth. +- :ref:`float` **voice/1/depth_ms** + ++----------+---------------------------+ +| *Setter* | set_voice_depth_ms(value) | ++----------+---------------------------+ +| *Getter* | get_voice_depth_ms() | ++----------+---------------------------+ + +The voice filter's depth. .. _class_AudioEffectChorus_voice/1/level_db: -- :ref:`float` **voice/1/level_db** - The voice's volume. +- :ref:`float` **voice/1/level_db** + ++----------+---------------------------+ +| *Setter* | set_voice_level_db(value) | ++----------+---------------------------+ +| *Getter* | get_voice_level_db() | ++----------+---------------------------+ + +The voice's volume. .. _class_AudioEffectChorus_voice/1/pan: -- :ref:`float` **voice/1/pan** - The voice's pan level. +- :ref:`float` **voice/1/pan** + ++----------+----------------------+ +| *Setter* | set_voice_pan(value) | ++----------+----------------------+ +| *Getter* | get_voice_pan() | ++----------+----------------------+ + +The voice's pan level. .. _class_AudioEffectChorus_voice/1/rate_hz: -- :ref:`float` **voice/1/rate_hz** - The voice's filter rate. +- :ref:`float` **voice/1/rate_hz** + ++----------+--------------------------+ +| *Setter* | set_voice_rate_hz(value) | ++----------+--------------------------+ +| *Getter* | get_voice_rate_hz() | ++----------+--------------------------+ + +The voice's filter rate. .. _class_AudioEffectChorus_voice/2/cutoff_hz: -- :ref:`float` **voice/2/cutoff_hz** - The voice's cutoff frequency. +- :ref:`float` **voice/2/cutoff_hz** + ++----------+----------------------------+ +| *Setter* | set_voice_cutoff_hz(value) | ++----------+----------------------------+ +| *Getter* | get_voice_cutoff_hz() | ++----------+----------------------------+ + +The voice's cutoff frequency. .. _class_AudioEffectChorus_voice/2/delay_ms: -- :ref:`float` **voice/2/delay_ms** - The voice's signal delay. +- :ref:`float` **voice/2/delay_ms** + ++----------+---------------------------+ +| *Setter* | set_voice_delay_ms(value) | ++----------+---------------------------+ +| *Getter* | get_voice_delay_ms() | ++----------+---------------------------+ + +The voice's signal delay. .. _class_AudioEffectChorus_voice/2/depth_ms: -- :ref:`float` **voice/2/depth_ms** - The voice filter's depth. +- :ref:`float` **voice/2/depth_ms** + ++----------+---------------------------+ +| *Setter* | set_voice_depth_ms(value) | ++----------+---------------------------+ +| *Getter* | get_voice_depth_ms() | ++----------+---------------------------+ + +The voice filter's depth. .. _class_AudioEffectChorus_voice/2/level_db: -- :ref:`float` **voice/2/level_db** - The voice's volume. +- :ref:`float` **voice/2/level_db** + ++----------+---------------------------+ +| *Setter* | set_voice_level_db(value) | ++----------+---------------------------+ +| *Getter* | get_voice_level_db() | ++----------+---------------------------+ + +The voice's volume. .. _class_AudioEffectChorus_voice/2/pan: -- :ref:`float` **voice/2/pan** - The voice's pan level. +- :ref:`float` **voice/2/pan** + ++----------+----------------------+ +| *Setter* | set_voice_pan(value) | ++----------+----------------------+ +| *Getter* | get_voice_pan() | ++----------+----------------------+ + +The voice's pan level. .. _class_AudioEffectChorus_voice/2/rate_hz: -- :ref:`float` **voice/2/rate_hz** - The voice's filter rate. +- :ref:`float` **voice/2/rate_hz** + ++----------+--------------------------+ +| *Setter* | set_voice_rate_hz(value) | ++----------+--------------------------+ +| *Getter* | get_voice_rate_hz() | ++----------+--------------------------+ + +The voice's filter rate. .. _class_AudioEffectChorus_voice/3/cutoff_hz: -- :ref:`float` **voice/3/cutoff_hz** - The voice's cutoff frequency. +- :ref:`float` **voice/3/cutoff_hz** + ++----------+----------------------------+ +| *Setter* | set_voice_cutoff_hz(value) | ++----------+----------------------------+ +| *Getter* | get_voice_cutoff_hz() | ++----------+----------------------------+ + +The voice's cutoff frequency. .. _class_AudioEffectChorus_voice/3/delay_ms: -- :ref:`float` **voice/3/delay_ms** - The voice's signal delay. +- :ref:`float` **voice/3/delay_ms** + ++----------+---------------------------+ +| *Setter* | set_voice_delay_ms(value) | ++----------+---------------------------+ +| *Getter* | get_voice_delay_ms() | ++----------+---------------------------+ + +The voice's signal delay. .. _class_AudioEffectChorus_voice/3/depth_ms: -- :ref:`float` **voice/3/depth_ms** - The voice filter's depth. +- :ref:`float` **voice/3/depth_ms** + ++----------+---------------------------+ +| *Setter* | set_voice_depth_ms(value) | ++----------+---------------------------+ +| *Getter* | get_voice_depth_ms() | ++----------+---------------------------+ + +The voice filter's depth. .. _class_AudioEffectChorus_voice/3/level_db: -- :ref:`float` **voice/3/level_db** - The voice's volume. +- :ref:`float` **voice/3/level_db** + ++----------+---------------------------+ +| *Setter* | set_voice_level_db(value) | ++----------+---------------------------+ +| *Getter* | get_voice_level_db() | ++----------+---------------------------+ + +The voice's volume. .. _class_AudioEffectChorus_voice/3/pan: -- :ref:`float` **voice/3/pan** - The voice's pan level. +- :ref:`float` **voice/3/pan** + ++----------+----------------------+ +| *Setter* | set_voice_pan(value) | ++----------+----------------------+ +| *Getter* | get_voice_pan() | ++----------+----------------------+ + +The voice's pan level. .. _class_AudioEffectChorus_voice/3/rate_hz: -- :ref:`float` **voice/3/rate_hz** - The voice's filter rate. +- :ref:`float` **voice/3/rate_hz** + ++----------+--------------------------+ +| *Setter* | set_voice_rate_hz(value) | ++----------+--------------------------+ +| *Getter* | get_voice_rate_hz() | ++----------+--------------------------+ + +The voice's filter rate. .. _class_AudioEffectChorus_voice/4/cutoff_hz: -- :ref:`float` **voice/4/cutoff_hz** - The voice's cutoff frequency. +- :ref:`float` **voice/4/cutoff_hz** + ++----------+----------------------------+ +| *Setter* | set_voice_cutoff_hz(value) | ++----------+----------------------------+ +| *Getter* | get_voice_cutoff_hz() | ++----------+----------------------------+ + +The voice's cutoff frequency. .. _class_AudioEffectChorus_voice/4/delay_ms: -- :ref:`float` **voice/4/delay_ms** - The voice's signal delay. +- :ref:`float` **voice/4/delay_ms** + ++----------+---------------------------+ +| *Setter* | set_voice_delay_ms(value) | ++----------+---------------------------+ +| *Getter* | get_voice_delay_ms() | ++----------+---------------------------+ + +The voice's signal delay. .. _class_AudioEffectChorus_voice/4/depth_ms: -- :ref:`float` **voice/4/depth_ms** - The voice filter's depth. +- :ref:`float` **voice/4/depth_ms** + ++----------+---------------------------+ +| *Setter* | set_voice_depth_ms(value) | ++----------+---------------------------+ +| *Getter* | get_voice_depth_ms() | ++----------+---------------------------+ + +The voice filter's depth. .. _class_AudioEffectChorus_voice/4/level_db: -- :ref:`float` **voice/4/level_db** - The voice's volume. +- :ref:`float` **voice/4/level_db** + ++----------+---------------------------+ +| *Setter* | set_voice_level_db(value) | ++----------+---------------------------+ +| *Getter* | get_voice_level_db() | ++----------+---------------------------+ + +The voice's volume. .. _class_AudioEffectChorus_voice/4/pan: -- :ref:`float` **voice/4/pan** - The voice's pan level. +- :ref:`float` **voice/4/pan** + ++----------+----------------------+ +| *Setter* | set_voice_pan(value) | ++----------+----------------------+ +| *Getter* | get_voice_pan() | ++----------+----------------------+ + +The voice's pan level. .. _class_AudioEffectChorus_voice/4/rate_hz: -- :ref:`float` **voice/4/rate_hz** - The voice's filter rate. +- :ref:`float` **voice/4/rate_hz** + ++----------+--------------------------+ +| *Setter* | set_voice_rate_hz(value) | ++----------+--------------------------+ +| *Getter* | get_voice_rate_hz() | ++----------+--------------------------+ + +The voice's filter rate. .. _class_AudioEffectChorus_voice_count: -- :ref:`int` **voice_count** - The amount of voices in the effect. +- :ref:`int` **voice_count** + ++----------+------------------------+ +| *Setter* | set_voice_count(value) | ++----------+------------------------+ +| *Getter* | get_voice_count() | ++----------+------------------------+ + +The amount of voices in the effect. .. _class_AudioEffectChorus_wet: -- :ref:`float` **wet** - The effect's processed signal. +- :ref:`float` **wet** ++----------+----------------+ +| *Setter* | set_wet(value) | ++----------+----------------+ +| *Getter* | get_wet() | ++----------+----------------+ + +The effect's processed signal. diff --git a/classes/class_audioeffectcompressor.rst b/classes/class_audioeffectcompressor.rst index 857dd505b..993e201ac 100644 --- a/classes/class_audioeffectcompressor.rst +++ b/classes/class_audioeffectcompressor.rst @@ -8,6 +8,7 @@ AudioEffectCompressor ===================== **Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -17,6 +18,25 @@ Adds a Compressor audio effect to an Audio bus. Reduces sounds that exceed a certain threshold level, smooths out the dynamics and increases the overall volume. +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` | ++-----------------------------+-----------------------------------------------------------+ + Description ----------- @@ -37,30 +57,85 @@ Property Descriptions .. _class_AudioEffectCompressor_attack_us: -- :ref:`float` **attack_us** - Compressor's reaction time when the signal exceeds the threshold. Value can range from 20 to 2000. Default value: ``20ms``. +- :ref:`float` **attack_us** + ++----------+----------------------+ +| *Setter* | set_attack_us(value) | ++----------+----------------------+ +| *Getter* | get_attack_us() | ++----------+----------------------+ + +Compressor's reaction time when the signal exceeds the threshold. Value can range from 20 to 2000. Default value: ``20ms``. .. _class_AudioEffectCompressor_gain: -- :ref:`float` **gain** - Gain applied to the output signal. +- :ref:`float` **gain** + ++----------+-----------------+ +| *Setter* | set_gain(value) | ++----------+-----------------+ +| *Getter* | get_gain() | ++----------+-----------------+ + +Gain applied to the output signal. .. _class_AudioEffectCompressor_mix: -- :ref:`float` **mix** - Balance between original signal and effect signal. Value can range from 0 (totally dry) to 1 (totally wet). Default value: ``1``. +- :ref:`float` **mix** + ++----------+----------------+ +| *Setter* | set_mix(value) | ++----------+----------------+ +| *Getter* | get_mix() | ++----------+----------------+ + +Balance between original signal and effect signal. Value can range from 0 (totally dry) to 1 (totally wet). Default value: ``1``. .. _class_AudioEffectCompressor_ratio: -- :ref:`float` **ratio** - 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``. +- :ref:`float` **ratio** + ++----------+------------------+ +| *Setter* | set_ratio(value) | ++----------+------------------+ +| *Getter* | get_ratio() | ++----------+------------------+ + +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: -- :ref:`float` **release_ms** - 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``. +- :ref:`float` **release_ms** + ++----------+-----------------------+ +| *Setter* | set_release_ms(value) | ++----------+-----------------------+ +| *Getter* | get_release_ms() | ++----------+-----------------------+ + +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: -- :ref:`String` **sidechain** - Reduce the sound level using another audio bus for threshold detection. +- :ref:`String` **sidechain** + ++----------+----------------------+ +| *Setter* | set_sidechain(value) | ++----------+----------------------+ +| *Getter* | get_sidechain() | ++----------+----------------------+ + +Reduce the sound level using another audio bus for threshold detection. .. _class_AudioEffectCompressor_threshold: -- :ref:`float` **threshold** - The level above which compression is applied to the audio. Value can range from -60 to 0. Default value: ``0``. +- :ref:`float` **threshold** ++----------+----------------------+ +| *Setter* | set_threshold(value) | ++----------+----------------------+ +| *Getter* | get_threshold() | ++----------+----------------------+ + +The level above which compression is applied to the audio. Value can range from -60 to 0. Default value: ``0``. diff --git a/classes/class_audioeffectdelay.rst b/classes/class_audioeffectdelay.rst index b41c66fd2..a0785befb 100644 --- a/classes/class_audioeffectdelay.rst +++ b/classes/class_audioeffectdelay.rst @@ -8,6 +8,7 @@ AudioEffectDelay ================ **Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -17,6 +18,37 @@ Adds a Delay audio effect to an Audio bus. Plays input signal back after a perio 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` | ++---------------------------+--------------------------------------------------------------------+ + Description ----------- @@ -27,54 +59,157 @@ Property Descriptions .. _class_AudioEffectDelay_dry: -- :ref:`float` **dry** - Output percent of original sound. At 0, only delayed sounds are output. Value can range from 0 to 1. Default value: ``1``. +- :ref:`float` **dry** + ++----------+----------------+ +| *Setter* | set_dry(value) | ++----------+----------------+ +| *Getter* | get_dry() | ++----------+----------------+ + +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: -- :ref:`bool` **feedback/active** - If ``true`` feedback is enabled. Default value: ``false``. +- :ref:`bool` **feedback/active** + ++----------+----------------------------+ +| *Setter* | set_feedback_active(value) | ++----------+----------------------------+ +| *Getter* | is_feedback_active() | ++----------+----------------------------+ + +If ``true`` feedback is enabled. Default value: ``false``. .. _class_AudioEffectDelay_feedback/delay_ms: -- :ref:`float` **feedback/delay_ms** - Feedback delay time in milliseconds. Default value: ``340``. +- :ref:`float` **feedback/delay_ms** + ++----------+------------------------------+ +| *Setter* | set_feedback_delay_ms(value) | ++----------+------------------------------+ +| *Getter* | get_feedback_delay_ms() | ++----------+------------------------------+ + +Feedback delay time in milliseconds. Default value: ``340``. .. _class_AudioEffectDelay_feedback/level_db: -- :ref:`float` **feedback/level_db** - Sound level for ``tap1``. Default value: ``-6 dB``. +- :ref:`float` **feedback/level_db** + ++----------+------------------------------+ +| *Setter* | set_feedback_level_db(value) | ++----------+------------------------------+ +| *Getter* | get_feedback_level_db() | ++----------+------------------------------+ + +Sound level for ``tap1``. Default value: ``-6 dB``. .. _class_AudioEffectDelay_feedback/lowpass: -- :ref:`float` **feedback/lowpass** - Low-pass filter for feedback. Frequencies below the Low Cut value are filtered out of the source signal. Default value: ``16000``. +- :ref:`float` **feedback/lowpass** + ++----------+-----------------------------+ +| *Setter* | set_feedback_lowpass(value) | ++----------+-----------------------------+ +| *Getter* | get_feedback_lowpass() | ++----------+-----------------------------+ + +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: -- :ref:`bool` **tap1/active** - If ``true``, ``tap1`` will be enabled. Default value: ``true``. +- :ref:`bool` **tap1/active** + ++----------+------------------------+ +| *Setter* | set_tap1_active(value) | ++----------+------------------------+ +| *Getter* | is_tap1_active() | ++----------+------------------------+ + +If ``true``, ``tap1`` will be enabled. Default value: ``true``. .. _class_AudioEffectDelay_tap1/delay_ms: -- :ref:`float` **tap1/delay_ms** - **Tap1** delay time in milliseconds. Default value: ``250ms``. +- :ref:`float` **tap1/delay_ms** + ++----------+--------------------------+ +| *Setter* | set_tap1_delay_ms(value) | ++----------+--------------------------+ +| *Getter* | get_tap1_delay_ms() | ++----------+--------------------------+ + +**Tap1** delay time in milliseconds. Default value: ``250ms``. .. _class_AudioEffectDelay_tap1/level_db: -- :ref:`float` **tap1/level_db** - Sound level for ``tap1``. Default value: ``-6 dB``. +- :ref:`float` **tap1/level_db** + ++----------+--------------------------+ +| *Setter* | set_tap1_level_db(value) | ++----------+--------------------------+ +| *Getter* | get_tap1_level_db() | ++----------+--------------------------+ + +Sound level for ``tap1``. Default value: ``-6 dB``. .. _class_AudioEffectDelay_tap1/pan: -- :ref:`float` **tap1/pan** - Pan position for ``tap1``. Value can range from -1 (fully left) to 1 (fully right). Default value: ``0.2``. +- :ref:`float` **tap1/pan** + ++----------+---------------------+ +| *Setter* | set_tap1_pan(value) | ++----------+---------------------+ +| *Getter* | get_tap1_pan() | ++----------+---------------------+ + +Pan position for ``tap1``. Value can range from -1 (fully left) to 1 (fully right). Default value: ``0.2``. .. _class_AudioEffectDelay_tap2/active: -- :ref:`bool` **tap2/active** - If ``true``, ``tap2`` will be enabled. Default value: ``true``. +- :ref:`bool` **tap2/active** + ++----------+------------------------+ +| *Setter* | set_tap2_active(value) | ++----------+------------------------+ +| *Getter* | is_tap2_active() | ++----------+------------------------+ + +If ``true``, ``tap2`` will be enabled. Default value: ``true``. .. _class_AudioEffectDelay_tap2/delay_ms: -- :ref:`float` **tap2/delay_ms** - **Tap2** delay time in milliseconds. Default value: ``500ms``. +- :ref:`float` **tap2/delay_ms** + ++----------+--------------------------+ +| *Setter* | set_tap2_delay_ms(value) | ++----------+--------------------------+ +| *Getter* | get_tap2_delay_ms() | ++----------+--------------------------+ + +**Tap2** delay time in milliseconds. Default value: ``500ms``. .. _class_AudioEffectDelay_tap2/level_db: -- :ref:`float` **tap2/level_db** - Sound level for ``tap2``. Default value: ``-12 dB``. +- :ref:`float` **tap2/level_db** + ++----------+--------------------------+ +| *Setter* | set_tap2_level_db(value) | ++----------+--------------------------+ +| *Getter* | get_tap2_level_db() | ++----------+--------------------------+ + +Sound level for ``tap2``. Default value: ``-12 dB``. .. _class_AudioEffectDelay_tap2/pan: -- :ref:`float` **tap2/pan** - Pan position for ``tap2``. Value can range from -1 (fully left) to 1 (fully right). Default value: ``-0.4``. +- :ref:`float` **tap2/pan** ++----------+---------------------+ +| *Setter* | set_tap2_pan(value) | ++----------+---------------------+ +| *Getter* | get_tap2_pan() | ++----------+---------------------+ + +Pan position for ``tap2``. Value can range from -1 (fully left) to 1 (fully right). Default value: ``-0.4``. diff --git a/classes/class_audioeffectdistortion.rst b/classes/class_audioeffectdistortion.rst index a104a1545..4142f71c0 100644 --- a/classes/class_audioeffectdistortion.rst +++ b/classes/class_audioeffectdistortion.rst @@ -8,6 +8,7 @@ AudioEffectDistortion ===================== **Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -17,12 +18,27 @@ Adds a Distortion audio effect to an Audio bus. 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` | ++----------------------------------------------+-----------------------------------------------------------+ + Enumerations ------------ .. _enum_AudioEffectDistortion_Mode: -enum **Mode** +enum **Mode**: - **MODE_CLIP** = **0** --- Digital distortion effect which cuts off peaks at the top and bottom of the waveform. - **MODE_ATAN** = **1** @@ -30,7 +46,6 @@ enum **Mode** - **MODE_OVERDRIVE** = **3** --- Emulates the warm distortion produced by a field effect transistor, which is commonly used in solid-state musical instrument amplifiers. - **MODE_WAVESHAPE** = **4** --- Waveshaper distortions are used mainly by electronic musicians to achieve an extra-abrasive sound. - Description ----------- @@ -43,22 +58,61 @@ Property Descriptions .. _class_AudioEffectDistortion_drive: -- :ref:`float` **drive** - Distortion power. Value can range from 0 to 1. Default value: ``0``. +- :ref:`float` **drive** + ++----------+------------------+ +| *Setter* | set_drive(value) | ++----------+------------------+ +| *Getter* | get_drive() | ++----------+------------------+ + +Distortion power. Value can range from 0 to 1. Default value: ``0``. .. _class_AudioEffectDistortion_keep_hf_hz: -- :ref:`float` **keep_hf_hz** - 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``. +- :ref:`float` **keep_hf_hz** + ++----------+-----------------------+ +| *Setter* | set_keep_hf_hz(value) | ++----------+-----------------------+ +| *Getter* | get_keep_hf_hz() | ++----------+-----------------------+ + +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: -- :ref:`Mode` **mode** - Distortion type. Default value: ``MODE_CLIP``. +- :ref:`Mode` **mode** + ++----------+-----------------+ +| *Setter* | set_mode(value) | ++----------+-----------------+ +| *Getter* | get_mode() | ++----------+-----------------+ + +Distortion type. Default value: ``MODE_CLIP``. .. _class_AudioEffectDistortion_post_gain: -- :ref:`float` **post_gain** - Increases or decreases the volume after the effect. Value can range from -80 to 24. Default value: ``0``. +- :ref:`float` **post_gain** + ++----------+----------------------+ +| *Setter* | set_post_gain(value) | ++----------+----------------------+ +| *Getter* | get_post_gain() | ++----------+----------------------+ + +Increases or decreases the volume after the effect. Value can range from -80 to 24. Default value: ``0``. .. _class_AudioEffectDistortion_pre_gain: -- :ref:`float` **pre_gain** - Increases or decreases the volume before the effect. Value can range from -60 to 60. Default value: ``0``. +- :ref:`float` **pre_gain** ++----------+---------------------+ +| *Setter* | set_pre_gain(value) | ++----------+---------------------+ +| *Getter* | get_pre_gain() | ++----------+---------------------+ + +Increases or decreases the volume before the effect. Value can range from -60 to 60. Default value: ``0``. diff --git a/classes/class_audioeffecteq.rst b/classes/class_audioeffecteq.rst index 049a28f5d..54b53b7e7 100644 --- a/classes/class_audioeffecteq.rst +++ b/classes/class_audioeffecteq.rst @@ -8,7 +8,9 @@ AudioEffectEQ ============= **Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`AudioEffectEQ6`, :ref:`AudioEffectEQ21`, :ref:`AudioEffectEQ10` + **Category:** Core Brief Description @@ -37,22 +39,21 @@ AudioEffectEQ gives you control over frequencies. Use it to compensate for exist Method Descriptions ------------------- -.. _class_AudioEffectEQ_get_band_count: + .. _class_AudioEffectEQ_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_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_set_band_gain_db: - void **set_band_gain_db** **(** :ref:`int` band_idx, :ref:`float` volume_db **)** Sets band's gain at the specified index, in dB. - diff --git a/classes/class_audioeffecteq10.rst b/classes/class_audioeffecteq10.rst index bb5480f42..27862cd14 100644 --- a/classes/class_audioeffecteq10.rst +++ b/classes/class_audioeffecteq10.rst @@ -8,6 +8,7 @@ AudioEffectEQ10 =============== **Inherits:** :ref:`AudioEffectEQ` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_audioeffecteq21.rst b/classes/class_audioeffecteq21.rst index 81ef1b6a3..073f494bc 100644 --- a/classes/class_audioeffecteq21.rst +++ b/classes/class_audioeffecteq21.rst @@ -8,6 +8,7 @@ AudioEffectEQ21 =============== **Inherits:** :ref:`AudioEffectEQ` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_audioeffecteq6.rst b/classes/class_audioeffecteq6.rst index 7807f0040..9796b0128 100644 --- a/classes/class_audioeffecteq6.rst +++ b/classes/class_audioeffecteq6.rst @@ -8,6 +8,7 @@ AudioEffectEQ6 ============== **Inherits:** :ref:`AudioEffectEQ` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_audioeffectfilter.rst b/classes/class_audioeffectfilter.rst index 4a83e2b4b..a369a7115 100644 --- a/classes/class_audioeffectfilter.rst +++ b/classes/class_audioeffectfilter.rst @@ -8,7 +8,9 @@ AudioEffectFilter ================= **Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`AudioEffectHighPassFilter`, :ref:`AudioEffectBandLimitFilter`, :ref:`AudioEffectLowShelfFilter`, :ref:`AudioEffectHighShelfFilter`, :ref:`AudioEffectBandPassFilter`, :ref:`AudioEffectNotchFilter`, :ref:`AudioEffectLowPassFilter` + **Category:** Core Brief Description @@ -16,19 +18,31 @@ Brief Description 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` | ++--------------------------------------------------+-----------------------------------------------------+ + Enumerations ------------ .. _enum_AudioEffectFilter_FilterDB: -enum **FilterDB** +enum **FilterDB**: - **FILTER_6DB** = **0** - **FILTER_12DB** = **1** - **FILTER_18DB** = **2** - **FILTER_24DB** = **3** - Description ----------- @@ -39,18 +53,47 @@ Property Descriptions .. _class_AudioEffectFilter_cutoff_hz: -- :ref:`float` **cutoff_hz** - Threshold frequency for the filter. +- :ref:`float` **cutoff_hz** + ++----------+-------------------+ +| *Setter* | set_cutoff(value) | ++----------+-------------------+ +| *Getter* | get_cutoff() | ++----------+-------------------+ + +Threshold frequency for the filter. .. _class_AudioEffectFilter_db: - :ref:`FilterDB` **db** ++----------+---------------+ +| *Setter* | set_db(value) | ++----------+---------------+ +| *Getter* | get_db() | ++----------+---------------+ + .. _class_AudioEffectFilter_gain: -- :ref:`float` **gain** - Gain amount of the frequencies after the filter. +- :ref:`float` **gain** + ++----------+-----------------+ +| *Setter* | set_gain(value) | ++----------+-----------------+ +| *Getter* | get_gain() | ++----------+-----------------+ + +Gain amount of the frequencies after the filter. .. _class_AudioEffectFilter_resonance: -- :ref:`float` **resonance** - Amount of boost in the overtones near the cutoff frequency. +- :ref:`float` **resonance** ++----------+----------------------+ +| *Setter* | set_resonance(value) | ++----------+----------------------+ +| *Getter* | get_resonance() | ++----------+----------------------+ + +Amount of boost in the overtones near the cutoff frequency. diff --git a/classes/class_audioeffecthighpassfilter.rst b/classes/class_audioeffecthighpassfilter.rst index 65396c2b8..86bd34403 100644 --- a/classes/class_audioeffecthighpassfilter.rst +++ b/classes/class_audioeffecthighpassfilter.rst @@ -8,6 +8,7 @@ AudioEffectHighPassFilter ========================= **Inherits:** :ref:`AudioEffectFilter` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_audioeffecthighshelffilter.rst b/classes/class_audioeffecthighshelffilter.rst index 8b2b73102..c2ce40212 100644 --- a/classes/class_audioeffecthighshelffilter.rst +++ b/classes/class_audioeffecthighshelffilter.rst @@ -8,6 +8,7 @@ AudioEffectHighShelfFilter ========================== **Inherits:** :ref:`AudioEffectFilter` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_audioeffectlimiter.rst b/classes/class_audioeffectlimiter.rst index 5e7fd4887..70efb5f8a 100644 --- a/classes/class_audioeffectlimiter.rst +++ b/classes/class_audioeffectlimiter.rst @@ -8,6 +8,7 @@ AudioEffectLimiter ================== **Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,19 @@ Brief Description 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` | ++---------------------------+------------------------------------------------------------------+ + Description ----------- @@ -27,18 +41,47 @@ Property Descriptions .. _class_AudioEffectLimiter_ceiling_db: -- :ref:`float` **ceiling_db** - The waveform's maximum allowed value. Value can range from -20 to -0.1. Default value: ``-0.1dB``. +- :ref:`float` **ceiling_db** + ++----------+-----------------------+ +| *Setter* | set_ceiling_db(value) | ++----------+-----------------------+ +| *Getter* | get_ceiling_db() | ++----------+-----------------------+ + +The waveform's maximum allowed value. Value can range from -20 to -0.1. Default value: ``-0.1dB``. .. _class_AudioEffectLimiter_soft_clip_db: -- :ref:`float` **soft_clip_db** - Applies a gain to the limited waves. Value can range from 0 to 6. Default value: ``2dB``. +- :ref:`float` **soft_clip_db** + ++----------+-------------------------+ +| *Setter* | set_soft_clip_db(value) | ++----------+-------------------------+ +| *Getter* | get_soft_clip_db() | ++----------+-------------------------+ + +Applies a gain to the limited waves. Value can range from 0 to 6. Default value: ``2dB``. .. _class_AudioEffectLimiter_soft_clip_ratio: - :ref:`float` **soft_clip_ratio** ++----------+----------------------------+ +| *Setter* | set_soft_clip_ratio(value) | ++----------+----------------------------+ +| *Getter* | get_soft_clip_ratio() | ++----------+----------------------------+ + .. _class_AudioEffectLimiter_threshold_db: -- :ref:`float` **threshold_db** - Threshold from which the limiter begins to be active. Value can range from -30 to 0. Default value: ``0dB``. +- :ref:`float` **threshold_db** ++----------+-------------------------+ +| *Setter* | set_threshold_db(value) | ++----------+-------------------------+ +| *Getter* | get_threshold_db() | ++----------+-------------------------+ + +Threshold from which the limiter begins to be active. Value can range from -30 to 0. Default value: ``0dB``. diff --git a/classes/class_audioeffectlowpassfilter.rst b/classes/class_audioeffectlowpassfilter.rst index b38645e18..5c194d14d 100644 --- a/classes/class_audioeffectlowpassfilter.rst +++ b/classes/class_audioeffectlowpassfilter.rst @@ -8,6 +8,7 @@ AudioEffectLowPassFilter ======================== **Inherits:** :ref:`AudioEffectFilter` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_audioeffectlowshelffilter.rst b/classes/class_audioeffectlowshelffilter.rst index 3e6b41238..159920c71 100644 --- a/classes/class_audioeffectlowshelffilter.rst +++ b/classes/class_audioeffectlowshelffilter.rst @@ -8,6 +8,7 @@ AudioEffectLowShelfFilter ========================= **Inherits:** :ref:`AudioEffectFilter` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_audioeffectnotchfilter.rst b/classes/class_audioeffectnotchfilter.rst index 187f8786f..058f00474 100644 --- a/classes/class_audioeffectnotchfilter.rst +++ b/classes/class_audioeffectnotchfilter.rst @@ -8,6 +8,7 @@ AudioEffectNotchFilter ====================== **Inherits:** :ref:`AudioEffectFilter` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_audioeffectpanner.rst b/classes/class_audioeffectpanner.rst index ef055238c..d3453af7b 100644 --- a/classes/class_audioeffectpanner.rst +++ b/classes/class_audioeffectpanner.rst @@ -8,6 +8,7 @@ AudioEffectPanner ================= **Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Adds a Panner audio effect to an Audio bus. Pans sound left or right. +Properties +---------- + ++---------------------------+-----------------------------------------+ +| :ref:`float` | :ref:`pan` | ++---------------------------+-----------------------------------------+ + Description ----------- @@ -25,6 +33,13 @@ Property Descriptions .. _class_AudioEffectPanner_pan: -- :ref:`float` **pan** - Pan position. Value can range from -1 (fully left) to 1 (fully right). +- :ref:`float` **pan** ++----------+----------------+ +| *Setter* | set_pan(value) | ++----------+----------------+ +| *Getter* | get_pan() | ++----------+----------------+ + +Pan position. Value can range from -1 (fully left) to 1 (fully right). diff --git a/classes/class_audioeffectphaser.rst b/classes/class_audioeffectphaser.rst index a8dc16411..6e2828d13 100644 --- a/classes/class_audioeffectphaser.rst +++ b/classes/class_audioeffectphaser.rst @@ -8,6 +8,7 @@ AudioEffectPhaser ================= **Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -17,6 +18,21 @@ Adds a Phaser audio effect to an Audio bus. Combines the original signal with a copy that is slightly out of phase with the original. +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` | ++---------------------------+-----------------------------------------------------------+ + Description ----------- @@ -27,22 +43,61 @@ Property Descriptions .. _class_AudioEffectPhaser_depth: -- :ref:`float` **depth** - 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``. +- :ref:`float` **depth** + ++----------+------------------+ +| *Setter* | set_depth(value) | ++----------+------------------+ +| *Getter* | get_depth() | ++----------+------------------+ + +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: -- :ref:`float` **feedback** - Output percent of modified sound. Value can range from 0.1 to 0.9. Default value: ``0.7``. +- :ref:`float` **feedback** + ++----------+---------------------+ +| *Setter* | set_feedback(value) | ++----------+---------------------+ +| *Getter* | get_feedback() | ++----------+---------------------+ + +Output percent of modified sound. Value can range from 0.1 to 0.9. Default value: ``0.7``. .. _class_AudioEffectPhaser_range_max_hz: -- :ref:`float` **range_max_hz** - Determines the maximum frequency affected by the LFO modulations. Value can range from 10 to 10000. Default value: ``1600hz``. +- :ref:`float` **range_max_hz** + ++----------+-------------------------+ +| *Setter* | set_range_max_hz(value) | ++----------+-------------------------+ +| *Getter* | get_range_max_hz() | ++----------+-------------------------+ + +Determines the maximum frequency affected by the LFO modulations. Value can range from 10 to 10000. Default value: ``1600hz``. .. _class_AudioEffectPhaser_range_min_hz: -- :ref:`float` **range_min_hz** - Determines the minimum frequency affected by the LFO modulations. Value can range from 10 to 10000. Default value: ``440hz``. +- :ref:`float` **range_min_hz** + ++----------+-------------------------+ +| *Setter* | set_range_min_hz(value) | ++----------+-------------------------+ +| *Getter* | get_range_min_hz() | ++----------+-------------------------+ + +Determines the minimum frequency affected by the LFO modulations. Value can range from 10 to 10000. Default value: ``440hz``. .. _class_AudioEffectPhaser_rate_hz: -- :ref:`float` **rate_hz** - Adjusts the rate at which the effect sweeps up and down across the frequency range. +- :ref:`float` **rate_hz** ++----------+--------------------+ +| *Setter* | set_rate_hz(value) | ++----------+--------------------+ +| *Getter* | get_rate_hz() | ++----------+--------------------+ + +Adjusts the rate at which the effect sweeps up and down across the frequency range. diff --git a/classes/class_audioeffectpitchshift.rst b/classes/class_audioeffectpitchshift.rst index 89276e7a8..0ada89dd8 100644 --- a/classes/class_audioeffectpitchshift.rst +++ b/classes/class_audioeffectpitchshift.rst @@ -8,6 +8,7 @@ AudioEffectPitchShift ===================== **Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -17,6 +18,13 @@ Adds a Pitch shift audio effect to an Audio bus. Raises or lowers the pitch of original sound. +Properties +---------- + ++---------------------------+-------------------------------------------------------------+ +| :ref:`float` | :ref:`pitch_scale` | ++---------------------------+-------------------------------------------------------------+ + Description ----------- @@ -27,6 +35,13 @@ Property Descriptions .. _class_AudioEffectPitchShift_pitch_scale: -- :ref:`float` **pitch_scale** - Pitch value. Can range from 0 (-1 octave) to 16 (+16 octaves). +- :ref:`float` **pitch_scale** ++----------+------------------------+ +| *Setter* | set_pitch_scale(value) | ++----------+------------------------+ +| *Getter* | get_pitch_scale() | ++----------+------------------------+ + +Pitch value. Can range from 0 (-1 octave) to 16 (+16 octaves). diff --git a/classes/class_audioeffectrecord.rst b/classes/class_audioeffectrecord.rst index ecfa63caf..ea19c9d53 100644 --- a/classes/class_audioeffectrecord.rst +++ b/classes/class_audioeffectrecord.rst @@ -8,6 +8,7 @@ AudioEffectRecord ================= **Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description +Properties +---------- + ++----------------------------------------------+-----------------------------------------------+ +| :ref:`Format` | :ref:`format` | ++----------------------------------------------+-----------------------------------------------+ + Methods ------- @@ -33,20 +41,24 @@ Property Descriptions - :ref:`Format` **format** ++----------+-------------------+ +| *Setter* | set_format(value) | ++----------+-------------------+ +| *Getter* | get_format() | ++----------+-------------------+ Method Descriptions ------------------- -.. _class_AudioEffectRecord_get_recording: + .. _class_AudioEffectRecord_get_recording: - :ref:`AudioStreamSample` **get_recording** **(** **)** const -.. _class_AudioEffectRecord_is_recording_active: + .. _class_AudioEffectRecord_is_recording_active: - :ref:`bool` **is_recording_active** **(** **)** const -.. _class_AudioEffectRecord_set_recording_active: + .. _class_AudioEffectRecord_set_recording_active: - void **set_recording_active** **(** :ref:`bool` record **)** - diff --git a/classes/class_audioeffectreverb.rst b/classes/class_audioeffectreverb.rst index a0682c7e4..5fbae5c59 100644 --- a/classes/class_audioeffectreverb.rst +++ b/classes/class_audioeffectreverb.rst @@ -8,6 +8,7 @@ AudioEffectReverb ================= **Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -17,6 +18,27 @@ Adds a Reverb audio effect to an Audio bus. Simulates the sound of acoustic environments such as rooms, concert halls, caverns, or an open spaces. +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` | ++---------------------------+---------------------------------------------------------------------+ + Description ----------- @@ -27,34 +49,97 @@ Property Descriptions .. _class_AudioEffectReverb_damping: -- :ref:`float` **damping** - Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Value can range from 0 to 1. Default value: ``1``. +- :ref:`float` **damping** + ++----------+--------------------+ +| *Setter* | set_damping(value) | ++----------+--------------------+ +| *Getter* | get_damping() | ++----------+--------------------+ + +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_dry: -- :ref:`float` **dry** - Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1. Default value: ``1``. +- :ref:`float` **dry** + ++----------+----------------+ +| *Setter* | set_dry(value) | ++----------+----------------+ +| *Getter* | get_dry() | ++----------+----------------+ + +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: -- :ref:`float` **hipass** - 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``. +- :ref:`float` **hipass** + ++----------+----------------+ +| *Setter* | set_hpf(value) | ++----------+----------------+ +| *Getter* | get_hpf() | ++----------+----------------+ + +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: -- :ref:`float` **predelay_feedback** - Output percent of predelay. Value can range from 0 to 1. Default value: ``1``. +- :ref:`float` **predelay_feedback** + ++----------+--------------------------+ +| *Setter* | set_predelay_msec(value) | ++----------+--------------------------+ +| *Getter* | get_predelay_msec() | ++----------+--------------------------+ + +Output percent of predelay. Value can range from 0 to 1. Default value: ``1``. .. _class_AudioEffectReverb_predelay_msec: -- :ref:`float` **predelay_msec** - Time between the original signal and the early reflections of the reverb signal. Default value: ``150ms``. +- :ref:`float` **predelay_msec** + ++----------+--------------------------+ +| *Setter* | set_predelay_msec(value) | ++----------+--------------------------+ +| *Getter* | get_predelay_msec() | ++----------+--------------------------+ + +Time between the original signal and the early reflections of the reverb signal. Default value: ``150ms``. .. _class_AudioEffectReverb_room_size: -- :ref:`float` **room_size** - Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1. Default value: ``0.8``. +- :ref:`float` **room_size** + ++----------+----------------------+ +| *Setter* | set_room_size(value) | ++----------+----------------------+ +| *Getter* | get_room_size() | ++----------+----------------------+ + +Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1. Default value: ``0.8``. .. _class_AudioEffectReverb_spread: -- :ref:`float` **spread** - Defines how reflective the imaginary room's walls are. Value can range from 0 to 1. Default value: ``1``. +- :ref:`float` **spread** + ++----------+-------------------+ +| *Setter* | set_spread(value) | ++----------+-------------------+ +| *Getter* | get_spread() | ++----------+-------------------+ + +Defines how reflective the imaginary room's walls are. Value can range from 0 to 1. Default value: ``1``. .. _class_AudioEffectReverb_wet: -- :ref:`float` **wet** - Output percent of modified sound. At 0, only original sound is outputted. Value can range from 0 to 1. Default value: ``0.5``. +- :ref:`float` **wet** ++----------+----------------+ +| *Setter* | set_wet(value) | ++----------+----------------+ +| *Getter* | get_wet() | ++----------+----------------+ + +Output percent of modified sound. At 0, only original sound is outputted. Value can range from 0 to 1. Default value: ``0.5``. diff --git a/classes/class_audioeffectstereoenhance.rst b/classes/class_audioeffectstereoenhance.rst index 79bde4583..0c9442799 100644 --- a/classes/class_audioeffectstereoenhance.rst +++ b/classes/class_audioeffectstereoenhance.rst @@ -8,6 +8,7 @@ AudioEffectStereoEnhance ======================== **Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,17 @@ Brief Description +Properties +---------- + ++---------------------------+------------------------------------------------------------------------+ +| :ref:`float` | :ref:`pan_pullout` | ++---------------------------+------------------------------------------------------------------------+ +| :ref:`float` | :ref:`surround` | ++---------------------------+------------------------------------------------------------------------+ +| :ref:`float` | :ref:`time_pullout_ms` | ++---------------------------+------------------------------------------------------------------------+ + Property Descriptions --------------------- @@ -22,12 +34,29 @@ Property Descriptions - :ref:`float` **pan_pullout** ++----------+------------------------+ +| *Setter* | set_pan_pullout(value) | ++----------+------------------------+ +| *Getter* | get_pan_pullout() | ++----------+------------------------+ + .. _class_AudioEffectStereoEnhance_surround: - :ref:`float` **surround** ++----------+---------------------+ +| *Setter* | set_surround(value) | ++----------+---------------------+ +| *Getter* | get_surround() | ++----------+---------------------+ + .. _class_AudioEffectStereoEnhance_time_pullout_ms: - :ref:`float` **time_pullout_ms** ++----------+-------------------------+ +| *Setter* | set_time_pullout(value) | ++----------+-------------------------+ +| *Getter* | get_time_pullout() | ++----------+-------------------------+ diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index d6b1c7c68..7a54794d1 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -8,6 +8,7 @@ AudioServer =========== **Inherits:** :ref:`Object` + **Category:** Core Brief Description @@ -101,25 +102,23 @@ Methods Signals ------- -.. _class_AudioServer_bus_layout_changed: + .. _class_AudioServer_bus_layout_changed: - **bus_layout_changed** **(** **)** Emitted when the :ref:`AudioBusLayout` changes. - Enumerations ------------ .. _enum_AudioServer_SpeakerMode: -enum **SpeakerMode** +enum **SpeakerMode**: - **SPEAKER_MODE_STEREO** = **0** --- Two or fewer speakers are detected. - **SPEAKER_SURROUND_51** = **2** --- A 5.1 channel surround setup detected. - **SPEAKER_SURROUND_71** = **3** --- A 7.1 channel surround setup detected. - Description ----------- @@ -129,230 +128,228 @@ Tutorials --------- - :doc:`../tutorials/audio/audio_buses` - Method Descriptions ------------------- -.. _class_AudioServer_add_bus: + .. _class_AudioServer_add_bus: - void **add_bus** **(** :ref:`int` at_position=-1 **)** Adds a bus at ``at_position``. -.. _class_AudioServer_add_bus_effect: + .. _class_AudioServer_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_capture_get_device: - :ref:`String` **capture_get_device** **(** **)** -.. _class_AudioServer_capture_get_device_list: + .. _class_AudioServer_capture_get_device_list: - :ref:`Array` **capture_get_device_list** **(** **)** -.. _class_AudioServer_capture_set_device: + .. _class_AudioServer_capture_set_device: - void **capture_set_device** **(** :ref:`String` name **)** -.. _class_AudioServer_generate_bus_layout: + .. _class_AudioServer_generate_bus_layout: - :ref:`AudioBusLayout` **generate_bus_layout** **(** **)** const Generates an :ref:`AudioBusLayout` using the available busses and effects. -.. _class_AudioServer_get_bus_count: + .. _class_AudioServer_get_bus_count: - :ref:`int` **get_bus_count** **(** **)** const Returns the number of available busses. -.. _class_AudioServer_get_bus_effect: + .. _class_AudioServer_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_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_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_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_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_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_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_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_get_device: - :ref:`String` **get_device** **(** **)** -.. _class_AudioServer_get_device_list: + .. _class_AudioServer_get_device_list: - :ref:`Array` **get_device_list** **(** **)** -.. _class_AudioServer_get_mix_rate: + .. _class_AudioServer_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_get_speaker_mode: - :ref:`SpeakerMode` **get_speaker_mode** **(** **)** const Returns the speaker configuration. -.. _class_AudioServer_is_bus_bypassing_effects: + .. _class_AudioServer_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_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_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_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_lock: - void **lock** **(** **)** Locks the audio drivers mainloop. Remember to unlock it afterwards. -.. _class_AudioServer_move_bus: + .. _class_AudioServer_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_remove_bus: - void **remove_bus** **(** :ref:`int` index **)** Removes the bus at index ``index``. -.. _class_AudioServer_remove_bus_effect: + .. _class_AudioServer_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_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_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_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_set_bus_layout: - void **set_bus_layout** **(** :ref:`AudioBusLayout` bus_layout **)** Overwrites the currently used :ref:`AudioBusLayout`. -.. _class_AudioServer_set_bus_mute: + .. _class_AudioServer_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_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_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_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_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_set_device: - void **set_device** **(** :ref:`String` device **)** -.. _class_AudioServer_swap_bus_effects: + .. _class_AudioServer_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_unlock: - void **unlock** **(** **)** Unlocks the audiodriver's main loop. After locking it always unlock it. - diff --git a/classes/class_audiostream.rst b/classes/class_audiostream.rst index a26a2fbbe..0c8be7705 100644 --- a/classes/class_audiostream.rst +++ b/classes/class_audiostream.rst @@ -8,7 +8,9 @@ AudioStream =========== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`AudioStreamMicrophone`, :ref:`AudioStreamSample`, :ref:`AudioStreamRandomPitch`, :ref:`AudioStreamOGGVorbis` + **Category:** Core Brief Description @@ -32,14 +34,12 @@ Tutorials --------- - :doc:`../tutorials/audio/audio_streams` - Method Descriptions ------------------- -.. _class_AudioStream_get_length: + .. _class_AudioStream_get_length: - :ref:`float` **get_length** **(** **)** const Returns the length of the audio stream in seconds. - diff --git a/classes/class_audiostreammicrophone.rst b/classes/class_audiostreammicrophone.rst index b4465391e..a52357ba5 100644 --- a/classes/class_audiostreammicrophone.rst +++ b/classes/class_audiostreammicrophone.rst @@ -8,6 +8,7 @@ AudioStreamMicrophone ===================== **Inherits:** :ref:`AudioStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_audiostreamoggvorbis.rst b/classes/class_audiostreamoggvorbis.rst index 87f6fd676..d67902a5d 100644 --- a/classes/class_audiostreamoggvorbis.rst +++ b/classes/class_audiostreamoggvorbis.rst @@ -8,6 +8,7 @@ AudioStreamOGGVorbis ==================== **Inherits:** :ref:`AudioStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,17 @@ Brief Description OGG Vorbis audio stream driver. +Properties +---------- + ++-------------------------------------------+------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`data` | ++-------------------------------------------+------------------------------------------------------------+ +| :ref:`bool` | :ref:`loop` | ++-------------------------------------------+------------------------------------------------------------+ +| :ref:`float` | :ref:`loop_offset` | ++-------------------------------------------+------------------------------------------------------------+ + Description ----------- @@ -25,14 +37,33 @@ Property Descriptions .. _class_AudioStreamOGGVorbis_data: -- :ref:`PoolByteArray` **data** - Contains the audio data in bytes. +- :ref:`PoolByteArray` **data** + ++----------+-----------------+ +| *Setter* | set_data(value) | ++----------+-----------------+ +| *Getter* | get_data() | ++----------+-----------------+ + +Contains the audio data in bytes. .. _class_AudioStreamOGGVorbis_loop: - :ref:`bool` **loop** ++----------+-----------------+ +| *Setter* | set_loop(value) | ++----------+-----------------+ +| *Getter* | has_loop() | ++----------+-----------------+ + .. _class_AudioStreamOGGVorbis_loop_offset: - :ref:`float` **loop_offset** ++----------+------------------------+ +| *Setter* | set_loop_offset(value) | ++----------+------------------------+ +| *Getter* | get_loop_offset() | ++----------+------------------------+ diff --git a/classes/class_audiostreamplayback.rst b/classes/class_audiostreamplayback.rst index 65a05c058..5ad5a86fa 100644 --- a/classes/class_audiostreamplayback.rst +++ b/classes/class_audiostreamplayback.rst @@ -8,6 +8,7 @@ AudioStreamPlayback =================== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_audiostreamplayer.rst b/classes/class_audiostreamplayer.rst index 1dfdec932..f1ef28175 100644 --- a/classes/class_audiostreamplayer.rst +++ b/classes/class_audiostreamplayer.rst @@ -8,6 +8,7 @@ AudioStreamPlayer ================= **Inherits:** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,27 @@ Brief Description 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` | ++----------------------------------------------------+-------------------------------------------------------------+ + Methods ------- @@ -31,25 +53,23 @@ Methods Signals ------- -.. _class_AudioStreamPlayer_finished: + .. _class_AudioStreamPlayer_finished: - **finished** **(** **)** Emitted when the audio stops playing. - Enumerations ------------ .. _enum_AudioStreamPlayer_MixTarget: -enum **MixTarget** +enum **MixTarget**: - **MIX_TARGET_STEREO** = **0** --- The audio will be played only on the first channel. - **MIX_TARGET_SURROUND** = **1** --- The audio will be played on all surround channels. - **MIX_TARGET_CENTER** = **2** --- The audio will be played on the second channel, which is usually the center. - Description ----------- @@ -60,68 +80,125 @@ Tutorials - :doc:`../learning/features/audio/index` - :doc:`../tutorials/audio/audio_streams` - Property Descriptions --------------------- .. _class_AudioStreamPlayer_autoplay: -- :ref:`bool` **autoplay** - If ``true`` audio plays when added to scene tree. Default value: ``false``. +- :ref:`bool` **autoplay** + ++----------+-----------------------+ +| *Setter* | set_autoplay(value) | ++----------+-----------------------+ +| *Getter* | is_autoplay_enabled() | ++----------+-----------------------+ + +If ``true`` audio plays when added to scene tree. Default value: ``false``. .. _class_AudioStreamPlayer_bus: -- :ref:`String` **bus** - Bus on which this audio is playing. +- :ref:`String` **bus** + ++----------+----------------+ +| *Setter* | set_bus(value) | ++----------+----------------+ +| *Getter* | get_bus() | ++----------+----------------+ + +Bus on which this audio is playing. .. _class_AudioStreamPlayer_mix_target: -- :ref:`MixTarget` **mix_target** - If the audio configuration has more than two speakers, this sets the target channels. See ``MIX_TARGET_*`` constants. +- :ref:`MixTarget` **mix_target** + ++----------+-----------------------+ +| *Setter* | set_mix_target(value) | ++----------+-----------------------+ +| *Getter* | get_mix_target() | ++----------+-----------------------+ + +If the audio configuration has more than two speakers, this sets the target channels. See ``MIX_TARGET_*`` constants. .. _class_AudioStreamPlayer_pitch_scale: -- :ref:`float` **pitch_scale** - Changes the pitch and the tempo of the audio. +- :ref:`float` **pitch_scale** + ++----------+------------------------+ +| *Setter* | set_pitch_scale(value) | ++----------+------------------------+ +| *Getter* | get_pitch_scale() | ++----------+------------------------+ + +Changes the pitch and the tempo of the audio. .. _class_AudioStreamPlayer_playing: -- :ref:`bool` **playing** - If ``true`` audio is playing. +- :ref:`bool` **playing** + ++----------+--------------+ +| *Getter* | is_playing() | ++----------+--------------+ + +If ``true`` audio is playing. .. _class_AudioStreamPlayer_stream: -- :ref:`AudioStream` **stream** - The :ref:`AudioStream` object to be played. +- :ref:`AudioStream` **stream** + ++----------+-------------------+ +| *Setter* | set_stream(value) | ++----------+-------------------+ +| *Getter* | get_stream() | ++----------+-------------------+ + +The :ref:`AudioStream` object to be played. .. _class_AudioStreamPlayer_stream_paused: - :ref:`bool` **stream_paused** ++----------+--------------------------+ +| *Setter* | set_stream_paused(value) | ++----------+--------------------------+ +| *Getter* | get_stream_paused() | ++----------+--------------------------+ + .. _class_AudioStreamPlayer_volume_db: -- :ref:`float` **volume_db** - Volume of sound, in dB. +- :ref:`float` **volume_db** ++----------+----------------------+ +| *Setter* | set_volume_db(value) | ++----------+----------------------+ +| *Getter* | get_volume_db() | ++----------+----------------------+ + +Volume of sound, in dB. Method Descriptions ------------------- -.. _class_AudioStreamPlayer_get_playback_position: + .. _class_AudioStreamPlayer_get_playback_position: - :ref:`float` **get_playback_position** **(** **)** Returns the position in the :ref:`AudioStream` in seconds. -.. _class_AudioStreamPlayer_play: + .. _class_AudioStreamPlayer_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_seek: - void **seek** **(** :ref:`float` to_position **)** Sets the position from which audio will be played, in seconds. -.. _class_AudioStreamPlayer_stop: + .. _class_AudioStreamPlayer_stop: - void **stop** **(** **)** Stops the audio. - diff --git a/classes/class_audiostreamplayer2d.rst b/classes/class_audiostreamplayer2d.rst index 86812f239..f5b07e717 100644 --- a/classes/class_audiostreamplayer2d.rst +++ b/classes/class_audiostreamplayer2d.rst @@ -8,6 +8,7 @@ AudioStreamPlayer2D =================== **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,31 @@ Brief Description 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` | ++---------------------------------------+---------------------------------------------------------------+ + Methods ------- @@ -31,13 +57,12 @@ Methods Signals ------- -.. _class_AudioStreamPlayer2D_finished: + .. _class_AudioStreamPlayer2D_finished: - **finished** **(** **)** Emitted when the audio stops playing. - Description ----------- @@ -48,76 +73,149 @@ Tutorials - :doc:`../learning/features/audio/index` - :doc:`../tutorials/audio/audio_streams` - Property Descriptions --------------------- .. _class_AudioStreamPlayer2D_area_mask: -- :ref:`int` **area_mask** - Areas in which this sound plays. +- :ref:`int` **area_mask** + ++----------+----------------------+ +| *Setter* | set_area_mask(value) | ++----------+----------------------+ +| *Getter* | get_area_mask() | ++----------+----------------------+ + +Areas in which this sound plays. .. _class_AudioStreamPlayer2D_attenuation: -- :ref:`float` **attenuation** - Dampens audio over distance with this as an exponent. +- :ref:`float` **attenuation** + ++----------+------------------------+ +| *Setter* | set_attenuation(value) | ++----------+------------------------+ +| *Getter* | get_attenuation() | ++----------+------------------------+ + +Dampens audio over distance with this as an exponent. .. _class_AudioStreamPlayer2D_autoplay: -- :ref:`bool` **autoplay** - If ``true`` audio plays when added to scene tree. Default value: ``false``. +- :ref:`bool` **autoplay** + ++----------+-----------------------+ +| *Setter* | set_autoplay(value) | ++----------+-----------------------+ +| *Getter* | is_autoplay_enabled() | ++----------+-----------------------+ + +If ``true`` audio plays when added to scene tree. Default value: ``false``. .. _class_AudioStreamPlayer2D_bus: -- :ref:`String` **bus** - Bus on which this audio is playing. +- :ref:`String` **bus** + ++----------+----------------+ +| *Setter* | set_bus(value) | ++----------+----------------+ +| *Getter* | get_bus() | ++----------+----------------+ + +Bus on which this audio is playing. .. _class_AudioStreamPlayer2D_max_distance: -- :ref:`float` **max_distance** - Maximum distance from which audio is still hearable. +- :ref:`float` **max_distance** + ++----------+-------------------------+ +| *Setter* | set_max_distance(value) | ++----------+-------------------------+ +| *Getter* | get_max_distance() | ++----------+-------------------------+ + +Maximum distance from which audio is still hearable. .. _class_AudioStreamPlayer2D_pitch_scale: -- :ref:`float` **pitch_scale** - Changes the pitch and the tempo of the audio. +- :ref:`float` **pitch_scale** + ++----------+------------------------+ +| *Setter* | set_pitch_scale(value) | ++----------+------------------------+ +| *Getter* | get_pitch_scale() | ++----------+------------------------+ + +Changes the pitch and the tempo of the audio. .. _class_AudioStreamPlayer2D_playing: -- :ref:`bool` **playing** - If ``true`` audio is playing. +- :ref:`bool` **playing** + ++----------+--------------+ +| *Getter* | is_playing() | ++----------+--------------+ + +If ``true`` audio is playing. .. _class_AudioStreamPlayer2D_stream: -- :ref:`AudioStream` **stream** - The :ref:`AudioStream` object to be played. +- :ref:`AudioStream` **stream** + ++----------+-------------------+ +| *Setter* | set_stream(value) | ++----------+-------------------+ +| *Getter* | get_stream() | ++----------+-------------------+ + +The :ref:`AudioStream` object to be played. .. _class_AudioStreamPlayer2D_stream_paused: - :ref:`bool` **stream_paused** ++----------+--------------------------+ +| *Setter* | set_stream_paused(value) | ++----------+--------------------------+ +| *Getter* | get_stream_paused() | ++----------+--------------------------+ + .. _class_AudioStreamPlayer2D_volume_db: -- :ref:`float` **volume_db** - Base volume without dampening. +- :ref:`float` **volume_db** ++----------+----------------------+ +| *Setter* | set_volume_db(value) | ++----------+----------------------+ +| *Getter* | get_volume_db() | ++----------+----------------------+ + +Base volume without dampening. Method Descriptions ------------------- -.. _class_AudioStreamPlayer2D_get_playback_position: + .. _class_AudioStreamPlayer2D_get_playback_position: - :ref:`float` **get_playback_position** **(** **)** Returns the position in the :ref:`AudioStream`. -.. _class_AudioStreamPlayer2D_play: + .. _class_AudioStreamPlayer2D_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_seek: - void **seek** **(** :ref:`float` to_position **)** Sets the position from which audio will be played, in seconds. -.. _class_AudioStreamPlayer2D_stop: + .. _class_AudioStreamPlayer2D_stop: - void **stop** **(** **)** Stops the audio. - diff --git a/classes/class_audiostreamplayer3d.rst b/classes/class_audiostreamplayer3d.rst index efe04ac5d..78a707bef 100644 --- a/classes/class_audiostreamplayer3d.rst +++ b/classes/class_audiostreamplayer3d.rst @@ -8,6 +8,7 @@ AudioStreamPlayer3D =================== **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,49 @@ Brief Description 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` | ++--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ + Methods ------- @@ -31,19 +75,18 @@ Methods Signals ------- -.. _class_AudioStreamPlayer3D_finished: + .. _class_AudioStreamPlayer3D_finished: - **finished** **(** **)** Fires when the audio stops playing. - Enumerations ------------ .. _enum_AudioStreamPlayer3D_DopplerTracking: -enum **DopplerTracking** +enum **DopplerTracking**: - **DOPPLER_TRACKING_DISABLED** = **0** --- Disables doppler tracking. - **DOPPLER_TRACKING_IDLE_STEP** = **1** --- Executes doppler tracking in idle step. @@ -51,20 +94,19 @@ enum **DopplerTracking** .. _enum_AudioStreamPlayer3D_OutOfRangeMode: -enum **OutOfRangeMode** +enum **OutOfRangeMode**: - **OUT_OF_RANGE_MIX** = **0** --- Mix this audio in, even when it's out of range. - **OUT_OF_RANGE_PAUSE** = **1** --- Pause this audio when it gets out of range. .. _enum_AudioStreamPlayer3D_AttenuationModel: -enum **AttenuationModel** +enum **AttenuationModel**: - **ATTENUATION_INVERSE_DISTANCE** = **0** --- Linear dampening of loudness according to distance. - **ATTENUATION_INVERSE_SQUARE_DISTANCE** = **1** --- Squared dampening of loudness according to distance. - **ATTENUATION_LOGARITHMIC** = **2** --- Logarithmic dampening of loudness according to distance. - Description ----------- @@ -75,112 +117,257 @@ Tutorials - :doc:`../learning/features/audio/index` - :doc:`../tutorials/audio/audio_streams` - Property Descriptions --------------------- .. _class_AudioStreamPlayer3D_area_mask: -- :ref:`int` **area_mask** - Areas in which this sound plays. +- :ref:`int` **area_mask** + ++----------+----------------------+ +| *Setter* | set_area_mask(value) | ++----------+----------------------+ +| *Getter* | get_area_mask() | ++----------+----------------------+ + +Areas in which this sound plays. .. _class_AudioStreamPlayer3D_attenuation_filter_cutoff_hz: -- :ref:`float` **attenuation_filter_cutoff_hz** - Dampens audio above this frequency, in Hz. +- :ref:`float` **attenuation_filter_cutoff_hz** + ++----------+-----------------------------------------+ +| *Setter* | set_attenuation_filter_cutoff_hz(value) | ++----------+-----------------------------------------+ +| *Getter* | get_attenuation_filter_cutoff_hz() | ++----------+-----------------------------------------+ + +Dampens audio above this frequency, in Hz. .. _class_AudioStreamPlayer3D_attenuation_filter_db: -- :ref:`float` **attenuation_filter_db** - Amount how much the filter affects the loudness, in dB. +- :ref:`float` **attenuation_filter_db** + ++----------+----------------------------------+ +| *Setter* | set_attenuation_filter_db(value) | ++----------+----------------------------------+ +| *Getter* | get_attenuation_filter_db() | ++----------+----------------------------------+ + +Amount how much the filter affects the loudness, in dB. .. _class_AudioStreamPlayer3D_attenuation_model: -- :ref:`AttenuationModel` **attenuation_model** - Decides if audio should get quieter with distance linearly, quadratically or logarithmically. +- :ref:`AttenuationModel` **attenuation_model** + ++----------+------------------------------+ +| *Setter* | set_attenuation_model(value) | ++----------+------------------------------+ +| *Getter* | get_attenuation_model() | ++----------+------------------------------+ + +Decides if audio should get quieter with distance linearly, quadratically or logarithmically. .. _class_AudioStreamPlayer3D_autoplay: -- :ref:`bool` **autoplay** - If ``true`` audio plays when added to scene tree. Default value: ``false``. +- :ref:`bool` **autoplay** + ++----------+-----------------------+ +| *Setter* | set_autoplay(value) | ++----------+-----------------------+ +| *Getter* | is_autoplay_enabled() | ++----------+-----------------------+ + +If ``true`` audio plays when added to scene tree. Default value: ``false``. .. _class_AudioStreamPlayer3D_bus: -- :ref:`String` **bus** - Bus on which this audio is playing. +- :ref:`String` **bus** + ++----------+----------------+ +| *Setter* | set_bus(value) | ++----------+----------------+ +| *Getter* | get_bus() | ++----------+----------------+ + +Bus on which this audio is playing. .. _class_AudioStreamPlayer3D_doppler_tracking: -- :ref:`DopplerTracking` **doppler_tracking** - Decides in which step the Doppler effect should be calculated. +- :ref:`DopplerTracking` **doppler_tracking** + ++----------+-----------------------------+ +| *Setter* | set_doppler_tracking(value) | ++----------+-----------------------------+ +| *Getter* | get_doppler_tracking() | ++----------+-----------------------------+ + +Decides in which step the Doppler effect should be calculated. .. _class_AudioStreamPlayer3D_emission_angle_degrees: -- :ref:`float` **emission_angle_degrees** - The angle in which the audio reaches cameras undampened. +- :ref:`float` **emission_angle_degrees** + ++----------+---------------------------+ +| *Setter* | set_emission_angle(value) | ++----------+---------------------------+ +| *Getter* | get_emission_angle() | ++----------+---------------------------+ + +The angle in which the audio reaches cameras undampened. .. _class_AudioStreamPlayer3D_emission_angle_enabled: -- :ref:`bool` **emission_angle_enabled** - If ``true`` the audio should be dampened according to the direction of the sound. +- :ref:`bool` **emission_angle_enabled** + ++----------+-----------------------------------+ +| *Setter* | set_emission_angle_enabled(value) | ++----------+-----------------------------------+ +| *Getter* | is_emission_angle_enabled() | ++----------+-----------------------------------+ + +If ``true`` the audio should be dampened according to the direction of the sound. .. _class_AudioStreamPlayer3D_emission_angle_filter_attenuation_db: -- :ref:`float` **emission_angle_filter_attenuation_db** - dampens audio if camera is outside of 'emission_angle_degrees' and 'emission_angle_enabled' is set by this factor, in dB. +- :ref:`float` **emission_angle_filter_attenuation_db** + ++----------+-------------------------------------------------+ +| *Setter* | set_emission_angle_filter_attenuation_db(value) | ++----------+-------------------------------------------------+ +| *Getter* | get_emission_angle_filter_attenuation_db() | ++----------+-------------------------------------------------+ + +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: -- :ref:`float` **max_db** - Sets the absolute maximum of the soundlevel, in dB. +- :ref:`float` **max_db** + ++----------+-------------------+ +| *Setter* | set_max_db(value) | ++----------+-------------------+ +| *Getter* | get_max_db() | ++----------+-------------------+ + +Sets the absolute maximum of the soundlevel, in dB. .. _class_AudioStreamPlayer3D_max_distance: -- :ref:`float` **max_distance** - Sets the distance from which the 'out_of_range_mode' takes effect. Has no effect if set to 0. +- :ref:`float` **max_distance** + ++----------+-------------------------+ +| *Setter* | set_max_distance(value) | ++----------+-------------------------+ +| *Getter* | get_max_distance() | ++----------+-------------------------+ + +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: -- :ref:`OutOfRangeMode` **out_of_range_mode** - Decides if audio should pause when source is outside of 'max_distance' range. +- :ref:`OutOfRangeMode` **out_of_range_mode** + ++----------+------------------------------+ +| *Setter* | set_out_of_range_mode(value) | ++----------+------------------------------+ +| *Getter* | get_out_of_range_mode() | ++----------+------------------------------+ + +Decides if audio should pause when source is outside of 'max_distance' range. .. _class_AudioStreamPlayer3D_pitch_scale: -- :ref:`float` **pitch_scale** - Changes the pitch and the tempo of the audio. +- :ref:`float` **pitch_scale** + ++----------+------------------------+ +| *Setter* | set_pitch_scale(value) | ++----------+------------------------+ +| *Getter* | get_pitch_scale() | ++----------+------------------------+ + +Changes the pitch and the tempo of the audio. .. _class_AudioStreamPlayer3D_playing: -- :ref:`bool` **playing** - If ``true``, audio is playing. +- :ref:`bool` **playing** + ++----------+--------------+ +| *Getter* | is_playing() | ++----------+--------------+ + +If ``true``, audio is playing. .. _class_AudioStreamPlayer3D_stream: -- :ref:`AudioStream` **stream** - The :ref:`AudioStream` object to be played. +- :ref:`AudioStream` **stream** + ++----------+-------------------+ +| *Setter* | set_stream(value) | ++----------+-------------------+ +| *Getter* | get_stream() | ++----------+-------------------+ + +The :ref:`AudioStream` object to be played. .. _class_AudioStreamPlayer3D_stream_paused: - :ref:`bool` **stream_paused** ++----------+--------------------------+ +| *Setter* | set_stream_paused(value) | ++----------+--------------------------+ +| *Getter* | get_stream_paused() | ++----------+--------------------------+ + .. _class_AudioStreamPlayer3D_unit_db: -- :ref:`float` **unit_db** - Base sound level unaffected by dampening, in dB. +- :ref:`float` **unit_db** + ++----------+--------------------+ +| *Setter* | set_unit_db(value) | ++----------+--------------------+ +| *Getter* | get_unit_db() | ++----------+--------------------+ + +Base sound level unaffected by dampening, in dB. .. _class_AudioStreamPlayer3D_unit_size: -- :ref:`float` **unit_size** - Factor for the attenuation effect. +- :ref:`float` **unit_size** ++----------+----------------------+ +| *Setter* | set_unit_size(value) | ++----------+----------------------+ +| *Getter* | get_unit_size() | ++----------+----------------------+ + +Factor for the attenuation effect. Method Descriptions ------------------- -.. _class_AudioStreamPlayer3D_get_playback_position: + .. _class_AudioStreamPlayer3D_get_playback_position: - :ref:`float` **get_playback_position** **(** **)** Returns the position in the :ref:`AudioStream`. -.. _class_AudioStreamPlayer3D_play: + .. _class_AudioStreamPlayer3D_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_seek: - void **seek** **(** :ref:`float` to_position **)** Sets the position from which audio will be played, in seconds. -.. _class_AudioStreamPlayer3D_stop: + .. _class_AudioStreamPlayer3D_stop: - void **stop** **(** **)** Stops the audio. - diff --git a/classes/class_audiostreamrandompitch.rst b/classes/class_audiostreamrandompitch.rst index 41481f9c2..81438634e 100644 --- a/classes/class_audiostreamrandompitch.rst +++ b/classes/class_audiostreamrandompitch.rst @@ -8,6 +8,7 @@ AudioStreamRandomPitch ====================== **Inherits:** :ref:`AudioStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description Plays audio with random pitch tweaking. +Properties +---------- + ++---------------------------------------+----------------------------------------------------------------+ +| :ref:`AudioStream` | :ref:`audio_stream` | ++---------------------------------------+----------------------------------------------------------------+ +| :ref:`float` | :ref:`random_pitch` | ++---------------------------------------+----------------------------------------------------------------+ + Description ----------- @@ -25,10 +35,25 @@ Property Descriptions .. _class_AudioStreamRandomPitch_audio_stream: -- :ref:`AudioStream` **audio_stream** - The current :ref:`AudioStream`. +- :ref:`AudioStream` **audio_stream** + ++----------+-------------------------+ +| *Setter* | set_audio_stream(value) | ++----------+-------------------------+ +| *Getter* | get_audio_stream() | ++----------+-------------------------+ + +The current :ref:`AudioStream`. .. _class_AudioStreamRandomPitch_random_pitch: -- :ref:`float` **random_pitch** - The intensity of random pitch variation. +- :ref:`float` **random_pitch** ++----------+-------------------------+ +| *Setter* | set_random_pitch(value) | ++----------+-------------------------+ +| *Getter* | get_random_pitch() | ++----------+-------------------------+ + +The intensity of random pitch variation. diff --git a/classes/class_audiostreamsample.rst b/classes/class_audiostreamsample.rst index 718dab7ba..ecf911ee5 100644 --- a/classes/class_audiostreamsample.rst +++ b/classes/class_audiostreamsample.rst @@ -8,6 +8,7 @@ AudioStreamSample ================= **Inherits:** :ref:`AudioStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,25 @@ Brief Description 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` | ++--------------------------------------------------+-------------------------------------------------------+ + Methods ------- @@ -27,7 +47,7 @@ Enumerations .. _enum_AudioStreamSample_LoopMode: -enum **LoopMode** +enum **LoopMode**: - **LOOP_DISABLED** = **0** --- Audio does not loop. - **LOOP_FORWARD** = **1** --- Audio loops the data between loop_begin and loop_end playing forward only. @@ -35,13 +55,12 @@ enum **LoopMode** .. _enum_AudioStreamSample_Format: -enum **Format** +enum **Format**: - **FORMAT_8_BITS** = **0** --- Audio codec 8 bit. - **FORMAT_16_BITS** = **1** --- Audio codec 16 bit. - **FORMAT_IMA_ADPCM** = **2** --- Audio codec IMA ADPCM. - Description ----------- @@ -52,38 +71,92 @@ Property Descriptions .. _class_AudioStreamSample_data: -- :ref:`PoolByteArray` **data** - Contains the audio data in bytes. +- :ref:`PoolByteArray` **data** + ++----------+-----------------+ +| *Setter* | set_data(value) | ++----------+-----------------+ +| *Getter* | get_data() | ++----------+-----------------+ + +Contains the audio data in bytes. .. _class_AudioStreamSample_format: -- :ref:`Format` **format** - Audio format. See FORMAT\_\* constants for values. +- :ref:`Format` **format** + ++----------+-------------------+ +| *Setter* | set_format(value) | ++----------+-------------------+ +| *Getter* | get_format() | ++----------+-------------------+ + +Audio format. See FORMAT\_\* constants for values. .. _class_AudioStreamSample_loop_begin: -- :ref:`int` **loop_begin** - Loop start in bytes. +- :ref:`int` **loop_begin** + ++----------+-----------------------+ +| *Setter* | set_loop_begin(value) | ++----------+-----------------------+ +| *Getter* | get_loop_begin() | ++----------+-----------------------+ + +Loop start in bytes. .. _class_AudioStreamSample_loop_end: -- :ref:`int` **loop_end** - Loop end in bytes. +- :ref:`int` **loop_end** + ++----------+---------------------+ +| *Setter* | set_loop_end(value) | ++----------+---------------------+ +| *Getter* | get_loop_end() | ++----------+---------------------+ + +Loop end in bytes. .. _class_AudioStreamSample_loop_mode: -- :ref:`LoopMode` **loop_mode** - Loop mode. See LOOP\_\* constants for values. +- :ref:`LoopMode` **loop_mode** + ++----------+----------------------+ +| *Setter* | set_loop_mode(value) | ++----------+----------------------+ +| *Getter* | get_loop_mode() | ++----------+----------------------+ + +Loop mode. See LOOP\_\* constants for values. .. _class_AudioStreamSample_mix_rate: -- :ref:`int` **mix_rate** - The sample rate for mixing this audio. +- :ref:`int` **mix_rate** + ++----------+---------------------+ +| *Setter* | set_mix_rate(value) | ++----------+---------------------+ +| *Getter* | get_mix_rate() | ++----------+---------------------+ + +The sample rate for mixing this audio. .. _class_AudioStreamSample_stereo: -- :ref:`bool` **stereo** - If ``true``, audio is stereo. Default value: ``false``. +- :ref:`bool` **stereo** ++----------+-------------------+ +| *Setter* | set_stereo(value) | ++----------+-------------------+ +| *Getter* | is_stereo() | ++----------+-------------------+ + +If ``true``, audio is stereo. Default value: ``false``. Method Descriptions ------------------- -.. _class_AudioStreamSample_save_to_wav: + .. _class_AudioStreamSample_save_to_wav: - void **save_to_wav** **(** :ref:`String` path **)** - diff --git a/classes/class_backbuffercopy.rst b/classes/class_backbuffercopy.rst index 036f6a398..6f0dc5965 100644 --- a/classes/class_backbuffercopy.rst +++ b/classes/class_backbuffercopy.rst @@ -8,6 +8,7 @@ BackBufferCopy ============== **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,18 +16,26 @@ Brief Description Copies a region of the screen (or the whole screen) to a buffer so it can be accessed with ``SCREEN_TEXTURE`` in the ``texture()`` function. +Properties +---------- + ++-----------------------------------------------+--------------------------------------------------+ +| :ref:`CopyMode` | :ref:`copy_mode` | ++-----------------------------------------------+--------------------------------------------------+ +| :ref:`Rect2` | :ref:`rect` | ++-----------------------------------------------+--------------------------------------------------+ + Enumerations ------------ .. _enum_BackBufferCopy_CopyMode: -enum **CopyMode** +enum **CopyMode**: - **COPY_MODE_DISABLED** = **0** --- Disables the buffering mode. This means the BackBufferCopy node will directly use the portion of screen it covers. - **COPY_MODE_RECT** = **1** --- BackBufferCopy buffers a rectangular region. - **COPY_MODE_VIEWPORT** = **2** --- BackBufferCopy buffers the entire screen. - Description ----------- @@ -37,10 +46,25 @@ Property Descriptions .. _class_BackBufferCopy_copy_mode: -- :ref:`CopyMode` **copy_mode** - Buffer mode. See ``COPY_MODE_*`` constants. +- :ref:`CopyMode` **copy_mode** + ++----------+----------------------+ +| *Setter* | set_copy_mode(value) | ++----------+----------------------+ +| *Getter* | get_copy_mode() | ++----------+----------------------+ + +Buffer mode. See ``COPY_MODE_*`` constants. .. _class_BackBufferCopy_rect: -- :ref:`Rect2` **rect** - The area covered by the BackBufferCopy. Only used if ``copy_mode`` is ``COPY_MODE_RECT``. +- :ref:`Rect2` **rect** ++----------+-----------------+ +| *Setter* | set_rect(value) | ++----------+-----------------+ +| *Getter* | get_rect() | ++----------+-----------------+ + +The area covered by the BackBufferCopy. Only used if ``copy_mode`` is ``COPY_MODE_RECT``. diff --git a/classes/class_bakedlightmap.rst b/classes/class_bakedlightmap.rst index bb33760f1..54fb7d260 100644 --- a/classes/class_bakedlightmap.rst +++ b/classes/class_bakedlightmap.rst @@ -8,6 +8,7 @@ BakedLightmap ============= **Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,31 @@ Brief Description 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` | ++----------------------------------------------------+-----------------------------------------------------------------+ + Methods ------- @@ -29,7 +55,7 @@ Enumerations .. _enum_BakedLightmap_BakeQuality: -enum **BakeQuality** +enum **BakeQuality**: - **BAKE_QUALITY_LOW** = **0** --- Lowest bake quality mode. Fastest to calculate. - **BAKE_QUALITY_MEDIUM** = **1** --- Default bake quality mode. @@ -37,7 +63,7 @@ enum **BakeQuality** .. _enum_BakedLightmap_BakeError: -enum **BakeError** +enum **BakeError**: - **BAKE_ERROR_OK** = **0** - **BAKE_ERROR_NO_SAVE_PATH** = **1** @@ -47,12 +73,11 @@ enum **BakeError** .. _enum_BakedLightmap_BakeMode: -enum **BakeMode** +enum **BakeMode**: - **BAKE_MODE_CONE_TRACE** = **0** --- Less precise but faster bake mode. - **BAKE_MODE_RAY_TRACE** = **1** --- More precise bake mode but can take considerably longer to bake. - Description ----------- @@ -62,60 +87,133 @@ Tutorials --------- - :doc:`../tutorials/3d/baked_lightmaps` - Property Descriptions --------------------- .. _class_BakedLightmap_bake_cell_size: -- :ref:`float` **bake_cell_size** - 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. +- :ref:`float` **bake_cell_size** + ++----------+---------------------------+ +| *Setter* | set_bake_cell_size(value) | ++----------+---------------------------+ +| *Getter* | get_bake_cell_size() | ++----------+---------------------------+ + +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: - :ref:`float` **bake_energy** ++----------+-------------------+ +| *Setter* | set_energy(value) | ++----------+-------------------+ +| *Getter* | get_energy() | ++----------+-------------------+ + .. _class_BakedLightmap_bake_extents: -- :ref:`Vector3` **bake_extents** - Size of affected area. +- :ref:`Vector3` **bake_extents** + ++----------+--------------------+ +| *Setter* | set_extents(value) | ++----------+--------------------+ +| *Getter* | get_extents() | ++----------+--------------------+ + +Size of affected area. .. _class_BakedLightmap_bake_hdr: -- :ref:`bool` **bake_hdr** - If ``true`` lightmap can capture light values greater than ``1.0``. Turning this off will result in a smaller lightmap. Default value:``false``. +- :ref:`bool` **bake_hdr** + ++----------+----------------+ +| *Setter* | set_hdr(value) | ++----------+----------------+ +| *Getter* | is_hdr() | ++----------+----------------+ + +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: -- :ref:`BakeMode` **bake_mode** - Lightmapping mode. See :ref:`BakeMode`. +- :ref:`BakeMode` **bake_mode** + ++----------+----------------------+ +| *Setter* | set_bake_mode(value) | ++----------+----------------------+ +| *Getter* | get_bake_mode() | ++----------+----------------------+ + +Lightmapping mode. See :ref:`BakeMode`. .. _class_BakedLightmap_bake_propagation: - :ref:`float` **bake_propagation** ++----------+------------------------+ +| *Setter* | set_propagation(value) | ++----------+------------------------+ +| *Getter* | get_propagation() | ++----------+------------------------+ + .. _class_BakedLightmap_bake_quality: -- :ref:`BakeQuality` **bake_quality** - Three quality modes are available. Higher quality requires more rendering time. See :ref:`BakeQuality`. +- :ref:`BakeQuality` **bake_quality** + ++----------+-------------------------+ +| *Setter* | set_bake_quality(value) | ++----------+-------------------------+ +| *Getter* | get_bake_quality() | ++----------+-------------------------+ + +Three quality modes are available. Higher quality requires more rendering time. See :ref:`BakeQuality`. .. _class_BakedLightmap_capture_cell_size: -- :ref:`float` **capture_cell_size** - Grid size used for real-time capture information on dynamic objects. Cannot be larger than :ref:`bake_cell_size`. +- :ref:`float` **capture_cell_size** + ++----------+------------------------------+ +| *Setter* | set_capture_cell_size(value) | ++----------+------------------------------+ +| *Getter* | get_capture_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: -- :ref:`String` **image_path** - Location where lightmaps will be saved. +- :ref:`String` **image_path** + ++----------+-----------------------+ +| *Setter* | set_image_path(value) | ++----------+-----------------------+ +| *Getter* | get_image_path() | ++----------+-----------------------+ + +Location where lightmaps will be saved. .. _class_BakedLightmap_light_data: -- :ref:`BakedLightmapData` **light_data** - The calculated light data. +- :ref:`BakedLightmapData` **light_data** ++----------+-----------------------+ +| *Setter* | set_light_data(value) | ++----------+-----------------------+ +| *Getter* | get_light_data() | ++----------+-----------------------+ + +The calculated light data. Method Descriptions ------------------- -.. _class_BakedLightmap_bake: + .. _class_BakedLightmap_bake: - :ref:`BakeError` **bake** **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** -.. _class_BakedLightmap_debug_bake: + .. _class_BakedLightmap_debug_bake: - void **debug_bake** **(** **)** - diff --git a/classes/class_bakedlightmapdata.rst b/classes/class_bakedlightmapdata.rst index c8e212bab..c43b8393d 100644 --- a/classes/class_bakedlightmapdata.rst +++ b/classes/class_bakedlightmapdata.rst @@ -8,6 +8,7 @@ BakedLightmapData ================= **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,21 @@ 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` | ++-------------------------------------------+---------------------------------------------------------------------------+ + Methods ------- @@ -37,44 +53,72 @@ Property Descriptions - :ref:`AABB` **bounds** ++----------+-------------------+ +| *Setter* | set_bounds(value) | ++----------+-------------------+ +| *Getter* | get_bounds() | ++----------+-------------------+ + .. _class_BakedLightmapData_cell_space_transform: - :ref:`Transform` **cell_space_transform** ++----------+---------------------------------+ +| *Setter* | set_cell_space_transform(value) | ++----------+---------------------------------+ +| *Getter* | get_cell_space_transform() | ++----------+---------------------------------+ + .. _class_BakedLightmapData_cell_subdiv: - :ref:`int` **cell_subdiv** ++----------+------------------------+ +| *Setter* | set_cell_subdiv(value) | ++----------+------------------------+ +| *Getter* | get_cell_subdiv() | ++----------+------------------------+ + .. _class_BakedLightmapData_energy: - :ref:`float` **energy** ++----------+-------------------+ +| *Setter* | set_energy(value) | ++----------+-------------------+ +| *Getter* | get_energy() | ++----------+-------------------+ + .. _class_BakedLightmapData_octree: - :ref:`PoolByteArray` **octree** ++----------+-------------------+ +| *Setter* | set_octree(value) | ++----------+-------------------+ +| *Getter* | get_octree() | ++----------+-------------------+ Method Descriptions ------------------- -.. _class_BakedLightmapData_add_user: + .. _class_BakedLightmapData_add_user: - void **add_user** **(** :ref:`NodePath` path, :ref:`Texture` lightmap, :ref:`int` instance **)** -.. _class_BakedLightmapData_clear_users: + .. _class_BakedLightmapData_clear_users: - void **clear_users** **(** **)** -.. _class_BakedLightmapData_get_user_count: + .. _class_BakedLightmapData_get_user_count: - :ref:`int` **get_user_count** **(** **)** const -.. _class_BakedLightmapData_get_user_lightmap: + .. _class_BakedLightmapData_get_user_lightmap: - :ref:`Texture` **get_user_lightmap** **(** :ref:`int` user_idx **)** const -.. _class_BakedLightmapData_get_user_path: + .. _class_BakedLightmapData_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 5c75bb51d..375eef7cc 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -8,7 +8,9 @@ BaseButton ========== **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`LinkButton`, :ref:`TextureButton`, :ref:`Button` + **Category:** Core Brief Description @@ -16,6 +18,27 @@ Brief Description 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:`toggle_mode` | ++-----------------------------------------------+----------------------------------------------------------------+ + Methods ------- @@ -32,51 +55,49 @@ Methods Signals ------- -.. _class_BaseButton_button_down: + .. _class_BaseButton_button_down: - **button_down** **(** **)** Emitted when the button starts being held down. -.. _class_BaseButton_button_up: + .. _class_BaseButton_button_up: - **button_up** **(** **)** Emitted when the button stops being held down. -.. _class_BaseButton_pressed: + .. _class_BaseButton_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_toggled: - **toggled** **(** :ref:`bool` button_pressed **)** This signal is emitted when the button was just toggled between pressed and normal states (only if toggle_mode is active). The new state is contained in the *pressed* argument. - Enumerations ------------ .. _enum_BaseButton_ActionMode: -enum **ActionMode** +enum **ActionMode**: - **ACTION_MODE_BUTTON_PRESS** = **0** --- Require just a press to consider the button clicked. - **ACTION_MODE_BUTTON_RELEASE** = **1** --- Require a press and a subsequent release before considering the button clicked. .. _enum_BaseButton_DrawMode: -enum **DrawMode** +enum **DrawMode**: - **DRAW_NORMAL** = **0** --- The normal state (i.e. not pressed, not hovered, not toggled and enabled) of buttons. - **DRAW_PRESSED** = **1** --- The state of buttons are pressed. - **DRAW_HOVER** = **2** --- The state of buttons are hovered. - **DRAW_DISABLED** = **3** --- The state of buttons are disabled. - Description ----------- @@ -87,64 +108,126 @@ Property Descriptions .. _class_BaseButton_action_mode: -- :ref:`ActionMode` **action_mode** - Determines when the button is considered clicked, one of the ACTION_MODE\_\* constants. +- :ref:`ActionMode` **action_mode** + ++----------+------------------------+ +| *Setter* | set_action_mode(value) | ++----------+------------------------+ +| *Getter* | get_action_mode() | ++----------+------------------------+ + +Determines when the button is considered clicked, one of the ACTION_MODE\_\* constants. .. _class_BaseButton_button_mask: -- :ref:`int` **button_mask** - Binary mask to choose which mouse buttons this button will respond to. +- :ref:`int` **button_mask** + ++----------+------------------------+ +| *Setter* | set_button_mask(value) | ++----------+------------------------+ +| *Getter* | get_button_mask() | ++----------+------------------------+ + +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: -- :ref:`bool` **disabled** - If ``true`` the button is in disabled state and can't be clicked or toggled. +- :ref:`bool` **disabled** + ++----------+---------------------+ +| *Setter* | set_disabled(value) | ++----------+---------------------+ +| *Getter* | is_disabled() | ++----------+---------------------+ + +If ``true`` the button is in disabled state and can't be clicked or toggled. .. _class_BaseButton_enabled_focus_mode: -- :ref:`FocusMode` **enabled_focus_mode** - Focus access mode to use when switching between enabled/disabled (see :ref:`Control.set_focus_mode` and :ref:`disabled`). +- :ref:`FocusMode` **enabled_focus_mode** + ++----------+-------------------------------+ +| *Setter* | set_enabled_focus_mode(value) | ++----------+-------------------------------+ +| *Getter* | get_enabled_focus_mode() | ++----------+-------------------------------+ + +Focus access mode to use when switching between enabled/disabled (see :ref:`Control.set_focus_mode` and :ref:`disabled`). .. _class_BaseButton_group: -- :ref:`ButtonGroup` **group** - :ref:`ButtonGroup` associated to the button. +- :ref:`ButtonGroup` **group** + ++----------+-------------------------+ +| *Setter* | set_button_group(value) | ++----------+-------------------------+ +| *Getter* | get_button_group() | ++----------+-------------------------+ + +:ref:`ButtonGroup` associated to the button. .. _class_BaseButton_pressed: -- :ref:`bool` **pressed** - If ``true`` the button's state is pressed. Means the button is pressed down or toggled (if toggle_mode is active). +- :ref:`bool` **pressed** + ++----------+--------------------+ +| *Setter* | set_pressed(value) | ++----------+--------------------+ +| *Getter* | is_pressed() | ++----------+--------------------+ + +If ``true`` the button's state is pressed. Means the button is pressed down or toggled (if toggle_mode is active). .. _class_BaseButton_shortcut: -- :ref:`ShortCut` **shortcut** - Shortcut associated to the button. +- :ref:`ShortCut` **shortcut** + ++----------+---------------------+ +| *Setter* | set_shortcut(value) | ++----------+---------------------+ +| *Getter* | get_shortcut() | ++----------+---------------------+ + +Shortcut associated to the button. .. _class_BaseButton_toggle_mode: -- :ref:`bool` **toggle_mode** - If ``true`` the button is in toggle mode. Makes the button flip state between pressed and unpressed each time its area is clicked. +- :ref:`bool` **toggle_mode** ++----------+------------------------+ +| *Setter* | set_toggle_mode(value) | ++----------+------------------------+ +| *Getter* | is_toggle_mode() | ++----------+------------------------+ + +If ``true`` the button is in toggle mode. Makes the button flip state between pressed and unpressed each time its area is clicked. Method Descriptions ------------------- -.. _class_BaseButton__pressed: + .. _class_BaseButton__pressed: - void **_pressed** **(** **)** virtual Called when the button is pressed. -.. _class_BaseButton__toggled: + .. _class_BaseButton__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_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_is_hovered: - :ref:`bool` **is_hovered** **(** **)** const Return true if the mouse has entered the button and has not left it yet. - diff --git a/classes/class_basis.rst b/classes/class_basis.rst index be5aed3dc..746188880 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -14,6 +14,17 @@ Brief Description 3x3 matrix datatype. +Properties +---------- + ++-------------------------------+-------------------------+ +| :ref:`Vector3` | :ref:`x` | ++-------------------------------+-------------------------+ +| :ref:`Vector3` | :ref:`y` | ++-------------------------------+-------------------------+ +| :ref:`Vector3` | :ref:`z` | ++-------------------------------+-------------------------+ + Methods ------- @@ -69,138 +80,141 @@ Tutorials - :doc:`../tutorials/3d/using_transforms` - :doc:`../tutorials/math/rotations` - Property Descriptions --------------------- .. _class_Basis_x: -- :ref:`Vector3` **x** - The basis matrix's x vector. +- :ref:`Vector3` **x** + +The basis matrix's x vector. .. _class_Basis_y: -- :ref:`Vector3` **y** - The basis matrix's y vector. +- :ref:`Vector3` **y** + +The basis matrix's y vector. .. _class_Basis_z: -- :ref:`Vector3` **z** - The basis matrix's z vector. +- :ref:`Vector3` **z** +The basis matrix's z vector. Method Descriptions ------------------- -.. _class_Basis_Basis: + .. _class_Basis_Basis: - :ref:`Basis` **Basis** **(** :ref:`Quat` from **)** Create a rotation matrix from the given quaternion. -.. _class_Basis_Basis: + .. _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: + .. _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: + .. _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_determinant: - :ref:`float` **determinant** **(** **)** Return the determinant of the matrix. -.. _class_Basis_get_euler: + .. _class_Basis_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_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_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_inverse: - :ref:`Basis` **inverse** **(** **)** Return the inverse of the matrix. -.. _class_Basis_orthonormalized: + .. _class_Basis_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_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_scaled: - :ref:`Basis` **scaled** **(** :ref:`Vector3` scale **)** Introduce an additional scaling specified by the given 3D scaling factor. -.. _class_Basis_slerp: + .. _class_Basis_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_tdotx: - :ref:`float` **tdotx** **(** :ref:`Vector3` with **)** Transposed dot product with the x axis of the matrix. -.. _class_Basis_tdoty: + .. _class_Basis_tdoty: - :ref:`float` **tdoty** **(** :ref:`Vector3` with **)** Transposed dot product with the y axis of the matrix. -.. _class_Basis_tdotz: + .. _class_Basis_tdotz: - :ref:`float` **tdotz** **(** :ref:`Vector3` with **)** Transposed dot product with the z axis of the matrix. -.. _class_Basis_transposed: + .. _class_Basis_transposed: - :ref:`Basis` **transposed** **(** **)** Return the transposed version of the matrix. -.. _class_Basis_xform: + .. _class_Basis_xform: - :ref:`Vector3` **xform** **(** :ref:`Vector3` v **)** Return a vector transformed (multiplied) by the matrix. -.. _class_Basis_xform_inv: + .. _class_Basis_xform_inv: - :ref:`Vector3` **xform_inv** **(** :ref:`Vector3` v **)** Return a vector transformed (multiplied) by the transposed matrix. Note that this results in a multiplication by the inverse of the matrix only if it represents a rotation-reflection. - diff --git a/classes/class_bitmap.rst b/classes/class_bitmap.rst index d1ba56134..e96d9d55d 100644 --- a/classes/class_bitmap.rst +++ b/classes/class_bitmap.rst @@ -8,6 +8,7 @@ BitMap ====== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -46,54 +47,53 @@ A two-dimensional array of boolean values, can be used to efficiently store a bi Method Descriptions ------------------- -.. _class_BitMap_create: + .. _class_BitMap_create: - void **create** **(** :ref:`Vector2` size **)** Creates a bitmap with the specified size, filled with false. -.. _class_BitMap_create_from_image_alpha: + .. _class_BitMap_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_get_bit: - :ref:`bool` **get_bit** **(** :ref:`Vector2` position **)** const Returns bitmap's value at the specified position. -.. _class_BitMap_get_size: + .. _class_BitMap_get_size: - :ref:`Vector2` **get_size** **(** **)** const Returns bitmap's dimensions. -.. _class_BitMap_get_true_bit_count: + .. _class_BitMap_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_grow_mask: - void **grow_mask** **(** :ref:`int` pixels, :ref:`Rect2` rect **)** -.. _class_BitMap_opaque_to_polygons: + .. _class_BitMap_opaque_to_polygons: - :ref:`Array` **opaque_to_polygons** **(** :ref:`Rect2` rect, :ref:`float` epsilon=2.0 **)** const -.. _class_BitMap_set_bit: + .. _class_BitMap_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_set_bit_rect: - void **set_bit_rect** **(** :ref:`Rect2` p_rect, :ref:`bool` bit **)** Sets a rectangular portion of the bitmap to the specified value. - diff --git a/classes/class_bitmapfont.rst b/classes/class_bitmapfont.rst index 096937f75..d0c562276 100644 --- a/classes/class_bitmapfont.rst +++ b/classes/class_bitmapfont.rst @@ -8,6 +8,7 @@ BitmapFont ========== **Inherits:** :ref:`Font` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,19 @@ Brief Description Renders text using ``*.fnt`` fonts. +Properties +---------- + ++-------------------------------------+--------------------------------------------------------+ +| :ref:`float` | :ref:`ascent` | ++-------------------------------------+--------------------------------------------------------+ +| :ref:`bool` | :ref:`distance_field` | ++-------------------------------------+--------------------------------------------------------+ +| :ref:`BitmapFont` | :ref:`fallback` | ++-------------------------------------+--------------------------------------------------------+ +| :ref:`float` | :ref:`height` | ++-------------------------------------+--------------------------------------------------------+ + Methods ------- @@ -48,76 +62,106 @@ Property Descriptions .. _class_BitmapFont_ascent: -- :ref:`float` **ascent** - Ascent (number of pixels above the baseline). +- :ref:`float` **ascent** + ++----------+-------------------+ +| *Setter* | set_ascent(value) | ++----------+-------------------+ +| *Getter* | get_ascent() | ++----------+-------------------+ + +Ascent (number of pixels above the baseline). .. _class_BitmapFont_distance_field: -- :ref:`bool` **distance_field** - If ``true`` distance field hint is enabled. +- :ref:`bool` **distance_field** + ++----------+--------------------------------+ +| *Setter* | set_distance_field_hint(value) | ++----------+--------------------------------+ +| *Getter* | is_distance_field_hint() | ++----------+--------------------------------+ + +If ``true`` distance field hint is enabled. .. _class_BitmapFont_fallback: -- :ref:`BitmapFont` **fallback** - The fallback font. +- :ref:`BitmapFont` **fallback** + ++----------+---------------------+ +| *Setter* | set_fallback(value) | ++----------+---------------------+ +| *Getter* | get_fallback() | ++----------+---------------------+ + +The fallback font. .. _class_BitmapFont_height: -- :ref:`float` **height** - Total font height (ascent plus descent) in pixels. +- :ref:`float` **height** ++----------+-------------------+ +| *Setter* | set_height(value) | ++----------+-------------------+ +| *Getter* | get_height() | ++----------+-------------------+ + +Total font height (ascent plus descent) in pixels. Method Descriptions ------------------- -.. _class_BitmapFont_add_char: + .. _class_BitmapFont_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_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_add_texture: - void **add_texture** **(** :ref:`Texture` texture **)** Adds a texture to the ``BitmapFont``. -.. _class_BitmapFont_clear: + .. _class_BitmapFont_clear: - void **clear** **(** **)** Clears all the font data and settings. -.. _class_BitmapFont_create_from_fnt: + .. _class_BitmapFont_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_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_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_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_get_texture_count: - :ref:`int` **get_texture_count** **(** **)** const Returns the number of textures in the BitmapFont atlas. - diff --git a/classes/class_bone2d.rst b/classes/class_bone2d.rst index d58f05558..4b25398ed 100644 --- a/classes/class_bone2d.rst +++ b/classes/class_bone2d.rst @@ -8,6 +8,7 @@ Bone2D ====== **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description +Properties +---------- + ++---------------------------------------+----------------------------------------------------+ +| :ref:`float` | :ref:`default_length` | ++---------------------------------------+----------------------------------------------------+ +| :ref:`Transform2D` | :ref:`rest` | ++---------------------------------------+----------------------------------------------------+ + Methods ------- @@ -33,24 +43,34 @@ Property Descriptions - :ref:`float` **default_length** ++----------+---------------------------+ +| *Setter* | set_default_length(value) | ++----------+---------------------------+ +| *Getter* | get_default_length() | ++----------+---------------------------+ + .. _class_Bone2D_rest: - :ref:`Transform2D` **rest** ++----------+-----------------+ +| *Setter* | set_rest(value) | ++----------+-----------------+ +| *Getter* | get_rest() | ++----------+-----------------+ Method Descriptions ------------------- -.. _class_Bone2D_apply_rest: + .. _class_Bone2D_apply_rest: - void **apply_rest** **(** **)** -.. _class_Bone2D_get_index_in_skeleton: + .. _class_Bone2D_get_index_in_skeleton: - :ref:`int` **get_index_in_skeleton** **(** **)** const -.. _class_Bone2D_get_skeleton_rest: + .. _class_Bone2D_get_skeleton_rest: - :ref:`Transform2D` **get_skeleton_rest** **(** **)** const - diff --git a/classes/class_boneattachment.rst b/classes/class_boneattachment.rst index 6eeb85278..bd504fa7e 100644 --- a/classes/class_boneattachment.rst +++ b/classes/class_boneattachment.rst @@ -8,6 +8,7 @@ BoneAttachment ============== **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description A node that will attach to a bone. +Properties +---------- + ++-----------------------------+--------------------------------------------------+ +| :ref:`String` | :ref:`bone_name` | ++-----------------------------+--------------------------------------------------+ + Description ----------- @@ -25,6 +33,13 @@ Property Descriptions .. _class_BoneAttachment_bone_name: -- :ref:`String` **bone_name** - The name of the attached bone. +- :ref:`String` **bone_name** ++----------+----------------------+ +| *Setter* | set_bone_name(value) | ++----------+----------------------+ +| *Getter* | get_bone_name() | ++----------+----------------------+ + +The name of the attached bone. diff --git a/classes/class_bool.rst b/classes/class_bool.rst index 7878f9bd1..27d1d493a 100644 --- a/classes/class_bool.rst +++ b/classes/class_bool.rst @@ -33,22 +33,21 @@ Boolean built-in type. Method Descriptions ------------------- -.. _class_bool_bool: + .. _class_bool_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: + .. _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: + .. _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 da6a3db67..b859d4fcf 100644 --- a/classes/class_boxcontainer.rst +++ b/classes/class_boxcontainer.rst @@ -8,7 +8,9 @@ BoxContainer ============ **Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`VBoxContainer`, :ref:`HBoxContainer`, :ref:`ColorPicker` + **Category:** Core Brief Description @@ -16,6 +18,13 @@ Brief Description Base class for box containers. +Properties +---------- + ++-----------------------------------------------+------------------------------------------------+ +| :ref:`AlignMode` | :ref:`alignment` | ++-----------------------------------------------+------------------------------------------------+ + Methods ------- @@ -28,13 +37,12 @@ Enumerations .. _enum_BoxContainer_AlignMode: -enum **AlignMode** +enum **AlignMode**: - **ALIGN_BEGIN** = **0** --- Aligns children with the beginning of the container. - **ALIGN_CENTER** = **1** --- Aligns children with the center of the container. - **ALIGN_END** = **2** --- Aligns children with the end of the container. - Description ----------- @@ -45,16 +53,22 @@ Property Descriptions .. _class_BoxContainer_alignment: -- :ref:`AlignMode` **alignment** - The alignment of the container's children (must be one of ALIGN_BEGIN, ALIGN_CENTER, or ALIGN_END). +- :ref:`AlignMode` **alignment** ++----------+----------------------+ +| *Setter* | set_alignment(value) | ++----------+----------------------+ +| *Getter* | get_alignment() | ++----------+----------------------+ + +The alignment of the container's children (must be one of ALIGN_BEGIN, ALIGN_CENTER, or ALIGN_END). Method Descriptions ------------------- -.. _class_BoxContainer_add_spacer: + .. _class_BoxContainer_add_spacer: - void **add_spacer** **(** :ref:`bool` begin **)** Adds a control to the box as a spacer. If ``true``, *begin* will insert the spacer control in front of other children. - diff --git a/classes/class_boxshape.rst b/classes/class_boxshape.rst index c35d754df..7fcbf8e31 100644 --- a/classes/class_boxshape.rst +++ b/classes/class_boxshape.rst @@ -8,6 +8,7 @@ BoxShape ======== **Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Box shape resource. +Properties +---------- + ++-------------------------------+----------------------------------------+ +| :ref:`Vector3` | :ref:`extents` | ++-------------------------------+----------------------------------------+ + Description ----------- @@ -25,6 +33,13 @@ Property Descriptions .. _class_BoxShape_extents: -- :ref:`Vector3` **extents** - The shape's half extents. +- :ref:`Vector3` **extents** ++----------+--------------------+ +| *Setter* | set_extents(value) | ++----------+--------------------+ +| *Getter* | get_extents() | ++----------+--------------------+ + +The shape's half extents. diff --git a/classes/class_bulletphysicsdirectbodystate.rst b/classes/class_bulletphysicsdirectbodystate.rst index 200e557aa..285402546 100644 --- a/classes/class_bulletphysicsdirectbodystate.rst +++ b/classes/class_bulletphysicsdirectbodystate.rst @@ -8,6 +8,7 @@ BulletPhysicsDirectBodyState ============================ **Inherits:** :ref:`PhysicsDirectBodyState` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_bulletphysicsserver.rst b/classes/class_bulletphysicsserver.rst index 52112c1f0..1044d1360 100644 --- a/classes/class_bulletphysicsserver.rst +++ b/classes/class_bulletphysicsserver.rst @@ -8,6 +8,7 @@ BulletPhysicsServer =================== **Inherits:** :ref:`PhysicsServer` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_button.rst b/classes/class_button.rst index d879db459..5084be899 100644 --- a/classes/class_button.rst +++ b/classes/class_button.rst @@ -8,7 +8,9 @@ Button ====== **Inherits:** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`OptionButton`, :ref:`ColorPickerButton`, :ref:`CheckButton`, :ref:`MenuButton`, :ref:`ToolButton`, :ref:`CheckBox` + **Category:** Core Brief Description @@ -16,18 +18,59 @@ Brief Description 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` | ++-----------------------------------------+------------------------------------------+ + +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` | ++---------------------------------+--------------------------------------------------------------+ + Enumerations ------------ .. _enum_Button_TextAlign: -enum **TextAlign** +enum **TextAlign**: - **ALIGN_LEFT** = **0** --- Align the text to the left. - **ALIGN_CENTER** = **1** --- Align the text to the center. - **ALIGN_RIGHT** = **2** --- Align the text to the right. - Description ----------- @@ -38,22 +81,61 @@ Property Descriptions .. _class_Button_align: -- :ref:`TextAlign` **align** - Text alignment policy for the button's text, use one of the ALIGN\_\* constants. +- :ref:`TextAlign` **align** + ++----------+-----------------------+ +| *Setter* | set_text_align(value) | ++----------+-----------------------+ +| *Getter* | get_text_align() | ++----------+-----------------------+ + +Text alignment policy for the button's text, use one of the ALIGN\_\* constants. .. _class_Button_clip_text: -- :ref:`bool` **clip_text** - 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. +- :ref:`bool` **clip_text** + ++----------+----------------------+ +| *Setter* | set_clip_text(value) | ++----------+----------------------+ +| *Getter* | get_clip_text() | ++----------+----------------------+ + +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: -- :ref:`bool` **flat** - Flat buttons don't display decoration. +- :ref:`bool` **flat** + ++----------+-----------------+ +| *Setter* | set_flat(value) | ++----------+-----------------+ +| *Getter* | is_flat() | ++----------+-----------------+ + +Flat buttons don't display decoration. .. _class_Button_icon: -- :ref:`Texture` **icon** - Button's icon, if text is present the icon will be placed before the text. +- :ref:`Texture` **icon** + ++----------+------------------------+ +| *Setter* | set_button_icon(value) | ++----------+------------------------+ +| *Getter* | get_button_icon() | ++----------+------------------------+ + +Button's icon, if text is present the icon will be placed before the text. .. _class_Button_text: -- :ref:`String` **text** - The button's text that will be displayed inside the button's area. +- :ref:`String` **text** ++----------+-----------------+ +| *Setter* | set_text(value) | ++----------+-----------------+ +| *Getter* | get_text() | ++----------+-----------------+ + +The button's text that will be displayed inside the button's area. diff --git a/classes/class_buttongroup.rst b/classes/class_buttongroup.rst index 22fb6222c..1a13909f8 100644 --- a/classes/class_buttongroup.rst +++ b/classes/class_buttongroup.rst @@ -8,6 +8,7 @@ ButtonGroup =========== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -22,6 +23,13 @@ Methods | :ref:`BaseButton` | :ref:`get_pressed_button` **(** **)** | +--------------------------------------+-----------------------------------------------------------------------------+ +Theme Properties +---------------- + ++---------------------------------+---------------------------------------+ +| :ref:`StyleBox` | :ref:`panel` | ++---------------------------------+---------------------------------------+ + Description ----------- @@ -32,10 +40,9 @@ Group of :ref:`Button`. All direct and indirect children buttons b Method Descriptions ------------------- -.. _class_ButtonGroup_get_pressed_button: + .. _class_ButtonGroup_get_pressed_button: - :ref:`BaseButton` **get_pressed_button** **(** **)** Return the pressed button. - diff --git a/classes/class_camera.rst b/classes/class_camera.rst index 039f97783..ee226b1d5 100644 --- a/classes/class_camera.rst +++ b/classes/class_camera.rst @@ -8,7 +8,9 @@ Camera ====== **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`InterpolatedCamera`, :ref:`ClippedCamera`, :ref:`ARVRCamera` + **Category:** Core Brief Description @@ -16,6 +18,35 @@ Brief Description 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` | ++-----------------------------------------------------+--------------------------------------------------------+ + Methods ------- @@ -52,7 +83,7 @@ Enumerations .. _enum_Camera_DopplerTracking: -enum **DopplerTracking** +enum **DopplerTracking**: - **DOPPLER_TRACKING_DISABLED** = **0** --- Disable Doppler effect simulation (default). - **DOPPLER_TRACKING_IDLE_STEP** = **1** --- Simulate Doppler effect by tracking positions of objects that are changed in ``_process``. Changes in the relative velocity of this Camera compared to those objects affect how Audio is perceived (changing the Audio's ``pitch shift``). @@ -60,19 +91,18 @@ enum **DopplerTracking** .. _enum_Camera_Projection: -enum **Projection** +enum **Projection**: - **PROJECTION_PERSPECTIVE** = **0** --- Perspective Projection (object's size on the screen becomes smaller when far away). - **PROJECTION_ORTHOGONAL** = **1** --- Orthogonal Projection (objects remain the same size on the screen no matter how far away they are). .. _enum_Camera_KeepAspect: -enum **KeepAspect** +enum **KeepAspect**: - **KEEP_WIDTH** = **0** --- Preserves the horizontal aspect ratio. - **KEEP_HEIGHT** = **1** --- Preserves the vertical aspect ratio. - Description ----------- @@ -83,128 +113,222 @@ Property Descriptions .. _class_Camera_cull_mask: -- :ref:`int` **cull_mask** - The culling mask that describes which 3D render layers are rendered by this camera. +- :ref:`int` **cull_mask** + ++----------+----------------------+ +| *Setter* | set_cull_mask(value) | ++----------+----------------------+ +| *Getter* | get_cull_mask() | ++----------+----------------------+ + +The culling mask that describes which 3D render layers are rendered by this camera. .. _class_Camera_current: -- :ref:`bool` **current** - If ``true`` the ancestor :ref:`Viewport` is currently using this Camera. Default value: ``false``. +- :ref:`bool` **current** + ++----------+--------------------+ +| *Setter* | set_current(value) | ++----------+--------------------+ +| *Getter* | is_current() | ++----------+--------------------+ + +If ``true`` the ancestor :ref:`Viewport` is currently using this Camera. Default value: ``false``. .. _class_Camera_doppler_tracking: -- :ref:`DopplerTracking` **doppler_tracking** - If not ``DOPPLER_TRACKING_DISABLED`` this Camera will simulate the Doppler effect for objects changed in particular ``_process`` methods. Default value: ``DOPPLER_TRACKING_DISABLED``. +- :ref:`DopplerTracking` **doppler_tracking** + ++----------+-----------------------------+ +| *Setter* | set_doppler_tracking(value) | ++----------+-----------------------------+ +| *Getter* | get_doppler_tracking() | ++----------+-----------------------------+ + +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: -- :ref:`Environment` **environment** - The :ref:`Environment` to use for this Camera. +- :ref:`Environment` **environment** + ++----------+------------------------+ +| *Setter* | set_environment(value) | ++----------+------------------------+ +| *Getter* | get_environment() | ++----------+------------------------+ + +The :ref:`Environment` to use for this Camera. .. _class_Camera_far: -- :ref:`float` **far** - The distance to the far culling boundary for this Camera relative to its local z-axis. +- :ref:`float` **far** + ++----------+-----------------+ +| *Setter* | set_zfar(value) | ++----------+-----------------+ +| *Getter* | get_zfar() | ++----------+-----------------+ + +The distance to the far culling boundary for this Camera relative to its local z-axis. .. _class_Camera_fov: -- :ref:`float` **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. +- :ref:`float` **fov** + ++----------+----------------+ +| *Setter* | set_fov(value) | ++----------+----------------+ +| *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. .. _class_Camera_h_offset: -- :ref:`float` **h_offset** - The horizontal (X) offset of the Camera viewport. +- :ref:`float` **h_offset** + ++----------+---------------------+ +| *Setter* | set_h_offset(value) | ++----------+---------------------+ +| *Getter* | get_h_offset() | ++----------+---------------------+ + +The horizontal (X) offset of the Camera viewport. .. _class_Camera_keep_aspect: -- :ref:`KeepAspect` **keep_aspect** - The axis to lock during :ref:`fov`/:ref:`size` adjustments. Can be either ``KEEP_WIDTH`` or ``KEEP_HEIGHT``. +- :ref:`KeepAspect` **keep_aspect** + ++----------+-----------------------------+ +| *Setter* | set_keep_aspect_mode(value) | ++----------+-----------------------------+ +| *Getter* | get_keep_aspect_mode() | ++----------+-----------------------------+ + +The axis to lock during :ref:`fov`/:ref:`size` adjustments. Can be either ``KEEP_WIDTH`` or ``KEEP_HEIGHT``. .. _class_Camera_near: -- :ref:`float` **near** - The distance to the near culling boundary for this Camera relative to its local z-axis. +- :ref:`float` **near** + ++----------+------------------+ +| *Setter* | set_znear(value) | ++----------+------------------+ +| *Getter* | get_znear() | ++----------+------------------+ + +The distance to the near culling boundary for this Camera relative to its local z-axis. .. _class_Camera_projection: -- :ref:`Projection` **projection** - The camera's projection mode. In ``PROJECTION_PERSPECTIVE`` mode, objects' z-distance from the camera's local space scales their perceived size. +- :ref:`Projection` **projection** + ++----------+-----------------------+ +| *Setter* | set_projection(value) | ++----------+-----------------------+ +| *Getter* | get_projection() | ++----------+-----------------------+ + +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: -- :ref:`float` **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. +- :ref:`float` **size** + ++----------+-----------------+ +| *Setter* | set_size(value) | ++----------+-----------------+ +| *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. .. _class_Camera_v_offset: -- :ref:`float` **v_offset** - The vertical (Y) offset of the Camera viewport. +- :ref:`float` **v_offset** ++----------+---------------------+ +| *Setter* | set_v_offset(value) | ++----------+---------------------+ +| *Getter* | get_v_offset() | ++----------+---------------------+ + +The vertical (Y) offset of the Camera viewport. Method Descriptions ------------------- -.. _class_Camera_clear_current: + .. _class_Camera_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_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_get_cull_mask_bit: - :ref:`bool` **get_cull_mask_bit** **(** :ref:`int` layer **)** const -.. _class_Camera_is_position_behind: + .. _class_Camera_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_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_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_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_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_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_set_cull_mask_bit: - void **set_cull_mask_bit** **(** :ref:`int` layer, :ref:`bool` enable **)** -.. _class_Camera_set_orthogonal: + .. _class_Camera_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_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_unproject_position: - :ref:`Vector2` **unproject_position** **(** :ref:`Vector3` world_point **)** const Returns the 2D coordinate in the :ref:`Viewport` rectangle that maps to the given 3D point in worldspace. - diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index 89122d5c8..1080607df 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -8,6 +8,7 @@ Camera2D ======== **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,59 @@ Brief Description 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:`bool` | :ref:`rotating` | ++---------------------------------------------+------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`smoothing_enabled` | ++---------------------------------------------+------------------------------------------------------------------------+ +| :ref:`float` | :ref:`smoothing_speed` | ++---------------------------------------------+------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`zoom` | ++---------------------------------------------+------------------------------------------------------------------------+ + Methods ------- @@ -39,12 +93,11 @@ Enumerations .. _enum_Camera2D_AnchorMode: -enum **AnchorMode** +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. - **ANCHOR_MODE_DRAG_CENTER** = **1** --- The camera's position takes into account vertical/horizontal offsets and the screen size. - Description ----------- @@ -57,141 +110,330 @@ Property Descriptions .. _class_Camera2D_anchor_mode: -- :ref:`AnchorMode` **anchor_mode** - The Camera2D's anchor point. See ``ANCHOR_MODE_*`` constants. +- :ref:`AnchorMode` **anchor_mode** + ++----------+------------------------+ +| *Setter* | set_anchor_mode(value) | ++----------+------------------------+ +| *Getter* | get_anchor_mode() | ++----------+------------------------+ + +The Camera2D's anchor point. See ``ANCHOR_MODE_*`` constants. .. _class_Camera2D_current: -- :ref:`bool` **current** - 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. +- :ref:`bool` **current** + ++----------+--------------+ +| *Getter* | is_current() | ++----------+--------------+ + +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: -- :ref:`Node` **custom_viewport** - The custom :ref:`Viewport` node attached to the ``Camera2D``. If null or not a :ref:`Viewport`, uses the default viewport instead. +- :ref:`Node` **custom_viewport** + ++----------+----------------------------+ +| *Setter* | set_custom_viewport(value) | ++----------+----------------------------+ +| *Getter* | get_custom_viewport() | ++----------+----------------------------+ + +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: -- :ref:`float` **drag_margin_bottom** - Bottom margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen. +- :ref:`float` **drag_margin_bottom** + ++----------+------------------------+ +| *Setter* | set_drag_margin(value) | ++----------+------------------------+ +| *Getter* | get_drag_margin() | ++----------+------------------------+ + +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: -- :ref:`bool` **drag_margin_h_enabled** - If ``true`` the camera only moves when reaching the horizontal drag margins. If ``false`` the camera moves horizontally regardless of margins. Default value: ``true``. +- :ref:`bool` **drag_margin_h_enabled** + ++----------+---------------------------+ +| *Setter* | set_h_drag_enabled(value) | ++----------+---------------------------+ +| *Getter* | is_h_drag_enabled() | ++----------+---------------------------+ + +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: -- :ref:`float` **drag_margin_left** - Left margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen. +- :ref:`float` **drag_margin_left** + ++----------+------------------------+ +| *Setter* | set_drag_margin(value) | ++----------+------------------------+ +| *Getter* | get_drag_margin() | ++----------+------------------------+ + +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: -- :ref:`float` **drag_margin_right** - Right margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen. +- :ref:`float` **drag_margin_right** + ++----------+------------------------+ +| *Setter* | set_drag_margin(value) | ++----------+------------------------+ +| *Getter* | get_drag_margin() | ++----------+------------------------+ + +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: -- :ref:`float` **drag_margin_top** - Top margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen. +- :ref:`float` **drag_margin_top** + ++----------+------------------------+ +| *Setter* | set_drag_margin(value) | ++----------+------------------------+ +| *Getter* | get_drag_margin() | ++----------+------------------------+ + +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: -- :ref:`bool` **drag_margin_v_enabled** - If ``true`` the camera only moves when reaching the vertical drag margins. If ``false`` the camera moves vertically regardless of margins. Default value: ``true``. +- :ref:`bool` **drag_margin_v_enabled** + ++----------+---------------------------+ +| *Setter* | set_v_drag_enabled(value) | ++----------+---------------------------+ +| *Getter* | is_v_drag_enabled() | ++----------+---------------------------+ + +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: -- :ref:`bool` **editor_draw_drag_margin** - If ``true`` draws the camera's drag margin rectangle in the editor. Default value: ``false`` +- :ref:`bool` **editor_draw_drag_margin** + ++----------+-----------------------------------+ +| *Setter* | set_margin_drawing_enabled(value) | ++----------+-----------------------------------+ +| *Getter* | is_margin_drawing_enabled() | ++----------+-----------------------------------+ + +If ``true`` draws the camera's drag margin rectangle in the editor. Default value: ``false`` .. _class_Camera2D_editor_draw_limits: -- :ref:`bool` **editor_draw_limits** - If ``true`` draws the camera's limits rectangle in the editor. Default value: ``true`` +- :ref:`bool` **editor_draw_limits** + ++----------+----------------------------------+ +| *Setter* | set_limit_drawing_enabled(value) | ++----------+----------------------------------+ +| *Getter* | is_limit_drawing_enabled() | ++----------+----------------------------------+ + +If ``true`` draws the camera's limits rectangle in the editor. Default value: ``true`` .. _class_Camera2D_editor_draw_screen: -- :ref:`bool` **editor_draw_screen** - If ``true`` draws the camera's screen rectangle in the editor. Default value: ``false`` +- :ref:`bool` **editor_draw_screen** + ++----------+-----------------------------------+ +| *Setter* | set_screen_drawing_enabled(value) | ++----------+-----------------------------------+ +| *Getter* | is_screen_drawing_enabled() | ++----------+-----------------------------------+ + +If ``true`` draws the camera's screen rectangle in the editor. Default value: ``false`` .. _class_Camera2D_limit_bottom: -- :ref:`int` **limit_bottom** - Bottom scroll limit in pixels. The camera stops moving when reaching this value. +- :ref:`int` **limit_bottom** + ++----------+------------------+ +| *Setter* | set_limit(value) | ++----------+------------------+ +| *Getter* | get_limit() | ++----------+------------------+ + +Bottom scroll limit in pixels. The camera stops moving when reaching this value. .. _class_Camera2D_limit_left: -- :ref:`int` **limit_left** - Left scroll limit in pixels. The camera stops moving when reaching this value. +- :ref:`int` **limit_left** + ++----------+------------------+ +| *Setter* | set_limit(value) | ++----------+------------------+ +| *Getter* | get_limit() | ++----------+------------------+ + +Left scroll limit in pixels. The camera stops moving when reaching this value. .. _class_Camera2D_limit_right: -- :ref:`int` **limit_right** - Right scroll limit in pixels. The camera stops moving when reaching this value. +- :ref:`int` **limit_right** + ++----------+------------------+ +| *Setter* | set_limit(value) | ++----------+------------------+ +| *Getter* | get_limit() | ++----------+------------------+ + +Right scroll limit in pixels. The camera stops moving when reaching this value. .. _class_Camera2D_limit_smoothed: -- :ref:`bool` **limit_smoothed** - If ``true`` the camera smoothly stops when reaches its limits. Default value: ``false`` +- :ref:`bool` **limit_smoothed** + ++----------+------------------------------------+ +| *Setter* | set_limit_smoothing_enabled(value) | ++----------+------------------------------------+ +| *Getter* | is_limit_smoothing_enabled() | ++----------+------------------------------------+ + +If ``true`` the camera smoothly stops when reaches its limits. Default value: ``false`` .. _class_Camera2D_limit_top: -- :ref:`int` **limit_top** - Top scroll limit in pixels. The camera stops moving when reaching this value. +- :ref:`int` **limit_top** + ++----------+------------------+ +| *Setter* | set_limit(value) | ++----------+------------------+ +| *Getter* | get_limit() | ++----------+------------------+ + +Top scroll limit in pixels. The camera stops moving when reaching this value. .. _class_Camera2D_offset: -- :ref:`Vector2` **offset** - The camera's offset, useful for looking around or camera shake animations. +- :ref:`Vector2` **offset** + ++----------+-------------------+ +| *Setter* | set_offset(value) | ++----------+-------------------+ +| *Getter* | get_offset() | ++----------+-------------------+ + +The camera's offset, useful for looking around or camera shake animations. .. _class_Camera2D_offset_h: -- :ref:`float` **offset_h** - The horizontal offset of the camera, relative to the drag margins. Default value: ``0`` +- :ref:`float` **offset_h** + ++----------+---------------------+ +| *Setter* | set_h_offset(value) | ++----------+---------------------+ +| *Getter* | get_h_offset() | ++----------+---------------------+ + +The horizontal offset of the camera, relative to the drag margins. Default value: ``0`` .. _class_Camera2D_offset_v: -- :ref:`float` **offset_v** - The vertical offset of the camera, relative to the drag margins. Default value: ``0`` +- :ref:`float` **offset_v** + ++----------+---------------------+ +| *Setter* | set_v_offset(value) | ++----------+---------------------+ +| *Getter* | get_v_offset() | ++----------+---------------------+ + +The vertical offset of the camera, relative to the drag margins. Default value: ``0`` .. _class_Camera2D_rotating: -- :ref:`bool` **rotating** - If ``true`` the camera rotates with the target. Default value: ``false`` +- :ref:`bool` **rotating** + ++----------+---------------------+ +| *Setter* | set_rotating(value) | ++----------+---------------------+ +| *Getter* | is_rotating() | ++----------+---------------------+ + +If ``true`` the camera rotates with the target. Default value: ``false`` .. _class_Camera2D_smoothing_enabled: -- :ref:`bool` **smoothing_enabled** - If ``true`` the camera smoothly moves towards the target at :ref:`smoothing_speed`. Default value: ``false`` +- :ref:`bool` **smoothing_enabled** + ++----------+------------------------------------+ +| *Setter* | set_enable_follow_smoothing(value) | ++----------+------------------------------------+ +| *Getter* | is_follow_smoothing_enabled() | ++----------+------------------------------------+ + +If ``true`` the camera smoothly moves towards the target at :ref:`smoothing_speed`. Default value: ``false`` .. _class_Camera2D_smoothing_speed: -- :ref:`float` **smoothing_speed** - Speed in pixels per second of the camera's smoothing effect when :ref:`smoothing_enabled` is ``true`` +- :ref:`float` **smoothing_speed** + ++----------+-----------------------------+ +| *Setter* | set_follow_smoothing(value) | ++----------+-----------------------------+ +| *Getter* | get_follow_smoothing() | ++----------+-----------------------------+ + +Speed in pixels per second of the camera's smoothing effect when :ref:`smoothing_enabled` is ``true`` .. _class_Camera2D_zoom: -- :ref:`Vector2` **zoom** - The camera's zoom relative to the viewport. Values larger than ``Vector2(1, 1)`` zoom out and smaller values zoom in. For an example, use ``Vector2(0.5, 0.5)`` for a 2x zoom in, and ``Vector2(4, 4)`` for a 4x zoom out. +- :ref:`Vector2` **zoom** ++----------+-----------------+ +| *Setter* | set_zoom(value) | ++----------+-----------------+ +| *Getter* | get_zoom() | ++----------+-----------------+ + +The camera's zoom relative to the viewport. Values larger than ``Vector2(1, 1)`` zoom out and smaller values zoom in. For an example, use ``Vector2(0.5, 0.5)`` for a 2x zoom in, and ``Vector2(4, 4)`` for a 4x zoom out. Method Descriptions ------------------- -.. _class_Camera2D_align: + .. _class_Camera2D_align: - void **align** **(** **)** Align the camera to the tracked node -.. _class_Camera2D_clear_current: + .. _class_Camera2D_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_force_update_scroll: - void **force_update_scroll** **(** **)** Force the camera to update scroll immediately. -.. _class_Camera2D_get_camera_position: + .. _class_Camera2D_get_camera_position: - :ref:`Vector2` **get_camera_position** **(** **)** const Return the camera position. -.. _class_Camera2D_get_camera_screen_center: + .. _class_Camera2D_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_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_reset_smoothing: - void **reset_smoothing** **(** **)** @@ -199,4 +441,3 @@ Set the camera's position immediately to its current smoothing destination. This has no effect if smoothing is disabled. - diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index 1e2abd8c5..922eb696b 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -8,7 +8,9 @@ CanvasItem ========== **Inherits:** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`Node2D`, :ref:`Control` + **Category:** Core Brief Description @@ -16,6 +18,27 @@ Brief Description 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` | ++---------------------------------+------------------------------------------------------------------+ + Methods ------- @@ -114,37 +137,36 @@ Methods Signals ------- -.. _class_CanvasItem_draw: + .. _class_CanvasItem_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_hide: - **hide** **(** **)** Emitted when becoming hidden. -.. _class_CanvasItem_item_rect_changed: + .. _class_CanvasItem_item_rect_changed: - **item_rect_changed** **(** **)** Emitted when the item rect has changed. -.. _class_CanvasItem_visibility_changed: + .. _class_CanvasItem_visibility_changed: - **visibility_changed** **(** **)** Emitted when the visibility (hidden/visible) changes. - Enumerations ------------ .. _enum_CanvasItem_BlendMode: -enum **BlendMode** +enum **BlendMode**: - **BLEND_MODE_MIX** = **0** --- Mix blending mode. Colors are assumed to be independent of the alpha (opacity) value. - **BLEND_MODE_ADD** = **1** --- Additive blending mode. @@ -153,7 +175,6 @@ enum **BlendMode** - **BLEND_MODE_PREMULT_ALPHA** = **4** --- Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value. - **BLEND_MODE_DISABLED** = **5** --- Disable blending mode. Colors including alpha are written as is. Only applicable for render targets with a transparent background. No lighting will be applied. - Constants --------- @@ -162,7 +183,6 @@ Constants - **NOTIFICATION_VISIBILITY_CHANGED** = **31** --- Canvas item visibility has changed. - **NOTIFICATION_ENTER_CANVAS** = **32** --- Canvas item has entered the canvas. - **NOTIFICATION_EXIT_CANVAS** = **33** --- Canvas item has exited the canvas. - Description ----------- @@ -181,308 +201,363 @@ Tutorials - :doc:`../tutorials/2d/2d_transforms` - :doc:`../tutorials/2d/custom_drawing_in_2d` - Property Descriptions --------------------- .. _class_CanvasItem_light_mask: -- :ref:`int` **light_mask** - The rendering layers in which this ``CanvasItem`` responds to :ref:`Light2D` nodes. Default value: ``1``. +- :ref:`int` **light_mask** + ++----------+-----------------------+ +| *Setter* | set_light_mask(value) | ++----------+-----------------------+ +| *Getter* | get_light_mask() | ++----------+-----------------------+ + +The rendering layers in which this ``CanvasItem`` responds to :ref:`Light2D` nodes. Default value: ``1``. .. _class_CanvasItem_material: -- :ref:`Material` **material** - The material applied to textures on this ``CanvasItem``. Default value: ``null``. +- :ref:`Material` **material** + ++----------+---------------------+ +| *Setter* | set_material(value) | ++----------+---------------------+ +| *Getter* | get_material() | ++----------+---------------------+ + +The material applied to textures on this ``CanvasItem``. Default value: ``null``. .. _class_CanvasItem_modulate: -- :ref:`Color` **modulate** - The color applied to textures on this ``CanvasItem``. Default value: ``Color(1, 1, 1, 1)`` (opaque "white"). +- :ref:`Color` **modulate** + ++----------+---------------------+ +| *Setter* | set_modulate(value) | ++----------+---------------------+ +| *Getter* | get_modulate() | ++----------+---------------------+ + +The color applied to textures on this ``CanvasItem``. Default value: ``Color(1, 1, 1, 1)`` (opaque "white"). .. _class_CanvasItem_self_modulate: -- :ref:`Color` **self_modulate** - 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").. +- :ref:`Color` **self_modulate** + ++----------+--------------------------+ +| *Setter* | set_self_modulate(value) | ++----------+--------------------------+ +| *Getter* | get_self_modulate() | ++----------+--------------------------+ + +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: -- :ref:`bool` **show_behind_parent** - If ``true`` the object draws behind its parent. Default value: ``false``. +- :ref:`bool` **show_behind_parent** + ++----------+---------------------------------+ +| *Setter* | set_draw_behind_parent(value) | ++----------+---------------------------------+ +| *Getter* | is_draw_behind_parent_enabled() | ++----------+---------------------------------+ + +If ``true`` the object draws behind its parent. Default value: ``false``. .. _class_CanvasItem_show_on_top: -- :ref:`bool` **show_on_top** - If ``true`` the object draws on top of its parent. Default value: ``true``. +- :ref:`bool` **show_on_top** + +If ``true`` the object draws on top of its parent. Default value: ``true``. .. _class_CanvasItem_use_parent_material: -- :ref:`bool` **use_parent_material** - If ``true`` the parent ``CanvasItem``'s :ref:`material` property is used as this one's material. Default value: ``false``. +- :ref:`bool` **use_parent_material** + ++----------+--------------------------------+ +| *Setter* | set_use_parent_material(value) | ++----------+--------------------------------+ +| *Getter* | get_use_parent_material() | ++----------+--------------------------------+ + +If ``true`` the parent ``CanvasItem``'s :ref:`material` property is used as this one's material. Default value: ``false``. .. _class_CanvasItem_visible: -- :ref:`bool` **visible** - If ``true`` this ``CanvasItem`` is drawn. Default value: ``true``. +- :ref:`bool` **visible** ++----------+--------------------+ +| *Setter* | set_visible(value) | ++----------+--------------------+ +| *Getter* | is_visible() | ++----------+--------------------+ + +If ``true`` this ``CanvasItem`` is drawn. Default value: ``true``. Method Descriptions ------------------- -.. _class_CanvasItem__draw: + .. _class_CanvasItem__draw: - void **_draw** **(** **)** virtual Called (if exists) to draw the canvas item. -.. _class_CanvasItem_draw_char: + .. _class_CanvasItem_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_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_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_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_draw_mesh: - void **draw_mesh** **(** :ref:`Mesh` mesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null **)** -.. _class_CanvasItem_draw_multiline: + .. _class_CanvasItem_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_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_draw_multimesh: - void **draw_multimesh** **(** :ref:`Mesh` mesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null **)** -.. _class_CanvasItem_draw_polygon: + .. _class_CanvasItem_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_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_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_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_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_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_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_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_draw_style_box: - void **draw_style_box** **(** :ref:`StyleBox` style_box, :ref:`Rect2` rect **)** Draws a styled rectangle. -.. _class_CanvasItem_draw_texture: + .. _class_CanvasItem_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_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_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_force_update_transform: - void **force_update_transform** **(** **)** -.. _class_CanvasItem_get_canvas: + .. _class_CanvasItem_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_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_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_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_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_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_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_get_transform: - :ref:`Transform2D` **get_transform** **(** **)** const Get the transform matrix of this item. -.. _class_CanvasItem_get_viewport_rect: + .. _class_CanvasItem_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_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_get_world_2d: - :ref:`World2D` **get_world_2d** **(** **)** const Get the :ref:`World2D` where this item is in. -.. _class_CanvasItem_hide: + .. _class_CanvasItem_hide: - void **hide** **(** **)** Hide the CanvasItem currently visible. -.. _class_CanvasItem_is_local_transform_notification_enabled: + .. _class_CanvasItem_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_is_set_as_toplevel: - :ref:`bool` **is_set_as_toplevel** **(** **)** const Return if set as toplevel. See :ref:`set_as_toplevel`. -.. _class_CanvasItem_is_transform_notification_enabled: + .. _class_CanvasItem_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_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``. -.. _class_CanvasItem_make_canvas_position_local: + .. _class_CanvasItem_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_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_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_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_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_show: - void **show** **(** **)** Show the CanvasItem currently hidden. -.. _class_CanvasItem_update: + .. _class_CanvasItem_update: - void **update** **(** **)** Queue the CanvasItem for update. ``NOTIFICATION_DRAW`` will be called on idle time to request redraw. - diff --git a/classes/class_canvasitemmaterial.rst b/classes/class_canvasitemmaterial.rst index 26fe5811d..dac0a724f 100644 --- a/classes/class_canvasitemmaterial.rst +++ b/classes/class_canvasitemmaterial.rst @@ -8,6 +8,7 @@ CanvasItemMaterial ================== **Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,12 +16,21 @@ Brief Description A material for :ref:`CanvasItem`\ s. +Properties +---------- + ++-----------------------------------------------------+--------------------------------------------------------+ +| :ref:`BlendMode` | :ref:`blend_mode` | ++-----------------------------------------------------+--------------------------------------------------------+ +| :ref:`LightMode` | :ref:`light_mode` | ++-----------------------------------------------------+--------------------------------------------------------+ + Enumerations ------------ .. _enum_CanvasItemMaterial_LightMode: -enum **LightMode** +enum **LightMode**: - **LIGHT_MODE_NORMAL** = **0** --- Render the material using both light and non-light sensitive material properties. - **LIGHT_MODE_UNSHADED** = **1** --- Render the material as if there were no light. @@ -28,7 +38,7 @@ enum **LightMode** .. _enum_CanvasItemMaterial_BlendMode: -enum **BlendMode** +enum **BlendMode**: - **BLEND_MODE_MIX** = **0** --- Mix blending mode. Colors are assumed to be independent of the alpha (opacity) value. - **BLEND_MODE_ADD** = **1** --- Additive blending mode. @@ -36,7 +46,6 @@ enum **BlendMode** - **BLEND_MODE_MUL** = **3** --- Multiplicative blending mode. - **BLEND_MODE_PREMULT_ALPHA** = **4** --- Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value. - Description ----------- @@ -47,10 +56,25 @@ Property Descriptions .. _class_CanvasItemMaterial_blend_mode: -- :ref:`BlendMode` **blend_mode** - The manner in which a material's rendering is applied to underlying textures. +- :ref:`BlendMode` **blend_mode** + ++----------+-----------------------+ +| *Setter* | set_blend_mode(value) | ++----------+-----------------------+ +| *Getter* | get_blend_mode() | ++----------+-----------------------+ + +The manner in which a material's rendering is applied to underlying textures. .. _class_CanvasItemMaterial_light_mode: -- :ref:`LightMode` **light_mode** - The manner in which material reacts to lighting. +- :ref:`LightMode` **light_mode** ++----------+-----------------------+ +| *Setter* | set_light_mode(value) | ++----------+-----------------------+ +| *Getter* | get_light_mode() | ++----------+-----------------------+ + +The manner in which material reacts to lighting. diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index 8467d922f..4aecdc23f 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -8,7 +8,9 @@ CanvasLayer =========== **Inherits:** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`ParallaxBackground` + **Category:** Core Brief Description @@ -16,6 +18,25 @@ Brief Description 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` | ++---------------------------------------+-------------------------------------------------------------+ + Methods ------- @@ -33,46 +54,99 @@ Tutorials - :doc:`../tutorials/2d/2d_transforms` - :doc:`../tutorials/2d/canvas_layers` - Property Descriptions --------------------- .. _class_CanvasLayer_custom_viewport: -- :ref:`Node` **custom_viewport** - The custom :ref:`Viewport` node assigned to the ``CanvasLayer``. If null, uses the default viewport instead. +- :ref:`Node` **custom_viewport** + ++----------+----------------------------+ +| *Setter* | set_custom_viewport(value) | ++----------+----------------------------+ +| *Getter* | get_custom_viewport() | ++----------+----------------------------+ + +The custom :ref:`Viewport` node assigned to the ``CanvasLayer``. If null, uses the default viewport instead. .. _class_CanvasLayer_layer: -- :ref:`int` **layer** - Layer index for draw order. Lower values are drawn first. Default value: ``1``. +- :ref:`int` **layer** + ++----------+------------------+ +| *Setter* | set_layer(value) | ++----------+------------------+ +| *Getter* | get_layer() | ++----------+------------------+ + +Layer index for draw order. Lower values are drawn first. Default value: ``1``. .. _class_CanvasLayer_offset: -- :ref:`Vector2` **offset** - The layer's base offset. +- :ref:`Vector2` **offset** + ++----------+-------------------+ +| *Setter* | set_offset(value) | ++----------+-------------------+ +| *Getter* | get_offset() | ++----------+-------------------+ + +The layer's base offset. .. _class_CanvasLayer_rotation: -- :ref:`float` **rotation** - The layer's rotation in radians. +- :ref:`float` **rotation** + ++----------+---------------------+ +| *Setter* | set_rotation(value) | ++----------+---------------------+ +| *Getter* | get_rotation() | ++----------+---------------------+ + +The layer's rotation in radians. .. _class_CanvasLayer_rotation_degrees: -- :ref:`float` **rotation_degrees** - The layer's rotation in degrees. +- :ref:`float` **rotation_degrees** + ++----------+-----------------------------+ +| *Setter* | set_rotation_degrees(value) | ++----------+-----------------------------+ +| *Getter* | get_rotation_degrees() | ++----------+-----------------------------+ + +The layer's rotation in degrees. .. _class_CanvasLayer_scale: -- :ref:`Vector2` **scale** - The layer's scale. +- :ref:`Vector2` **scale** + ++----------+------------------+ +| *Setter* | set_scale(value) | ++----------+------------------+ +| *Getter* | get_scale() | ++----------+------------------+ + +The layer's scale. .. _class_CanvasLayer_transform: -- :ref:`Transform2D` **transform** - The layer's transform. +- :ref:`Transform2D` **transform** ++----------+----------------------+ +| *Setter* | set_transform(value) | ++----------+----------------------+ +| *Getter* | get_transform() | ++----------+----------------------+ + +The layer's transform. Method Descriptions ------------------- -.. _class_CanvasLayer_get_canvas: + .. _class_CanvasLayer_get_canvas: - :ref:`RID` **get_canvas** **(** **)** const Returns the RID of the canvas used by this layer. - diff --git a/classes/class_canvasmodulate.rst b/classes/class_canvasmodulate.rst index f39f9bb25..b2ebf34cb 100644 --- a/classes/class_canvasmodulate.rst +++ b/classes/class_canvasmodulate.rst @@ -8,6 +8,7 @@ CanvasModulate ============== **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Tint the entire canvas. +Properties +---------- + ++---------------------------+------------------------------------------+ +| :ref:`Color` | :ref:`color` | ++---------------------------+------------------------------------------+ + Description ----------- @@ -25,6 +33,13 @@ Property Descriptions .. _class_CanvasModulate_color: -- :ref:`Color` **color** - The tint color to apply. +- :ref:`Color` **color** ++----------+------------------+ +| *Setter* | set_color(value) | ++----------+------------------+ +| *Getter* | get_color() | ++----------+------------------+ + +The tint color to apply. diff --git a/classes/class_capsulemesh.rst b/classes/class_capsulemesh.rst index 00938278e..5aca61853 100644 --- a/classes/class_capsulemesh.rst +++ b/classes/class_capsulemesh.rst @@ -8,6 +8,7 @@ CapsuleMesh =========== **Inherits:** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,19 @@ Brief Description 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` | ++---------------------------+-----------------------------------------------------------+ + Description ----------- @@ -25,18 +39,49 @@ Property Descriptions .. _class_CapsuleMesh_mid_height: -- :ref:`float` **mid_height** - Height of the capsule mesh from the center point. Defaults to 1.0. +- :ref:`float` **mid_height** + ++----------+-----------------------+ +| *Setter* | set_mid_height(value) | ++----------+-----------------------+ +| *Getter* | get_mid_height() | ++----------+-----------------------+ + +Height of the capsule mesh from the center point. Defaults to 1.0. .. _class_CapsuleMesh_radial_segments: -- :ref:`int` **radial_segments** - Number of radial segments on the capsule mesh. Defaults to 64. +- :ref:`int` **radial_segments** + ++----------+----------------------------+ +| *Setter* | set_radial_segments(value) | ++----------+----------------------------+ +| *Getter* | get_radial_segments() | ++----------+----------------------------+ + +Number of radial segments on the capsule mesh. Defaults to 64. .. _class_CapsuleMesh_radius: -- :ref:`float` **radius** - Radius of the capsule mesh. Defaults to 1.0. +- :ref:`float` **radius** + ++----------+-------------------+ +| *Setter* | set_radius(value) | ++----------+-------------------+ +| *Getter* | get_radius() | ++----------+-------------------+ + +Radius of the capsule mesh. Defaults to 1.0. .. _class_CapsuleMesh_rings: -- :ref:`int` **rings** - Number of rings along the height of the capsule. Defaults to 8. +- :ref:`int` **rings** ++----------+------------------+ +| *Setter* | set_rings(value) | ++----------+------------------+ +| *Getter* | get_rings() | ++----------+------------------+ + +Number of rings along the height of the capsule. Defaults to 8. diff --git a/classes/class_capsuleshape.rst b/classes/class_capsuleshape.rst index 7b28ec88c..58916f56c 100644 --- a/classes/class_capsuleshape.rst +++ b/classes/class_capsuleshape.rst @@ -8,6 +8,7 @@ CapsuleShape ============ **Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description Capsule shape for collisions. +Properties +---------- + ++---------------------------+------------------------------------------+ +| :ref:`float` | :ref:`height` | ++---------------------------+------------------------------------------+ +| :ref:`float` | :ref:`radius` | ++---------------------------+------------------------------------------+ + Description ----------- @@ -25,10 +35,25 @@ Property Descriptions .. _class_CapsuleShape_height: -- :ref:`float` **height** - The capsule's height. +- :ref:`float` **height** + ++----------+-------------------+ +| *Setter* | set_height(value) | ++----------+-------------------+ +| *Getter* | get_height() | ++----------+-------------------+ + +The capsule's height. .. _class_CapsuleShape_radius: -- :ref:`float` **radius** - The capsule's radius. +- :ref:`float` **radius** ++----------+-------------------+ +| *Setter* | set_radius(value) | ++----------+-------------------+ +| *Getter* | get_radius() | ++----------+-------------------+ + +The capsule's radius. diff --git a/classes/class_capsuleshape2d.rst b/classes/class_capsuleshape2d.rst index 4072b6441..e02b1d72b 100644 --- a/classes/class_capsuleshape2d.rst +++ b/classes/class_capsuleshape2d.rst @@ -8,6 +8,7 @@ CapsuleShape2D ============== **Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description Capsule shape for 2D collisions. +Properties +---------- + ++---------------------------+--------------------------------------------+ +| :ref:`float` | :ref:`height` | ++---------------------------+--------------------------------------------+ +| :ref:`float` | :ref:`radius` | ++---------------------------+--------------------------------------------+ + Description ----------- @@ -25,10 +35,25 @@ Property Descriptions .. _class_CapsuleShape2D_height: -- :ref:`float` **height** - The capsule's height. +- :ref:`float` **height** + ++----------+-------------------+ +| *Setter* | set_height(value) | ++----------+-------------------+ +| *Getter* | get_height() | ++----------+-------------------+ + +The capsule's height. .. _class_CapsuleShape2D_radius: -- :ref:`float` **radius** - The capsule's radius. +- :ref:`float` **radius** ++----------+-------------------+ +| *Setter* | set_radius(value) | ++----------+-------------------+ +| *Getter* | get_radius() | ++----------+-------------------+ + +The capsule's radius. diff --git a/classes/class_centercontainer.rst b/classes/class_centercontainer.rst index 413f0e919..6513b46e1 100644 --- a/classes/class_centercontainer.rst +++ b/classes/class_centercontainer.rst @@ -8,6 +8,7 @@ CenterContainer =============== **Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Keeps children controls centered. +Properties +---------- + ++-------------------------+---------------------------------------------------------+ +| :ref:`bool` | :ref:`use_top_left` | ++-------------------------+---------------------------------------------------------+ + Description ----------- @@ -25,6 +33,13 @@ Property Descriptions .. _class_CenterContainer_use_top_left: -- :ref:`bool` **use_top_left** - If ``true`` centers children relative to the ``CenterContainer``'s top left corner. Default value: ``false``. +- :ref:`bool` **use_top_left** ++----------+-------------------------+ +| *Setter* | set_use_top_left(value) | ++----------+-------------------------+ +| *Getter* | is_using_top_left() | ++----------+-------------------------+ + +If ``true`` centers children relative to the ``CenterContainer``'s top left corner. Default value: ``false``. diff --git a/classes/class_checkbox.rst b/classes/class_checkbox.rst index 917301b23..b30ec352b 100644 --- a/classes/class_checkbox.rst +++ b/classes/class_checkbox.rst @@ -8,6 +8,7 @@ CheckBox ======== **Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,43 @@ Brief Description 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_pressed` | ++---------------------------------+----------------------------------------------------------------+ +| :ref:`StyleBox` | :ref:`hover` | ++---------------------------------+----------------------------------------------------------------+ +| :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` | ++---------------------------------+----------------------------------------------------------------+ + Description ----------- diff --git a/classes/class_checkbutton.rst b/classes/class_checkbutton.rst index d1a3b8ae6..fdbf16c56 100644 --- a/classes/class_checkbutton.rst +++ b/classes/class_checkbutton.rst @@ -8,6 +8,7 @@ CheckButton =========== **Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,39 @@ Brief Description 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_pressed` | ++---------------------------------+-------------------------------------------------------------------+ +| :ref:`StyleBox` | :ref:`hover` | ++---------------------------------+-------------------------------------------------------------------+ +| :ref:`int` | :ref:`hseparation` | ++---------------------------------+-------------------------------------------------------------------+ +| :ref:`StyleBox` | :ref:`normal` | ++---------------------------------+-------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`off` | ++---------------------------------+-------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`on` | ++---------------------------------+-------------------------------------------------------------------+ +| :ref:`StyleBox` | :ref:`pressed` | ++---------------------------------+-------------------------------------------------------------------+ + Description ----------- diff --git a/classes/class_circleshape2d.rst b/classes/class_circleshape2d.rst index 65f0b5f97..bd2def0d0 100644 --- a/classes/class_circleshape2d.rst +++ b/classes/class_circleshape2d.rst @@ -8,6 +8,7 @@ CircleShape2D ============= **Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Circular shape for 2D collisions. +Properties +---------- + ++---------------------------+-------------------------------------------+ +| :ref:`float` | :ref:`radius` | ++---------------------------+-------------------------------------------+ + Description ----------- @@ -25,6 +33,13 @@ Property Descriptions .. _class_CircleShape2D_radius: -- :ref:`float` **radius** - The circle's radius. +- :ref:`float` **radius** ++----------+-------------------+ +| *Setter* | set_radius(value) | ++----------+-------------------+ +| *Getter* | get_radius() | ++----------+-------------------+ + +The circle's radius. diff --git a/classes/class_classdb.rst b/classes/class_classdb.rst index 1cb555864..fed423911 100644 --- a/classes/class_classdb.rst +++ b/classes/class_classdb.rst @@ -8,6 +8,7 @@ ClassDB ======= **Inherits:** :ref:`Object` + **Category:** Core Brief Description @@ -68,124 +69,123 @@ Provides access to metadata stored for every available class. Method Descriptions ------------------- -.. _class_ClassDB_can_instance: + .. _class_ClassDB_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_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_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_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_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_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_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_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_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_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`. -.. _class_ClassDB_class_has_integer_constant: + .. _class_ClassDB_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_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_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_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_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_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_get_parent_class: - :ref:`String` **get_parent_class** **(** :ref:`String` class **)** const Returns the parent class of 'class'. -.. _class_ClassDB_instance: + .. _class_ClassDB_instance: - :ref:`Variant` **instance** **(** :ref:`String` class **)** const Creates an instance of 'class'. -.. _class_ClassDB_is_class_enabled: + .. _class_ClassDB_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_is_parent_class: - :ref:`bool` **is_parent_class** **(** :ref:`String` class, :ref:`String` inherits **)** const Returns whether 'inherits' is an ancestor of 'class' or not. - diff --git a/classes/class_clippedcamera.rst b/classes/class_clippedcamera.rst index f5e5887b0..8a15edd60 100644 --- a/classes/class_clippedcamera.rst +++ b/classes/class_clippedcamera.rst @@ -8,6 +8,7 @@ ClippedCamera ============= **Inherits:** :ref:`Camera` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,21 @@ 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` | ++----------------------------------------------------+-----------------------------------------------------------+ + Methods ------- @@ -39,12 +55,11 @@ Enumerations .. _enum_ClippedCamera_ProcessMode: -enum **ProcessMode** +enum **ProcessMode**: - **CLIP_PROCESS_PHYSICS** = **0** - **CLIP_PROCESS_IDLE** = **1** - Property Descriptions --------------------- @@ -52,52 +67,80 @@ Property Descriptions - :ref:`bool` **clip_to_areas** ++----------+----------------------------+ +| *Setter* | set_clip_to_areas(value) | ++----------+----------------------------+ +| *Getter* | is_clip_to_areas_enabled() | ++----------+----------------------------+ + .. _class_ClippedCamera_clip_to_bodies: - :ref:`bool` **clip_to_bodies** ++----------+-----------------------------+ +| *Setter* | set_clip_to_bodies(value) | ++----------+-----------------------------+ +| *Getter* | is_clip_to_bodies_enabled() | ++----------+-----------------------------+ + .. _class_ClippedCamera_collision_mask: - :ref:`int` **collision_mask** ++----------+---------------------------+ +| *Setter* | set_collision_mask(value) | ++----------+---------------------------+ +| *Getter* | get_collision_mask() | ++----------+---------------------------+ + .. _class_ClippedCamera_margin: - :ref:`float` **margin** ++----------+-------------------+ +| *Setter* | set_margin(value) | ++----------+-------------------+ +| *Getter* | get_margin() | ++----------+-------------------+ + .. _class_ClippedCamera_process_mode: - :ref:`ProcessMode` **process_mode** ++----------+-------------------------+ +| *Setter* | set_process_mode(value) | ++----------+-------------------------+ +| *Getter* | get_process_mode() | ++----------+-------------------------+ Method Descriptions ------------------- -.. _class_ClippedCamera_add_exception: + .. _class_ClippedCamera_add_exception: - void **add_exception** **(** :ref:`Object` node **)** -.. _class_ClippedCamera_add_exception_rid: + .. _class_ClippedCamera_add_exception_rid: - void **add_exception_rid** **(** :ref:`RID` rid **)** -.. _class_ClippedCamera_clear_exceptions: + .. _class_ClippedCamera_clear_exceptions: - void **clear_exceptions** **(** **)** -.. _class_ClippedCamera_get_collision_mask_bit: + .. _class_ClippedCamera_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const -.. _class_ClippedCamera_remove_exception: + .. _class_ClippedCamera_remove_exception: - void **remove_exception** **(** :ref:`Object` node **)** -.. _class_ClippedCamera_remove_exception_rid: + .. _class_ClippedCamera_remove_exception_rid: - void **remove_exception_rid** **(** :ref:`RID` rid **)** -.. _class_ClippedCamera_set_collision_mask_bit: + .. _class_ClippedCamera_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 7f6620a3b..2a42bfe0f 100644 --- a/classes/class_collisionobject.rst +++ b/classes/class_collisionobject.rst @@ -8,7 +8,9 @@ CollisionObject =============== **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`PhysicsBody`, :ref:`Area` + **Category:** Core Brief Description @@ -16,6 +18,15 @@ Brief Description Base node for collision objects. +Properties +---------- + ++-------------------------+---------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_capture_on_drag` | ++-------------------------+---------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_ray_pickable` | ++-------------------------+---------------------------------------------------------------------------+ + Methods ------- @@ -58,25 +69,24 @@ Methods Signals ------- -.. _class_CollisionObject_input_event: + .. _class_CollisionObject_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. -.. _class_CollisionObject_mouse_entered: + .. _class_CollisionObject_mouse_entered: - **mouse_entered** **(** **)** Emitted when the mouse pointer enters any of this object's shapes. -.. _class_CollisionObject_mouse_exited: + .. _class_CollisionObject_mouse_exited: - **mouse_exited** **(** **)** Emitted when the mouse pointer exits all this object's shapes. - Description ----------- @@ -87,116 +97,130 @@ Property Descriptions .. _class_CollisionObject_input_capture_on_drag: -- :ref:`bool` **input_capture_on_drag** - If ``true`` the ``CollisionObject`` will continue to receive input events as the mouse is dragged across its shapes. Default value: ``false``. +- :ref:`bool` **input_capture_on_drag** + ++----------+----------------------------------+ +| *Setter* | set_capture_input_on_drag(value) | ++----------+----------------------------------+ +| *Getter* | get_capture_input_on_drag() | ++----------+----------------------------------+ + +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: -- :ref:`bool` **input_ray_pickable** - If ``true`` the :ref:`CollisionObject`'s shapes will respond to :ref:`RayCast`\ s. Default value: ``true``. +- :ref:`bool` **input_ray_pickable** ++----------+-------------------------+ +| *Setter* | set_ray_pickable(value) | ++----------+-------------------------+ +| *Getter* | is_ray_pickable() | ++----------+-------------------------+ + +If ``true`` the :ref:`CollisionObject`'s shapes will respond to :ref:`RayCast`\ s. Default value: ``true``. Method Descriptions ------------------- -.. _class_CollisionObject__input_event: + .. _class_CollisionObject__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_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_get_rid: - :ref:`RID` **get_rid** **(** **)** const Returns the object's :ref:`RID`. -.. _class_CollisionObject_get_shape_owners: + .. _class_CollisionObject_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_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_remove_shape_owner: - void **remove_shape_owner** **(** :ref:`int` owner_id **)** Removes the given shape owner. -.. _class_CollisionObject_shape_find_owner: + .. _class_CollisionObject_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_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_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_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_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_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_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_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_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_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_shape_owner_set_transform: - void **shape_owner_set_transform** **(** :ref:`int` owner_id, :ref:`Transform` transform **)** Sets the :ref:`Transform` of the given shape owner. - diff --git a/classes/class_collisionobject2d.rst b/classes/class_collisionobject2d.rst index 6b3309887..cbfbaf1f0 100644 --- a/classes/class_collisionobject2d.rst +++ b/classes/class_collisionobject2d.rst @@ -8,7 +8,9 @@ CollisionObject2D ================= **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`Area2D`, :ref:`PhysicsBody2D` + **Category:** Core Brief Description @@ -16,6 +18,13 @@ Brief Description Base node for 2D collision objects. +Properties +---------- + ++-------------------------+---------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_pickable` | ++-------------------------+---------------------------------------------------------------+ + Methods ------- @@ -62,25 +71,24 @@ Methods Signals ------- -.. _class_CollisionObject2D_input_event: + .. _class_CollisionObject2D_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. -.. _class_CollisionObject2D_mouse_entered: + .. _class_CollisionObject2D_mouse_entered: - **mouse_entered** **(** **)** Emitted when the mouse pointer enters any of this object's shapes. -.. _class_CollisionObject2D_mouse_exited: + .. _class_CollisionObject2D_mouse_exited: - **mouse_exited** **(** **)** Emitted when the mouse pointer exits all this object's shapes. - Description ----------- @@ -91,124 +99,130 @@ Property Descriptions .. _class_CollisionObject2D_input_pickable: -- :ref:`bool` **input_pickable** - If ``true`` this object is pickable. A pickable object can detect the mouse pointer entering/leaving, and if the mouse is inside it, report input events. +- :ref:`bool` **input_pickable** ++----------+---------------------+ +| *Setter* | set_pickable(value) | ++----------+---------------------+ +| *Getter* | is_pickable() | ++----------+---------------------+ + +If ``true`` this object is pickable. A pickable object can detect the mouse pointer entering/leaving, and if the mouse is inside it, report input events. Method Descriptions ------------------- -.. _class_CollisionObject2D__input_event: + .. _class_CollisionObject2D__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_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_get_rid: - :ref:`RID` **get_rid** **(** **)** const Returns the object's :ref:`RID`. -.. _class_CollisionObject2D_get_shape_owners: + .. _class_CollisionObject2D_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_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_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_remove_shape_owner: - void **remove_shape_owner** **(** :ref:`int` owner_id **)** Removes the given shape owner. -.. _class_CollisionObject2D_shape_find_owner: + .. _class_CollisionObject2D_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_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_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_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_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_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_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_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_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_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_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_shape_owner_set_transform: - void **shape_owner_set_transform** **(** :ref:`int` owner_id, :ref:`Transform2D` transform **)** Sets the :ref:`Transform2D` of the given shape owner. - diff --git a/classes/class_collisionpolygon.rst b/classes/class_collisionpolygon.rst index d2364bebe..d4c60046f 100644 --- a/classes/class_collisionpolygon.rst +++ b/classes/class_collisionpolygon.rst @@ -8,6 +8,7 @@ CollisionPolygon ================ **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,17 @@ Brief Description Editor-only class for defining a collision polygon in 3D space. +Properties +---------- + ++-------------------------------------------------+--------------------------------------------------+ +| :ref:`float` | :ref:`depth` | ++-------------------------------------------------+--------------------------------------------------+ +| :ref:`bool` | :ref:`disabled` | ++-------------------------------------------------+--------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`polygon` | ++-------------------------------------------------+--------------------------------------------------+ + Description ----------- @@ -25,14 +37,37 @@ Property Descriptions .. _class_CollisionPolygon_depth: -- :ref:`float` **depth** - Length that the resulting collision extends in either direction perpendicular to its polygon. +- :ref:`float` **depth** + ++----------+------------------+ +| *Setter* | set_depth(value) | ++----------+------------------+ +| *Getter* | get_depth() | ++----------+------------------+ + +Length that the resulting collision extends in either direction perpendicular to its polygon. .. _class_CollisionPolygon_disabled: -- :ref:`bool` **disabled** - If true, no collision will be produced. +- :ref:`bool` **disabled** + ++----------+---------------------+ +| *Setter* | set_disabled(value) | ++----------+---------------------+ +| *Getter* | is_disabled() | ++----------+---------------------+ + +If true, no collision will be produced. .. _class_CollisionPolygon_polygon: -- :ref:`PoolVector2Array` **polygon** - Array of vertices which define the polygon. +- :ref:`PoolVector2Array` **polygon** ++----------+--------------------+ +| *Setter* | set_polygon(value) | ++----------+--------------------+ +| *Getter* | get_polygon() | ++----------+--------------------+ + +Array of vertices which define the polygon. diff --git a/classes/class_collisionpolygon2d.rst b/classes/class_collisionpolygon2d.rst index f1ed0b420..5a0b612f6 100644 --- a/classes/class_collisionpolygon2d.rst +++ b/classes/class_collisionpolygon2d.rst @@ -8,6 +8,7 @@ CollisionPolygon2D ================== **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,17 +16,29 @@ Brief Description 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` | ++-----------------------------------------------------+----------------------------------------------------------------------+ + Enumerations ------------ .. _enum_CollisionPolygon2D_BuildMode: -enum **BuildMode** +enum **BuildMode**: - **BUILD_SOLIDS** = **0** --- Collisions will include the polygon and its contained area. - **BUILD_SEGMENTS** = **1** --- Collisions will only include the polygon edges. - Description ----------- @@ -36,18 +49,49 @@ Property Descriptions .. _class_CollisionPolygon2D_build_mode: -- :ref:`BuildMode` **build_mode** - Collision build mode. Use one of the ``BUILD_*`` constants. Default value: ``BUILD_SOLIDS``. +- :ref:`BuildMode` **build_mode** + ++----------+-----------------------+ +| *Setter* | set_build_mode(value) | ++----------+-----------------------+ +| *Getter* | get_build_mode() | ++----------+-----------------------+ + +Collision build mode. Use one of the ``BUILD_*`` constants. Default value: ``BUILD_SOLIDS``. .. _class_CollisionPolygon2D_disabled: -- :ref:`bool` **disabled** - If ``true`` no collisions will be detected. +- :ref:`bool` **disabled** + ++----------+---------------------+ +| *Setter* | set_disabled(value) | ++----------+---------------------+ +| *Getter* | is_disabled() | ++----------+---------------------+ + +If ``true`` no collisions will be detected. .. _class_CollisionPolygon2D_one_way_collision: -- :ref:`bool` **one_way_collision** - If ``true`` only edges that face up, relative to CollisionPolygon2D's rotation, will collide with other objects. +- :ref:`bool` **one_way_collision** + ++----------+--------------------------------+ +| *Setter* | set_one_way_collision(value) | ++----------+--------------------------------+ +| *Getter* | is_one_way_collision_enabled() | ++----------+--------------------------------+ + +If ``true`` only edges that face up, relative to CollisionPolygon2D's rotation, will collide with other objects. .. _class_CollisionPolygon2D_polygon: -- :ref:`PoolVector2Array` **polygon** - The polygon's list of vertices. The final point will be connected to the first. +- :ref:`PoolVector2Array` **polygon** ++----------+--------------------+ +| *Setter* | set_polygon(value) | ++----------+--------------------+ +| *Getter* | get_polygon() | ++----------+--------------------+ + +The polygon's list of vertices. The final point will be connected to the first. diff --git a/classes/class_collisionshape.rst b/classes/class_collisionshape.rst index b52bffab8..87403916f 100644 --- a/classes/class_collisionshape.rst +++ b/classes/class_collisionshape.rst @@ -8,6 +8,7 @@ CollisionShape ============== **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description Node that represents collision shape data in 3D space. +Properties +---------- + ++---------------------------+------------------------------------------------+ +| :ref:`bool` | :ref:`disabled` | ++---------------------------+------------------------------------------------+ +| :ref:`Shape` | :ref:`shape` | ++---------------------------+------------------------------------------------+ + Methods ------- @@ -33,32 +43,45 @@ Tutorials --------- - :doc:`../tutorials/physics/physics_introduction` - Property Descriptions --------------------- .. _class_CollisionShape_disabled: -- :ref:`bool` **disabled** - A disabled collision shape has no effect in the world. +- :ref:`bool` **disabled** + ++----------+---------------------+ +| *Setter* | set_disabled(value) | ++----------+---------------------+ +| *Getter* | is_disabled() | ++----------+---------------------+ + +A disabled collision shape has no effect in the world. .. _class_CollisionShape_shape: -- :ref:`Shape` **shape** - The actual shape owned by this collision shape. +- :ref:`Shape` **shape** ++----------+------------------+ +| *Setter* | set_shape(value) | ++----------+------------------+ +| *Getter* | get_shape() | ++----------+------------------+ + +The actual shape owned by this collision shape. Method Descriptions ------------------- -.. _class_CollisionShape_make_convex_from_brothers: + .. _class_CollisionShape_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_resource_changed: - void **resource_changed** **(** :ref:`Resource` resource **)** If this method exists within a script it will be called whenever the shape resource has been modified. - diff --git a/classes/class_collisionshape2d.rst b/classes/class_collisionshape2d.rst index 714e8b0cc..bb1cf1201 100644 --- a/classes/class_collisionshape2d.rst +++ b/classes/class_collisionshape2d.rst @@ -8,6 +8,7 @@ CollisionShape2D ================ **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,17 @@ Brief Description Node that represents collision shape data in 2D space. +Properties +---------- + ++-------------------------------+--------------------------------------------------------------------+ +| :ref:`bool` | :ref:`disabled` | ++-------------------------------+--------------------------------------------------------------------+ +| :ref:`bool` | :ref:`one_way_collision` | ++-------------------------------+--------------------------------------------------------------------+ +| :ref:`Shape2D` | :ref:`shape` | ++-------------------------------+--------------------------------------------------------------------+ + Description ----------- @@ -24,20 +36,42 @@ Tutorials --------- - :doc:`../tutorials/physics/physics_introduction` - Property Descriptions --------------------- .. _class_CollisionShape2D_disabled: -- :ref:`bool` **disabled** - A disabled collision shape has no effect in the world. +- :ref:`bool` **disabled** + ++----------+---------------------+ +| *Setter* | set_disabled(value) | ++----------+---------------------+ +| *Getter* | is_disabled() | ++----------+---------------------+ + +A disabled collision shape has no effect in the world. .. _class_CollisionShape2D_one_way_collision: -- :ref:`bool` **one_way_collision** - Sets whether this collision shape should only detect collision on one side (top or bottom). +- :ref:`bool` **one_way_collision** + ++----------+--------------------------------+ +| *Setter* | set_one_way_collision(value) | ++----------+--------------------------------+ +| *Getter* | is_one_way_collision_enabled() | ++----------+--------------------------------+ + +Sets whether this collision shape should only detect collision on one side (top or bottom). .. _class_CollisionShape2D_shape: -- :ref:`Shape2D` **shape** - The actual shape owned by this collision shape. +- :ref:`Shape2D` **shape** ++----------+------------------+ +| *Setter* | set_shape(value) | ++----------+------------------+ +| *Getter* | get_shape() | ++----------+------------------+ + +The actual shape owned by this collision shape. diff --git a/classes/class_color.rst b/classes/class_color.rst index 434a92c35..24397cc9c 100644 --- a/classes/class_color.rst +++ b/classes/class_color.rst @@ -14,6 +14,33 @@ Brief Description 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` | ++---------------------------+---------------------------+ + Methods ------- @@ -205,7 +232,6 @@ Constants - **whitesmoke** = **Color( 0.96, 0.96, 0.96, 1 )** - **yellow** = **Color( 1, 1, 0, 1 )** - **yellowgreen** = **Color( 0.6, 0.8, 0.2, 1 )** - Description ----------- @@ -218,53 +244,74 @@ Property Descriptions .. _class_Color_a: -- :ref:`float` **a** - Alpha (0 to 1) +- :ref:`float` **a** + +Alpha (0 to 1) .. _class_Color_a8: -- :ref:`int` **a8** - Alpha (0 to 255) +- :ref:`int` **a8** + +Alpha (0 to 255) .. _class_Color_b: -- :ref:`float` **b** - Blue (0 to 1) +- :ref:`float` **b** + +Blue (0 to 1) .. _class_Color_b8: -- :ref:`int` **b8** - Blue (0 to 255) +- :ref:`int` **b8** + +Blue (0 to 255) .. _class_Color_g: -- :ref:`float` **g** - Green (0 to 1) +- :ref:`float` **g** + +Green (0 to 1) .. _class_Color_g8: -- :ref:`int` **g8** - Green (0 to 255) +- :ref:`int` **g8** + +Green (0 to 255) .. _class_Color_h: -- :ref:`float` **h** - Hue (0 to 1) +- :ref:`float` **h** + +Hue (0 to 1) .. _class_Color_r: -- :ref:`float` **r** - Red (0 to 1) +- :ref:`float` **r** + +Red (0 to 1) .. _class_Color_r8: -- :ref:`int` **r8** - Red (0 to 255) +- :ref:`int` **r8** + +Red (0 to 255) .. _class_Color_s: -- :ref:`float` **s** - Saturation (0 to 1) +- :ref:`float` **s** + +Saturation (0 to 1) .. _class_Color_v: -- :ref:`float` **v** - Value (0 to 1) +- :ref:`float` **v** +Value (0 to 1) Method Descriptions ------------------- -.. _class_Color_Color: + .. _class_Color_Color: - :ref:`Color` **Color** **(** :ref:`String` from **)** @@ -288,7 +335,7 @@ The following string formats are supported: var c3 = Color("#b2d90a") # RGB format with '#' var c4 = Color("b2d90a") # RGB format -.. _class_Color_Color: + .. _class_Color_Color: - :ref:`Color` **Color** **(** :ref:`int` from **)** @@ -298,7 +345,7 @@ Constructs a color from a 32-bit integer (each byte represents a component of th var c = Color(274) # a color of an RGBA(0, 0, 1, 18) -.. _class_Color_Color: + .. _class_Color_Color: - :ref:`Color` **Color** **(** :ref:`float` r, :ref:`float` g, :ref:`float` b **)** @@ -308,7 +355,7 @@ Constructs a color from an RGB profile using values between 0 and 1 (float). Alp var c = Color(0.2, 1.0, .7) # a color of an RGBA(51, 255, 178, 255) -.. _class_Color_Color: + .. _class_Color_Color: - :ref:`Color` **Color** **(** :ref:`float` r, :ref:`float` g, :ref:`float` b, :ref:`float` a **)** @@ -318,7 +365,7 @@ Constructs a color from an RGBA profile using values between 0 and 1 (float). var c = Color(0.2, 1.0, .7, .8) # a color of an RGBA(51, 255, 178, 204) -.. _class_Color_blend: + .. _class_Color_blend: - :ref:`Color` **blend** **(** :ref:`Color` over **)** @@ -330,7 +377,7 @@ Returns a new color resulting from blending this color over another color. If th var fg = Color(1.0, 0.0, 0.0, .5) # Red with alpha of 50% var blendedColor = bg.blend(fg) # Brown with alpha of 75% -.. _class_Color_contrasted: + .. _class_Color_contrasted: - :ref:`Color` **contrasted** **(** **)** @@ -341,7 +388,7 @@ Returns the most contrasting color. var c = Color(.3, .4, .9) var contrastedColor = c.contrasted() # a color of an RGBA(204, 229, 102, 255) -.. _class_Color_darkened: + .. _class_Color_darkened: - :ref:`Color` **darkened** **(** :ref:`float` amount **)** @@ -352,7 +399,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_from_hsv: - :ref:`Color` **from_hsv** **(** :ref:`float` h, :ref:`float` s, :ref:`float` v, :ref:`float` a=1 **)** @@ -362,7 +409,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_gray: - :ref:`float` **gray** **(** **)** @@ -375,7 +422,7 @@ The gray is calculated by (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_inverted: - :ref:`Color` **inverted** **(** **)** @@ -386,7 +433,7 @@ Returns the inverted color (1-r, 1-g, 1-b, 1-a). var c = Color(.3, .4, .9) var invertedColor = c.inverted() # a color of an RGBA(178, 153, 26, 255) -.. _class_Color_lightened: + .. _class_Color_lightened: - :ref:`Color` **lightened** **(** :ref:`float` amount **)** @@ -397,7 +444,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_linear_interpolate: - :ref:`Color` **linear_interpolate** **(** :ref:`Color` b, :ref:`float` t **)** @@ -409,7 +456,7 @@ Returns the color of the linear interpolation with another color. The value t is 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_to_abgr32: - :ref:`int` **to_abgr32** **(** **)** @@ -420,7 +467,7 @@ Returns the color's 32-bit integer in ABGR format (each byte represents a compon var c = Color(1, .5, .2) print(c.to_abgr32()) # Prints 4281565439 -.. _class_Color_to_abgr64: + .. _class_Color_to_abgr64: - :ref:`int` **to_abgr64** **(** **)** @@ -431,7 +478,7 @@ Returns the color's 64-bit integer in ABGR format (each word represents a compon var c = Color(1, .5, .2) print(c.to_abgr64()) # Prints -225178692812801 -.. _class_Color_to_argb32: + .. _class_Color_to_argb32: - :ref:`int` **to_argb32** **(** **)** @@ -442,7 +489,7 @@ Returns the color's 32-bit integer in ARGB format (each byte represents a compon var c = Color(1, .5, .2) print(c.to_argb32()) # Prints 4294934323 -.. _class_Color_to_argb64: + .. _class_Color_to_argb64: - :ref:`int` **to_argb64** **(** **)** @@ -453,7 +500,7 @@ Returns the color's 64-bit integer in ARGB format (each word represents a compon var c = Color(1, .5, .2) print(c.to_argb64()) # Prints -2147470541 -.. _class_Color_to_html: + .. _class_Color_to_html: - :ref:`String` **to_html** **(** :ref:`bool` with_alpha=True **)** @@ -467,7 +514,7 @@ Optionally flag 'false' to not include alpha in hexadecimal string. var s1 = c.to_html() # Results "7fffffff" var s2 = c.to_html(false) # Results 'ffffff' -.. _class_Color_to_rgba32: + .. _class_Color_to_rgba32: - :ref:`int` **to_rgba32** **(** **)** @@ -478,7 +525,7 @@ Returns the color's 32-bit integer in RGBA format (each byte represents a compon var c = Color(1, .5, .2) print(c.to_rgba32()) # Prints 4286526463 -.. _class_Color_to_rgba64: + .. _class_Color_to_rgba64: - :ref:`int` **to_rgba64** **(** **)** @@ -489,4 +536,3 @@ Returns the color's 64-bit integer in RGBA format (each word represents a compon var c = Color(1, .5, .2) print(c.to_rgba64()) # Prints -140736629309441 - diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index 962b4df89..8a7730aeb 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -8,6 +8,7 @@ ColorPicker =========== **Inherits:** :ref:`BoxContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,19 @@ Brief Description Color picker control. +Properties +---------- + ++---------------------------+-------------------------------------------------------+ +| :ref:`Color` | :ref:`color` | ++---------------------------+-------------------------------------------------------+ +| :ref:`bool` | :ref:`deferred_mode` | ++---------------------------+-------------------------------------------------------+ +| :ref:`bool` | :ref:`edit_alpha` | ++---------------------------+-------------------------------------------------------+ +| :ref:`bool` | :ref:`raw_mode` | ++---------------------------+-------------------------------------------------------+ + Methods ------- @@ -22,16 +36,40 @@ Methods | void | :ref:`add_preset` **(** :ref:`Color` color **)** | +-------+---------------------------------------------------------------------------------------------+ +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` | ++-------------------------------+-------------------------------------------------------+ + Signals ------- -.. _class_ColorPicker_color_changed: + .. _class_ColorPicker_color_changed: - **color_changed** **(** :ref:`Color` color **)** Emitted when the color is changed. - Description ----------- @@ -42,28 +80,58 @@ Property Descriptions .. _class_ColorPicker_color: -- :ref:`Color` **color** - The currently selected color. +- :ref:`Color` **color** + ++----------+-----------------------+ +| *Setter* | set_pick_color(value) | ++----------+-----------------------+ +| *Getter* | get_pick_color() | ++----------+-----------------------+ + +The currently selected color. .. _class_ColorPicker_deferred_mode: -- :ref:`bool` **deferred_mode** - If ``true`` the color will apply only after the user releases the mouse button, otherwise it will apply immediatly even in mouse motion event (which can cause performance issues). +- :ref:`bool` **deferred_mode** + ++----------+--------------------------+ +| *Setter* | set_deferred_mode(value) | ++----------+--------------------------+ +| *Getter* | is_deferred_mode() | ++----------+--------------------------+ + +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: -- :ref:`bool` **edit_alpha** - If ``true`` shows an alpha channel slider (transparency). +- :ref:`bool` **edit_alpha** + ++----------+-----------------------+ +| *Setter* | set_edit_alpha(value) | ++----------+-----------------------+ +| *Getter* | is_editing_alpha() | ++----------+-----------------------+ + +If ``true`` shows an alpha channel slider (transparency). .. _class_ColorPicker_raw_mode: -- :ref:`bool` **raw_mode** - If ``true`` allows the color R, G, B component values to go beyond 1.0, which can be used for certain special operations that require it (like tinting without darkening or rendering sprites in HDR). +- :ref:`bool` **raw_mode** ++----------+---------------------+ +| *Setter* | set_raw_mode(value) | ++----------+---------------------+ +| *Getter* | is_raw_mode() | ++----------+---------------------+ + +If ``true`` allows the color R, G, B component values to go beyond 1.0, which can be used for certain special operations that require it (like tinting without darkening or rendering sprites in HDR). Method Descriptions ------------------- -.. _class_ColorPicker_add_preset: + .. _class_ColorPicker_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. - diff --git a/classes/class_colorpickerbutton.rst b/classes/class_colorpickerbutton.rst index 611657274..b40ffd69a 100644 --- a/classes/class_colorpickerbutton.rst +++ b/classes/class_colorpickerbutton.rst @@ -8,6 +8,7 @@ ColorPickerButton ================= **Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description Button that pops out a :ref:`ColorPicker`. +Properties +---------- + ++---------------------------+-------------------------------------------------------+ +| :ref:`Color` | :ref:`color` | ++---------------------------+-------------------------------------------------------+ +| :ref:`bool` | :ref:`edit_alpha` | ++---------------------------+-------------------------------------------------------+ + Methods ------- @@ -24,50 +34,92 @@ Methods | :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` | ++---------------------------------+-------------------------------------------------------------------------+ + Signals ------- -.. _class_ColorPickerButton_color_changed: + .. _class_ColorPickerButton_color_changed: - **color_changed** **(** :ref:`Color` color **)** Emitted when the color changes. -.. _class_ColorPickerButton_popup_closed: + .. _class_ColorPickerButton_popup_closed: - **popup_closed** **(** **)** - Description ----------- -Encapsulates a :ref:`ColorPicker` making it accesible by pressing a button. Pressing the button will toggle the :ref:`ColorPicker` visibility. +Encapsulates a :ref:`ColorPicker` making it accessible by pressing a button. Pressing the button will toggle the :ref:`ColorPicker` visibility. Property Descriptions --------------------- .. _class_ColorPickerButton_color: -- :ref:`Color` **color** - The currently selected color. +- :ref:`Color` **color** + ++----------+-----------------------+ +| *Setter* | set_pick_color(value) | ++----------+-----------------------+ +| *Getter* | get_pick_color() | ++----------+-----------------------+ + +The currently selected color. .. _class_ColorPickerButton_edit_alpha: -- :ref:`bool` **edit_alpha** - If ``true`` the alpha channel in the displayed :ref:`ColorPicker` will be visible. Default value: ``true``. +- :ref:`bool` **edit_alpha** ++----------+-----------------------+ +| *Setter* | set_edit_alpha(value) | ++----------+-----------------------+ +| *Getter* | is_editing_alpha() | ++----------+-----------------------+ + +If ``true`` the alpha channel in the displayed :ref:`ColorPicker` will be visible. Default value: ``true``. Method Descriptions ------------------- -.. _class_ColorPickerButton_get_picker: + .. _class_ColorPickerButton_get_picker: - :ref:`ColorPicker` **get_picker** **(** **)** Returns the :ref:`ColorPicker` that this node toggles. -.. _class_ColorPickerButton_get_popup: + .. _class_ColorPickerButton_get_popup: - :ref:`PopupPanel` **get_popup** **(** **)** Returns the control's :ref:`PopupPanel` which allows you to connect to popup signals. This allows you to handle events when the ColorPicker is shown or hidden. - diff --git a/classes/class_colorrect.rst b/classes/class_colorrect.rst index 040650662..77d2833a9 100644 --- a/classes/class_colorrect.rst +++ b/classes/class_colorrect.rst @@ -8,6 +8,7 @@ ColorRect ========= **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Colored rectangle. +Properties +---------- + ++---------------------------+-------------------------------------+ +| :ref:`Color` | :ref:`color` | ++---------------------------+-------------------------------------+ + Description ----------- @@ -25,10 +33,17 @@ Property Descriptions .. _class_ColorRect_color: -- :ref:`Color` **color** - The fill color. +- :ref:`Color` **color** + ++----------+------------------------+ +| *Setter* | set_frame_color(value) | ++----------+------------------------+ +| *Getter* | get_frame_color() | ++----------+------------------------+ + +The fill color. :: $ColorRect.color = Color(1, 0, 0, 1) # Set ColorRect's color to red. - diff --git a/classes/class_concavepolygonshape.rst b/classes/class_concavepolygonshape.rst index 746939276..2cc2bcffe 100644 --- a/classes/class_concavepolygonshape.rst +++ b/classes/class_concavepolygonshape.rst @@ -8,6 +8,7 @@ ConcavePolygonShape =================== **Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -32,16 +33,15 @@ 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_set_faces: - void **set_faces** **(** :ref:`PoolVector3Array` faces **)** Set the faces (an array of triangles). - diff --git a/classes/class_concavepolygonshape2d.rst b/classes/class_concavepolygonshape2d.rst index 0af05ca9d..2d9e447cc 100644 --- a/classes/class_concavepolygonshape2d.rst +++ b/classes/class_concavepolygonshape2d.rst @@ -8,6 +8,7 @@ ConcavePolygonShape2D ===================== **Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Concave polygon 2D shape resource for physics. +Properties +---------- + ++-------------------------------------------------+-------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`segments` | ++-------------------------------------------------+-------------------------------------------------------+ + Description ----------- @@ -27,6 +35,13 @@ Property Descriptions .. _class_ConcavePolygonShape2D_segments: -- :ref:`PoolVector2Array` **segments** - The array of points that make up the ``ConcavePolygonShape2D``'s line segments. +- :ref:`PoolVector2Array` **segments** ++----------+---------------------+ +| *Setter* | set_segments(value) | ++----------+---------------------+ +| *Getter* | get_segments() | ++----------+---------------------+ + +The array of points that make up the ``ConcavePolygonShape2D``'s line segments. diff --git a/classes/class_conetwistjoint.rst b/classes/class_conetwistjoint.rst index 6e007b68e..964af42f8 100644 --- a/classes/class_conetwistjoint.rst +++ b/classes/class_conetwistjoint.rst @@ -8,6 +8,7 @@ ConeTwistJoint ============== **Inherits:** :ref:`Joint` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,12 +16,27 @@ Brief Description 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` | ++---------------------------+----------------------------------------------------+ + Enumerations ------------ .. _enum_ConeTwistJoint_Param: -enum **Param** +enum **Param**: - **PARAM_SWING_SPAN** = **0** --- Swing is rotation from side to side, around the axis perpendicular to the twist axis. @@ -39,7 +55,6 @@ The higher, the faster. - **PARAM_RELAXATION** = **4** --- Defines, how fast the swing- and twist-speed-difference on both sides gets synced. - **PARAM_MAX** = **5** --- End flag of PARAM\_\* constants, used internally. - Description ----------- @@ -54,21 +69,47 @@ Property Descriptions .. _class_ConeTwistJoint_bias: -- :ref:`float` **bias** - The speed with which the swing or twist will take place. +- :ref:`float` **bias** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +The speed with which the swing or twist will take place. The higher, the faster. .. _class_ConeTwistJoint_relaxation: -- :ref:`float` **relaxation** - Defines, how fast the swing- and twist-speed-difference on both sides gets synced. +- :ref:`float` **relaxation** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +Defines, how fast the swing- and twist-speed-difference on both sides gets synced. .. _class_ConeTwistJoint_softness: -- :ref:`float` **softness** - The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint. +- :ref:`float` **softness** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +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: -- :ref:`float` **swing_span** - Swing is rotation from side to side, around the axis perpendicular to the twist axis. +- :ref:`float` **swing_span** + +Swing is rotation from side to side, around the axis perpendicular to the twist axis. The swing span defines, how much rotation will not get corrected allong the swing axis. @@ -78,8 +119,9 @@ If below 0.05, this behaviour is locked. Default value: ``PI/4``. .. _class_ConeTwistJoint_twist_span: -- :ref:`float` **twist_span** - Twist is the rotation around the twist axis, this value defined how far the joint can twist. +- :ref:`float` **twist_span** + +Twist is the rotation around the twist axis, this value defined how far the joint can twist. Twist is locked if below 0.05. - diff --git a/classes/class_configfile.rst b/classes/class_configfile.rst index 4d2a2fe34..7b4a4cdc0 100644 --- a/classes/class_configfile.rst +++ b/classes/class_configfile.rst @@ -8,6 +8,7 @@ ConfigFile ========== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -70,58 +71,57 @@ The following example shows how to parse an INI-style file from the system, read Method Descriptions ------------------- -.. _class_ConfigFile_erase_section: + .. _class_ConfigFile_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_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_get_sections: - :ref:`PoolStringArray` **get_sections** **(** **)** const Returns an array of all defined section identifiers. -.. _class_ConfigFile_get_value: + .. _class_ConfigFile_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_has_section: - :ref:`bool` **has_section** **(** :ref:`String` section **)** const Returns ``true`` if the specified section exists. -.. _class_ConfigFile_has_section_key: + .. _class_ConfigFile_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_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_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_set_value: - void **set_value** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` value **)** Assigns a value to the specified key of the specified section. If the section and/or the key do not exist, they are created. Passing a ``null`` value deletes the specified key if it exists, and deletes the section if it ends up empty once the key has been removed. - diff --git a/classes/class_confirmationdialog.rst b/classes/class_confirmationdialog.rst index 8d39a1939..821a184f2 100644 --- a/classes/class_confirmationdialog.rst +++ b/classes/class_confirmationdialog.rst @@ -8,7 +8,9 @@ ConfirmationDialog ================== **Inherits:** :ref:`AcceptDialog` **<** :ref:`WindowDialog` **<** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`ScriptCreateDialog`, :ref:`EditorFileDialog`, :ref:`FileDialog` + **Category:** Core Brief Description @@ -31,10 +33,9 @@ Dialog for confirmation of actions. This dialog inherits from :ref:`AcceptDialog Method Descriptions ------------------- -.. _class_ConfirmationDialog_get_cancel: + .. _class_ConfirmationDialog_get_cancel: - :ref:`Button` **get_cancel** **(** **)** Return the cancel button. - diff --git a/classes/class_container.rst b/classes/class_container.rst index 1608e6466..933eafe22 100644 --- a/classes/class_container.rst +++ b/classes/class_container.rst @@ -8,7 +8,9 @@ Container ========= **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`PanelContainer`, :ref:`GridContainer`, :ref:`ScrollContainer`, :ref:`ViewportContainer`, :ref:`MarginContainer`, :ref:`CenterContainer`, :ref:`TabContainer`, :ref:`GraphNode`, :ref:`SplitContainer`, :ref:`BoxContainer`, :ref:`EditorProperty` + **Category:** Core Brief Description @@ -28,18 +30,16 @@ Methods Signals ------- -.. _class_Container_sort_children: + .. _class_Container_sort_children: - **sort_children** **(** **)** Emitted when sorting the children is needed. - Constants --------- - **NOTIFICATION_SORT_CHILDREN** = **50** --- Notification for when sorting the children, it must be obeyed immediately. - Description ----------- @@ -50,16 +50,15 @@ A Control can inherit this to create custom container classes. Method Descriptions ------------------- -.. _class_Container_fit_child_in_rect: + .. _class_Container_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_queue_sort: - void **queue_sort** **(** **)** Queue resort of the contained children. This is called automatically anyway, but can be called upon request. - diff --git a/classes/class_control.rst b/classes/class_control.rst index 4c79b1a9f..8432603ea 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -8,7 +8,9 @@ Control ======= **Inherits:** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`TextureRect`, :ref:`ColorRect`, :ref:`Label`, :ref:`Tabs`, :ref:`GraphEdit`, :ref:`VideoPlayer`, :ref:`NinePatchRect`, :ref:`LineEdit`, :ref:`Container`, :ref:`TextEdit`, :ref:`BaseButton`, :ref:`Popup`, :ref:`Tree`, :ref:`Separator`, :ref:`ReferenceRect`, :ref:`Panel`, :ref:`Range`, :ref:`RichTextLabel`, :ref:`ItemList` + **Category:** Core Brief Description @@ -16,6 +18,75 @@ Brief Description All User Interface nodes inherit from Control. A control's anchors and margins adapt its position and size relative to its parent. +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` | ++--------------------------------------------------+-----------------------------------------------------------------------------+ + Methods ------- @@ -146,67 +217,66 @@ Methods Signals ------- -.. _class_Control_focus_entered: + .. _class_Control_focus_entered: - **focus_entered** **(** **)** Emitted when the node gains keyboard focus. -.. _class_Control_focus_exited: + .. _class_Control_focus_exited: - **focus_exited** **(** **)** Emitted when the node loses keyboard focus. -.. _class_Control_gui_input: + .. _class_Control_gui_input: - **gui_input** **(** :ref:`InputEvent` event **)** Emitted when the node receives an :ref:`InputEvent`. -.. _class_Control_minimum_size_changed: + .. _class_Control_minimum_size_changed: - **minimum_size_changed** **(** **)** Emitted when the node's minimum size changes. -.. _class_Control_modal_closed: + .. _class_Control_modal_closed: - **modal_closed** **(** **)** Emitted when a modal ``Control`` is closed. See :ref:`show_modal`. -.. _class_Control_mouse_entered: + .. _class_Control_mouse_entered: - **mouse_entered** **(** **)** 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_mouse_exited: - **mouse_exited** **(** **)** 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_resized: - **resized** **(** **)** Emitted when the control changes size. -.. _class_Control_size_flags_changed: + .. _class_Control_size_flags_changed: - **size_flags_changed** **(** **)** Emitted when one of the size flags changes. See :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. - Enumerations ------------ .. _enum_Control_SizeFlags: -enum **SizeFlags** +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_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`. @@ -216,7 +286,7 @@ enum **SizeFlags** .. _enum_Control_CursorShape: -enum **CursorShape** +enum **CursorShape**: - **CURSOR_ARROW** = **0** --- Show the system's arrow mouse cursor when the user hovers the node. Use with :ref:`set_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. @@ -238,7 +308,7 @@ enum **CursorShape** .. _enum_Control_FocusMode: -enum **FocusMode** +enum **FocusMode**: - **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`. @@ -246,7 +316,7 @@ enum **FocusMode** .. _enum_Control_GrowDirection: -enum **GrowDirection** +enum **GrowDirection**: - **GROW_DIRECTION_BEGIN** = **0** - **GROW_DIRECTION_END** = **1** @@ -254,7 +324,7 @@ enum **GrowDirection** .. _enum_Control_LayoutPresetMode: -enum **LayoutPresetMode** +enum **LayoutPresetMode**: - **PRESET_MODE_MINSIZE** = **0** - **PRESET_MODE_KEEP_WIDTH** = **1** @@ -263,7 +333,7 @@ enum **LayoutPresetMode** .. _enum_Control_LayoutPreset: -enum **LayoutPreset** +enum **LayoutPreset**: - **PRESET_TOP_LEFT** = **0** --- Snap all 4 anchors to the top-left of the parent container's bounds. Use with :ref:`set_anchors_preset`. - **PRESET_TOP_RIGHT** = **1** --- Snap all 4 anchors to the top-right of the parent container's bounds. Use with :ref:`set_anchors_preset`. @@ -284,7 +354,7 @@ enum **LayoutPreset** .. _enum_Control_MouseFilter: -enum **MouseFilter** +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_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. @@ -292,12 +362,11 @@ enum **MouseFilter** .. _enum_Control_Anchor: -enum **Anchor** +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_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 --------- @@ -310,7 +379,6 @@ Constants - **NOTIFICATION_MODAL_CLOSE** = **46** --- Sent when an open modal dialog closes. See :ref:`show_modal`. - **NOTIFICATION_SCROLL_BEGIN** = **47** - **NOTIFICATION_SCROLL_END** = **48** - Description ----------- @@ -333,159 +401,393 @@ Tutorials - :doc:`../tutorials/gui/index` - :doc:`../tutorials/2d/custom_drawing_in_2d` - Property Descriptions --------------------- .. _class_Control_anchor_bottom: -- :ref:`float` **anchor_bottom** - Anchors the bottom edge of the node to the origin, the center, or the end of its parent container. It changes how the bottom margin updates when the node moves or changes size. Use one of the ``ANCHOR_*`` constants. Default value: ``ANCHOR_BEGIN``. +- :ref:`float` **anchor_bottom** + ++----------+--------------+ +| *Getter* | get_anchor() | ++----------+--------------+ + +Anchors the bottom edge of the node to the origin, the center, or the end of its parent container. It changes how the bottom margin updates when the node moves or changes size. Use one of the ``ANCHOR_*`` constants. Default value: ``ANCHOR_BEGIN``. .. _class_Control_anchor_left: -- :ref:`float` **anchor_left** - Anchors the left edge of the node to the origin, the center or the end of its parent container. It changes how the left margin updates when the node moves or changes size. Use one of the ``ANCHOR_*`` constants. Default value: ``ANCHOR_BEGIN``. +- :ref:`float` **anchor_left** + ++----------+--------------+ +| *Getter* | get_anchor() | ++----------+--------------+ + +Anchors the left edge of the node to the origin, the center or the end of its parent container. It changes how the left margin updates when the node moves or changes size. Use one of the ``ANCHOR_*`` constants. Default value: ``ANCHOR_BEGIN``. .. _class_Control_anchor_right: -- :ref:`float` **anchor_right** - Anchors the right edge of the node to the origin, the center or the end of its parent container. It changes how the right margin updates when the node moves or changes size. Use one of the ``ANCHOR_*`` constants. Default value: ``ANCHOR_BEGIN``. +- :ref:`float` **anchor_right** + ++----------+--------------+ +| *Getter* | get_anchor() | ++----------+--------------+ + +Anchors the right edge of the node to the origin, the center or the end of its parent container. It changes how the right margin updates when the node moves or changes size. Use one of the ``ANCHOR_*`` constants. Default value: ``ANCHOR_BEGIN``. .. _class_Control_anchor_top: -- :ref:`float` **anchor_top** - Anchors the top edge of the node to the origin, the center or the end of its parent container. It changes how the top margin updates when the node moves or changes size. Use one of the ``ANCHOR_*`` constants. Default value: ``ANCHOR_BEGIN``. +- :ref:`float` **anchor_top** + ++----------+--------------+ +| *Getter* | get_anchor() | ++----------+--------------+ + +Anchors the top edge of the node to the origin, the center or the end of its parent container. It changes how the top margin updates when the node moves or changes size. Use one of the ``ANCHOR_*`` constants. Default value: ``ANCHOR_BEGIN``. .. _class_Control_focus_mode: -- :ref:`FocusMode` **focus_mode** - 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. +- :ref:`FocusMode` **focus_mode** + ++----------+-----------------------+ +| *Setter* | set_focus_mode(value) | ++----------+-----------------------+ +| *Getter* | get_focus_mode() | ++----------+-----------------------+ + +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: -- :ref:`NodePath` **focus_neighbour_bottom** - Tells Godot which node it should give keyboard focus to if the user presses Tab, the down arrow on the keyboard, or down on a gamepad. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one. +- :ref:`NodePath` **focus_neighbour_bottom** + ++----------+----------------------------+ +| *Setter* | set_focus_neighbour(value) | ++----------+----------------------------+ +| *Getter* | get_focus_neighbour() | ++----------+----------------------------+ + +Tells Godot which node it should give keyboard focus to if the user presses Tab, the down arrow on the keyboard, or down on a gamepad. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one. If the user presses Tab, Godot will give focus to the closest node to the right first, then to the bottom. If the user presses Shift+Tab, Godot will look to the left of the node, then above it. .. _class_Control_focus_neighbour_left: -- :ref:`NodePath` **focus_neighbour_left** - Tells Godot which node it should give keyboard focus to if the user presses Shift+Tab, the left arrow on the keyboard or left on a gamepad. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the left of this one. +- :ref:`NodePath` **focus_neighbour_left** + ++----------+----------------------------+ +| *Setter* | set_focus_neighbour(value) | ++----------+----------------------------+ +| *Getter* | get_focus_neighbour() | ++----------+----------------------------+ + +Tells Godot which node it should give keyboard focus to if the user presses Shift+Tab, the left arrow on the keyboard or left on a gamepad. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the left of this one. .. _class_Control_focus_neighbour_right: -- :ref:`NodePath` **focus_neighbour_right** - Tells Godot which node it should give keyboard focus to if the user presses Tab, the right arrow on the keyboard or right on a gamepad. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one. +- :ref:`NodePath` **focus_neighbour_right** + ++----------+----------------------------+ +| *Setter* | set_focus_neighbour(value) | ++----------+----------------------------+ +| *Getter* | get_focus_neighbour() | ++----------+----------------------------+ + +Tells Godot which node it should give keyboard focus to if the user presses Tab, the right arrow on the keyboard or right on a gamepad. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one. .. _class_Control_focus_neighbour_top: -- :ref:`NodePath` **focus_neighbour_top** - Tells Godot which node it should give keyboard focus to if the user presses Shift+Tab, the top arrow on the keyboard or top on a gamepad. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one. +- :ref:`NodePath` **focus_neighbour_top** + ++----------+----------------------------+ +| *Setter* | set_focus_neighbour(value) | ++----------+----------------------------+ +| *Getter* | get_focus_neighbour() | ++----------+----------------------------+ + +Tells Godot which node it should give keyboard focus to if the user presses Shift+Tab, the top arrow on the keyboard or top on a gamepad. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one. .. _class_Control_focus_next: - :ref:`NodePath` **focus_next** ++----------+-----------------------+ +| *Setter* | set_focus_next(value) | ++----------+-----------------------+ +| *Getter* | get_focus_next() | ++----------+-----------------------+ + .. _class_Control_focus_previous: - :ref:`NodePath` **focus_previous** ++----------+---------------------------+ +| *Setter* | set_focus_previous(value) | ++----------+---------------------------+ +| *Getter* | get_focus_previous() | ++----------+---------------------------+ + .. _class_Control_grow_horizontal: - :ref:`GrowDirection` **grow_horizontal** ++----------+-----------------------------+ +| *Setter* | set_h_grow_direction(value) | ++----------+-----------------------------+ +| *Getter* | get_h_grow_direction() | ++----------+-----------------------------+ + .. _class_Control_grow_vertical: - :ref:`GrowDirection` **grow_vertical** ++----------+-----------------------------+ +| *Setter* | set_v_grow_direction(value) | ++----------+-----------------------------+ +| *Getter* | get_v_grow_direction() | ++----------+-----------------------------+ + .. _class_Control_hint_tooltip: -- :ref:`String` **hint_tooltip** - Changes the tooltip text. The tooltip appears when the user's mouse cursor stays idle over this control for a few moments. +- :ref:`String` **hint_tooltip** + ++----------+--------------------+ +| *Setter* | set_tooltip(value) | ++----------+--------------------+ + +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: -- :ref:`float` **margin_bottom** - Distance between the node's bottom edge and its parent container, based on :ref:`anchor_bottom`. +- :ref:`float` **margin_bottom** + ++----------+-------------------+ +| *Setter* | set_margin(value) | ++----------+-------------------+ +| *Getter* | get_margin() | ++----------+-------------------+ + +Distance between the node's bottom edge and its parent container, based on :ref:`anchor_bottom`. Margins are often controlled by one or multiple parent :ref:`Container` nodes. Margins update automatically when you move or resize the node. .. _class_Control_margin_left: -- :ref:`float` **margin_left** - Distance between the node's left edge and its parent container, based on :ref:`anchor_left`. +- :ref:`float` **margin_left** + ++----------+-------------------+ +| *Setter* | set_margin(value) | ++----------+-------------------+ +| *Getter* | get_margin() | ++----------+-------------------+ + +Distance between the node's left edge and its parent container, based on :ref:`anchor_left`. .. _class_Control_margin_right: -- :ref:`float` **margin_right** - Distance between the node's right edge and its parent container, based on :ref:`anchor_right`. +- :ref:`float` **margin_right** + ++----------+-------------------+ +| *Setter* | set_margin(value) | ++----------+-------------------+ +| *Getter* | get_margin() | ++----------+-------------------+ + +Distance between the node's right edge and its parent container, based on :ref:`anchor_right`. .. _class_Control_margin_top: -- :ref:`float` **margin_top** - Distance between the node's top edge and its parent container, based on :ref:`anchor_top`. +- :ref:`float` **margin_top** + ++----------+-------------------+ +| *Setter* | set_margin(value) | ++----------+-------------------+ +| *Getter* | get_margin() | ++----------+-------------------+ + +Distance between the node's top edge and its parent container, based on :ref:`anchor_top`. .. _class_Control_mouse_default_cursor_shape: -- :ref:`CursorShape` **mouse_default_cursor_shape** - The default cursor shape for this control. Useful for Godot plugins and applications or games that use the system's mouse cursors. +- :ref:`CursorShape` **mouse_default_cursor_shape** + ++----------+---------------------------------+ +| *Setter* | set_default_cursor_shape(value) | ++----------+---------------------------------+ +| *Getter* | get_default_cursor_shape() | ++----------+---------------------------------+ + +The default cursor shape for this control. Useful for Godot plugins and applications or games that use the system's mouse cursors. **Note:** On Linux, shapes may vary depending on the cursor theme of the system. .. _class_Control_mouse_filter: -- :ref:`MouseFilter` **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. Use one of the ``MOUSE_FILTER_*`` constants. See the constants to learn what each does. +- :ref:`MouseFilter` **mouse_filter** + ++----------+-------------------------+ +| *Setter* | set_mouse_filter(value) | ++----------+-------------------------+ +| *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. Use one of the ``MOUSE_FILTER_*`` constants. See the constants to learn what each does. .. _class_Control_rect_clip_content: - :ref:`bool` **rect_clip_content** ++----------+--------------------------+ +| *Setter* | set_clip_contents(value) | ++----------+--------------------------+ +| *Getter* | is_clipping_contents() | ++----------+--------------------------+ + .. _class_Control_rect_global_position: -- :ref:`Vector2` **rect_global_position** - The node's global position, relative to the world (usually to the top-left corner of the window). +- :ref:`Vector2` **rect_global_position** + ++----------+----------------------------+ +| *Setter* | set_global_position(value) | ++----------+----------------------------+ +| *Getter* | get_global_position() | ++----------+----------------------------+ + +The node's global position, relative to the world (usually to the top-left corner of the window). .. _class_Control_rect_min_size: -- :ref:`Vector2` **rect_min_size** - 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. +- :ref:`Vector2` **rect_min_size** + ++----------+--------------------------------+ +| *Setter* | set_custom_minimum_size(value) | ++----------+--------------------------------+ +| *Getter* | get_custom_minimum_size() | ++----------+--------------------------------+ + +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: -- :ref:`Vector2` **rect_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. +- :ref:`Vector2` **rect_pivot_offset** + ++----------+-------------------------+ +| *Setter* | set_pivot_offset(value) | ++----------+-------------------------+ +| *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. .. _class_Control_rect_position: -- :ref:`Vector2` **rect_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`. +- :ref:`Vector2` **rect_position** + ++----------+---------------------+ +| *Setter* | set_position(value) | ++----------+---------------------+ +| *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`. .. _class_Control_rect_rotation: -- :ref:`float` **rect_rotation** - The node's rotation around its pivot, in degrees. See :ref:`rect_pivot_offset` to change the pivot's position. +- :ref:`float` **rect_rotation** + ++----------+-----------------------------+ +| *Setter* | set_rotation_degrees(value) | ++----------+-----------------------------+ +| *Getter* | get_rotation_degrees() | ++----------+-----------------------------+ + +The node's rotation around its pivot, in degrees. See :ref:`rect_pivot_offset` to change the pivot's position. .. _class_Control_rect_scale: -- :ref:`Vector2` **rect_scale** - The node's scale, relative to its :ref:`rect_size`. Change this property to scale the node around its :ref:`rect_pivot_offset`. +- :ref:`Vector2` **rect_scale** + ++----------+------------------+ +| *Setter* | set_scale(value) | ++----------+------------------+ +| *Getter* | get_scale() | ++----------+------------------+ + +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: -- :ref:`Vector2` **rect_size** - The size of the node's bounding rectangle, in pixels. :ref:`Container` nodes update this property automatically. +- :ref:`Vector2` **rect_size** + ++----------+-----------------+ +| *Setter* | set_size(value) | ++----------+-----------------+ +| *Getter* | get_size() | ++----------+-----------------+ + +The size of the node's bounding rectangle, in pixels. :ref:`Container` nodes update this property automatically. .. _class_Control_size_flags_horizontal: -- :ref:`int` **size_flags_horizontal** - Tells the parent :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. +- :ref:`int` **size_flags_horizontal** + ++----------+-------------------------+ +| *Setter* | set_h_size_flags(value) | ++----------+-------------------------+ +| *Getter* | get_h_size_flags() | ++----------+-------------------------+ + +Tells the parent :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: -- :ref:`float` **size_flags_stretch_ratio** - 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. +- :ref:`float` **size_flags_stretch_ratio** + ++----------+--------------------------+ +| *Setter* | set_stretch_ratio(value) | ++----------+--------------------------+ +| *Getter* | get_stretch_ratio() | ++----------+--------------------------+ + +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: -- :ref:`int` **size_flags_vertical** - 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. +- :ref:`int` **size_flags_vertical** + ++----------+-------------------------+ +| *Setter* | set_v_size_flags(value) | ++----------+-------------------------+ +| *Getter* | get_v_size_flags() | ++----------+-------------------------+ + +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: -- :ref:`Theme` **theme** - Changing this property replaces the current :ref:`Theme` resource this node and all its ``Control`` children use. +- :ref:`Theme` **theme** ++----------+------------------+ +| *Setter* | set_theme(value) | ++----------+------------------+ +| *Getter* | get_theme() | ++----------+------------------+ + +Changing this property replaces the current :ref:`Theme` resource this node and all its ``Control`` children use. Method Descriptions ------------------- -.. _class_Control__clips_input: + .. _class_Control__clips_input: - :ref:`bool` **_clips_input** **(** **)** virtual -.. _class_Control__get_minimum_size: + .. _class_Control__get_minimum_size: - :ref:`Vector2` **_get_minimum_size** **(** **)** virtual Returns the minimum size for this control. See :ref:`rect_min_size`. -.. _class_Control__gui_input: + .. _class_Control__gui_input: - void **_gui_input** **(** :ref:`InputEvent` event **)** virtual @@ -493,53 +795,53 @@ Use this method to process and accept inputs on UI elements. See :ref:`accept_ev Replaces Godot 2's ``_input_event``. -.. _class_Control__make_custom_tooltip: + .. _class_Control__make_custom_tooltip: - :ref:`Object` **_make_custom_tooltip** **(** :ref:`String` for_text **)** virtual -.. _class_Control_accept_event: + .. _class_Control_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`. -.. _class_Control_add_color_override: + .. _class_Control_add_color_override: - void **add_color_override** **(** :ref:`String` name, :ref:`Color` color **)** Overrides the color in the :ref:`theme` resource the node uses. -.. _class_Control_add_constant_override: + .. _class_Control_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. See :ref:`Theme.INVALID_CONSTANT` for more information. -.. _class_Control_add_font_override: + .. _class_Control_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. -.. _class_Control_add_icon_override: + .. _class_Control_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. -.. _class_Control_add_shader_override: + .. _class_Control_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. -.. _class_Control_add_stylebox_override: + .. _class_Control_add_stylebox_override: - void **add_stylebox_override** **(** :ref:`String` name, :ref:`StyleBox` stylebox **)** Overrides the ``name`` Stylebox in the :ref:`theme` resource the node uses. If ``stylebox`` is empty, Godot clears the override. -.. _class_Control_can_drop_data: + .. _class_Control_can_drop_data: - :ref:`bool` **can_drop_data** **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual @@ -556,7 +858,7 @@ 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_drop_data: - void **drop_data** **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual @@ -572,7 +874,7 @@ 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_force_drag: - void **force_drag** **(** :ref:`Variant` data, :ref:`Control` preview **)** @@ -580,31 +882,31 @@ Forces drag and bypasses :ref:`get_drag_data` and : 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_get_begin: - :ref:`Vector2` **get_begin** **(** **)** const Returns :ref:`margin_left` and :ref:`margin_top`. See also :ref:`rect_position`. -.. _class_Control_get_color: + .. _class_Control_get_color: - :ref:`Color` **get_color** **(** :ref:`String` name, :ref:`String` type="" **)** const -.. _class_Control_get_combined_minimum_size: + .. _class_Control_get_combined_minimum_size: - :ref:`Vector2` **get_combined_minimum_size** **(** **)** const -.. _class_Control_get_constant: + .. _class_Control_get_constant: - :ref:`int` **get_constant** **(** :ref:`String` name, :ref:`String` type="" **)** const -.. _class_Control_get_cursor_shape: + .. _class_Control_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`. -.. _class_Control_get_drag_data: + .. _class_Control_get_drag_data: - :ref:`Object` **get_drag_data** **(** :ref:`Vector2` position **)** virtual @@ -621,169 +923,169 @@ 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_get_end: - :ref:`Vector2` **get_end** **(** **)** const Returns :ref:`margin_right` and :ref:`margin_bottom`. -.. _class_Control_get_focus_owner: + .. _class_Control_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_get_font: - :ref:`Font` **get_font** **(** :ref:`String` name, :ref:`String` type="" **)** const -.. _class_Control_get_global_rect: + .. _class_Control_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`. -.. _class_Control_get_icon: + .. _class_Control_get_icon: - :ref:`Texture` **get_icon** **(** :ref:`String` name, :ref:`String` type="" **)** const -.. _class_Control_get_minimum_size: + .. _class_Control_get_minimum_size: - :ref:`Vector2` **get_minimum_size** **(** **)** const Returns the minimum size for this control. See :ref:`rect_min_size`. -.. _class_Control_get_parent_area_size: + .. _class_Control_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_get_parent_control: - :ref:`Control` **get_parent_control** **(** **)** const Returns the parent control node. -.. _class_Control_get_rect: + .. _class_Control_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`. -.. _class_Control_get_rotation: + .. _class_Control_get_rotation: - :ref:`float` **get_rotation** **(** **)** const Returns the rotation (in radians). -.. _class_Control_get_stylebox: + .. _class_Control_get_stylebox: - :ref:`StyleBox` **get_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** const -.. _class_Control_get_tooltip: + .. _class_Control_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_grab_click_focus: - void **grab_click_focus** **(** **)** -.. _class_Control_grab_focus: + .. _class_Control_grab_focus: - void **grab_focus** **(** **)** Steal the focus from another control and become the focused control (see :ref:`set_focus_mode`). -.. _class_Control_has_color: + .. _class_Control_has_color: - :ref:`bool` **has_color** **(** :ref:`String` name, :ref:`String` type="" **)** const -.. _class_Control_has_color_override: + .. _class_Control_has_color_override: - :ref:`bool` **has_color_override** **(** :ref:`String` name **)** const -.. _class_Control_has_constant: + .. _class_Control_has_constant: - :ref:`bool` **has_constant** **(** :ref:`String` name, :ref:`String` type="" **)** const -.. _class_Control_has_constant_override: + .. _class_Control_has_constant_override: - :ref:`bool` **has_constant_override** **(** :ref:`String` name **)** const -.. _class_Control_has_focus: + .. _class_Control_has_focus: - :ref:`bool` **has_focus** **(** **)** const Returns ``true`` if this is the current focused control. See :ref:`focus_mode`. -.. _class_Control_has_font: + .. _class_Control_has_font: - :ref:`bool` **has_font** **(** :ref:`String` name, :ref:`String` type="" **)** const -.. _class_Control_has_font_override: + .. _class_Control_has_font_override: - :ref:`bool` **has_font_override** **(** :ref:`String` name **)** const -.. _class_Control_has_icon: + .. _class_Control_has_icon: - :ref:`bool` **has_icon** **(** :ref:`String` name, :ref:`String` type="" **)** const -.. _class_Control_has_icon_override: + .. _class_Control_has_icon_override: - :ref:`bool` **has_icon_override** **(** :ref:`String` name **)** const -.. _class_Control_has_point: + .. _class_Control_has_point: - :ref:`bool` **has_point** **(** :ref:`Vector2` point **)** virtual -.. _class_Control_has_shader_override: + .. _class_Control_has_shader_override: - :ref:`bool` **has_shader_override** **(** :ref:`String` name **)** const -.. _class_Control_has_stylebox: + .. _class_Control_has_stylebox: - :ref:`bool` **has_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** const -.. _class_Control_has_stylebox_override: + .. _class_Control_has_stylebox_override: - :ref:`bool` **has_stylebox_override** **(** :ref:`String` name **)** const -.. _class_Control_minimum_size_changed: + .. _class_Control_minimum_size_changed: - void **minimum_size_changed** **(** **)** -.. _class_Control_release_focus: + .. _class_Control_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_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_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_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_set_anchors_preset: - void **set_anchors_preset** **(** :ref:`LayoutPreset` preset, :ref:`bool` keep_margin=false **)** -.. _class_Control_set_begin: + .. _class_Control_set_begin: - void **set_begin** **(** :ref:`Vector2` position **)** Sets :ref:`margin_left` and :ref:`margin_top` at the same time. -.. _class_Control_set_drag_forwarding: + .. _class_Control_set_drag_forwarding: - void **set_drag_forwarding** **(** :ref:`Control` target **)** @@ -814,36 +1116,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_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`. -.. _class_Control_set_end: + .. _class_Control_set_end: - void **set_end** **(** :ref:`Vector2` position **)** Sets :ref:`margin_right` and :ref:`margin_bottom` at the same time. -.. _class_Control_set_margins_preset: + .. _class_Control_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_set_rotation: - void **set_rotation** **(** :ref:`float` radians **)** Sets the rotation (in radians). -.. _class_Control_show_modal: + .. _class_Control_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_warp_mouse: - void **warp_mouse** **(** :ref:`Vector2` to_position **)** - diff --git a/classes/class_convexpolygonshape.rst b/classes/class_convexpolygonshape.rst index a659e2fdb..b24a35b66 100644 --- a/classes/class_convexpolygonshape.rst +++ b/classes/class_convexpolygonshape.rst @@ -8,6 +8,7 @@ ConvexPolygonShape ================== **Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Convex polygon shape for 3D physics. +Properties +---------- + ++-------------------------------------------------+------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`points` | ++-------------------------------------------------+------------------------------------------------+ + Description ----------- @@ -25,6 +33,13 @@ Property Descriptions .. _class_ConvexPolygonShape_points: -- :ref:`PoolVector3Array` **points** - The list of 3D points forming the convex polygon shape. +- :ref:`PoolVector3Array` **points** ++----------+-------------------+ +| *Setter* | set_points(value) | ++----------+-------------------+ +| *Getter* | get_points() | ++----------+-------------------+ + +The list of 3D points forming the convex polygon shape. diff --git a/classes/class_convexpolygonshape2d.rst b/classes/class_convexpolygonshape2d.rst index 42463c4c1..95beb184e 100644 --- a/classes/class_convexpolygonshape2d.rst +++ b/classes/class_convexpolygonshape2d.rst @@ -8,6 +8,7 @@ ConvexPolygonShape2D ==================== **Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Convex Polygon Shape for 2D physics. +Properties +---------- + ++-------------------------------------------------+--------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`points` | ++-------------------------------------------------+--------------------------------------------------+ + Methods ------- @@ -34,16 +42,22 @@ Property Descriptions .. _class_ConvexPolygonShape2D_points: -- :ref:`PoolVector2Array` **points** - The polygon's list of vertices. Can be in either clockwise or counterclockwise order. +- :ref:`PoolVector2Array` **points** ++----------+-------------------+ +| *Setter* | set_points(value) | ++----------+-------------------+ +| *Getter* | get_points() | ++----------+-------------------+ + +The polygon's list of vertices. Can be in either clockwise or counterclockwise order. Method Descriptions ------------------- -.. _class_ConvexPolygonShape2D_set_point_cloud: + .. _class_ConvexPolygonShape2D_set_point_cloud: - void **set_point_cloud** **(** :ref:`PoolVector2Array` point_cloud **)** Currently, this method does nothing. - diff --git a/classes/class_cpuparticles.rst b/classes/class_cpuparticles.rst index fe49fbfc9..8100ec7a4 100644 --- a/classes/class_cpuparticles.rst +++ b/classes/class_cpuparticles.rst @@ -8,6 +8,7 @@ CPUParticles ============ **Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,131 @@ 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:`bool` | :ref:`anim_loop` | ++-------------------------------------------------------+----------------------------------------------------------------------------+ +| :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` | ++-------------------------------------------------------+----------------------------------------------------------------------------+ +| :ref:`Curve` | :ref:`scale_curve` | ++-------------------------------------------------------+----------------------------------------------------------------------------+ +| :ref:`float` | :ref:`scale_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 ------- @@ -29,7 +155,7 @@ Enumerations .. _enum_CPUParticles_Flags: -enum **Flags** +enum **Flags**: - **FLAG_ALIGN_Y_TO_VELOCITY** = **0** - **FLAG_ROTATE_Y** = **1** @@ -37,7 +163,7 @@ enum **Flags** .. _enum_CPUParticles_Parameter: -enum **Parameter** +enum **Parameter**: - **PARAM_INITIAL_LINEAR_VELOCITY** = **0** - **PARAM_ANGULAR_VELOCITY** = **1** @@ -54,7 +180,7 @@ enum **Parameter** .. _enum_CPUParticles_EmissionShape: -enum **EmissionShape** +enum **EmissionShape**: - **EMISSION_SHAPE_POINT** = **0** - **EMISSION_SHAPE_SPHERE** = **1** @@ -64,13 +190,12 @@ enum **EmissionShape** .. _enum_CPUParticles_DrawOrder: -enum **DrawOrder** +enum **DrawOrder**: - **DRAW_ORDER_INDEX** = **0** - **DRAW_ORDER_LIFETIME** = **1** - **DRAW_ORDER_VIEW_DEPTH** = **2** - Property Descriptions --------------------- @@ -78,252 +203,610 @@ Property Descriptions - :ref:`int` **amount** ++----------+-------------------+ +| *Setter* | set_amount(value) | ++----------+-------------------+ +| *Getter* | get_amount() | ++----------+-------------------+ + .. _class_CPUParticles_angle: - :ref:`float` **angle** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + .. _class_CPUParticles_angle_curve: - :ref:`Curve` **angle_curve** ++----------+------------------------+ +| *Setter* | set_param_curve(value) | ++----------+------------------------+ +| *Getter* | get_param_curve() | ++----------+------------------------+ + .. _class_CPUParticles_angle_random: - :ref:`float` **angle_random** ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + .. _class_CPUParticles_angular_velocity: - :ref:`float` **angular_velocity** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + .. _class_CPUParticles_angular_velocity_curve: - :ref:`Curve` **angular_velocity_curve** ++----------+------------------------+ +| *Setter* | set_param_curve(value) | ++----------+------------------------+ +| *Getter* | get_param_curve() | ++----------+------------------------+ + .. _class_CPUParticles_angular_velocity_random: - :ref:`float` **angular_velocity_random** ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + .. _class_CPUParticles_anim_loop: - :ref:`bool` **anim_loop** ++----------+--------------------------+ +| *Setter* | set_particle_flag(value) | ++----------+--------------------------+ +| *Getter* | get_particle_flag() | ++----------+--------------------------+ + .. _class_CPUParticles_anim_offset: - :ref:`float` **anim_offset** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + .. _class_CPUParticles_anim_offset_curve: - :ref:`Curve` **anim_offset_curve** ++----------+------------------------+ +| *Setter* | set_param_curve(value) | ++----------+------------------------+ +| *Getter* | get_param_curve() | ++----------+------------------------+ + .. _class_CPUParticles_anim_offset_random: - :ref:`float` **anim_offset_random** ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + .. _class_CPUParticles_anim_speed: - :ref:`float` **anim_speed** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + .. _class_CPUParticles_anim_speed_curve: - :ref:`Curve` **anim_speed_curve** ++----------+------------------------+ +| *Setter* | set_param_curve(value) | ++----------+------------------------+ +| *Getter* | get_param_curve() | ++----------+------------------------+ + .. _class_CPUParticles_anim_speed_random: - :ref:`float` **anim_speed_random** ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + .. _class_CPUParticles_color: - :ref:`Color` **color** ++----------+------------------+ +| *Setter* | set_color(value) | ++----------+------------------+ +| *Getter* | get_color() | ++----------+------------------+ + .. _class_CPUParticles_color_ramp: - :ref:`Gradient` **color_ramp** ++----------+-----------------------+ +| *Setter* | set_color_ramp(value) | ++----------+-----------------------+ +| *Getter* | get_color_ramp() | ++----------+-----------------------+ + .. _class_CPUParticles_damping: - :ref:`float` **damping** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + .. _class_CPUParticles_damping_curve: - :ref:`Curve` **damping_curve** ++----------+------------------------+ +| *Setter* | set_param_curve(value) | ++----------+------------------------+ +| *Getter* | get_param_curve() | ++----------+------------------------+ + .. _class_CPUParticles_damping_random: - :ref:`float` **damping_random** ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + .. _class_CPUParticles_draw_order: - :ref:`DrawOrder` **draw_order** ++----------+-----------------------+ +| *Setter* | set_draw_order(value) | ++----------+-----------------------+ +| *Getter* | get_draw_order() | ++----------+-----------------------+ + .. _class_CPUParticles_emission_box_extents: - :ref:`Vector3` **emission_box_extents** ++----------+---------------------------------+ +| *Setter* | set_emission_box_extents(value) | ++----------+---------------------------------+ +| *Getter* | get_emission_box_extents() | ++----------+---------------------------------+ + .. _class_CPUParticles_emission_colors: - :ref:`PoolColorArray` **emission_colors** ++----------+----------------------------+ +| *Setter* | set_emission_colors(value) | ++----------+----------------------------+ +| *Getter* | get_emission_colors() | ++----------+----------------------------+ + .. _class_CPUParticles_emission_normals: - :ref:`PoolVector3Array` **emission_normals** ++----------+-----------------------------+ +| *Setter* | set_emission_normals(value) | ++----------+-----------------------------+ +| *Getter* | get_emission_normals() | ++----------+-----------------------------+ + .. _class_CPUParticles_emission_points: - :ref:`PoolVector3Array` **emission_points** ++----------+----------------------------+ +| *Setter* | set_emission_points(value) | ++----------+----------------------------+ +| *Getter* | get_emission_points() | ++----------+----------------------------+ + .. _class_CPUParticles_emission_shape: - :ref:`EmissionShape` **emission_shape** ++----------+---------------------------+ +| *Setter* | set_emission_shape(value) | ++----------+---------------------------+ +| *Getter* | get_emission_shape() | ++----------+---------------------------+ + .. _class_CPUParticles_emission_sphere_radius: - :ref:`float` **emission_sphere_radius** ++----------+-----------------------------------+ +| *Setter* | set_emission_sphere_radius(value) | ++----------+-----------------------------------+ +| *Getter* | get_emission_sphere_radius() | ++----------+-----------------------------------+ + .. _class_CPUParticles_emitting: - :ref:`bool` **emitting** ++----------+---------------------+ +| *Setter* | set_emitting(value) | ++----------+---------------------+ +| *Getter* | is_emitting() | ++----------+---------------------+ + .. _class_CPUParticles_explosiveness: - :ref:`float` **explosiveness** ++----------+--------------------------------+ +| *Setter* | set_explosiveness_ratio(value) | ++----------+--------------------------------+ +| *Getter* | get_explosiveness_ratio() | ++----------+--------------------------------+ + .. _class_CPUParticles_fixed_fps: - :ref:`int` **fixed_fps** ++----------+----------------------+ +| *Setter* | set_fixed_fps(value) | ++----------+----------------------+ +| *Getter* | get_fixed_fps() | ++----------+----------------------+ + .. _class_CPUParticles_flag_align_y: - :ref:`bool` **flag_align_y** ++----------+--------------------------+ +| *Setter* | set_particle_flag(value) | ++----------+--------------------------+ +| *Getter* | get_particle_flag() | ++----------+--------------------------+ + .. _class_CPUParticles_flag_disable_z: - :ref:`bool` **flag_disable_z** ++----------+--------------------------+ +| *Setter* | set_particle_flag(value) | ++----------+--------------------------+ +| *Getter* | get_particle_flag() | ++----------+--------------------------+ + .. _class_CPUParticles_flag_rotate_y: - :ref:`bool` **flag_rotate_y** ++----------+--------------------------+ +| *Setter* | set_particle_flag(value) | ++----------+--------------------------+ +| *Getter* | get_particle_flag() | ++----------+--------------------------+ + .. _class_CPUParticles_flatness: - :ref:`float` **flatness** ++----------+---------------------+ +| *Setter* | set_flatness(value) | ++----------+---------------------+ +| *Getter* | get_flatness() | ++----------+---------------------+ + .. _class_CPUParticles_fract_delta: - :ref:`bool` **fract_delta** ++----------+-----------------------------+ +| *Setter* | set_fractional_delta(value) | ++----------+-----------------------------+ +| *Getter* | get_fractional_delta() | ++----------+-----------------------------+ + .. _class_CPUParticles_gravity: - :ref:`Vector3` **gravity** ++----------+--------------------+ +| *Setter* | set_gravity(value) | ++----------+--------------------+ +| *Getter* | get_gravity() | ++----------+--------------------+ + .. _class_CPUParticles_hue_variation: - :ref:`float` **hue_variation** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + .. _class_CPUParticles_hue_variation_curve: - :ref:`Curve` **hue_variation_curve** ++----------+------------------------+ +| *Setter* | set_param_curve(value) | ++----------+------------------------+ +| *Getter* | get_param_curve() | ++----------+------------------------+ + .. _class_CPUParticles_hue_variation_random: - :ref:`float` **hue_variation_random** ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + .. _class_CPUParticles_initial_velocity: - :ref:`float` **initial_velocity** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + .. _class_CPUParticles_initial_velocity_random: - :ref:`float` **initial_velocity_random** ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + .. _class_CPUParticles_lifetime: - :ref:`float` **lifetime** ++----------+---------------------+ +| *Setter* | set_lifetime(value) | ++----------+---------------------+ +| *Getter* | get_lifetime() | ++----------+---------------------+ + .. _class_CPUParticles_linear_accel: - :ref:`float` **linear_accel** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + .. _class_CPUParticles_linear_accel_curve: - :ref:`Curve` **linear_accel_curve** ++----------+------------------------+ +| *Setter* | set_param_curve(value) | ++----------+------------------------+ +| *Getter* | get_param_curve() | ++----------+------------------------+ + .. _class_CPUParticles_linear_accel_random: - :ref:`float` **linear_accel_random** ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + .. _class_CPUParticles_local_coords: - :ref:`bool` **local_coords** ++----------+----------------------------------+ +| *Setter* | set_use_local_coordinates(value) | ++----------+----------------------------------+ +| *Getter* | get_use_local_coordinates() | ++----------+----------------------------------+ + .. _class_CPUParticles_mesh: - :ref:`Mesh` **mesh** ++----------+-----------------+ +| *Setter* | set_mesh(value) | ++----------+-----------------+ +| *Getter* | get_mesh() | ++----------+-----------------+ + .. _class_CPUParticles_one_shot: - :ref:`bool` **one_shot** ++----------+---------------------+ +| *Setter* | set_one_shot(value) | ++----------+---------------------+ +| *Getter* | get_one_shot() | ++----------+---------------------+ + .. _class_CPUParticles_preprocess: - :ref:`float` **preprocess** ++----------+-----------------------------+ +| *Setter* | set_pre_process_time(value) | ++----------+-----------------------------+ +| *Getter* | get_pre_process_time() | ++----------+-----------------------------+ + .. _class_CPUParticles_radial_accel: - :ref:`float` **radial_accel** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + .. _class_CPUParticles_radial_accel_curve: - :ref:`Curve` **radial_accel_curve** ++----------+------------------------+ +| *Setter* | set_param_curve(value) | ++----------+------------------------+ +| *Getter* | get_param_curve() | ++----------+------------------------+ + .. _class_CPUParticles_radial_accel_random: - :ref:`float` **radial_accel_random** ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + .. _class_CPUParticles_randomness: - :ref:`float` **randomness** ++----------+-----------------------------+ +| *Setter* | set_randomness_ratio(value) | ++----------+-----------------------------+ +| *Getter* | get_randomness_ratio() | ++----------+-----------------------------+ + .. _class_CPUParticles_scale: - :ref:`float` **scale** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + .. _class_CPUParticles_scale_curve: - :ref:`Curve` **scale_curve** ++----------+------------------------+ +| *Setter* | set_param_curve(value) | ++----------+------------------------+ +| *Getter* | get_param_curve() | ++----------+------------------------+ + .. _class_CPUParticles_scale_random: - :ref:`float` **scale_random** ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + .. _class_CPUParticles_speed_scale: - :ref:`float` **speed_scale** ++----------+------------------------+ +| *Setter* | set_speed_scale(value) | ++----------+------------------------+ +| *Getter* | get_speed_scale() | ++----------+------------------------+ + .. _class_CPUParticles_spread: - :ref:`float` **spread** ++----------+-------------------+ +| *Setter* | set_spread(value) | ++----------+-------------------+ +| *Getter* | get_spread() | ++----------+-------------------+ + .. _class_CPUParticles_tangential_accel: - :ref:`float` **tangential_accel** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + .. _class_CPUParticles_tangential_accel_curve: - :ref:`Curve` **tangential_accel_curve** ++----------+------------------------+ +| *Setter* | set_param_curve(value) | ++----------+------------------------+ +| *Getter* | get_param_curve() | ++----------+------------------------+ + .. _class_CPUParticles_tangential_accel_random: - :ref:`float` **tangential_accel_random** ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ Method Descriptions ------------------- -.. _class_CPUParticles_convert_from_particles: + .. _class_CPUParticles_convert_from_particles: - void **convert_from_particles** **(** :ref:`Node` particles **)** -.. _class_CPUParticles_restart: + .. _class_CPUParticles_restart: - void **restart** **(** **)** - diff --git a/classes/class_cpuparticles2d.rst b/classes/class_cpuparticles2d.rst index 2be52e008..bc898d362 100644 --- a/classes/class_cpuparticles2d.rst +++ b/classes/class_cpuparticles2d.rst @@ -8,6 +8,7 @@ CPUParticles2D ============== **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,129 @@ 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:`bool` | :ref:`anim_loop` | ++---------------------------------------------------------+------------------------------------------------------------------------------+ +| :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` | ++---------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`Curve` | :ref:`scale_curve` | ++---------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`scale_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 ------- @@ -29,14 +153,14 @@ Enumerations .. _enum_CPUParticles2D_Flags: -enum **Flags** +enum **Flags**: - **FLAG_ALIGN_Y_TO_VELOCITY** = **0** - **FLAG_MAX** = **2** .. _enum_CPUParticles2D_Parameter: -enum **Parameter** +enum **Parameter**: - **PARAM_INITIAL_LINEAR_VELOCITY** = **0** - **PARAM_ANGULAR_VELOCITY** = **1** @@ -54,7 +178,7 @@ enum **Parameter** .. _enum_CPUParticles2D_EmissionShape: -enum **EmissionShape** +enum **EmissionShape**: - **EMISSION_SHAPE_POINT** = **0** - **EMISSION_SHAPE_CIRCLE** = **1** @@ -64,12 +188,11 @@ enum **EmissionShape** .. _enum_CPUParticles2D_DrawOrder: -enum **DrawOrder** +enum **DrawOrder**: - **DRAW_ORDER_INDEX** = **0** - **DRAW_ORDER_LIFETIME** = **1** - Property Descriptions --------------------- @@ -77,248 +200,600 @@ Property Descriptions - :ref:`int` **amount** ++----------+-------------------+ +| *Setter* | set_amount(value) | ++----------+-------------------+ +| *Getter* | get_amount() | ++----------+-------------------+ + .. _class_CPUParticles2D_angle: - :ref:`float` **angle** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + .. _class_CPUParticles2D_angle_curve: - :ref:`Curve` **angle_curve** ++----------+------------------------+ +| *Setter* | set_param_curve(value) | ++----------+------------------------+ +| *Getter* | get_param_curve() | ++----------+------------------------+ + .. _class_CPUParticles2D_angle_random: - :ref:`float` **angle_random** ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + .. _class_CPUParticles2D_angular_velocity: - :ref:`float` **angular_velocity** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + .. _class_CPUParticles2D_angular_velocity_curve: - :ref:`Curve` **angular_velocity_curve** ++----------+------------------------+ +| *Setter* | set_param_curve(value) | ++----------+------------------------+ +| *Getter* | get_param_curve() | ++----------+------------------------+ + .. _class_CPUParticles2D_angular_velocity_random: - :ref:`float` **angular_velocity_random** ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + .. _class_CPUParticles2D_anim_loop: - :ref:`bool` **anim_loop** ++----------+--------------------------+ +| *Setter* | set_particle_flag(value) | ++----------+--------------------------+ +| *Getter* | get_particle_flag() | ++----------+--------------------------+ + .. _class_CPUParticles2D_anim_offset: - :ref:`float` **anim_offset** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + .. _class_CPUParticles2D_anim_offset_curve: - :ref:`Curve` **anim_offset_curve** ++----------+------------------------+ +| *Setter* | set_param_curve(value) | ++----------+------------------------+ +| *Getter* | get_param_curve() | ++----------+------------------------+ + .. _class_CPUParticles2D_anim_offset_random: - :ref:`float` **anim_offset_random** ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + .. _class_CPUParticles2D_anim_speed: - :ref:`float` **anim_speed** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + .. _class_CPUParticles2D_anim_speed_curve: - :ref:`Curve` **anim_speed_curve** ++----------+------------------------+ +| *Setter* | set_param_curve(value) | ++----------+------------------------+ +| *Getter* | get_param_curve() | ++----------+------------------------+ + .. _class_CPUParticles2D_anim_speed_random: - :ref:`float` **anim_speed_random** ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + .. _class_CPUParticles2D_color: - :ref:`Color` **color** ++----------+------------------+ +| *Setter* | set_color(value) | ++----------+------------------+ +| *Getter* | get_color() | ++----------+------------------+ + .. _class_CPUParticles2D_color_ramp: - :ref:`Gradient` **color_ramp** ++----------+-----------------------+ +| *Setter* | set_color_ramp(value) | ++----------+-----------------------+ +| *Getter* | get_color_ramp() | ++----------+-----------------------+ + .. _class_CPUParticles2D_damping: - :ref:`float` **damping** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + .. _class_CPUParticles2D_damping_curve: - :ref:`Curve` **damping_curve** ++----------+------------------------+ +| *Setter* | set_param_curve(value) | ++----------+------------------------+ +| *Getter* | get_param_curve() | ++----------+------------------------+ + .. _class_CPUParticles2D_damping_random: - :ref:`float` **damping_random** ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + .. _class_CPUParticles2D_draw_order: - :ref:`DrawOrder` **draw_order** ++----------+-----------------------+ +| *Setter* | set_draw_order(value) | ++----------+-----------------------+ +| *Getter* | get_draw_order() | ++----------+-----------------------+ + .. _class_CPUParticles2D_emission_colors: - :ref:`PoolColorArray` **emission_colors** ++----------+----------------------------+ +| *Setter* | set_emission_colors(value) | ++----------+----------------------------+ +| *Getter* | get_emission_colors() | ++----------+----------------------------+ + .. _class_CPUParticles2D_emission_normals: - :ref:`PoolVector2Array` **emission_normals** ++----------+-----------------------------+ +| *Setter* | set_emission_normals(value) | ++----------+-----------------------------+ +| *Getter* | get_emission_normals() | ++----------+-----------------------------+ + .. _class_CPUParticles2D_emission_points: - :ref:`PoolVector2Array` **emission_points** ++----------+----------------------------+ +| *Setter* | set_emission_points(value) | ++----------+----------------------------+ +| *Getter* | get_emission_points() | ++----------+----------------------------+ + .. _class_CPUParticles2D_emission_rect_extents: - :ref:`Vector2` **emission_rect_extents** ++----------+----------------------------------+ +| *Setter* | set_emission_rect_extents(value) | ++----------+----------------------------------+ +| *Getter* | get_emission_rect_extents() | ++----------+----------------------------------+ + .. _class_CPUParticles2D_emission_shape: - :ref:`EmissionShape` **emission_shape** ++----------+---------------------------+ +| *Setter* | set_emission_shape(value) | ++----------+---------------------------+ +| *Getter* | get_emission_shape() | ++----------+---------------------------+ + .. _class_CPUParticles2D_emission_sphere_radius: - :ref:`float` **emission_sphere_radius** ++----------+-----------------------------------+ +| *Setter* | set_emission_sphere_radius(value) | ++----------+-----------------------------------+ +| *Getter* | get_emission_sphere_radius() | ++----------+-----------------------------------+ + .. _class_CPUParticles2D_emitting: - :ref:`bool` **emitting** ++----------+---------------------+ +| *Setter* | set_emitting(value) | ++----------+---------------------+ +| *Getter* | is_emitting() | ++----------+---------------------+ + .. _class_CPUParticles2D_explosiveness: - :ref:`float` **explosiveness** ++----------+--------------------------------+ +| *Setter* | set_explosiveness_ratio(value) | ++----------+--------------------------------+ +| *Getter* | get_explosiveness_ratio() | ++----------+--------------------------------+ + .. _class_CPUParticles2D_fixed_fps: - :ref:`int` **fixed_fps** ++----------+----------------------+ +| *Setter* | set_fixed_fps(value) | ++----------+----------------------+ +| *Getter* | get_fixed_fps() | ++----------+----------------------+ + .. _class_CPUParticles2D_flag_align_y: - :ref:`bool` **flag_align_y** ++----------+--------------------------+ +| *Setter* | set_particle_flag(value) | ++----------+--------------------------+ +| *Getter* | get_particle_flag() | ++----------+--------------------------+ + .. _class_CPUParticles2D_flatness: - :ref:`float` **flatness** ++----------+---------------------+ +| *Setter* | set_flatness(value) | ++----------+---------------------+ +| *Getter* | get_flatness() | ++----------+---------------------+ + .. _class_CPUParticles2D_fract_delta: - :ref:`bool` **fract_delta** ++----------+-----------------------------+ +| *Setter* | set_fractional_delta(value) | ++----------+-----------------------------+ +| *Getter* | get_fractional_delta() | ++----------+-----------------------------+ + .. _class_CPUParticles2D_gravity: - :ref:`Vector2` **gravity** ++----------+--------------------+ +| *Setter* | set_gravity(value) | ++----------+--------------------+ +| *Getter* | get_gravity() | ++----------+--------------------+ + .. _class_CPUParticles2D_hue_variation: - :ref:`float` **hue_variation** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + .. _class_CPUParticles2D_hue_variation_curve: - :ref:`Curve` **hue_variation_curve** ++----------+------------------------+ +| *Setter* | set_param_curve(value) | ++----------+------------------------+ +| *Getter* | get_param_curve() | ++----------+------------------------+ + .. _class_CPUParticles2D_hue_variation_random: - :ref:`float` **hue_variation_random** ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + .. _class_CPUParticles2D_initial_velocity: - :ref:`float` **initial_velocity** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + .. _class_CPUParticles2D_initial_velocity_random: - :ref:`float` **initial_velocity_random** ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + .. _class_CPUParticles2D_lifetime: - :ref:`float` **lifetime** ++----------+---------------------+ +| *Setter* | set_lifetime(value) | ++----------+---------------------+ +| *Getter* | get_lifetime() | ++----------+---------------------+ + .. _class_CPUParticles2D_linear_accel: - :ref:`float` **linear_accel** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + .. _class_CPUParticles2D_linear_accel_curve: - :ref:`Curve` **linear_accel_curve** ++----------+------------------------+ +| *Setter* | set_param_curve(value) | ++----------+------------------------+ +| *Getter* | get_param_curve() | ++----------+------------------------+ + .. _class_CPUParticles2D_linear_accel_random: - :ref:`float` **linear_accel_random** ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + .. _class_CPUParticles2D_local_coords: - :ref:`bool` **local_coords** ++----------+----------------------------------+ +| *Setter* | set_use_local_coordinates(value) | ++----------+----------------------------------+ +| *Getter* | get_use_local_coordinates() | ++----------+----------------------------------+ + .. _class_CPUParticles2D_normalmap: - :ref:`Texture` **normalmap** ++----------+----------------------+ +| *Setter* | set_normalmap(value) | ++----------+----------------------+ +| *Getter* | get_normalmap() | ++----------+----------------------+ + .. _class_CPUParticles2D_one_shot: - :ref:`bool` **one_shot** ++----------+---------------------+ +| *Setter* | set_one_shot(value) | ++----------+---------------------+ +| *Getter* | get_one_shot() | ++----------+---------------------+ + .. _class_CPUParticles2D_preprocess: - :ref:`float` **preprocess** ++----------+-----------------------------+ +| *Setter* | set_pre_process_time(value) | ++----------+-----------------------------+ +| *Getter* | get_pre_process_time() | ++----------+-----------------------------+ + .. _class_CPUParticles2D_radial_accel: - :ref:`float` **radial_accel** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + .. _class_CPUParticles2D_radial_accel_curve: - :ref:`Curve` **radial_accel_curve** ++----------+------------------------+ +| *Setter* | set_param_curve(value) | ++----------+------------------------+ +| *Getter* | get_param_curve() | ++----------+------------------------+ + .. _class_CPUParticles2D_radial_accel_random: - :ref:`float` **radial_accel_random** ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + .. _class_CPUParticles2D_randomness: - :ref:`float` **randomness** ++----------+-----------------------------+ +| *Setter* | set_randomness_ratio(value) | ++----------+-----------------------------+ +| *Getter* | get_randomness_ratio() | ++----------+-----------------------------+ + .. _class_CPUParticles2D_scale: - :ref:`float` **scale** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + .. _class_CPUParticles2D_scale_curve: - :ref:`Curve` **scale_curve** ++----------+------------------------+ +| *Setter* | set_param_curve(value) | ++----------+------------------------+ +| *Getter* | get_param_curve() | ++----------+------------------------+ + .. _class_CPUParticles2D_scale_random: - :ref:`float` **scale_random** ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + .. _class_CPUParticles2D_speed_scale: - :ref:`float` **speed_scale** ++----------+------------------------+ +| *Setter* | set_speed_scale(value) | ++----------+------------------------+ +| *Getter* | get_speed_scale() | ++----------+------------------------+ + .. _class_CPUParticles2D_spread: - :ref:`float` **spread** ++----------+-------------------+ +| *Setter* | set_spread(value) | ++----------+-------------------+ +| *Getter* | get_spread() | ++----------+-------------------+ + .. _class_CPUParticles2D_tangential_accel: - :ref:`float` **tangential_accel** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + .. _class_CPUParticles2D_tangential_accel_curve: - :ref:`Curve` **tangential_accel_curve** ++----------+------------------------+ +| *Setter* | set_param_curve(value) | ++----------+------------------------+ +| *Getter* | get_param_curve() | ++----------+------------------------+ + .. _class_CPUParticles2D_tangential_accel_random: - :ref:`float` **tangential_accel_random** ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + .. _class_CPUParticles2D_texture: - :ref:`Texture` **texture** ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ Method Descriptions ------------------- -.. _class_CPUParticles2D_convert_from_particles: + .. _class_CPUParticles2D_convert_from_particles: - void **convert_from_particles** **(** :ref:`Node` particles **)** -.. _class_CPUParticles2D_restart: + .. _class_CPUParticles2D_restart: - void **restart** **(** **)** - diff --git a/classes/class_csgbox.rst b/classes/class_csgbox.rst index 96e695192..8001b719d 100644 --- a/classes/class_csgbox.rst +++ b/classes/class_csgbox.rst @@ -8,6 +8,7 @@ CSGBox ====== **Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,19 @@ Brief Description A CSG Box shape. +Properties +---------- + ++---------------------------------+----------------------------------------+ +| :ref:`float` | :ref:`depth` | ++---------------------------------+----------------------------------------+ +| :ref:`float` | :ref:`height` | ++---------------------------------+----------------------------------------+ +| :ref:`Material` | :ref:`material` | ++---------------------------------+----------------------------------------+ +| :ref:`float` | :ref:`width` | ++---------------------------------+----------------------------------------+ + Description ----------- @@ -25,18 +39,49 @@ Property Descriptions .. _class_CSGBox_depth: -- :ref:`float` **depth** - Depth of the box measured from the center of the box. +- :ref:`float` **depth** + ++----------+------------------+ +| *Setter* | set_depth(value) | ++----------+------------------+ +| *Getter* | get_depth() | ++----------+------------------+ + +Depth of the box measured from the center of the box. .. _class_CSGBox_height: -- :ref:`float` **height** - Height of the box measured from the center of the box. +- :ref:`float` **height** + ++----------+-------------------+ +| *Setter* | set_height(value) | ++----------+-------------------+ +| *Getter* | get_height() | ++----------+-------------------+ + +Height of the box measured from the center of the box. .. _class_CSGBox_material: -- :ref:`Material` **material** - The material used to render the box. +- :ref:`Material` **material** + ++----------+---------------------+ +| *Setter* | set_material(value) | ++----------+---------------------+ +| *Getter* | get_material() | ++----------+---------------------+ + +The material used to render the box. .. _class_CSGBox_width: -- :ref:`float` **width** - Width of the box measured from the center of the box. +- :ref:`float` **width** ++----------+------------------+ +| *Setter* | set_width(value) | ++----------+------------------+ +| *Getter* | get_width() | ++----------+------------------+ + +Width of the box measured from the center of the box. diff --git a/classes/class_csgcombiner.rst b/classes/class_csgcombiner.rst index 48db2547b..78ea551a5 100644 --- a/classes/class_csgcombiner.rst +++ b/classes/class_csgcombiner.rst @@ -8,6 +8,7 @@ CSGCombiner =========== **Inherits:** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_csgcylinder.rst b/classes/class_csgcylinder.rst index 94cdfa7b6..faaa22c10 100644 --- a/classes/class_csgcylinder.rst +++ b/classes/class_csgcylinder.rst @@ -8,6 +8,7 @@ CSGCylinder =========== **Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,23 @@ Brief Description 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` | ++---------------------------------+-----------------------------------------------------+ + Description ----------- @@ -25,26 +43,73 @@ Property Descriptions .. _class_CSGCylinder_cone: -- :ref:`bool` **cone** - If true a cone is created, the :ref:`radius` will only apply to one side. +- :ref:`bool` **cone** + ++----------+-----------------+ +| *Setter* | set_cone(value) | ++----------+-----------------+ +| *Getter* | is_cone() | ++----------+-----------------+ + +If true a cone is created, the :ref:`radius` will only apply to one side. .. _class_CSGCylinder_height: -- :ref:`float` **height** - The height of the cylinder. +- :ref:`float` **height** + ++----------+-------------------+ +| *Setter* | set_height(value) | ++----------+-------------------+ +| *Getter* | get_height() | ++----------+-------------------+ + +The height of the cylinder. .. _class_CSGCylinder_material: -- :ref:`Material` **material** - The material used to render the cylinder. +- :ref:`Material` **material** + ++----------+---------------------+ +| *Setter* | set_material(value) | ++----------+---------------------+ +| *Getter* | get_material() | ++----------+---------------------+ + +The material used to render the cylinder. .. _class_CSGCylinder_radius: -- :ref:`float` **radius** - The radius of the cylinder. +- :ref:`float` **radius** + ++----------+-------------------+ +| *Setter* | set_radius(value) | ++----------+-------------------+ +| *Getter* | get_radius() | ++----------+-------------------+ + +The radius of the cylinder. .. _class_CSGCylinder_sides: -- :ref:`int` **sides** - The number of sides of the cylinder, the higher this number the more detail there will be in the cylinder. +- :ref:`int` **sides** + ++----------+------------------+ +| *Setter* | set_sides(value) | ++----------+------------------+ +| *Getter* | get_sides() | ++----------+------------------+ + +The number of sides of the cylinder, the higher this number the more detail there will be in the cylinder. .. _class_CSGCylinder_smooth_faces: -- :ref:`bool` **smooth_faces** - If true the normals of the cylinder are set to give a smooth effect making the cylinder seem rounded. When false the cylinder will have a flat shaded look. +- :ref:`bool` **smooth_faces** ++----------+-------------------------+ +| *Setter* | set_smooth_faces(value) | ++----------+-------------------------+ +| *Getter* | get_smooth_faces() | ++----------+-------------------------+ + +If true the normals of the cylinder are set to give a smooth effect making the cylinder seem rounded. When false the cylinder will have a flat shaded look. diff --git a/classes/class_csgmesh.rst b/classes/class_csgmesh.rst index 4808aafec..621dd3d2f 100644 --- a/classes/class_csgmesh.rst +++ b/classes/class_csgmesh.rst @@ -8,6 +8,7 @@ CSGMesh ======= **Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description A CSG Mesh shape that uses a mesh resource. +Properties +---------- + ++-------------------------+---------------------------------+ +| :ref:`Mesh` | :ref:`mesh` | ++-------------------------+---------------------------------+ + Description ----------- @@ -25,6 +33,13 @@ Property Descriptions .. _class_CSGMesh_mesh: -- :ref:`Mesh` **mesh** - The mesh resource to use as a CSG shape. +- :ref:`Mesh` **mesh** ++----------+-----------------+ +| *Setter* | set_mesh(value) | ++----------+-----------------+ +| *Getter* | get_mesh() | ++----------+-----------------+ + +The mesh resource to use as a CSG shape. diff --git a/classes/class_csgpolygon.rst b/classes/class_csgpolygon.rst index 54d7fccc6..6c0a967a6 100644 --- a/classes/class_csgpolygon.rst +++ b/classes/class_csgpolygon.rst @@ -8,6 +8,7 @@ CSGPolygon ========== **Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,12 +16,43 @@ Brief Description 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` | ++---------------------------------------------------+--------------------------------------------------------------+ + Enumerations ------------ .. _enum_CSGPolygon_Mode: -enum **Mode** +enum **Mode**: - **MODE_DEPTH** = **0** --- Shape is extruded to :ref:`depth`. - **MODE_SPIN** = **1** --- Shape is extruded by rotating it around an axis. @@ -28,13 +60,12 @@ enum **Mode** .. _enum_CSGPolygon_PathRotation: -enum **PathRotation** +enum **PathRotation**: - **PATH_ROTATION_POLYGON** = **0** --- Slice is not rotated. - **PATH_ROTATION_PATH** = **1** --- Slice is rotated around the up vector of the path. - **PATH_ROTATION_PATH_FOLLOW** = **2** --- Slice is rotate to match the path exactly. - Description ----------- @@ -45,54 +76,157 @@ Property Descriptions .. _class_CSGPolygon_depth: -- :ref:`float` **depth** - Extrusion depth when :ref:`mode` is constant MODE_DEPTH. +- :ref:`float` **depth** + ++----------+------------------+ +| *Setter* | set_depth(value) | ++----------+------------------+ +| *Getter* | get_depth() | ++----------+------------------+ + +Extrusion depth when :ref:`mode` is constant MODE_DEPTH. .. _class_CSGPolygon_material: -- :ref:`Material` **material** - Material to use for the resulting mesh. +- :ref:`Material` **material** + ++----------+---------------------+ +| *Setter* | set_material(value) | ++----------+---------------------+ +| *Getter* | get_material() | ++----------+---------------------+ + +Material to use for the resulting mesh. .. _class_CSGPolygon_mode: -- :ref:`Mode` **mode** - Extrusion mode. +- :ref:`Mode` **mode** + ++----------+-----------------+ +| *Setter* | set_mode(value) | ++----------+-----------------+ +| *Getter* | get_mode() | ++----------+-----------------+ + +Extrusion mode. .. _class_CSGPolygon_path_continuous_u: -- :ref:`bool` **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. +- :ref:`bool` **path_continuous_u** + ++----------+------------------------------+ +| *Setter* | set_path_continuous_u(value) | ++----------+------------------------------+ +| *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. .. _class_CSGPolygon_path_interval: -- :ref:`float` **path_interval** - Interval at which a new extrusion slice is added along the path when :ref:`mode` is constant MODE_PATH. +- :ref:`float` **path_interval** + ++----------+--------------------------+ +| *Setter* | set_path_interval(value) | ++----------+--------------------------+ +| *Getter* | get_path_interval() | ++----------+--------------------------+ + +Interval at which a new extrusion slice is added along the path when :ref:`mode` is constant MODE_PATH. .. _class_CSGPolygon_path_joined: -- :ref:`bool` **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. +- :ref:`bool` **path_joined** + ++----------+------------------------+ +| *Setter* | set_path_joined(value) | ++----------+------------------------+ +| *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. .. _class_CSGPolygon_path_local: -- :ref:`bool` **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. +- :ref:`bool` **path_local** + ++----------+-----------------------+ +| *Setter* | set_path_local(value) | ++----------+-----------------------+ +| *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. .. _class_CSGPolygon_path_node: -- :ref:`NodePath` **path_node** - The :ref:`Shape` object containing the path along which we extrude when :ref:`mode` is constant MODE_PATH. +- :ref:`NodePath` **path_node** + ++----------+----------------------+ +| *Setter* | set_path_node(value) | ++----------+----------------------+ +| *Getter* | get_path_node() | ++----------+----------------------+ + +The :ref:`Shape` object containing the path along which we extrude when :ref:`mode` is constant MODE_PATH. .. _class_CSGPolygon_path_rotation: -- :ref:`PathRotation` **path_rotation** - The method by which each slice is rotated along the path when :ref:`mode` is constant MODE_PATH. +- :ref:`PathRotation` **path_rotation** + ++----------+--------------------------+ +| *Setter* | set_path_rotation(value) | ++----------+--------------------------+ +| *Getter* | get_path_rotation() | ++----------+--------------------------+ + +The method by which each slice is rotated along the path when :ref:`mode` is constant MODE_PATH. .. _class_CSGPolygon_polygon: -- :ref:`PoolVector2Array` **polygon** - Point array that defines the shape that we'll extrude. +- :ref:`PoolVector2Array` **polygon** + ++----------+--------------------+ +| *Setter* | set_polygon(value) | ++----------+--------------------+ +| *Getter* | get_polygon() | ++----------+--------------------+ + +Point array that defines the shape that we'll extrude. .. _class_CSGPolygon_smooth_faces: -- :ref:`bool` **smooth_faces** - Generates smooth normals so smooth shading is applied to our mesh. +- :ref:`bool` **smooth_faces** + ++----------+-------------------------+ +| *Setter* | set_smooth_faces(value) | ++----------+-------------------------+ +| *Getter* | get_smooth_faces() | ++----------+-------------------------+ + +Generates smooth normals so smooth shading is applied to our mesh. .. _class_CSGPolygon_spin_degrees: -- :ref:`float` **spin_degrees** - Degrees to rotate our extrusion for each slice when :ref:`mode` is constant MODE_SPIN. +- :ref:`float` **spin_degrees** + ++----------+-------------------------+ +| *Setter* | set_spin_degrees(value) | ++----------+-------------------------+ +| *Getter* | get_spin_degrees() | ++----------+-------------------------+ + +Degrees to rotate our extrusion for each slice when :ref:`mode` is constant MODE_SPIN. .. _class_CSGPolygon_spin_sides: -- :ref:`int` **spin_sides** - Number of extrusion when :ref:`mode` is constant MODE_SPIN. +- :ref:`int` **spin_sides** ++----------+-----------------------+ +| *Setter* | set_spin_sides(value) | ++----------+-----------------------+ +| *Getter* | get_spin_sides() | ++----------+-----------------------+ + +Number of extrusion when :ref:`mode` is constant MODE_SPIN. diff --git a/classes/class_csgprimitive.rst b/classes/class_csgprimitive.rst index 295046efd..9b3ddc8ee 100644 --- a/classes/class_csgprimitive.rst +++ b/classes/class_csgprimitive.rst @@ -8,7 +8,9 @@ CSGPrimitive ============ **Inherits:** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`CSGSphere`, :ref:`CSGPolygon`, :ref:`CSGCylinder`, :ref:`CSGBox`, :ref:`CSGTorus`, :ref:`CSGMesh` + **Category:** Core Brief Description @@ -16,11 +18,25 @@ Brief Description Base class for CSG primitives. +Properties +---------- + ++-------------------------+------------------------------------------------------+ +| :ref:`bool` | :ref:`invert_faces` | ++-------------------------+------------------------------------------------------+ + Property Descriptions --------------------- .. _class_CSGPrimitive_invert_faces: -- :ref:`bool` **invert_faces** - Invert the faces of the mesh. +- :ref:`bool` **invert_faces** ++----------+-------------------------+ +| *Setter* | set_invert_faces(value) | ++----------+-------------------------+ +| *Getter* | is_inverting_faces() | ++----------+-------------------------+ + +Invert the faces of the mesh. diff --git a/classes/class_csgshape.rst b/classes/class_csgshape.rst index 9b7d52dfa..40f0a52be 100644 --- a/classes/class_csgshape.rst +++ b/classes/class_csgshape.rst @@ -8,7 +8,9 @@ CSGShape ======== **Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`CSGCombiner`, :ref:`CSGPrimitive` + **Category:** Core Brief Description @@ -16,6 +18,17 @@ Brief Description The CSG base class. +Properties +---------- + ++-------------------------------------------+----------------------------------------------------+ +| :ref:`Operation` | :ref:`operation` | ++-------------------------------------------+----------------------------------------------------+ +| :ref:`float` | :ref:`snap` | ++-------------------------------------------+----------------------------------------------------+ +| :ref:`bool` | :ref:`use_collision` | ++-------------------------------------------+----------------------------------------------------+ + Methods ------- @@ -28,13 +41,12 @@ Enumerations .. _enum_CSGShape_Operation: -enum **Operation** +enum **Operation**: - **OPERATION_UNION** = **0** --- Geometry of both primitives is merged, intersecting geometry is removed. - **OPERATION_INTERSECTION** = **1** --- Only intersecting geometry remains, the rest is removed. - **OPERATION_SUBTRACTION** = **2** --- The second shape is susbtracted from the first, leaving a dent with it's shape. - Description ----------- @@ -45,24 +57,44 @@ Property Descriptions .. _class_CSGShape_operation: -- :ref:`Operation` **operation** - 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. +- :ref:`Operation` **operation** + ++----------+----------------------+ +| *Setter* | set_operation(value) | ++----------+----------------------+ +| *Getter* | get_operation() | ++----------+----------------------+ + +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: - :ref:`float` **snap** ++----------+-----------------+ +| *Setter* | set_snap(value) | ++----------+-----------------+ +| *Getter* | get_snap() | ++----------+-----------------+ + .. _class_CSGShape_use_collision: -- :ref:`bool` **use_collision** - Adds a collision shape to the physics engine for our CSG shape. This will always act like a static body. Note that the collision shape is still active even if the CSG shape itself is hidden. +- :ref:`bool` **use_collision** ++----------+--------------------------+ +| *Setter* | set_use_collision(value) | ++----------+--------------------------+ +| *Getter* | is_using_collision() | ++----------+--------------------------+ + +Adds a collision shape to the physics engine for our CSG shape. This will always act like a static body. Note that the collision shape is still active even if the CSG shape itself is hidden. Method Descriptions ------------------- -.. _class_CSGShape_is_root_shape: + .. _class_CSGShape_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. - diff --git a/classes/class_csgsphere.rst b/classes/class_csgsphere.rst index fa8ddb083..9748da8ea 100644 --- a/classes/class_csgsphere.rst +++ b/classes/class_csgsphere.rst @@ -8,6 +8,7 @@ CSGSphere ========= **Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,21 @@ Brief Description 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` | ++---------------------------------+---------------------------------------------------------+ + Description ----------- @@ -25,22 +41,61 @@ Property Descriptions .. _class_CSGSphere_material: -- :ref:`Material` **material** - The material used to render the sphere. +- :ref:`Material` **material** + ++----------+---------------------+ +| *Setter* | set_material(value) | ++----------+---------------------+ +| *Getter* | get_material() | ++----------+---------------------+ + +The material used to render the sphere. .. _class_CSGSphere_radial_segments: -- :ref:`int` **radial_segments** - Number of vertical slices for the sphere. +- :ref:`int` **radial_segments** + ++----------+----------------------------+ +| *Setter* | set_radial_segments(value) | ++----------+----------------------------+ +| *Getter* | get_radial_segments() | ++----------+----------------------------+ + +Number of vertical slices for the sphere. .. _class_CSGSphere_radius: -- :ref:`float` **radius** - Radius of the sphere. +- :ref:`float` **radius** + ++----------+-------------------+ +| *Setter* | set_radius(value) | ++----------+-------------------+ +| *Getter* | get_radius() | ++----------+-------------------+ + +Radius of the sphere. .. _class_CSGSphere_rings: -- :ref:`int` **rings** - Number of horizontal slices for the sphere. +- :ref:`int` **rings** + ++----------+------------------+ +| *Setter* | set_rings(value) | ++----------+------------------+ +| *Getter* | get_rings() | ++----------+------------------+ + +Number of horizontal slices for the sphere. .. _class_CSGSphere_smooth_faces: -- :ref:`bool` **smooth_faces** - If true the normals of the sphere are set to give a smooth effect making the sphere seem rounded. When false the sphere will have a flat shaded look. +- :ref:`bool` **smooth_faces** ++----------+-------------------------+ +| *Setter* | set_smooth_faces(value) | ++----------+-------------------------+ +| *Getter* | get_smooth_faces() | ++----------+-------------------------+ + +If true the normals of the sphere are set to give a smooth effect making the sphere seem rounded. When false the sphere will have a flat shaded look. diff --git a/classes/class_csgtorus.rst b/classes/class_csgtorus.rst index b1b8839bb..cdd932558 100644 --- a/classes/class_csgtorus.rst +++ b/classes/class_csgtorus.rst @@ -8,6 +8,7 @@ CSGTorus ======== **Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,23 @@ Brief Description 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` | ++---------------------------------+--------------------------------------------------+ + Description ----------- @@ -25,26 +43,73 @@ Property Descriptions .. _class_CSGTorus_inner_radius: -- :ref:`float` **inner_radius** - The inner radius of the torus. +- :ref:`float` **inner_radius** + ++----------+-------------------------+ +| *Setter* | set_inner_radius(value) | ++----------+-------------------------+ +| *Getter* | get_inner_radius() | ++----------+-------------------------+ + +The inner radius of the torus. .. _class_CSGTorus_material: -- :ref:`Material` **material** - The material used to render the torus. +- :ref:`Material` **material** + ++----------+---------------------+ +| *Setter* | set_material(value) | ++----------+---------------------+ +| *Getter* | get_material() | ++----------+---------------------+ + +The material used to render the torus. .. _class_CSGTorus_outer_radius: -- :ref:`float` **outer_radius** - The outer radius of the torus. +- :ref:`float` **outer_radius** + ++----------+-------------------------+ +| *Setter* | set_outer_radius(value) | ++----------+-------------------------+ +| *Getter* | get_outer_radius() | ++----------+-------------------------+ + +The outer radius of the torus. .. _class_CSGTorus_ring_sides: -- :ref:`int` **ring_sides** - The number of edges each ring of the torus is constructed of. +- :ref:`int` **ring_sides** + ++----------+-----------------------+ +| *Setter* | set_ring_sides(value) | ++----------+-----------------------+ +| *Getter* | get_ring_sides() | ++----------+-----------------------+ + +The number of edges each ring of the torus is constructed of. .. _class_CSGTorus_sides: -- :ref:`int` **sides** - The number of slices the torus is constructed of. +- :ref:`int` **sides** + ++----------+------------------+ +| *Setter* | set_sides(value) | ++----------+------------------+ +| *Getter* | get_sides() | ++----------+------------------+ + +The number of slices the torus is constructed of. .. _class_CSGTorus_smooth_faces: -- :ref:`bool` **smooth_faces** - If true the normals of the torus are set to give a smooth effect making the torus seem rounded. When false the torus will have a flat shaded look. +- :ref:`bool` **smooth_faces** ++----------+-------------------------+ +| *Setter* | set_smooth_faces(value) | ++----------+-------------------------+ +| *Getter* | get_smooth_faces() | ++----------+-------------------------+ + +If true the normals of the torus are set to give a smooth effect making the torus seem rounded. When false the torus will have a flat shaded look. diff --git a/classes/class_csharpscript.rst b/classes/class_csharpscript.rst index 60d7bd1f2..7536ec0c0 100644 --- a/classes/class_csharpscript.rst +++ b/classes/class_csharpscript.rst @@ -8,6 +8,7 @@ CSharpScript ============ **Inherits:** :ref:`Script` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -25,8 +26,7 @@ Methods Method Descriptions ------------------- -.. _class_CSharpScript_new: + .. _class_CSharpScript_new: - :ref:`Object` **new** **(** **)** vararg - diff --git a/classes/class_cubemap.rst b/classes/class_cubemap.rst index 868f3e304..a5697384d 100644 --- a/classes/class_cubemap.rst +++ b/classes/class_cubemap.rst @@ -8,6 +8,7 @@ CubeMap ======= **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,17 @@ Brief Description A CubeMap is a 6 sided 3D texture. +Properties +---------- + ++--------------------------------------+-------------------------------------------------------------------+ +| :ref:`int` | :ref:`flags` | ++--------------------------------------+-------------------------------------------------------------------+ +| :ref:`float` | :ref:`lossy_storage_quality` | ++--------------------------------------+-------------------------------------------------------------------+ +| :ref:`Storage` | :ref:`storage_mode` | ++--------------------------------------+-------------------------------------------------------------------+ + Methods ------- @@ -33,7 +45,7 @@ Enumerations .. _enum_CubeMap_Flags: -enum **Flags** +enum **Flags**: - **FLAG_MIPMAPS** = **1** --- Generate mipmaps, to enable smooth zooming out of the texture. - **FLAG_REPEAT** = **2** --- Repeat (instead of clamp to edge). @@ -42,7 +54,7 @@ enum **Flags** .. _enum_CubeMap_Storage: -enum **Storage** +enum **Storage**: - **STORAGE_RAW** = **0** --- Store the ``CubeMap`` without any compression. - **STORAGE_COMPRESS_LOSSY** = **1** --- Store the ``CubeMap`` with strong compression that reduces image quality. @@ -50,7 +62,7 @@ enum **Storage** .. _enum_CubeMap_Side: -enum **Side** +enum **Side**: - **SIDE_LEFT** = **0** --- Identifier for the left face of the ``CubeMap``. - **SIDE_RIGHT** = **1** --- Identifier for the right face of the ``CubeMap``. @@ -59,7 +71,6 @@ enum **Side** - **SIDE_FRONT** = **4** --- Identifier for the front face of the ``CubeMap``. - **SIDE_BACK** = **5** --- Identifier for the back face of the ``CubeMap``. - Description ----------- @@ -70,42 +81,64 @@ Property Descriptions .. _class_CubeMap_flags: -- :ref:`int` **flags** - The render flags for the ``CubeMap``. See the ``FLAG_*`` constants for details. +- :ref:`int` **flags** + ++----------+------------------+ +| *Setter* | set_flags(value) | ++----------+------------------+ +| *Getter* | get_flags() | ++----------+------------------+ + +The render flags for the ``CubeMap``. See the ``FLAG_*`` constants for details. .. _class_CubeMap_lossy_storage_quality: -- :ref:`float` **lossy_storage_quality** - The lossy storage quality of the ``CubeMap`` if the storage mode is set to STORAGE_COMPRESS_LOSSY. +- :ref:`float` **lossy_storage_quality** + ++----------+----------------------------------+ +| *Setter* | set_lossy_storage_quality(value) | ++----------+----------------------------------+ +| *Getter* | get_lossy_storage_quality() | ++----------+----------------------------------+ + +The lossy storage quality of the ``CubeMap`` if the storage mode is set to STORAGE_COMPRESS_LOSSY. .. _class_CubeMap_storage_mode: -- :ref:`Storage` **storage_mode** - The ``CubeMap``'s storage mode. See ``STORAGE_*`` constants. +- :ref:`Storage` **storage_mode** ++----------+--------------------+ +| *Setter* | set_storage(value) | ++----------+--------------------+ +| *Getter* | get_storage() | ++----------+--------------------+ + +The ``CubeMap``'s storage mode. See ``STORAGE_*`` constants. Method Descriptions ------------------- -.. _class_CubeMap_get_height: + .. _class_CubeMap_get_height: - :ref:`int` **get_height** **(** **)** const Returns the ``CubeMap``'s height. -.. _class_CubeMap_get_side: + .. _class_CubeMap_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_get_width: - :ref:`int` **get_width** **(** **)** const Returns the ``CubeMap``'s width. -.. _class_CubeMap_set_side: + .. _class_CubeMap_set_side: - void **set_side** **(** :ref:`Side` side, :ref:`Image` image **)** Sets an :ref:`Image` for a side of the ``CubeMap`` using one of the ``SIDE_*`` constants or an integer 0-5. - diff --git a/classes/class_cubemesh.rst b/classes/class_cubemesh.rst index a0089910a..6773c6812 100644 --- a/classes/class_cubemesh.rst +++ b/classes/class_cubemesh.rst @@ -8,6 +8,7 @@ CubeMesh ======== **Inherits:** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,19 @@ Brief Description 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` | ++-------------------------------+----------------------------------------------------------+ + Description ----------- @@ -25,18 +39,49 @@ Property Descriptions .. _class_CubeMesh_size: -- :ref:`Vector3` **size** - Size of the cuboid mesh. Defaults to (2, 2, 2). +- :ref:`Vector3` **size** + ++----------+-----------------+ +| *Setter* | set_size(value) | ++----------+-----------------+ +| *Getter* | get_size() | ++----------+-----------------+ + +Size of the cuboid mesh. Defaults to (2, 2, 2). .. _class_CubeMesh_subdivide_depth: -- :ref:`int` **subdivide_depth** - Number of extra edge loops inserted along the z-axis. Defaults to 0. +- :ref:`int` **subdivide_depth** + ++----------+----------------------------+ +| *Setter* | set_subdivide_depth(value) | ++----------+----------------------------+ +| *Getter* | get_subdivide_depth() | ++----------+----------------------------+ + +Number of extra edge loops inserted along the z-axis. Defaults to 0. .. _class_CubeMesh_subdivide_height: -- :ref:`int` **subdivide_height** - Number of extra edge loops inserted along the y-axis. Defaults to 0. +- :ref:`int` **subdivide_height** + ++----------+-----------------------------+ +| *Setter* | set_subdivide_height(value) | ++----------+-----------------------------+ +| *Getter* | get_subdivide_height() | ++----------+-----------------------------+ + +Number of extra edge loops inserted along the y-axis. Defaults to 0. .. _class_CubeMesh_subdivide_width: -- :ref:`int` **subdivide_width** - Number of extra edge loops inserted along the x-axis. Defaults to 0. +- :ref:`int` **subdivide_width** ++----------+----------------------------+ +| *Setter* | set_subdivide_width(value) | ++----------+----------------------------+ +| *Getter* | get_subdivide_width() | ++----------+----------------------------+ + +Number of extra edge loops inserted along the x-axis. Defaults to 0. diff --git a/classes/class_curve.rst b/classes/class_curve.rst index d19e3137e..8e3f37524 100644 --- a/classes/class_curve.rst +++ b/classes/class_curve.rst @@ -8,6 +8,7 @@ Curve ===== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,17 @@ Brief Description A mathematic curve. +Properties +---------- + ++---------------------------+-----------------------------------------------------+ +| :ref:`int` | :ref:`bake_resolution` | ++---------------------------+-----------------------------------------------------+ +| :ref:`float` | :ref:`max_value` | ++---------------------------+-----------------------------------------------------+ +| :ref:`float` | :ref:`min_value` | ++---------------------------+-----------------------------------------------------+ + Methods ------- @@ -61,25 +73,23 @@ Methods Signals ------- -.. _class_Curve_range_changed: + .. _class_Curve_range_changed: - **range_changed** **(** **)** Emitted when :ref:`max_value` or :ref:`min_value` is changed. - Enumerations ------------ .. _enum_Curve_TangentMode: -enum **TangentMode** +enum **TangentMode**: - **TANGENT_FREE** = **0** --- The tangent on this side of the point is user-defined. - **TANGENT_LINEAR** = **1** --- The curve calculates the tangent on this side of the point as the slope halfway towards the adjacent point. - **TANGENT_MODE_COUNT** = **2** --- The total number of available tangent modes. - Description ----------- @@ -90,132 +100,154 @@ Property Descriptions .. _class_Curve_bake_resolution: -- :ref:`int` **bake_resolution** - The number of points to include in the baked (i.e. cached) curve data. +- :ref:`int` **bake_resolution** + ++----------+----------------------------+ +| *Setter* | set_bake_resolution(value) | ++----------+----------------------------+ +| *Getter* | get_bake_resolution() | ++----------+----------------------------+ + +The number of points to include in the baked (i.e. cached) curve data. .. _class_Curve_max_value: -- :ref:`float` **max_value** - The maximum value the curve can reach. Default value: ``1``. +- :ref:`float` **max_value** + ++----------+----------------------+ +| *Setter* | set_max_value(value) | ++----------+----------------------+ +| *Getter* | get_max_value() | ++----------+----------------------+ + +The maximum value the curve can reach. Default value: ``1``. .. _class_Curve_min_value: -- :ref:`float` **min_value** - The minimum value the curve can reach. Default value: ``0``. +- :ref:`float` **min_value** ++----------+----------------------+ +| *Setter* | set_min_value(value) | ++----------+----------------------+ +| *Getter* | get_min_value() | ++----------+----------------------+ + +The minimum value the curve can reach. Default value: ``0``. Method Descriptions ------------------- -.. _class_Curve_add_point: + .. _class_Curve_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_bake: - void **bake** **(** **)** Recomputes the baked cache of points for the curve. -.. _class_Curve_clean_dupes: + .. _class_Curve_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_clear_points: - void **clear_points** **(** **)** Removes all points from the curve. -.. _class_Curve_get_point_count: + .. _class_Curve_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_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_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_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_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_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_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_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_remove_point: - void **remove_point** **(** :ref:`int` index **)** Removes the point at ``index`` from the curve. -.. _class_Curve_set_point_left_mode: + .. _class_Curve_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_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_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_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_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_set_point_value: - void **set_point_value** **(** :ref:`int` index, :ref:`float` y **)** Assigns the vertical position ``y`` to the point at ``index``. - diff --git a/classes/class_curve2d.rst b/classes/class_curve2d.rst index 748abb389..2dd272383 100644 --- a/classes/class_curve2d.rst +++ b/classes/class_curve2d.rst @@ -8,6 +8,7 @@ Curve2D ======= **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Describes a Bezier curve in 2D space. +Properties +---------- + ++---------------------------+---------------------------------------------------+ +| :ref:`float` | :ref:`bake_interval` | ++---------------------------+---------------------------------------------------+ + Methods ------- @@ -68,13 +76,20 @@ Property Descriptions .. _class_Curve2D_bake_interval: -- :ref:`float` **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. +- :ref:`float` **bake_interval** ++----------+--------------------------+ +| *Setter* | set_bake_interval(value) | ++----------+--------------------------+ +| *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. Method Descriptions ------------------- -.. _class_Curve2D_add_point: + .. _class_Curve2D_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 **)** @@ -82,25 +97,25 @@ 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 >= :ref:`get_point_count`), the point will be appended at the end of the point list. -.. _class_Curve2D_clear_points: + .. _class_Curve2D_clear_points: - void **clear_points** **(** **)** Removes all points from the curve. -.. _class_Curve2D_get_baked_length: + .. _class_Curve2D_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:`set_bake_interval`), it should be approximate enough. -.. _class_Curve2D_get_baked_points: + .. _class_Curve2D_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_get_closest_offset: - :ref:`float` **get_closest_offset** **(** :ref:`Vector2` to_point **)** const @@ -108,7 +123,7 @@ Returns the closest offset to ``to_point``. This offset is meant to be used in : ``to_point`` must be in this curve's local space. -.. _class_Curve2D_get_closest_point: + .. _class_Curve2D_get_closest_point: - :ref:`Vector2` **get_closest_point** **(** :ref:`Vector2` to_point **)** const @@ -116,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_get_point_count: - :ref:`int` **get_point_count** **(** **)** const Returns the number of points describing the curve. -.. _class_Curve2D_get_point_in: + .. _class_Curve2D_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_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_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_interpolate: - :ref:`Vector2` **interpolate** **(** :ref:`int` idx, :ref:`float` t **)** const @@ -148,7 +163,7 @@ Returns the position between the vertex "idx" and the vertex "idx"+1, where "t" 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_interpolate_baked: - :ref:`Vector2` **interpolate_baked** **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const @@ -158,37 +173,37 @@ To do that, it finds the two cached points where the "offset" lies between, then Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough). -.. _class_Curve2D_interpolatef: + .. _class_Curve2D_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". -.. _class_Curve2D_remove_point: + .. _class_Curve2D_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_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_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_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_tessellate: - :ref:`PoolVector2Array` **tessellate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const @@ -200,4 +215,3 @@ This approximation makes straight segments between each point, then subdivides t "tolerance_degrees" controls how many degrees the midpoint of a segment may deviate from the real curve, before the segment has to be subdivided. - diff --git a/classes/class_curve3d.rst b/classes/class_curve3d.rst index 885465627..9c90f64b2 100644 --- a/classes/class_curve3d.rst +++ b/classes/class_curve3d.rst @@ -8,6 +8,7 @@ Curve3D ======= **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description Describes a Bezier curve in 3D space. +Properties +---------- + ++---------------------------+-----------------------------------------------------------+ +| :ref:`float` | :ref:`bake_interval` | ++---------------------------+-----------------------------------------------------------+ +| :ref:`bool` | :ref:`up_vector_enabled` | ++---------------------------+-----------------------------------------------------------+ + Methods ------- @@ -78,17 +88,32 @@ Property Descriptions .. _class_Curve3D_bake_interval: -- :ref:`float` **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. +- :ref:`float` **bake_interval** + ++----------+--------------------------+ +| *Setter* | set_bake_interval(value) | ++----------+--------------------------+ +| *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. .. _class_Curve3D_up_vector_enabled: -- :ref:`bool` **up_vector_enabled** - If ``true``, the curve will bake up vectors used for orientation. See :ref:`OrientedPathFollow`. Changing it forces the cache to be recomputed. +- :ref:`bool` **up_vector_enabled** ++----------+------------------------------+ +| *Setter* | set_up_vector_enabled(value) | ++----------+------------------------------+ +| *Getter* | is_up_vector_enabled() | ++----------+------------------------------+ + +If ``true``, the curve will bake up vectors used for orientation. See :ref:`OrientedPathFollow`. Changing it forces the cache to be recomputed. Method Descriptions ------------------- -.. _class_Curve3D_add_point: + .. _class_Curve3D_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 **)** @@ -96,31 +121,31 @@ 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 >= :ref:`get_point_count`), the point will be appended at the end of the point list. -.. _class_Curve3D_clear_points: + .. _class_Curve3D_clear_points: - void **clear_points** **(** **)** Removes all points from the curve. -.. _class_Curve3D_get_baked_length: + .. _class_Curve3D_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:`set_bake_interval`), it should be approximate enough. -.. _class_Curve3D_get_baked_points: + .. _class_Curve3D_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_get_baked_tilts: - :ref:`PoolRealArray` **get_baked_tilts** **(** **)** const Returns the cache of tilts as a RealArray. -.. _class_Curve3D_get_baked_up_vectors: + .. _class_Curve3D_get_baked_up_vectors: - :ref:`PoolVector3Array` **get_baked_up_vectors** **(** **)** const @@ -128,7 +153,7 @@ Returns the cache of up vectors as a :ref:`PoolVector3Array` is ``false``, the cache will be empty. -.. _class_Curve3D_get_closest_offset: + .. _class_Curve3D_get_closest_offset: - :ref:`float` **get_closest_offset** **(** :ref:`Vector3` to_point **)** const @@ -136,7 +161,7 @@ Returns the closest offset to ``to_point``. This offset is meant to be used in o ``to_point`` must be in this curve's local space. -.. _class_Curve3D_get_closest_point: + .. _class_Curve3D_get_closest_point: - :ref:`Vector3` **get_closest_point** **(** :ref:`Vector3` to_point **)** const @@ -144,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_get_point_count: - :ref:`int` **get_point_count** **(** **)** const Returns the number of points describing the curve. -.. _class_Curve3D_get_point_in: + .. _class_Curve3D_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_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_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_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_interpolate: - :ref:`Vector3` **interpolate** **(** :ref:`int` idx, :ref:`float` t **)** const @@ -182,7 +207,7 @@ Returns the position between the vertex "idx" and the vertex "idx"+1, where "t" 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_interpolate_baked: - :ref:`Vector3` **interpolate_baked** **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const @@ -192,7 +217,7 @@ To do that, it finds the two cached points where the "offset" lies between, then Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough). -.. _class_Curve3D_interpolate_baked_up_vector: + .. _class_Curve3D_interpolate_baked_up_vector: - :ref:`Vector3` **interpolate_baked_up_vector** **(** :ref:`float` offset, :ref:`bool` apply_tilt=false **)** const @@ -202,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_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". -.. _class_Curve3D_remove_point: + .. _class_Curve3D_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_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_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_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_set_point_tilt: - void **set_point_tilt** **(** :ref:`int` idx, :ref:`float` tilt **)** @@ -240,7 +265,7 @@ Sets the tilt angle in radians for the point "idx". If the index is out of bound 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_tessellate: - :ref:`PoolVector3Array` **tessellate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const @@ -252,4 +277,3 @@ This approximation makes straight segments between each point, then subdivides t "tolerance_degrees" controls how many degrees the midpoint of a segment may deviate from the real curve, before the segment has to be subdivided. - diff --git a/classes/class_curvetexture.rst b/classes/class_curvetexture.rst index 816e735b5..5d8aafd00 100644 --- a/classes/class_curvetexture.rst +++ b/classes/class_curvetexture.rst @@ -8,6 +8,7 @@ CurveTexture ============ **Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description A texture that shows a curve. +Properties +---------- + ++---------------------------+----------------------------------------+ +| :ref:`Curve` | :ref:`curve` | ++---------------------------+----------------------------------------+ +| :ref:`int` | :ref:`width` | ++---------------------------+----------------------------------------+ + Description ----------- @@ -25,10 +35,25 @@ Property Descriptions .. _class_CurveTexture_curve: -- :ref:`Curve` **curve** - The ``curve`` rendered onto the texture. +- :ref:`Curve` **curve** + ++----------+------------------+ +| *Setter* | set_curve(value) | ++----------+------------------+ +| *Getter* | get_curve() | ++----------+------------------+ + +The ``curve`` rendered onto the texture. .. _class_CurveTexture_width: -- :ref:`int` **width** - The width of the texture. +- :ref:`int` **width** ++----------+------------------+ +| *Setter* | set_width(value) | ++----------+------------------+ +| *Getter* | get_width() | ++----------+------------------+ + +The width of the texture. diff --git a/classes/class_cylindermesh.rst b/classes/class_cylindermesh.rst index 18338797a..0d5634120 100644 --- a/classes/class_cylindermesh.rst +++ b/classes/class_cylindermesh.rst @@ -8,6 +8,7 @@ CylinderMesh ============ **Inherits:** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,21 @@ Brief Description 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` | ++---------------------------+------------------------------------------------------------+ + Description ----------- @@ -25,22 +41,61 @@ Property Descriptions .. _class_CylinderMesh_bottom_radius: -- :ref:`float` **bottom_radius** - Bottom radius of the cylinder. Defaults to 1.0. +- :ref:`float` **bottom_radius** + ++----------+--------------------------+ +| *Setter* | set_bottom_radius(value) | ++----------+--------------------------+ +| *Getter* | get_bottom_radius() | ++----------+--------------------------+ + +Bottom radius of the cylinder. Defaults to 1.0. .. _class_CylinderMesh_height: -- :ref:`float` **height** - Full height of the cylinder. Defaults to 2.0. +- :ref:`float` **height** + ++----------+-------------------+ +| *Setter* | set_height(value) | ++----------+-------------------+ +| *Getter* | get_height() | ++----------+-------------------+ + +Full height of the cylinder. Defaults to 2.0. .. _class_CylinderMesh_radial_segments: -- :ref:`int` **radial_segments** - Number of radial segments on the cylinder. Defaults to 64. +- :ref:`int` **radial_segments** + ++----------+----------------------------+ +| *Setter* | set_radial_segments(value) | ++----------+----------------------------+ +| *Getter* | get_radial_segments() | ++----------+----------------------------+ + +Number of radial segments on the cylinder. Defaults to 64. .. _class_CylinderMesh_rings: -- :ref:`int` **rings** - Number of edge rings along the height of the cylinder. Defaults to 4. +- :ref:`int` **rings** + ++----------+------------------+ +| *Setter* | set_rings(value) | ++----------+------------------+ +| *Getter* | get_rings() | ++----------+------------------+ + +Number of edge rings along the height of the cylinder. Defaults to 4. .. _class_CylinderMesh_top_radius: -- :ref:`float` **top_radius** - Top radius of the cylinder. Defaults to 1.0. +- :ref:`float` **top_radius** ++----------+-----------------------+ +| *Setter* | set_top_radius(value) | ++----------+-----------------------+ +| *Getter* | get_top_radius() | ++----------+-----------------------+ + +Top radius of the cylinder. Defaults to 1.0. diff --git a/classes/class_cylindershape.rst b/classes/class_cylindershape.rst index 2c1d00d6a..9a1ba2c10 100644 --- a/classes/class_cylindershape.rst +++ b/classes/class_cylindershape.rst @@ -8,6 +8,7 @@ CylinderShape ============= **Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description Cylinder shape for collisions. +Properties +---------- + ++---------------------------+-------------------------------------------+ +| :ref:`float` | :ref:`height` | ++---------------------------+-------------------------------------------+ +| :ref:`float` | :ref:`radius` | ++---------------------------+-------------------------------------------+ + Description ----------- @@ -25,10 +35,25 @@ Property Descriptions .. _class_CylinderShape_height: -- :ref:`float` **height** - The cylinder's height. +- :ref:`float` **height** + ++----------+-------------------+ +| *Setter* | set_height(value) | ++----------+-------------------+ +| *Getter* | get_height() | ++----------+-------------------+ + +The cylinder's height. .. _class_CylinderShape_radius: -- :ref:`float` **radius** - The cylinder's radius. +- :ref:`float` **radius** ++----------+-------------------+ +| *Setter* | set_radius(value) | ++----------+-------------------+ +| *Getter* | get_radius() | ++----------+-------------------+ + +The cylinder's radius. diff --git a/classes/class_dampedspringjoint2d.rst b/classes/class_dampedspringjoint2d.rst index d250b5075..4b256df45 100644 --- a/classes/class_dampedspringjoint2d.rst +++ b/classes/class_dampedspringjoint2d.rst @@ -8,6 +8,7 @@ DampedSpringJoint2D =================== **Inherits:** :ref:`Joint2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,19 @@ Brief Description Damped spring constraint for 2D physics. +Properties +---------- + ++---------------------------+-----------------------------------------------------------+ +| :ref:`float` | :ref:`damping` | ++---------------------------+-----------------------------------------------------------+ +| :ref:`float` | :ref:`length` | ++---------------------------+-----------------------------------------------------------+ +| :ref:`float` | :ref:`rest_length` | ++---------------------------+-----------------------------------------------------------+ +| :ref:`float` | :ref:`stiffness` | ++---------------------------+-----------------------------------------------------------+ + Description ----------- @@ -25,18 +39,49 @@ Property Descriptions .. _class_DampedSpringJoint2D_damping: -- :ref:`float` **damping** - 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`` +- :ref:`float` **damping** + ++----------+--------------------+ +| *Setter* | set_damping(value) | ++----------+--------------------+ +| *Getter* | get_damping() | ++----------+--------------------+ + +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: -- :ref:`float` **length** - The spring joint's maximum length. The two attached bodies cannot stretch it past this value. Default value: ``50`` +- :ref:`float` **length** + ++----------+-------------------+ +| *Setter* | set_length(value) | ++----------+-------------------+ +| *Getter* | get_length() | ++----------+-------------------+ + +The spring joint's maximum length. The two attached bodies cannot stretch it past this value. Default value: ``50`` .. _class_DampedSpringJoint2D_rest_length: -- :ref:`float` **rest_length** - 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`` +- :ref:`float` **rest_length** + ++----------+------------------------+ +| *Setter* | set_rest_length(value) | ++----------+------------------------+ +| *Getter* | get_rest_length() | ++----------+------------------------+ + +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: -- :ref:`float` **stiffness** - The higher the value, the less the bodies attached to the joint will deform it. The joint applies an opposing force to the bodies, the product of the stiffness multiplied by the size difference from its resting length. Default value: ``20`` +- :ref:`float` **stiffness** ++----------+----------------------+ +| *Setter* | set_stiffness(value) | ++----------+----------------------+ +| *Getter* | get_stiffness() | ++----------+----------------------+ + +The higher the value, the less the bodies attached to the joint will deform it. The joint applies an opposing force to the bodies, the product of the stiffness multiplied by the size difference from its resting length. Default value: ``20`` diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index 7fb8bb2f9..c60c123d9 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -47,64 +47,63 @@ Dictionary type. Associative container which contains values referenced by uniqu Method Descriptions ------------------- -.. _class_Dictionary_clear: + .. _class_Dictionary_clear: - void **clear** **(** **)** Clear the dictionary, removing all key/value pairs. -.. _class_Dictionary_duplicate: + .. _class_Dictionary_duplicate: - :ref:`Dictionary` **duplicate** **(** :ref:`bool` deep=False **)** Creates a copy of the dictionary, and returns it. -.. _class_Dictionary_empty: + .. _class_Dictionary_empty: - :ref:`bool` **empty** **(** **)** Return true if the dictionary is empty. -.. _class_Dictionary_erase: + .. _class_Dictionary_erase: - :ref:`bool` **erase** **(** :ref:`Variant` key **)** Erase a dictionary key/value pair by key. -.. _class_Dictionary_has: + .. _class_Dictionary_has: - :ref:`bool` **has** **(** :ref:`Variant` key **)** Return true if the dictionary has a given key. -.. _class_Dictionary_has_all: + .. _class_Dictionary_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_hash: - :ref:`int` **hash** **(** **)** Return a hashed integer value representing the dictionary contents. -.. _class_Dictionary_keys: + .. _class_Dictionary_keys: - :ref:`Array` **keys** **(** **)** Return the list of keys in the ``Dictionary``. -.. _class_Dictionary_size: + .. _class_Dictionary_size: - :ref:`int` **size** **(** **)** Return the size of the dictionary (in pairs). -.. _class_Dictionary_values: + .. _class_Dictionary_values: - :ref:`Array` **values** **(** **)** Return the list of values in the ``Dictionary``. - diff --git a/classes/class_directionallight.rst b/classes/class_directionallight.rst index f220edfb2..de1e9331f 100644 --- a/classes/class_directionallight.rst +++ b/classes/class_directionallight.rst @@ -8,6 +8,7 @@ DirectionalLight ================ **Inherits:** :ref:`Light` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,25 +16,47 @@ Brief Description 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` | ++-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ + Enumerations ------------ .. _enum_DirectionalLight_ShadowDepthRange: -enum **ShadowDepthRange** +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. - **SHADOW_DEPTH_RANGE_OPTIMIZED** = **1** --- Tries to achieve maximum shadow resolution. May result in saw effect on shadow edges. .. _enum_DirectionalLight_ShadowMode: -enum **ShadowMode** +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. - **SHADOW_PARALLEL_2_SPLITS** = **1** --- Splits the view frustum in 2 areas, each with its own shadow map. - **SHADOW_PARALLEL_4_SPLITS** = **2** --- Splits the view frustum in 4 areas, each with its own shadow map. - Description ----------- @@ -43,44 +66,114 @@ Tutorials --------- - :doc:`../tutorials/3d/lights_and_shadows` - Property Descriptions --------------------- .. _class_DirectionalLight_directional_shadow_bias_split_scale: -- :ref:`float` **directional_shadow_bias_split_scale** - 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. +- :ref:`float` **directional_shadow_bias_split_scale** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +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: -- :ref:`bool` **directional_shadow_blend_splits** - If ``true`` shadow detail is sacrificed in exchange for smoother transitions between splits. Default value:``false``. +- :ref:`bool` **directional_shadow_blend_splits** + ++----------+---------------------------+ +| *Setter* | set_blend_splits(value) | ++----------+---------------------------+ +| *Getter* | is_blend_splits_enabled() | ++----------+---------------------------+ + +If ``true`` shadow detail is sacrificed in exchange for smoother transitions between splits. Default value:``false``. .. _class_DirectionalLight_directional_shadow_depth_range: -- :ref:`ShadowDepthRange` **directional_shadow_depth_range** - Optimizes shadow rendering for detail versus movement. See :ref:`ShadowDepthRange`. +- :ref:`ShadowDepthRange` **directional_shadow_depth_range** + ++----------+-------------------------------+ +| *Setter* | set_shadow_depth_range(value) | ++----------+-------------------------------+ +| *Getter* | get_shadow_depth_range() | ++----------+-------------------------------+ + +Optimizes shadow rendering for detail versus movement. See :ref:`ShadowDepthRange`. .. _class_DirectionalLight_directional_shadow_max_distance: -- :ref:`float` **directional_shadow_max_distance** - The maximum distance for shadow splits. +- :ref:`float` **directional_shadow_max_distance** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +The maximum distance for shadow splits. .. _class_DirectionalLight_directional_shadow_mode: -- :ref:`ShadowMode` **directional_shadow_mode** - The light's shadow rendering algorithm. See :ref:`ShadowMode`. +- :ref:`ShadowMode` **directional_shadow_mode** + ++----------+------------------------+ +| *Setter* | set_shadow_mode(value) | ++----------+------------------------+ +| *Getter* | get_shadow_mode() | ++----------+------------------------+ + +The light's shadow rendering algorithm. See :ref:`ShadowMode`. .. _class_DirectionalLight_directional_shadow_normal_bias: -- :ref:`float` **directional_shadow_normal_bias** - Can be used to fix special cases of self shadowing when objects are perpendicular to the light. +- :ref:`float` **directional_shadow_normal_bias** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +Can be used to fix special cases of self shadowing when objects are perpendicular to the light. .. _class_DirectionalLight_directional_shadow_split_1: -- :ref:`float` **directional_shadow_split_1** - 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. +- :ref:`float` **directional_shadow_split_1** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *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. .. _class_DirectionalLight_directional_shadow_split_2: -- :ref:`float` **directional_shadow_split_2** - 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. +- :ref:`float` **directional_shadow_split_2** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *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. .. _class_DirectionalLight_directional_shadow_split_3: -- :ref:`float` **directional_shadow_split_3** - 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. +- :ref:`float` **directional_shadow_split_3** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *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. diff --git a/classes/class_directory.rst b/classes/class_directory.rst index 6964793f0..96d8d7103 100644 --- a/classes/class_directory.rst +++ b/classes/class_directory.rst @@ -8,6 +8,7 @@ Directory ========= **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -83,11 +84,10 @@ Tutorials --------- - :doc:`../getting_started/step_by_step/filesystem` - Method Descriptions ------------------- -.. _class_Directory_change_dir: + .. _class_Directory_change_dir: - :ref:`Error` **change_dir** **(** :ref:`String` todir **)** @@ -95,7 +95,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_copy: - :ref:`Error` **copy** **(** :ref:`String` from, :ref:`String` to **)** @@ -103,49 +103,49 @@ 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_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). -.. _class_Directory_dir_exists: + .. _class_Directory_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_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_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_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. -.. _class_Directory_get_drive: + .. _class_Directory_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_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_get_next: - :ref:`String` **get_next** **(** **)** @@ -153,13 +153,13 @@ Return the next element (file or directory) in the current directory (including 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_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_list_dir_begin: - :ref:`Error` **list_dir_begin** **(** :ref:`bool` skip_navigational=false, :ref:`bool` skip_hidden=false **)** @@ -169,13 +169,13 @@ 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_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). -.. _class_Directory_make_dir: + .. _class_Directory_make_dir: - :ref:`Error` **make_dir** **(** :ref:`String` path **)** @@ -183,7 +183,7 @@ Create a directory. The argument can be relative to the current directory, or an The method returns one of the error code constants defined in :ref:`@GlobalScope` (OK, FAILED or ERR\_\*). -.. _class_Directory_make_dir_recursive: + .. _class_Directory_make_dir_recursive: - :ref:`Error` **make_dir_recursive** **(** :ref:`String` path **)** @@ -191,7 +191,7 @@ Create a target directory and all necessary intermediate directories in its path Return one of the error code constants defined in :ref:`@GlobalScope` (OK, FAILED or ERR\_\*). -.. _class_Directory_open: + .. _class_Directory_open: - :ref:`Error` **open** **(** :ref:`String` path **)** @@ -199,7 +199,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_remove: - :ref:`Error` **remove** **(** :ref:`String` path **)** @@ -207,7 +207,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_rename: - :ref:`Error` **rename** **(** :ref:`String` from, :ref:`String` to **)** @@ -215,4 +215,3 @@ Rename (move) the *from* file to the *to* destination. Both arguments should be Return one of the error code constants defined in :ref:`@GlobalScope` (OK or FAILED). - diff --git a/classes/class_dynamicfont.rst b/classes/class_dynamicfont.rst index ba7f1a982..b539a3321 100644 --- a/classes/class_dynamicfont.rst +++ b/classes/class_dynamicfont.rst @@ -8,6 +8,7 @@ DynamicFont =========== **Inherits:** :ref:`Font` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,31 @@ Brief Description 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` | ++-----------------------------------------------+---------------------------------------------------------------------+ + Methods ------- @@ -35,14 +61,13 @@ Enumerations .. _enum_DynamicFont_SpacingType: -enum **SpacingType** +enum **SpacingType**: - **SPACING_TOP** = **0** --- Spacing at the top. - **SPACING_BOTTOM** = **1** --- Spacing at the bottom. - **SPACING_CHAR** = **2** --- Character spacing. - **SPACING_SPACE** = **3** --- Space spacing. - Description ----------- @@ -53,76 +78,150 @@ Property Descriptions .. _class_DynamicFont_extra_spacing_bottom: -- :ref:`int` **extra_spacing_bottom** - Extra spacing at the bottom in pixels. +- :ref:`int` **extra_spacing_bottom** + ++----------+--------------------+ +| *Setter* | set_spacing(value) | ++----------+--------------------+ +| *Getter* | get_spacing() | ++----------+--------------------+ + +Extra spacing at the bottom in pixels. .. _class_DynamicFont_extra_spacing_char: -- :ref:`int` **extra_spacing_char** - Extra character spacing in pixels. +- :ref:`int` **extra_spacing_char** + ++----------+--------------------+ +| *Setter* | set_spacing(value) | ++----------+--------------------+ +| *Getter* | get_spacing() | ++----------+--------------------+ + +Extra character spacing in pixels. .. _class_DynamicFont_extra_spacing_space: -- :ref:`int` **extra_spacing_space** - Extra space spacing in pixels. +- :ref:`int` **extra_spacing_space** + ++----------+--------------------+ +| *Setter* | set_spacing(value) | ++----------+--------------------+ +| *Getter* | get_spacing() | ++----------+--------------------+ + +Extra space spacing in pixels. .. _class_DynamicFont_extra_spacing_top: -- :ref:`int` **extra_spacing_top** - Extra spacing at the top in pixels. +- :ref:`int` **extra_spacing_top** + ++----------+--------------------+ +| *Setter* | set_spacing(value) | ++----------+--------------------+ +| *Getter* | get_spacing() | ++----------+--------------------+ + +Extra spacing at the top in pixels. .. _class_DynamicFont_font_data: -- :ref:`DynamicFontData` **font_data** - The font data. +- :ref:`DynamicFontData` **font_data** + ++----------+----------------------+ +| *Setter* | set_font_data(value) | ++----------+----------------------+ +| *Getter* | get_font_data() | ++----------+----------------------+ + +The font data. .. _class_DynamicFont_outline_color: - :ref:`Color` **outline_color** ++----------+--------------------------+ +| *Setter* | set_outline_color(value) | ++----------+--------------------------+ +| *Getter* | get_outline_color() | ++----------+--------------------------+ + .. _class_DynamicFont_outline_size: - :ref:`int` **outline_size** ++----------+-------------------------+ +| *Setter* | set_outline_size(value) | ++----------+-------------------------+ +| *Getter* | get_outline_size() | ++----------+-------------------------+ + .. _class_DynamicFont_size: -- :ref:`int` **size** - The font size. +- :ref:`int` **size** + ++----------+-----------------+ +| *Setter* | set_size(value) | ++----------+-----------------+ +| *Getter* | get_size() | ++----------+-----------------+ + +The font size. .. _class_DynamicFont_use_filter: -- :ref:`bool` **use_filter** - If ``true`` filtering is used. +- :ref:`bool` **use_filter** + ++----------+-----------------------+ +| *Setter* | set_use_filter(value) | ++----------+-----------------------+ +| *Getter* | get_use_filter() | ++----------+-----------------------+ + +If ``true`` filtering is used. .. _class_DynamicFont_use_mipmaps: -- :ref:`bool` **use_mipmaps** - If ``true`` mipmapping is used. +- :ref:`bool` **use_mipmaps** ++----------+------------------------+ +| *Setter* | set_use_mipmaps(value) | ++----------+------------------------+ +| *Getter* | get_use_mipmaps() | ++----------+------------------------+ + +If ``true`` mipmapping is used. Method Descriptions ------------------- -.. _class_DynamicFont_add_fallback: + .. _class_DynamicFont_add_fallback: - void **add_fallback** **(** :ref:`DynamicFontData` data **)** Adds a fallback font. -.. _class_DynamicFont_get_fallback: + .. _class_DynamicFont_get_fallback: - :ref:`DynamicFontData` **get_fallback** **(** :ref:`int` idx **)** const Returns the fallback font at index ``idx``. -.. _class_DynamicFont_get_fallback_count: + .. _class_DynamicFont_get_fallback_count: - :ref:`int` **get_fallback_count** **(** **)** const Returns the number of fallback fonts. -.. _class_DynamicFont_remove_fallback: + .. _class_DynamicFont_remove_fallback: - void **remove_fallback** **(** :ref:`int` idx **)** Removes the fallback font at index ``idx``. -.. _class_DynamicFont_set_fallback: + .. _class_DynamicFont_set_fallback: - void **set_fallback** **(** :ref:`int` idx, :ref:`DynamicFontData` data **)** Sets the fallback font at index ``idx``. - diff --git a/classes/class_dynamicfontdata.rst b/classes/class_dynamicfontdata.rst index d875aaae1..22629a46c 100644 --- a/classes/class_dynamicfontdata.rst +++ b/classes/class_dynamicfontdata.rst @@ -8,6 +8,7 @@ DynamicFontData =============== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,18 +16,26 @@ Brief Description Used with :ref:`DynamicFont` to describe the location of a font file. +Properties +---------- + ++----------------------------------------------+---------------------------------------------------+ +| :ref:`String` | :ref:`font_path` | ++----------------------------------------------+---------------------------------------------------+ +| :ref:`Hinting` | :ref:`hinting` | ++----------------------------------------------+---------------------------------------------------+ + Enumerations ------------ .. _enum_DynamicFontData_Hinting: -enum **Hinting** +enum **Hinting**: - **HINTING_NONE** = **0** --- Disable font hinting (smoother but less crisp). - **HINTING_LIGHT** = **1** --- Use the light font hinting mode. - **HINTING_NORMAL** = **2** --- Use the default font hinting mode (crisper but less smooth). - Description ----------- @@ -37,10 +46,25 @@ Property Descriptions .. _class_DynamicFontData_font_path: -- :ref:`String` **font_path** - The path to the vector font file. +- :ref:`String` **font_path** + ++----------+----------------------+ +| *Setter* | set_font_path(value) | ++----------+----------------------+ +| *Getter* | get_font_path() | ++----------+----------------------+ + +The path to the vector font file. .. _class_DynamicFontData_hinting: -- :ref:`Hinting` **hinting** - The font hinting mode used by FreeType. +- :ref:`Hinting` **hinting** ++----------+--------------------+ +| *Setter* | set_hinting(value) | ++----------+--------------------+ +| *Getter* | get_hinting() | ++----------+--------------------+ + +The font hinting mode used by FreeType. diff --git a/classes/class_editorexportplugin.rst b/classes/class_editorexportplugin.rst index 4828d539a..f4bc8c5bf 100644 --- a/classes/class_editorexportplugin.rst +++ b/classes/class_editorexportplugin.rst @@ -8,6 +8,7 @@ EditorExportPlugin ================== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -43,44 +44,43 @@ Methods Method Descriptions ------------------- -.. _class_EditorExportPlugin__export_begin: + .. _class_EditorExportPlugin__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__export_file: - void **_export_file** **(** :ref:`String` path, :ref:`String` type, :ref:`PoolStringArray` features **)** virtual -.. _class_EditorExportPlugin_add_file: + .. _class_EditorExportPlugin_add_file: - void **add_file** **(** :ref:`String` path, :ref:`PoolByteArray` file, :ref:`bool` remap **)** -.. _class_EditorExportPlugin_add_ios_bundle_file: + .. _class_EditorExportPlugin_add_ios_bundle_file: - void **add_ios_bundle_file** **(** :ref:`String` path **)** -.. _class_EditorExportPlugin_add_ios_cpp_code: + .. _class_EditorExportPlugin_add_ios_cpp_code: - void **add_ios_cpp_code** **(** :ref:`String` code **)** -.. _class_EditorExportPlugin_add_ios_framework: + .. _class_EditorExportPlugin_add_ios_framework: - void **add_ios_framework** **(** :ref:`String` path **)** -.. _class_EditorExportPlugin_add_ios_linker_flags: + .. _class_EditorExportPlugin_add_ios_linker_flags: - void **add_ios_linker_flags** **(** :ref:`String` flags **)** -.. _class_EditorExportPlugin_add_ios_plist_content: + .. _class_EditorExportPlugin_add_ios_plist_content: - void **add_ios_plist_content** **(** :ref:`String` plist_content **)** -.. _class_EditorExportPlugin_add_shared_object: + .. _class_EditorExportPlugin_add_shared_object: - void **add_shared_object** **(** :ref:`String` path, :ref:`PoolStringArray` tags **)** -.. _class_EditorExportPlugin_skip: + .. _class_EditorExportPlugin_skip: - void **skip** **(** **)** - diff --git a/classes/class_editorfiledialog.rst b/classes/class_editorfiledialog.rst index a978cc198..a0934a3fe 100644 --- a/classes/class_editorfiledialog.rst +++ b/classes/class_editorfiledialog.rst @@ -8,6 +8,7 @@ EditorFileDialog ================ **Inherits:** :ref:`ConfirmationDialog` **<** :ref:`AcceptDialog` **<** :ref:`WindowDialog` **<** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,27 @@ 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` | ++-------------------------------------------------------+------------------------------------------------------------------------------------+ + Methods ------- @@ -31,31 +53,30 @@ Methods Signals ------- -.. _class_EditorFileDialog_dir_selected: + .. _class_EditorFileDialog_dir_selected: - **dir_selected** **(** :ref:`String` dir **)** Emitted when a directory is selected. -.. _class_EditorFileDialog_file_selected: + .. _class_EditorFileDialog_file_selected: - **file_selected** **(** :ref:`String` path **)** Emitted when a file is selected. -.. _class_EditorFileDialog_files_selected: + .. _class_EditorFileDialog_files_selected: - **files_selected** **(** :ref:`PoolStringArray` paths **)** Emitted when multiple files are selected. - Enumerations ------------ .. _enum_EditorFileDialog_Access: -enum **Access** +enum **Access**: - **ACCESS_RESOURCES** = **0** --- The ``EditorFileDialog`` can only view ``res://`` directory contents. - **ACCESS_USERDATA** = **1** --- The ``EditorFileDialog`` can only view ``user://`` directory contents. @@ -63,14 +84,14 @@ enum **Access** .. _enum_EditorFileDialog_DisplayMode: -enum **DisplayMode** +enum **DisplayMode**: - **DISPLAY_THUMBNAILS** = **0** --- The ``EditorFileDialog`` displays resources as thumbnails. - **DISPLAY_LIST** = **1** --- The ``EditorFileDialog`` displays resources as a list of filenames. .. _enum_EditorFileDialog_Mode: -enum **Mode** +enum **Mode**: - **MODE_OPEN_FILE** = **0** --- The ``EditorFileDialog`` can select only one file. Accepting the window will open the file. - **MODE_OPEN_FILES** = **1** --- The ``EditorFileDialog`` can select multiple files. Accepting the window will open all files. @@ -78,47 +99,109 @@ enum **Mode** - **MODE_OPEN_ANY** = **3** --- The ``EditorFileDialog`` can select a file or directory. Accepting the window will open it. - **MODE_SAVE_FILE** = **4** --- The ``EditorFileDialog`` can select only one file. Accepting the window will save the file. - Property Descriptions --------------------- .. _class_EditorFileDialog_access: -- :ref:`Access` **access** - The location from which the user may select a file, including ``res://``, ``user://``, and the local file system. +- :ref:`Access` **access** + ++----------+-------------------+ +| *Setter* | set_access(value) | ++----------+-------------------+ +| *Getter* | get_access() | ++----------+-------------------+ + +The location from which the user may select a file, including ``res://``, ``user://``, and the local file system. .. _class_EditorFileDialog_current_dir: -- :ref:`String` **current_dir** - The currently occupied directory. +- :ref:`String` **current_dir** + ++----------+------------------------+ +| *Setter* | set_current_dir(value) | ++----------+------------------------+ +| *Getter* | get_current_dir() | ++----------+------------------------+ + +The currently occupied directory. .. _class_EditorFileDialog_current_file: -- :ref:`String` **current_file** - The currently selected file. +- :ref:`String` **current_file** + ++----------+-------------------------+ +| *Setter* | set_current_file(value) | ++----------+-------------------------+ +| *Getter* | get_current_file() | ++----------+-------------------------+ + +The currently selected file. .. _class_EditorFileDialog_current_path: -- :ref:`String` **current_path** - The file system path in the address bar. +- :ref:`String` **current_path** + ++----------+-------------------------+ +| *Setter* | set_current_path(value) | ++----------+-------------------------+ +| *Getter* | get_current_path() | ++----------+-------------------------+ + +The file system path in the address bar. .. _class_EditorFileDialog_disable_overwrite_warning: -- :ref:`bool` **disable_overwrite_warning** - If ``true`` the ``EditorFileDialog`` will not warn the user before overwriting files. +- :ref:`bool` **disable_overwrite_warning** + ++----------+--------------------------------------+ +| *Setter* | set_disable_overwrite_warning(value) | ++----------+--------------------------------------+ +| *Getter* | is_overwrite_warning_disabled() | ++----------+--------------------------------------+ + +If ``true`` the ``EditorFileDialog`` will not warn the user before overwriting files. .. _class_EditorFileDialog_display_mode: -- :ref:`DisplayMode` **display_mode** - The view format in which the ``EditorFileDialog`` displays resources to the user. +- :ref:`DisplayMode` **display_mode** + ++----------+-------------------------+ +| *Setter* | set_display_mode(value) | ++----------+-------------------------+ +| *Getter* | get_display_mode() | ++----------+-------------------------+ + +The view format in which the ``EditorFileDialog`` displays resources to the user. .. _class_EditorFileDialog_mode: -- :ref:`Mode` **mode** - The purpose of the ``EditorFileDialog``. Changes allowed behaviors. +- :ref:`Mode` **mode** + ++----------+-----------------+ +| *Setter* | set_mode(value) | ++----------+-----------------+ +| *Getter* | get_mode() | ++----------+-----------------+ + +The purpose of the ``EditorFileDialog``. Changes allowed behaviors. .. _class_EditorFileDialog_show_hidden_files: -- :ref:`bool` **show_hidden_files** - If ``true`` hidden files and directories will be visible in the ``EditorFileDialog``. +- :ref:`bool` **show_hidden_files** ++----------+------------------------------+ +| *Setter* | set_show_hidden_files(value) | ++----------+------------------------------+ +| *Getter* | is_showing_hidden_files() | ++----------+------------------------------+ + +If ``true`` hidden files and directories will be visible in the ``EditorFileDialog``. Method Descriptions ------------------- -.. _class_EditorFileDialog_add_filter: + .. _class_EditorFileDialog_add_filter: - void **add_filter** **(** :ref:`String` filter **)** @@ -126,22 +209,21 @@ 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_clear_filters: - void **clear_filters** **(** **)** Removes all filters except for "All Files (\*)". -.. _class_EditorFileDialog_get_vbox: + .. _class_EditorFileDialog_get_vbox: - :ref:`VBoxContainer` **get_vbox** **(** **)** Returns the ``VBoxContainer`` used to display the file system. -.. _class_EditorFileDialog_invalidate: + .. _class_EditorFileDialog_invalidate: - void **invalidate** **(** **)** Notify the ``EditorFileDialog`` that its view of the data is no longer accurate. Updates the view contents on next view update. - diff --git a/classes/class_editorfilesystem.rst b/classes/class_editorfilesystem.rst index 5c5d9240e..0a6d889b0 100644 --- a/classes/class_editorfilesystem.rst +++ b/classes/class_editorfilesystem.rst @@ -8,6 +8,7 @@ EditorFileSystem ================ **Inherits:** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -41,29 +42,28 @@ Methods Signals ------- -.. _class_EditorFileSystem_filesystem_changed: + .. _class_EditorFileSystem_filesystem_changed: - **filesystem_changed** **(** **)** Emitted if the filesystem changed. -.. _class_EditorFileSystem_resources_reimported: + .. _class_EditorFileSystem_resources_reimported: - **resources_reimported** **(** :ref:`PoolStringArray` resources **)** Remitted if a resource is reimported. -.. _class_EditorFileSystem_script_classes_updated: + .. _class_EditorFileSystem_script_classes_updated: - **script_classes_updated** **(** **)** -.. _class_EditorFileSystem_sources_changed: + .. _class_EditorFileSystem_sources_changed: - **sources_changed** **(** :ref:`bool` exist **)** Emitted if the source of any imported file changed. - Description ----------- @@ -72,56 +72,55 @@ This object holds information of all resources in the filesystem, their types, e Method Descriptions ------------------- -.. _class_EditorFileSystem_get_file_type: + .. _class_EditorFileSystem_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_get_filesystem: - :ref:`EditorFileSystemDirectory` **get_filesystem** **(** **)** Get the root directory object. -.. _class_EditorFileSystem_get_filesystem_path: + .. _class_EditorFileSystem_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_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_is_scanning: - :ref:`bool` **is_scanning** **(** **)** const Return true of the filesystem is being scanned. -.. _class_EditorFileSystem_scan: + .. _class_EditorFileSystem_scan: - void **scan** **(** **)** Scan the filesystem for changes. -.. _class_EditorFileSystem_scan_sources: + .. _class_EditorFileSystem_scan_sources: - void **scan_sources** **(** **)** Check if the source of any imported resource changed. -.. _class_EditorFileSystem_update_file: + .. _class_EditorFileSystem_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_update_script_classes: - void **update_script_classes** **(** **)** - diff --git a/classes/class_editorfilesystemdirectory.rst b/classes/class_editorfilesystemdirectory.rst index 2978c2c76..c13df422f 100644 --- a/classes/class_editorfilesystemdirectory.rst +++ b/classes/class_editorfilesystemdirectory.rst @@ -8,12 +8,13 @@ EditorFileSystemDirectory ========================= **Inherits:** :ref:`Object` + **Category:** Core Brief Description ----------------- -A diretory for the resource filesystem. +A directory for the resource filesystem. Methods ------- @@ -56,84 +57,83 @@ A more generalized, low-level variation of the directory concept. Method Descriptions ------------------- -.. _class_EditorFileSystemDirectory_find_dir_index: + .. _class_EditorFileSystemDirectory_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_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_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_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_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_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_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_get_file_script_class_name: - :ref:`String` **get_file_script_class_name** **(** :ref:`int` idx **)** const -.. _class_EditorFileSystemDirectory_get_file_type: + .. _class_EditorFileSystemDirectory_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_get_name: - :ref:`String` **get_name** **(** **)** Returns the name of this directory. -.. _class_EditorFileSystemDirectory_get_parent: + .. _class_EditorFileSystemDirectory_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_get_path: - :ref:`String` **get_path** **(** **)** const Returns the path to this directory. -.. _class_EditorFileSystemDirectory_get_subdir: + .. _class_EditorFileSystemDirectory_get_subdir: - :ref:`EditorFileSystemDirectory` **get_subdir** **(** :ref:`int` idx **)** Returns the subdirectory at index ``idx``. -.. _class_EditorFileSystemDirectory_get_subdir_count: + .. _class_EditorFileSystemDirectory_get_subdir_count: - :ref:`int` **get_subdir_count** **(** **)** const Returns the number of subdirectories in this directory. - diff --git a/classes/class_editorimportplugin.rst b/classes/class_editorimportplugin.rst index 3d45bd06c..19bd2855f 100644 --- a/classes/class_editorimportplugin.rst +++ b/classes/class_editorimportplugin.rst @@ -8,6 +8,7 @@ EditorImportPlugin ================== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -97,76 +98,74 @@ Tutorials --------- - :doc:`../tutorials/plugins/editor/import_plugins` - Method Descriptions ------------------- -.. _class_EditorImportPlugin_get_import_options: + .. _class_EditorImportPlugin_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_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_get_importer_name: - :ref:`String` **get_importer_name** **(** **)** virtual Get the unique name of the importer. -.. _class_EditorImportPlugin_get_option_visibility: + .. _class_EditorImportPlugin_get_option_visibility: - :ref:`bool` **get_option_visibility** **(** :ref:`String` option, :ref:`Dictionary` options **)** virtual -.. _class_EditorImportPlugin_get_preset_count: + .. _class_EditorImportPlugin_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. -.. _class_EditorImportPlugin_get_preset_name: + .. _class_EditorImportPlugin_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_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_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_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_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_get_visible_name: - :ref:`String` **get_visible_name** **(** **)** virtual Get the name to display in the import window. -.. _class_EditorImportPlugin_import: + .. _class_EditorImportPlugin_import: - :ref:`int` **import** **(** :ref:`String` source_file, :ref:`String` save_path, :ref:`Dictionary` options, :ref:`Array` r_platform_variants, :ref:`Array` r_gen_files **)** virtual - diff --git a/classes/class_editorinspector.rst b/classes/class_editorinspector.rst index a848466fd..63067d776 100644 --- a/classes/class_editorinspector.rst +++ b/classes/class_editorinspector.rst @@ -8,6 +8,7 @@ EditorInspector =============== **Inherits:** :ref:`ScrollContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -25,36 +26,34 @@ Methods Signals ------- -.. _class_EditorInspector_object_id_selected: + .. _class_EditorInspector_object_id_selected: - **object_id_selected** **(** :ref:`int` id **)** -.. _class_EditorInspector_property_edited: + .. _class_EditorInspector_property_edited: - **property_edited** **(** :ref:`String` property **)** -.. _class_EditorInspector_property_keyed: + .. _class_EditorInspector_property_keyed: - **property_keyed** **(** :ref:`String` property **)** -.. _class_EditorInspector_property_selected: + .. _class_EditorInspector_property_selected: - **property_selected** **(** :ref:`String` property **)** -.. _class_EditorInspector_resource_selected: + .. _class_EditorInspector_resource_selected: - **resource_selected** **(** :ref:`Object` res, :ref:`String` prop **)** -.. _class_EditorInspector_restart_requested: + .. _class_EditorInspector_restart_requested: - **restart_requested** **(** **)** - Method Descriptions ------------------- -.. _class_EditorInspector_refresh: + .. _class_EditorInspector_refresh: - void **refresh** **(** **)** - diff --git a/classes/class_editorinspectorplugin.rst b/classes/class_editorinspectorplugin.rst index 8b27e137c..fbb837708 100644 --- a/classes/class_editorinspectorplugin.rst +++ b/classes/class_editorinspectorplugin.rst @@ -8,6 +8,7 @@ EditorInspectorPlugin ===================== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -39,36 +40,35 @@ Methods Method Descriptions ------------------- -.. _class_EditorInspectorPlugin_add_custom_control: + .. _class_EditorInspectorPlugin_add_custom_control: - void **add_custom_control** **(** :ref:`Control` control **)** -.. _class_EditorInspectorPlugin_add_property_editor: + .. _class_EditorInspectorPlugin_add_property_editor: - void **add_property_editor** **(** :ref:`String` property, :ref:`Control` editor **)** -.. _class_EditorInspectorPlugin_add_property_editor_for_multiple_properties: + .. _class_EditorInspectorPlugin_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_can_handle: - :ref:`bool` **can_handle** **(** :ref:`Object` object **)** virtual -.. _class_EditorInspectorPlugin_parse_begin: + .. _class_EditorInspectorPlugin_parse_begin: - void **parse_begin** **(** :ref:`Object` object **)** virtual -.. _class_EditorInspectorPlugin_parse_category: + .. _class_EditorInspectorPlugin_parse_category: - void **parse_category** **(** :ref:`Object` object, :ref:`String` category **)** virtual -.. _class_EditorInspectorPlugin_parse_end: + .. _class_EditorInspectorPlugin_parse_end: - void **parse_end** **(** **)** virtual -.. _class_EditorInspectorPlugin_parse_property: + .. _class_EditorInspectorPlugin_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 d4c3f8347..ba598f3f8 100644 --- a/classes/class_editorinterface.rst +++ b/classes/class_editorinterface.rst @@ -8,6 +8,7 @@ EditorInterface =============== **Inherits:** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -68,120 +69,119 @@ Editor interface. Allows saving and (re-)loading scenes, rendering mesh previews Method Descriptions ------------------- -.. _class_EditorInterface_edit_resource: + .. _class_EditorInterface_edit_resource: - void **edit_resource** **(** :ref:`Resource` resource **)** Edits the given :ref:`Resource`. -.. _class_EditorInterface_get_base_control: + .. _class_EditorInterface_get_base_control: - :ref:`Control` **get_base_control** **(** **)** Returns the base :ref:`Control`. -.. _class_EditorInterface_get_edited_scene_root: + .. _class_EditorInterface_get_edited_scene_root: - :ref:`Node` **get_edited_scene_root** **(** **)** Returns the edited scene's root :ref:`Node`. -.. _class_EditorInterface_get_editor_settings: + .. _class_EditorInterface_get_editor_settings: - :ref:`EditorSettings` **get_editor_settings** **(** **)** Returns the :ref:`EditorSettings`. -.. _class_EditorInterface_get_editor_viewport: + .. _class_EditorInterface_get_editor_viewport: - :ref:`Control` **get_editor_viewport** **(** **)** Returns the editor :ref:`Viewport`. -.. _class_EditorInterface_get_open_scenes: + .. _class_EditorInterface_get_open_scenes: - :ref:`Array` **get_open_scenes** **(** **)** const Returns an :ref:`Array` of the currently opened scenes. -.. _class_EditorInterface_get_resource_filesystem: + .. _class_EditorInterface_get_resource_filesystem: - :ref:`EditorFileSystem` **get_resource_filesystem** **(** **)** Returns the :ref:`EditorFileSystem`. -.. _class_EditorInterface_get_resource_previewer: + .. _class_EditorInterface_get_resource_previewer: - :ref:`EditorResourcePreview` **get_resource_previewer** **(** **)** Returns the :ref:`EditorResourcePreview`\ er. -.. _class_EditorInterface_get_script_editor: + .. _class_EditorInterface_get_script_editor: - :ref:`ScriptEditor` **get_script_editor** **(** **)** Returns the :ref:`ScriptEditor`. -.. _class_EditorInterface_get_selected_path: + .. _class_EditorInterface_get_selected_path: - :ref:`String` **get_selected_path** **(** **)** const -.. _class_EditorInterface_get_selection: + .. _class_EditorInterface_get_selection: - :ref:`EditorSelection` **get_selection** **(** **)** Returns the :ref:`EditorSelection`. -.. _class_EditorInterface_inspect_object: + .. _class_EditorInterface_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_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_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_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_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_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_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_select_file: - void **select_file** **(** :ref:`String` p_file **)** -.. _class_EditorInterface_set_plugin_enabled: + .. _class_EditorInterface_set_plugin_enabled: - void **set_plugin_enabled** **(** :ref:`String` plugin, :ref:`bool` enabled **)** Sets the enabled status of a plugin. The plugin name is the same as its directory name. - diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index 96fd792f3..4afff643f 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -8,6 +8,7 @@ EditorPlugin ============ **Inherits:** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -121,35 +122,34 @@ Methods Signals ------- -.. _class_EditorPlugin_main_screen_changed: + .. _class_EditorPlugin_main_screen_changed: - **main_screen_changed** **(** :ref:`String` screen_name **)** Emitted when user change main screen view (2D, 3D, Script, AssetLib). Works also with screens which are defined by plugins. -.. _class_EditorPlugin_resource_saved: + .. _class_EditorPlugin_resource_saved: - **resource_saved** **(** :ref:`Resource` resource **)** -.. _class_EditorPlugin_scene_changed: + .. _class_EditorPlugin_scene_changed: - **scene_changed** **(** :ref:`Node` scene_root **)** Emitted when user change scene. The argument is a root node of freshly opened scene. -.. _class_EditorPlugin_scene_closed: + .. _class_EditorPlugin_scene_closed: - **scene_closed** **(** :ref:`String` filepath **)** Emitted when user close scene. The argument is file path to a closed scene. - Enumerations ------------ .. _enum_EditorPlugin_DockSlot: -enum **DockSlot** +enum **DockSlot**: - **DOCK_SLOT_LEFT_UL** = **0** - **DOCK_SLOT_LEFT_BL** = **1** @@ -163,7 +163,7 @@ enum **DockSlot** .. _enum_EditorPlugin_CustomControlContainer: -enum **CustomControlContainer** +enum **CustomControlContainer**: - **CONTAINER_TOOLBAR** = **0** - **CONTAINER_SPATIAL_EDITOR_MENU** = **1** @@ -176,7 +176,6 @@ enum **CustomControlContainer** - **CONTAINER_CANVAS_EDITOR_BOTTOM** = **8** - **CONTAINER_PROPERTY_EDITOR_BOTTOM** = **9** - Description ----------- @@ -186,23 +185,22 @@ Tutorials --------- - :doc:`../development/plugins/index` - Method Descriptions ------------------- -.. _class_EditorPlugin_add_autoload_singleton: + .. _class_EditorPlugin_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_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. If your plugin is being removed, also make sure to remove your control by calling :ref:`remove_control_from_bottom_panel`. -.. _class_EditorPlugin_add_control_to_container: + .. _class_EditorPlugin_add_control_to_container: - void **add_control_to_container** **(** :ref:`CustomControlContainer` container, :ref:`Control` control **)** @@ -212,7 +210,7 @@ Please remember that you have to manage the visibility of your custom controls y If your plugin is being removed, also make sure to remove your custom controls too. -.. _class_EditorPlugin_add_control_to_dock: + .. _class_EditorPlugin_add_control_to_dock: - void **add_control_to_dock** **(** :ref:`DockSlot` slot, :ref:`Control` control **)** @@ -222,7 +220,7 @@ If the dock is repositioned and as long as the plugin is active, the editor will If your plugin is being removed, also make sure to remove your control by calling :ref:`remove_control_from_docks`. -.. _class_EditorPlugin_add_custom_type: + .. _class_EditorPlugin_add_custom_type: - void **add_custom_type** **(** :ref:`String` type, :ref:`String` base, :ref:`Script` script, :ref:`Texture` icon **)** @@ -234,33 +232,33 @@ You can use the :ref:`EditorPlugin.handles` to check 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_add_export_plugin: - void **add_export_plugin** **(** :ref:`EditorExportPlugin` plugin **)** -.. _class_EditorPlugin_add_import_plugin: + .. _class_EditorPlugin_add_import_plugin: - void **add_import_plugin** **(** :ref:`EditorImportPlugin` importer **)** -.. _class_EditorPlugin_add_inspector_plugin: + .. _class_EditorPlugin_add_inspector_plugin: - void **add_inspector_plugin** **(** :ref:`EditorInspectorPlugin` plugin **)** -.. _class_EditorPlugin_add_scene_import_plugin: + .. _class_EditorPlugin_add_scene_import_plugin: - void **add_scene_import_plugin** **(** :ref:`EditorSceneImporter` scene_importer **)** -.. _class_EditorPlugin_add_tool_menu_item: + .. _class_EditorPlugin_add_tool_menu_item: - void **add_tool_menu_item** **(** :ref:`String` name, :ref:`Object` handler, :ref:`String` callback, :ref:`Variant` ud=null **)** Adds 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_add_tool_submenu_item: - void **add_tool_submenu_item** **(** :ref:`String` name, :ref:`Object` submenu **)** -.. _class_EditorPlugin_apply_changes: + .. _class_EditorPlugin_apply_changes: - void **apply_changes** **(** **)** virtual @@ -268,35 +266,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_build: - :ref:`bool` **build** **(** **)** virtual -.. _class_EditorPlugin_clear: + .. _class_EditorPlugin_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_edit: + .. _class_EditorPlugin_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_forward_canvas_gui_input: + .. _class_EditorPlugin_forward_canvas_gui_input: - :ref:`bool` **forward_canvas_gui_input** **(** :ref:`InputEvent` event **)** virtual -.. _class_EditorPlugin_forward_draw_over_viewport: + .. _class_EditorPlugin_forward_draw_over_viewport: - void **forward_draw_over_viewport** **(** :ref:`Control` overlay **)** virtual -.. _class_EditorPlugin_forward_force_draw_over_viewport: + .. _class_EditorPlugin_forward_force_draw_over_viewport: - void **forward_force_draw_over_viewport** **(** :ref:`Control` overlay **)** virtual -.. _class_EditorPlugin_forward_spatial_gui_input: + .. _class_EditorPlugin_forward_spatial_gui_input: - :ref:`bool` **forward_spatial_gui_input** **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** virtual @@ -304,69 +302,69 @@ Implement this function if you are interested in 3D view screen input events. It If you would like to always gets those input events then additionally use :ref:`set_input_forwarding_always_enabled`. -.. _class_EditorPlugin_get_breakpoints: + .. _class_EditorPlugin_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_get_editor_interface: - :ref:`EditorInterface` **get_editor_interface** **(** **)** -.. _class_EditorPlugin_get_plugin_icon: + .. _class_EditorPlugin_get_plugin_icon: - :ref:`Object` **get_plugin_icon** **(** **)** virtual -.. _class_EditorPlugin_get_plugin_name: + .. _class_EditorPlugin_get_plugin_name: - :ref:`String` **get_plugin_name** **(** **)** virtual -.. _class_EditorPlugin_get_script_create_dialog: + .. _class_EditorPlugin_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_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_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_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 the :ref:`EditorPlugin.queue_save_layout` is called or the editor layout was changed(For example changing the position of a dock). -.. _class_EditorPlugin_handles: + .. _class_EditorPlugin_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. -.. _class_EditorPlugin_has_main_screen: + .. _class_EditorPlugin_has_main_screen: - :ref:`bool` **has_main_screen** **(** **)** virtual Return true if this is a main screen editor plugin (it goes in the main screen selector together with 2D, 3D, Script). -.. _class_EditorPlugin_hide_bottom_panel: + .. _class_EditorPlugin_hide_bottom_panel: - void **hide_bottom_panel** **(** **)** -.. _class_EditorPlugin_make_bottom_panel_item_visible: + .. _class_EditorPlugin_make_bottom_panel_item_visible: - void **make_bottom_panel_item_visible** **(** :ref:`Control` item **)** -.. _class_EditorPlugin_make_visible: + .. _class_EditorPlugin_make_visible: - void **make_visible** **(** :ref:`bool` visible **)** virtual @@ -374,94 +372,93 @@ 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_queue_save_layout: - void **queue_save_layout** **(** **)** const Queue save the project's editor layout. -.. _class_EditorPlugin_remove_autoload_singleton: + .. _class_EditorPlugin_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_remove_control_from_bottom_panel: - void **remove_control_from_bottom_panel** **(** :ref:`Control` control **)** Remove the control from the bottom panel. Don't forget to call this if you added one, so the editor can remove it cleanly. -.. _class_EditorPlugin_remove_control_from_container: + .. _class_EditorPlugin_remove_control_from_container: - void **remove_control_from_container** **(** :ref:`CustomControlContainer` container, :ref:`Control` control **)** Remove the control from the specified container. Use it when cleaning up after adding a control with :ref:`add_control_to_container`. Note that you can simply free the control if you won't use it anymore. -.. _class_EditorPlugin_remove_control_from_docks: + .. _class_EditorPlugin_remove_control_from_docks: - void **remove_control_from_docks** **(** :ref:`Control` control **)** Remove the control from the dock. Don't forget to call this if you added one, so the editor can save the layout and remove it cleanly. -.. _class_EditorPlugin_remove_custom_type: + .. _class_EditorPlugin_remove_custom_type: - void **remove_custom_type** **(** :ref:`String` type **)** Remove a custom type added by :ref:`EditorPlugin.add_custom_type` -.. _class_EditorPlugin_remove_export_plugin: + .. _class_EditorPlugin_remove_export_plugin: - void **remove_export_plugin** **(** :ref:`EditorExportPlugin` plugin **)** -.. _class_EditorPlugin_remove_import_plugin: + .. _class_EditorPlugin_remove_import_plugin: - void **remove_import_plugin** **(** :ref:`EditorImportPlugin` importer **)** -.. _class_EditorPlugin_remove_inspector_plugin: + .. _class_EditorPlugin_remove_inspector_plugin: - void **remove_inspector_plugin** **(** :ref:`EditorInspectorPlugin` plugin **)** -.. _class_EditorPlugin_remove_scene_import_plugin: + .. _class_EditorPlugin_remove_scene_import_plugin: - void **remove_scene_import_plugin** **(** :ref:`EditorSceneImporter` scene_importer **)** -.. _class_EditorPlugin_remove_tool_menu_item: + .. _class_EditorPlugin_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_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_set_force_draw_over_forwarding_enabled: - void **set_force_draw_over_forwarding_enabled** **(** **)** -.. _class_EditorPlugin_set_input_event_forwarding_always_enabled: + .. _class_EditorPlugin_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. -.. _class_EditorPlugin_set_state: + .. _class_EditorPlugin_set_state: - void **set_state** **(** :ref:`Dictionary` state **)** virtual Restore the state saved by :ref:`EditorPlugin.get_state`. -.. _class_EditorPlugin_set_window_layout: + .. _class_EditorPlugin_set_window_layout: - void **set_window_layout** **(** :ref:`ConfigFile` layout **)** virtual Restore the plugin GUI layout saved by :ref:`EditorPlugin.get_window_layout`. -.. _class_EditorPlugin_update_overlays: + .. _class_EditorPlugin_update_overlays: - :ref:`int` **update_overlays** **(** **)** const - diff --git a/classes/class_editorproperty.rst b/classes/class_editorproperty.rst index ad9767eb0..aec8d4360 100644 --- a/classes/class_editorproperty.rst +++ b/classes/class_editorproperty.rst @@ -8,6 +8,7 @@ EditorProperty ============== **Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,23 @@ 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` | ++-----------------------------+--------------------------------------------------+ + Methods ------- @@ -31,39 +49,38 @@ Methods Signals ------- -.. _class_EditorProperty_multiple_properties_changed: + .. _class_EditorProperty_multiple_properties_changed: - **multiple_properties_changed** **(** :ref:`PoolStringArray` properties, :ref:`Array` value **)** -.. _class_EditorProperty_object_id_selected: + .. _class_EditorProperty_object_id_selected: - **object_id_selected** **(** :ref:`String` property, :ref:`int` id **)** -.. _class_EditorProperty_property_changed: + .. _class_EditorProperty_property_changed: - **property_changed** **(** :ref:`String` property, :ref:`Nil` value **)** -.. _class_EditorProperty_property_checked: + .. _class_EditorProperty_property_checked: - **property_checked** **(** :ref:`String` property, :ref:`String` bool **)** -.. _class_EditorProperty_property_keyed: + .. _class_EditorProperty_property_keyed: - **property_keyed** **(** :ref:`String` property **)** -.. _class_EditorProperty_property_keyed_with_value: + .. _class_EditorProperty_property_keyed_with_value: - **property_keyed_with_value** **(** :ref:`String` property, :ref:`Nil` value **)** -.. _class_EditorProperty_resource_selected: + .. _class_EditorProperty_resource_selected: - **resource_selected** **(** :ref:`String` path, :ref:`Resource` resource **)** -.. _class_EditorProperty_selected: + .. _class_EditorProperty_selected: - **selected** **(** :ref:`String` path, :ref:`int` focusable_idx **)** - Property Descriptions --------------------- @@ -71,44 +88,78 @@ Property Descriptions - :ref:`bool` **checkable** ++----------+----------------------+ +| *Setter* | set_checkable(value) | ++----------+----------------------+ +| *Getter* | is_checkable() | ++----------+----------------------+ + .. _class_EditorProperty_checked: - :ref:`bool` **checked** ++----------+--------------------+ +| *Setter* | set_checked(value) | ++----------+--------------------+ +| *Getter* | is_checked() | ++----------+--------------------+ + .. _class_EditorProperty_draw_red: - :ref:`bool` **draw_red** ++----------+---------------------+ +| *Setter* | set_draw_red(value) | ++----------+---------------------+ +| *Getter* | is_draw_red() | ++----------+---------------------+ + .. _class_EditorProperty_keying: - :ref:`bool` **keying** ++----------+-------------------+ +| *Setter* | set_keying(value) | ++----------+-------------------+ +| *Getter* | is_keying() | ++----------+-------------------+ + .. _class_EditorProperty_label: - :ref:`String` **label** ++----------+------------------+ +| *Setter* | set_label(value) | ++----------+------------------+ +| *Getter* | get_label() | ++----------+------------------+ + .. _class_EditorProperty_read_only: - :ref:`bool` **read_only** ++----------+----------------------+ +| *Setter* | set_read_only(value) | ++----------+----------------------+ +| *Getter* | is_read_only() | ++----------+----------------------+ Method Descriptions ------------------- -.. _class_EditorProperty_get_edited_object: + .. _class_EditorProperty_get_edited_object: - :ref:`Object` **get_edited_object** **(** **)** -.. _class_EditorProperty_get_edited_property: + .. _class_EditorProperty_get_edited_property: - :ref:`String` **get_edited_property** **(** **)** -.. _class_EditorProperty_get_tooltip_text: + .. _class_EditorProperty_get_tooltip_text: - :ref:`String` **get_tooltip_text** **(** **)** const -.. _class_EditorProperty_update_property: + .. _class_EditorProperty_update_property: - void **update_property** **(** **)** virtual - diff --git a/classes/class_editorresourceconversionplugin.rst b/classes/class_editorresourceconversionplugin.rst index 64b09e647..1897d8ef0 100644 --- a/classes/class_editorresourceconversionplugin.rst +++ b/classes/class_editorresourceconversionplugin.rst @@ -8,6 +8,7 @@ EditorResourceConversionPlugin ============================== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -27,12 +28,11 @@ Methods Method Descriptions ------------------- -.. _class_EditorResourceConversionPlugin__convert: + .. _class_EditorResourceConversionPlugin__convert: - :ref:`Resource` **_convert** **(** :ref:`Resource` resource **)** virtual -.. _class_EditorResourceConversionPlugin__converts_to: + .. _class_EditorResourceConversionPlugin__converts_to: - :ref:`String` **_converts_to** **(** **)** virtual - diff --git a/classes/class_editorresourcepreview.rst b/classes/class_editorresourcepreview.rst index 57b437db1..f021f62a2 100644 --- a/classes/class_editorresourcepreview.rst +++ b/classes/class_editorresourcepreview.rst @@ -8,6 +8,7 @@ EditorResourcePreview ===================== **Inherits:** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -33,13 +34,12 @@ Methods Signals ------- -.. _class_EditorResourcePreview_preview_invalidated: + .. _class_EditorResourcePreview_preview_invalidated: - **preview_invalidated** **(** :ref:`String` path **)** If a preview was invalidated (changed) this signal will emit (using the path of the preview) - Description ----------- @@ -48,34 +48,33 @@ This object is used to generate previews for resources of files. Method Descriptions ------------------- -.. _class_EditorResourcePreview_add_preview_generator: + .. _class_EditorResourcePreview_add_preview_generator: - void **add_preview_generator** **(** :ref:`EditorResourcePreviewGenerator` generator **)** Create an own, custom preview generator. -.. _class_EditorResourcePreview_check_for_invalidation: + .. _class_EditorResourcePreview_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_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_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_remove_preview_generator: - void **remove_preview_generator** **(** :ref:`EditorResourcePreviewGenerator` generator **)** Remove a custom preview generator. - diff --git a/classes/class_editorresourcepreviewgenerator.rst b/classes/class_editorresourcepreviewgenerator.rst index 26a1aef56..5c9627c0d 100644 --- a/classes/class_editorresourcepreviewgenerator.rst +++ b/classes/class_editorresourcepreviewgenerator.rst @@ -8,6 +8,7 @@ EditorResourcePreviewGenerator ============================== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -34,7 +35,7 @@ Custom code to generate previews. Please check "file_dialog/thumbnail_size" in E Method Descriptions ------------------- -.. _class_EditorResourcePreviewGenerator_generate: + .. _class_EditorResourcePreviewGenerator_generate: - :ref:`Texture` **generate** **(** :ref:`Resource` from **)** virtual @@ -44,7 +45,7 @@ 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_generate_from_path: - :ref:`Texture` **generate_from_path** **(** :ref:`String` path **)** virtual @@ -54,10 +55,9 @@ 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_handles: + .. _class_EditorResourcePreviewGenerator_handles: - :ref:`bool` **handles** **(** :ref:`String` type **)** virtual Return if your generator supports this resource type. - diff --git a/classes/class_editorsceneimporter.rst b/classes/class_editorsceneimporter.rst index 4681df058..9adb3ef26 100644 --- a/classes/class_editorsceneimporter.rst +++ b/classes/class_editorsceneimporter.rst @@ -8,6 +8,7 @@ EditorSceneImporter =================== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -45,32 +46,30 @@ Constants - **IMPORT_FAIL_ON_MISSING_DEPENDENCIES** = **512** - **IMPORT_MATERIALS_IN_INSTANCES** = **1024** - **IMPORT_USE_COMPRESSION** = **2048** - Method Descriptions ------------------- -.. _class_EditorSceneImporter__get_extensions: + .. _class_EditorSceneImporter__get_extensions: - :ref:`Array` **_get_extensions** **(** **)** virtual -.. _class_EditorSceneImporter__get_import_flags: + .. _class_EditorSceneImporter__get_import_flags: - :ref:`int` **_get_import_flags** **(** **)** virtual -.. _class_EditorSceneImporter__import_animation: + .. _class_EditorSceneImporter__import_animation: - :ref:`Animation` **_import_animation** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** virtual -.. _class_EditorSceneImporter__import_scene: + .. _class_EditorSceneImporter__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_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_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 710e1af15..bf9974302 100644 --- a/classes/class_editorscenepostimport.rst +++ b/classes/class_editorscenepostimport.rst @@ -8,6 +8,7 @@ EditorScenePostImport ===================== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -35,26 +36,24 @@ Tutorials --------- - `http://docs.godotengine.org/en/latest/learning/workflow/assets/importing_scenes.html?highlight=post%20import `_ - Method Descriptions ------------------- -.. _class_EditorScenePostImport_get_source_file: + .. _class_EditorScenePostImport_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_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_post_import: - :ref:`Object` **post_import** **(** :ref:`Object` scene **)** virtual Gets called after the scene got imported and has to return the modified version of the scene - diff --git a/classes/class_editorscript.rst b/classes/class_editorscript.rst index 7041b5a29..b0f613e8b 100644 --- a/classes/class_editorscript.rst +++ b/classes/class_editorscript.rst @@ -8,6 +8,7 @@ EditorScript ============ **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -48,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__run: - void **_run** **(** **)** virtual This method is executed by the Editor when ``File -> Run`` is used. -.. _class_EditorScript_add_root_node: + .. _class_EditorScript_add_root_node: - void **add_root_node** **(** :ref:`Node` node **)** @@ -62,16 +63,15 @@ 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_get_editor_interface: - :ref:`EditorInterface` **get_editor_interface** **(** **)** Returns the :ref:`EditorInterface` singleton instance. -.. _class_EditorScript_get_scene: + .. _class_EditorScript_get_scene: - :ref:`Node` **get_scene** **(** **)** Returns the Editor's currently active scene. - diff --git a/classes/class_editorselection.rst b/classes/class_editorselection.rst index f6d4099a3..38d045ebe 100644 --- a/classes/class_editorselection.rst +++ b/classes/class_editorselection.rst @@ -8,6 +8,7 @@ EditorSelection =============== **Inherits:** :ref:`Object` + **Category:** Core Brief Description @@ -33,13 +34,12 @@ Methods Signals ------- -.. _class_EditorSelection_selection_changed: + .. _class_EditorSelection_selection_changed: - **selection_changed** **(** **)** Emitted when the selection changes. - Description ----------- @@ -48,34 +48,33 @@ This object manages the SceneTree selection in the editor. Method Descriptions ------------------- -.. _class_EditorSelection_add_node: + .. _class_EditorSelection_add_node: - void **add_node** **(** :ref:`Node` node **)** Add a node to the selection. -.. _class_EditorSelection_clear: + .. _class_EditorSelection_clear: - void **clear** **(** **)** Clear the selection. -.. _class_EditorSelection_get_selected_nodes: + .. _class_EditorSelection_get_selected_nodes: - :ref:`Array` **get_selected_nodes** **(** **)** Get the list of selected nodes. -.. _class_EditorSelection_get_transformable_selected_nodes: + .. _class_EditorSelection_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_remove_node: - void **remove_node** **(** :ref:`Node` node **)** Remove a node from the selection. - diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index f5df32f7b..573d4f5fc 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -8,6 +8,7 @@ EditorSettings ============== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -55,11 +56,10 @@ Methods Signals ------- -.. _class_EditorSettings_settings_changed: + .. _class_EditorSettings_settings_changed: - **settings_changed** **(** **)** - Description ----------- @@ -76,7 +76,7 @@ Accessing the settings is done by using the regular :ref:`Object` Method Descriptions ------------------- -.. _class_EditorSettings_add_property_info: + .. _class_EditorSettings_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_erase: - void **erase** **(** :ref:`String` property **)** Erase a given setting (pass full property path). -.. _class_EditorSettings_get_favorite_dirs: + .. _class_EditorSettings_get_favorite_dirs: - :ref:`PoolStringArray` **get_favorite_dirs** **(** **)** const Get the list of favorite directories for this project. -.. _class_EditorSettings_get_project_metadata: + .. _class_EditorSettings_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_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_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_get_setting: - :ref:`Variant` **get_setting** **(** :ref:`String` name **)** const -.. _class_EditorSettings_get_settings_dir: + .. _class_EditorSettings_get_settings_dir: - :ref:`String` **get_settings_dir** **(** **)** const @@ -139,40 +139,39 @@ settings/tmp - used for temporary storage of files settings/templates - where export templates are located -.. _class_EditorSettings_has_setting: + .. _class_EditorSettings_has_setting: - :ref:`bool` **has_setting** **(** :ref:`String` name **)** const -.. _class_EditorSettings_property_can_revert: + .. _class_EditorSettings_property_can_revert: - :ref:`bool` **property_can_revert** **(** :ref:`String` name **)** -.. _class_EditorSettings_property_get_revert: + .. _class_EditorSettings_property_get_revert: - :ref:`Variant` **property_get_revert** **(** :ref:`String` name **)** -.. _class_EditorSettings_set_favorite_dirs: + .. _class_EditorSettings_set_favorite_dirs: - void **set_favorite_dirs** **(** :ref:`PoolStringArray` dirs **)** Set the list of favorite directories for this project. -.. _class_EditorSettings_set_initial_value: + .. _class_EditorSettings_set_initial_value: - void **set_initial_value** **(** :ref:`String` name, :ref:`Variant` value, :ref:`bool` update_current **)** -.. _class_EditorSettings_set_project_metadata: + .. _class_EditorSettings_set_project_metadata: - void **set_project_metadata** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` data **)** -.. _class_EditorSettings_set_recent_dirs: + .. _class_EditorSettings_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_set_setting: - void **set_setting** **(** :ref:`String` name, :ref:`Variant` value **)** - diff --git a/classes/class_editorspatialgizmo.rst b/classes/class_editorspatialgizmo.rst index f611f3cef..a1f702b46 100644 --- a/classes/class_editorspatialgizmo.rst +++ b/classes/class_editorspatialgizmo.rst @@ -8,6 +8,7 @@ EditorSpatialGizmo ================== **Inherits:** :ref:`SpatialGizmo` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -56,17 +57,17 @@ Custom gizmo that is used for providing custom visualization and editing (handle Method Descriptions ------------------- -.. _class_EditorSpatialGizmo_add_collision_segments: + .. _class_EditorSpatialGizmo_add_collision_segments: - void **add_collision_segments** **(** :ref:`PoolVector3Array` segments **)** -.. _class_EditorSpatialGizmo_add_collision_triangles: + .. _class_EditorSpatialGizmo_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`. -.. _class_EditorSpatialGizmo_add_handles: + .. _class_EditorSpatialGizmo_add_handles: - void **add_handles** **(** :ref:`PoolVector3Array` handles, :ref:`Material` material, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** @@ -74,27 +75,27 @@ Add a list of handles (points) which can be used to deform the object being edit 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_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`. -.. _class_EditorSpatialGizmo_add_mesh: + .. _class_EditorSpatialGizmo_add_mesh: - void **add_mesh** **(** :ref:`ArrayMesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton **)** -.. _class_EditorSpatialGizmo_add_unscaled_billboard: + .. _class_EditorSpatialGizmo_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`. -.. _class_EditorSpatialGizmo_clear: + .. _class_EditorSpatialGizmo_clear: - void **clear** **(** **)** -.. _class_EditorSpatialGizmo_commit_handle: + .. _class_EditorSpatialGizmo_commit_handle: - void **commit_handle** **(** :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** virtual @@ -102,7 +103,7 @@ Commit a handle being edited (handles must have been previously added by :ref:`a 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_get_handle_name: - :ref:`String` **get_handle_name** **(** :ref:`int` index **)** virtual @@ -110,19 +111,19 @@ Get the name of an edited handle (handles must have been previously added by :re Handles can be named for reference to the user when editing. -.. _class_EditorSpatialGizmo_get_handle_value: + .. _class_EditorSpatialGizmo_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` -.. _class_EditorSpatialGizmo_redraw: + .. _class_EditorSpatialGizmo_redraw: - void **redraw** **(** **)** virtual 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_set_handle: - void **set_handle** **(** :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual @@ -130,12 +131,11 @@ This function is used when the user drags a gizmo handle (previously added with The :ref:`Camera` is also provided so screen coordinates can be converted to raycasts. -.. _class_EditorSpatialGizmo_set_hidden: + .. _class_EditorSpatialGizmo_set_hidden: - void **set_hidden** **(** :ref:`bool` hidden **)** -.. _class_EditorSpatialGizmo_set_spatial_node: + .. _class_EditorSpatialGizmo_set_spatial_node: - void **set_spatial_node** **(** :ref:`Node` node **)** - diff --git a/classes/class_encodedobjectasid.rst b/classes/class_encodedobjectasid.rst index 18e0c71c9..b0921bd71 100644 --- a/classes/class_encodedobjectasid.rst +++ b/classes/class_encodedobjectasid.rst @@ -8,6 +8,7 @@ EncodedObjectAsID ================= **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -27,12 +28,11 @@ Methods Method Descriptions ------------------- -.. _class_EncodedObjectAsID_get_object_id: + .. _class_EncodedObjectAsID_get_object_id: - :ref:`int` **get_object_id** **(** **)** const -.. _class_EncodedObjectAsID_set_object_id: + .. _class_EncodedObjectAsID_set_object_id: - void **set_object_id** **(** :ref:`int` id **)** - diff --git a/classes/class_engine.rst b/classes/class_engine.rst index 3e95a2466..8cd1c84bf 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -8,6 +8,7 @@ Engine ====== **Inherits:** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,21 @@ Brief Description 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` | ++---------------------------+------------------------------------------------------------------+ + Methods ------- @@ -54,29 +70,66 @@ Property Descriptions .. _class_Engine_editor_hint: -- :ref:`bool` **editor_hint** - If ``true``, it is running inside the editor. Useful for tool scripts. +- :ref:`bool` **editor_hint** + ++----------+------------------------+ +| *Setter* | set_editor_hint(value) | ++----------+------------------------+ +| *Getter* | is_editor_hint() | ++----------+------------------------+ + +If ``true``, it is running inside the editor. Useful for tool scripts. .. _class_Engine_iterations_per_second: -- :ref:`int` **iterations_per_second** - The number of fixed iterations per second (for fixed process and physics). +- :ref:`int` **iterations_per_second** + ++----------+----------------------------------+ +| *Setter* | set_iterations_per_second(value) | ++----------+----------------------------------+ +| *Getter* | get_iterations_per_second() | ++----------+----------------------------------+ + +The number of fixed iterations per second (for fixed process and physics). .. _class_Engine_physics_jitter_fix: - :ref:`float` **physics_jitter_fix** ++----------+-------------------------------+ +| *Setter* | set_physics_jitter_fix(value) | ++----------+-------------------------------+ +| *Getter* | get_physics_jitter_fix() | ++----------+-------------------------------+ + .. _class_Engine_target_fps: -- :ref:`int` **target_fps** - The desired frames per second. If the hardware cannot keep up, this setting may not be respected. Defaults to 0, which indicates no limit. +- :ref:`int` **target_fps** + ++----------+-----------------------+ +| *Setter* | set_target_fps(value) | ++----------+-----------------------+ +| *Getter* | get_target_fps() | ++----------+-----------------------+ + +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: -- :ref:`float` **time_scale** - Controls how fast or slow the in-game clock ticks versus the real life one. It defaults to 1.0. A value of 2.0 means the game moves twice as fast as real life, whilst a value of 0.5 means the game moves at half the regular speed. +- :ref:`float` **time_scale** ++----------+-----------------------+ +| *Setter* | set_time_scale(value) | ++----------+-----------------------+ +| *Getter* | get_time_scale() | ++----------+-----------------------+ + +Controls how fast or slow the in-game clock ticks versus the real life one. It defaults to 1.0. A value of 2.0 means the game moves twice as fast as real life, whilst a value of 0.5 means the game moves at half the regular speed. Method Descriptions ------------------- -.. _class_Engine_get_author_info: + .. _class_Engine_get_author_info: - :ref:`Dictionary` **get_author_info** **(** **)** const @@ -90,7 +143,7 @@ Returns engine author information in a Dictionary. "developers" - Array of Strings, developer names -.. _class_Engine_get_copyright_info: + .. _class_Engine_get_copyright_info: - :ref:`Array` **get_copyright_info** **(** **)** const @@ -100,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_get_donor_info: - :ref:`Dictionary` **get_donor_info** **(** **)** const @@ -108,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_get_frames_drawn: - :ref:`int` **get_frames_drawn** **(** **)** Returns the total number of frames drawn. -.. _class_Engine_get_frames_per_second: + .. _class_Engine_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_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_get_license_text: - :ref:`String` **get_license_text** **(** **)** const Returns Godot license text. -.. _class_Engine_get_main_loop: + .. _class_Engine_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_get_singleton: - :ref:`Object` **get_singleton** **(** :ref:`String` name **)** const -.. _class_Engine_get_version_info: + .. _class_Engine_get_version_info: - :ref:`Dictionary` **get_version_info** **(** **)** const @@ -160,14 +213,13 @@ 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_has_singleton: - :ref:`bool` **has_singleton** **(** :ref:`String` name **)** const -.. _class_Engine_is_in_physics_frame: + .. _class_Engine_is_in_physics_frame: - :ref:`bool` **is_in_physics_frame** **(** **)** const Returns ``true`` if the game is inside the fixed process and physics phase of the game loop. - diff --git a/classes/class_environment.rst b/classes/class_environment.rst index 646e764d7..bf7795966 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -8,6 +8,7 @@ Environment =========== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,12 +16,173 @@ Brief Description Resource for environment nodes (like :ref:`WorldEnvironment`) that define multiple rendering options. +Properties +---------- + ++--------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| :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:`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:`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_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: -enum **BGMode** +enum **BGMode**: - **BG_KEEP** = **5** --- Keep on screen every pixel drawn in the background. - **BG_CLEAR_COLOR** = **0** --- Clear the background using the project's clear color. @@ -32,7 +194,7 @@ enum **BGMode** .. _enum_Environment_DOFBlurQuality: -enum **DOFBlurQuality** +enum **DOFBlurQuality**: - **DOF_BLUR_QUALITY_LOW** = **0** --- Low depth-of-field blur quality. - **DOF_BLUR_QUALITY_MEDIUM** = **1** --- Medium depth-of-field blur quality. @@ -40,7 +202,7 @@ enum **DOFBlurQuality** .. _enum_Environment_GlowBlendMode: -enum **GlowBlendMode** +enum **GlowBlendMode**: - **GLOW_BLEND_MODE_ADDITIVE** = **0** --- Additive glow blending mode. Mostly used for particles, glows (bloom), lens flare, bright sources. - **GLOW_BLEND_MODE_SCREEN** = **1** --- Screen glow blending mode. Increases brightness, used frequently with bloom. @@ -49,7 +211,7 @@ enum **GlowBlendMode** .. _enum_Environment_ToneMapper: -enum **ToneMapper** +enum **ToneMapper**: - **TONE_MAPPER_LINEAR** = **0** --- Linear tonemapper operator. Reads the linear data and performs an exposure adjustment. - **TONE_MAPPER_REINHARDT** = **1** --- Reinhardt tonemapper operator. Performs a variation on rendered pixels' colors by this formula: color = color / (1 + color). @@ -58,7 +220,7 @@ enum **ToneMapper** .. _enum_Environment_SSAOBlur: -enum **SSAOBlur** +enum **SSAOBlur**: - **SSAO_BLUR_DISABLED** = **0** - **SSAO_BLUR_1x1** = **1** @@ -67,13 +229,12 @@ enum **SSAOBlur** .. _enum_Environment_SSAOQuality: -enum **SSAOQuality** +enum **SSAOQuality**: - **SSAO_QUALITY_LOW** = **0** - **SSAO_QUALITY_MEDIUM** = **1** - **SSAO_QUALITY_HIGH** = **2** - Description ----------- @@ -96,320 +257,904 @@ Tutorials - :doc:`../tutorials/3d/environment_and_post_processing` - :doc:`../tutorials/3d/high_dynamic_range` - Property Descriptions --------------------- .. _class_Environment_adjustment_brightness: -- :ref:`float` **adjustment_brightness** - Global brightness value of the rendered scene (default value is 1). +- :ref:`float` **adjustment_brightness** + ++----------+----------------------------------+ +| *Setter* | set_adjustment_brightness(value) | ++----------+----------------------------------+ +| *Getter* | get_adjustment_brightness() | ++----------+----------------------------------+ + +Global brightness value of the rendered scene (default value is 1). .. _class_Environment_adjustment_color_correction: -- :ref:`Texture` **adjustment_color_correction** - Applies the provided :ref:`Texture` resource to affect the global color aspect of the rendered scene. +- :ref:`Texture` **adjustment_color_correction** + ++----------+----------------------------------------+ +| *Setter* | set_adjustment_color_correction(value) | ++----------+----------------------------------------+ +| *Getter* | get_adjustment_color_correction() | ++----------+----------------------------------------+ + +Applies the provided :ref:`Texture` resource to affect the global color aspect of the rendered scene. .. _class_Environment_adjustment_contrast: -- :ref:`float` **adjustment_contrast** - Global contrast value of the rendered scene (default value is 1). +- :ref:`float` **adjustment_contrast** + ++----------+--------------------------------+ +| *Setter* | set_adjustment_contrast(value) | ++----------+--------------------------------+ +| *Getter* | get_adjustment_contrast() | ++----------+--------------------------------+ + +Global contrast value of the rendered scene (default value is 1). .. _class_Environment_adjustment_enabled: -- :ref:`bool` **adjustment_enabled** - Enables the adjustment\_\* options provided by this resource. If false, adjustments modifications will have no effect on the rendered scene. +- :ref:`bool` **adjustment_enabled** + ++----------+------------------------------+ +| *Setter* | set_adjustment_enable(value) | ++----------+------------------------------+ +| *Getter* | is_adjustment_enabled() | ++----------+------------------------------+ + +Enables the adjustment\_\* options provided by this resource. If false, adjustments modifications will have no effect on the rendered scene. .. _class_Environment_adjustment_saturation: -- :ref:`float` **adjustment_saturation** - Global color saturation value of the rendered scene (default value is 1). +- :ref:`float` **adjustment_saturation** + ++----------+----------------------------------+ +| *Setter* | set_adjustment_saturation(value) | ++----------+----------------------------------+ +| *Getter* | get_adjustment_saturation() | ++----------+----------------------------------+ + +Global color saturation value of the rendered scene (default value is 1). .. _class_Environment_ambient_light_color: -- :ref:`Color` **ambient_light_color** - :ref:`Color` of the ambient light. +- :ref:`Color` **ambient_light_color** + ++----------+--------------------------------+ +| *Setter* | set_ambient_light_color(value) | ++----------+--------------------------------+ +| *Getter* | get_ambient_light_color() | ++----------+--------------------------------+ + +:ref:`Color` of the ambient light. .. _class_Environment_ambient_light_energy: -- :ref:`float` **ambient_light_energy** - Energy of the ambient light. The higher the value, the stronger the light. +- :ref:`float` **ambient_light_energy** + ++----------+---------------------------------+ +| *Setter* | set_ambient_light_energy(value) | ++----------+---------------------------------+ +| *Getter* | get_ambient_light_energy() | ++----------+---------------------------------+ + +Energy of the ambient light. The higher the value, the stronger the light. .. _class_Environment_ambient_light_sky_contribution: -- :ref:`float` **ambient_light_sky_contribution** - 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. +- :ref:`float` **ambient_light_sky_contribution** + ++----------+-------------------------------------------+ +| *Setter* | set_ambient_light_sky_contribution(value) | ++----------+-------------------------------------------+ +| *Getter* | get_ambient_light_sky_contribution() | ++----------+-------------------------------------------+ + +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: -- :ref:`bool` **auto_exposure_enabled** - 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. +- :ref:`bool` **auto_exposure_enabled** + ++----------+----------------------------------+ +| *Setter* | set_tonemap_auto_exposure(value) | ++----------+----------------------------------+ +| *Getter* | get_tonemap_auto_exposure() | ++----------+----------------------------------+ + +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: -- :ref:`float` **auto_exposure_max_luma** - Maximum luminance value for the auto exposure. +- :ref:`float` **auto_exposure_max_luma** + ++----------+--------------------------------------+ +| *Setter* | set_tonemap_auto_exposure_max(value) | ++----------+--------------------------------------+ +| *Getter* | get_tonemap_auto_exposure_max() | ++----------+--------------------------------------+ + +Maximum luminance value for the auto exposure. .. _class_Environment_auto_exposure_min_luma: -- :ref:`float` **auto_exposure_min_luma** - Minimum luminance value for the auto exposure. +- :ref:`float` **auto_exposure_min_luma** + ++----------+--------------------------------------+ +| *Setter* | set_tonemap_auto_exposure_min(value) | ++----------+--------------------------------------+ +| *Getter* | get_tonemap_auto_exposure_min() | ++----------+--------------------------------------+ + +Minimum luminance value for the auto exposure. .. _class_Environment_auto_exposure_scale: -- :ref:`float` **auto_exposure_scale** - Scale of the auto exposure effect. Affects the intensity of auto exposure. +- :ref:`float` **auto_exposure_scale** + ++----------+---------------------------------------+ +| *Setter* | set_tonemap_auto_exposure_grey(value) | ++----------+---------------------------------------+ +| *Getter* | get_tonemap_auto_exposure_grey() | ++----------+---------------------------------------+ + +Scale of the auto exposure effect. Affects the intensity of auto exposure. .. _class_Environment_auto_exposure_speed: -- :ref:`float` **auto_exposure_speed** - Speed of the auto exposure effect. Affects the time needed for the camera to perform auto exposure. +- :ref:`float` **auto_exposure_speed** + ++----------+----------------------------------------+ +| *Setter* | set_tonemap_auto_exposure_speed(value) | ++----------+----------------------------------------+ +| *Getter* | get_tonemap_auto_exposure_speed() | ++----------+----------------------------------------+ + +Speed of the auto exposure effect. Affects the time needed for the camera to perform auto exposure. .. _class_Environment_background_canvas_max_layer: -- :ref:`int` **background_canvas_max_layer** - Maximum layer id (if using Layer background mode). +- :ref:`int` **background_canvas_max_layer** + ++----------+-----------------------------+ +| *Setter* | set_canvas_max_layer(value) | ++----------+-----------------------------+ +| *Getter* | get_canvas_max_layer() | ++----------+-----------------------------+ + +Maximum layer id (if using Layer background mode). .. _class_Environment_background_color: -- :ref:`Color` **background_color** - Color displayed for clear areas of the scene (if using Custom color or Color+Sky background modes). +- :ref:`Color` **background_color** + ++----------+---------------------+ +| *Setter* | set_bg_color(value) | ++----------+---------------------+ +| *Getter* | get_bg_color() | ++----------+---------------------+ + +Color displayed for clear areas of the scene (if using Custom color or Color+Sky background modes). .. _class_Environment_background_energy: -- :ref:`float` **background_energy** - Power of light emitted by the background. +- :ref:`float` **background_energy** + ++----------+----------------------+ +| *Setter* | set_bg_energy(value) | ++----------+----------------------+ +| *Getter* | get_bg_energy() | ++----------+----------------------+ + +Power of light emitted by the background. .. _class_Environment_background_mode: -- :ref:`BGMode` **background_mode** - Defines the mode of background. +- :ref:`BGMode` **background_mode** + ++----------+-----------------------+ +| *Setter* | set_background(value) | ++----------+-----------------------+ +| *Getter* | get_background() | ++----------+-----------------------+ + +Defines the mode of background. .. _class_Environment_background_sky: -- :ref:`Sky` **background_sky** - :ref:`Sky` resource defined as background. +- :ref:`Sky` **background_sky** + ++----------+----------------+ +| *Setter* | set_sky(value) | ++----------+----------------+ +| *Getter* | get_sky() | ++----------+----------------+ + +:ref:`Sky` resource defined as background. .. _class_Environment_background_sky_custom_fov: -- :ref:`float` **background_sky_custom_fov** - :ref:`Sky` resource's custom field of view. +- :ref:`float` **background_sky_custom_fov** + ++----------+---------------------------+ +| *Setter* | set_sky_custom_fov(value) | ++----------+---------------------------+ +| *Getter* | get_sky_custom_fov() | ++----------+---------------------------+ + +:ref:`Sky` resource's custom field of view. .. _class_Environment_dof_blur_far_amount: -- :ref:`float` **dof_blur_far_amount** - Amount of far blur. +- :ref:`float` **dof_blur_far_amount** + ++----------+--------------------------------+ +| *Setter* | set_dof_blur_far_amount(value) | ++----------+--------------------------------+ +| *Getter* | get_dof_blur_far_amount() | ++----------+--------------------------------+ + +Amount of far blur. .. _class_Environment_dof_blur_far_distance: -- :ref:`float` **dof_blur_far_distance** - Distance from the camera where the far blur effect affects the rendering. +- :ref:`float` **dof_blur_far_distance** + ++----------+----------------------------------+ +| *Setter* | set_dof_blur_far_distance(value) | ++----------+----------------------------------+ +| *Getter* | get_dof_blur_far_distance() | ++----------+----------------------------------+ + +Distance from the camera where the far blur effect affects the rendering. .. _class_Environment_dof_blur_far_enabled: -- :ref:`bool` **dof_blur_far_enabled** - Enables the far blur effect. +- :ref:`bool` **dof_blur_far_enabled** + ++----------+---------------------------------+ +| *Setter* | set_dof_blur_far_enabled(value) | ++----------+---------------------------------+ +| *Getter* | is_dof_blur_far_enabled() | ++----------+---------------------------------+ + +Enables the far blur effect. .. _class_Environment_dof_blur_far_quality: -- :ref:`DOFBlurQuality` **dof_blur_far_quality** - Quality of the far blur quality. +- :ref:`DOFBlurQuality` **dof_blur_far_quality** + ++----------+---------------------------------+ +| *Setter* | set_dof_blur_far_quality(value) | ++----------+---------------------------------+ +| *Getter* | get_dof_blur_far_quality() | ++----------+---------------------------------+ + +Quality of the far blur quality. .. _class_Environment_dof_blur_far_transition: -- :ref:`float` **dof_blur_far_transition** - Transition between no-blur area and far blur. +- :ref:`float` **dof_blur_far_transition** + ++----------+------------------------------------+ +| *Setter* | set_dof_blur_far_transition(value) | ++----------+------------------------------------+ +| *Getter* | get_dof_blur_far_transition() | ++----------+------------------------------------+ + +Transition between no-blur area and far blur. .. _class_Environment_dof_blur_near_amount: -- :ref:`float` **dof_blur_near_amount** - Amount of near blur. +- :ref:`float` **dof_blur_near_amount** + ++----------+---------------------------------+ +| *Setter* | set_dof_blur_near_amount(value) | ++----------+---------------------------------+ +| *Getter* | get_dof_blur_near_amount() | ++----------+---------------------------------+ + +Amount of near blur. .. _class_Environment_dof_blur_near_distance: -- :ref:`float` **dof_blur_near_distance** - Distance from the camera where the near blur effect affects the rendering. +- :ref:`float` **dof_blur_near_distance** + ++----------+-----------------------------------+ +| *Setter* | set_dof_blur_near_distance(value) | ++----------+-----------------------------------+ +| *Getter* | get_dof_blur_near_distance() | ++----------+-----------------------------------+ + +Distance from the camera where the near blur effect affects the rendering. .. _class_Environment_dof_blur_near_enabled: -- :ref:`bool` **dof_blur_near_enabled** - Enables the near blur effect. +- :ref:`bool` **dof_blur_near_enabled** + ++----------+----------------------------------+ +| *Setter* | set_dof_blur_near_enabled(value) | ++----------+----------------------------------+ +| *Getter* | is_dof_blur_near_enabled() | ++----------+----------------------------------+ + +Enables the near blur effect. .. _class_Environment_dof_blur_near_quality: -- :ref:`DOFBlurQuality` **dof_blur_near_quality** - Quality of the near blur quality. +- :ref:`DOFBlurQuality` **dof_blur_near_quality** + ++----------+----------------------------------+ +| *Setter* | set_dof_blur_near_quality(value) | ++----------+----------------------------------+ +| *Getter* | get_dof_blur_near_quality() | ++----------+----------------------------------+ + +Quality of the near blur quality. .. _class_Environment_dof_blur_near_transition: -- :ref:`float` **dof_blur_near_transition** - Transition between near blur and no-blur area. +- :ref:`float` **dof_blur_near_transition** + ++----------+-------------------------------------+ +| *Setter* | set_dof_blur_near_transition(value) | ++----------+-------------------------------------+ +| *Getter* | get_dof_blur_near_transition() | ++----------+-------------------------------------+ + +Transition between near blur and no-blur area. .. _class_Environment_fog_color: -- :ref:`Color` **fog_color** - Fog's :ref:`Color`. +- :ref:`Color` **fog_color** + ++----------+----------------------+ +| *Setter* | set_fog_color(value) | ++----------+----------------------+ +| *Getter* | get_fog_color() | ++----------+----------------------+ + +Fog's :ref:`Color`. .. _class_Environment_fog_depth_begin: -- :ref:`float` **fog_depth_begin** - Fog's depth starting distance from the camera. +- :ref:`float` **fog_depth_begin** + ++----------+----------------------------+ +| *Setter* | set_fog_depth_begin(value) | ++----------+----------------------------+ +| *Getter* | get_fog_depth_begin() | ++----------+----------------------------+ + +Fog's depth starting distance from the camera. .. _class_Environment_fog_depth_curve: -- :ref:`float` **fog_depth_curve** - Value defining the fog depth intensity. +- :ref:`float` **fog_depth_curve** + ++----------+----------------------------+ +| *Setter* | set_fog_depth_curve(value) | ++----------+----------------------------+ +| *Getter* | get_fog_depth_curve() | ++----------+----------------------------+ + +Value defining the fog depth intensity. .. _class_Environment_fog_depth_enabled: -- :ref:`bool` **fog_depth_enabled** - Enables the fog depth. +- :ref:`bool` **fog_depth_enabled** + ++----------+------------------------------+ +| *Setter* | set_fog_depth_enabled(value) | ++----------+------------------------------+ +| *Getter* | is_fog_depth_enabled() | ++----------+------------------------------+ + +Enables the fog depth. .. _class_Environment_fog_enabled: -- :ref:`bool` **fog_enabled** - Enables the fog. Needs fog_height_enabled and/or for_depth_enabled to actually display fog. +- :ref:`bool` **fog_enabled** + ++----------+------------------------+ +| *Setter* | set_fog_enabled(value) | ++----------+------------------------+ +| *Getter* | is_fog_enabled() | ++----------+------------------------+ + +Enables the fog. Needs fog_height_enabled and/or for_depth_enabled to actually display fog. .. _class_Environment_fog_height_curve: -- :ref:`float` **fog_height_curve** - Value defining the fog height intensity. +- :ref:`float` **fog_height_curve** + ++----------+-----------------------------+ +| *Setter* | set_fog_height_curve(value) | ++----------+-----------------------------+ +| *Getter* | get_fog_height_curve() | ++----------+-----------------------------+ + +Value defining the fog height intensity. .. _class_Environment_fog_height_enabled: -- :ref:`bool` **fog_height_enabled** - Enables the fog height. +- :ref:`bool` **fog_height_enabled** + ++----------+-------------------------------+ +| *Setter* | set_fog_height_enabled(value) | ++----------+-------------------------------+ +| *Getter* | is_fog_height_enabled() | ++----------+-------------------------------+ + +Enables the fog height. .. _class_Environment_fog_height_max: -- :ref:`float` **fog_height_max** - Maximum height of fog. +- :ref:`float` **fog_height_max** + ++----------+---------------------------+ +| *Setter* | set_fog_height_max(value) | ++----------+---------------------------+ +| *Getter* | get_fog_height_max() | ++----------+---------------------------+ + +Maximum height of fog. .. _class_Environment_fog_height_min: -- :ref:`float` **fog_height_min** - Minimum height of fog. +- :ref:`float` **fog_height_min** + ++----------+---------------------------+ +| *Setter* | set_fog_height_min(value) | ++----------+---------------------------+ +| *Getter* | get_fog_height_min() | ++----------+---------------------------+ + +Minimum height of fog. .. _class_Environment_fog_sun_amount: -- :ref:`float` **fog_sun_amount** - Amount of sun that affects the fog rendering. +- :ref:`float` **fog_sun_amount** + ++----------+---------------------------+ +| *Setter* | set_fog_sun_amount(value) | ++----------+---------------------------+ +| *Getter* | get_fog_sun_amount() | ++----------+---------------------------+ + +Amount of sun that affects the fog rendering. .. _class_Environment_fog_sun_color: -- :ref:`Color` **fog_sun_color** - Sun :ref:`Color`. +- :ref:`Color` **fog_sun_color** + ++----------+--------------------------+ +| *Setter* | set_fog_sun_color(value) | ++----------+--------------------------+ +| *Getter* | get_fog_sun_color() | ++----------+--------------------------+ + +Sun :ref:`Color`. .. _class_Environment_fog_transmit_curve: -- :ref:`float` **fog_transmit_curve** - Amount of light that the fog transmits. +- :ref:`float` **fog_transmit_curve** + ++----------+-------------------------------+ +| *Setter* | set_fog_transmit_curve(value) | ++----------+-------------------------------+ +| *Getter* | get_fog_transmit_curve() | ++----------+-------------------------------+ + +Amount of light that the fog transmits. .. _class_Environment_fog_transmit_enabled: -- :ref:`bool` **fog_transmit_enabled** - Enables fog's light transmission. If enabled, lets reflections light to be transmitted by the fog. +- :ref:`bool` **fog_transmit_enabled** + ++----------+---------------------------------+ +| *Setter* | set_fog_transmit_enabled(value) | ++----------+---------------------------------+ +| *Getter* | is_fog_transmit_enabled() | ++----------+---------------------------------+ + +Enables fog's light transmission. If enabled, lets reflections light to be transmitted by the fog. .. _class_Environment_glow_bicubic_upscale: - :ref:`bool` **glow_bicubic_upscale** ++----------+-----------------------------------+ +| *Setter* | set_glow_bicubic_upscale(value) | ++----------+-----------------------------------+ +| *Getter* | is_glow_bicubic_upscale_enabled() | ++----------+-----------------------------------+ + .. _class_Environment_glow_blend_mode: -- :ref:`GlowBlendMode` **glow_blend_mode** - Glow blending mode. +- :ref:`GlowBlendMode` **glow_blend_mode** + ++----------+----------------------------+ +| *Setter* | set_glow_blend_mode(value) | ++----------+----------------------------+ +| *Getter* | get_glow_blend_mode() | ++----------+----------------------------+ + +Glow blending mode. .. _class_Environment_glow_bloom: -- :ref:`float` **glow_bloom** - Bloom value (global glow). +- :ref:`float` **glow_bloom** + ++----------+-----------------------+ +| *Setter* | set_glow_bloom(value) | ++----------+-----------------------+ +| *Getter* | get_glow_bloom() | ++----------+-----------------------+ + +Bloom value (global glow). .. _class_Environment_glow_enabled: -- :ref:`bool` **glow_enabled** - Enables glow rendering. +- :ref:`bool` **glow_enabled** + ++----------+-------------------------+ +| *Setter* | set_glow_enabled(value) | ++----------+-------------------------+ +| *Getter* | is_glow_enabled() | ++----------+-------------------------+ + +Enables glow rendering. .. _class_Environment_glow_hdr_scale: -- :ref:`float` **glow_hdr_scale** - Bleed scale of the HDR glow. +- :ref:`float` **glow_hdr_scale** + ++----------+---------------------------------+ +| *Setter* | set_glow_hdr_bleed_scale(value) | ++----------+---------------------------------+ +| *Getter* | get_glow_hdr_bleed_scale() | ++----------+---------------------------------+ + +Bleed scale of the HDR glow. .. _class_Environment_glow_hdr_threshold: -- :ref:`float` **glow_hdr_threshold** - Bleed threshold of the HDR glow. +- :ref:`float` **glow_hdr_threshold** + ++----------+-------------------------------------+ +| *Setter* | set_glow_hdr_bleed_threshold(value) | ++----------+-------------------------------------+ +| *Getter* | get_glow_hdr_bleed_threshold() | ++----------+-------------------------------------+ + +Bleed threshold of the HDR glow. .. _class_Environment_glow_intensity: -- :ref:`float` **glow_intensity** - Glow intensity. +- :ref:`float` **glow_intensity** + ++----------+---------------------------+ +| *Setter* | set_glow_intensity(value) | ++----------+---------------------------+ +| *Getter* | get_glow_intensity() | ++----------+---------------------------+ + +Glow intensity. .. _class_Environment_glow_levels/1: -- :ref:`bool` **glow_levels/1** - First level of glow (most local). +- :ref:`bool` **glow_levels/1** + ++----------+-------------------------+ +| *Setter* | set_glow_level(value) | ++----------+-------------------------+ +| *Getter* | is_glow_level_enabled() | ++----------+-------------------------+ + +First level of glow (most local). .. _class_Environment_glow_levels/2: -- :ref:`bool` **glow_levels/2** - Second level of glow. +- :ref:`bool` **glow_levels/2** + ++----------+-------------------------+ +| *Setter* | set_glow_level(value) | ++----------+-------------------------+ +| *Getter* | is_glow_level_enabled() | ++----------+-------------------------+ + +Second level of glow. .. _class_Environment_glow_levels/3: -- :ref:`bool` **glow_levels/3** - Third level of glow. +- :ref:`bool` **glow_levels/3** + ++----------+-------------------------+ +| *Setter* | set_glow_level(value) | ++----------+-------------------------+ +| *Getter* | is_glow_level_enabled() | ++----------+-------------------------+ + +Third level of glow. .. _class_Environment_glow_levels/4: -- :ref:`bool` **glow_levels/4** - Fourth level of glow. +- :ref:`bool` **glow_levels/4** + ++----------+-------------------------+ +| *Setter* | set_glow_level(value) | ++----------+-------------------------+ +| *Getter* | is_glow_level_enabled() | ++----------+-------------------------+ + +Fourth level of glow. .. _class_Environment_glow_levels/5: -- :ref:`bool` **glow_levels/5** - Fifth level of glow. +- :ref:`bool` **glow_levels/5** + ++----------+-------------------------+ +| *Setter* | set_glow_level(value) | ++----------+-------------------------+ +| *Getter* | is_glow_level_enabled() | ++----------+-------------------------+ + +Fifth level of glow. .. _class_Environment_glow_levels/6: -- :ref:`bool` **glow_levels/6** - Sixth level of glow. +- :ref:`bool` **glow_levels/6** + ++----------+-------------------------+ +| *Setter* | set_glow_level(value) | ++----------+-------------------------+ +| *Getter* | is_glow_level_enabled() | ++----------+-------------------------+ + +Sixth level of glow. .. _class_Environment_glow_levels/7: -- :ref:`bool` **glow_levels/7** - Seventh level of glow (most global). +- :ref:`bool` **glow_levels/7** + ++----------+-------------------------+ +| *Setter* | set_glow_level(value) | ++----------+-------------------------+ +| *Getter* | is_glow_level_enabled() | ++----------+-------------------------+ + +Seventh level of glow (most global). .. _class_Environment_glow_strength: -- :ref:`float` **glow_strength** - Glow strength. +- :ref:`float` **glow_strength** + ++----------+--------------------------+ +| *Setter* | set_glow_strength(value) | ++----------+--------------------------+ +| *Getter* | get_glow_strength() | ++----------+--------------------------+ + +Glow strength. .. _class_Environment_ss_reflections_depth_tolerance: - :ref:`float` **ss_reflections_depth_tolerance** ++----------+--------------------------------+ +| *Setter* | set_ssr_depth_tolerance(value) | ++----------+--------------------------------+ +| *Getter* | get_ssr_depth_tolerance() | ++----------+--------------------------------+ + .. _class_Environment_ss_reflections_enabled: - :ref:`bool` **ss_reflections_enabled** ++----------+------------------------+ +| *Setter* | set_ssr_enabled(value) | ++----------+------------------------+ +| *Getter* | is_ssr_enabled() | ++----------+------------------------+ + .. _class_Environment_ss_reflections_fade_in: - :ref:`float` **ss_reflections_fade_in** ++----------+------------------------+ +| *Setter* | set_ssr_fade_in(value) | ++----------+------------------------+ +| *Getter* | get_ssr_fade_in() | ++----------+------------------------+ + .. _class_Environment_ss_reflections_fade_out: - :ref:`float` **ss_reflections_fade_out** ++----------+-------------------------+ +| *Setter* | set_ssr_fade_out(value) | ++----------+-------------------------+ +| *Getter* | get_ssr_fade_out() | ++----------+-------------------------+ + .. _class_Environment_ss_reflections_max_steps: - :ref:`int` **ss_reflections_max_steps** ++----------+--------------------------+ +| *Setter* | set_ssr_max_steps(value) | ++----------+--------------------------+ +| *Getter* | get_ssr_max_steps() | ++----------+--------------------------+ + .. _class_Environment_ss_reflections_roughness: - :ref:`bool` **ss_reflections_roughness** ++----------+----------------------+ +| *Setter* | set_ssr_rough(value) | ++----------+----------------------+ +| *Getter* | is_ssr_rough() | ++----------+----------------------+ + .. _class_Environment_ssao_ao_channel_affect: - :ref:`float` **ssao_ao_channel_affect** ++----------+-----------------------------------+ +| *Setter* | set_ssao_ao_channel_affect(value) | ++----------+-----------------------------------+ +| *Getter* | get_ssao_ao_channel_affect() | ++----------+-----------------------------------+ + .. _class_Environment_ssao_bias: - :ref:`float` **ssao_bias** ++----------+----------------------+ +| *Setter* | set_ssao_bias(value) | ++----------+----------------------+ +| *Getter* | get_ssao_bias() | ++----------+----------------------+ + .. _class_Environment_ssao_blur: - :ref:`SSAOBlur` **ssao_blur** ++----------+------------------------+ +| *Setter* | set_ssao_blur(value) | ++----------+------------------------+ +| *Getter* | is_ssao_blur_enabled() | ++----------+------------------------+ + .. _class_Environment_ssao_color: - :ref:`Color` **ssao_color** ++----------+-----------------------+ +| *Setter* | set_ssao_color(value) | ++----------+-----------------------+ +| *Getter* | get_ssao_color() | ++----------+-----------------------+ + .. _class_Environment_ssao_edge_sharpness: - :ref:`float` **ssao_edge_sharpness** ++----------+--------------------------------+ +| *Setter* | set_ssao_edge_sharpness(value) | ++----------+--------------------------------+ +| *Getter* | get_ssao_edge_sharpness() | ++----------+--------------------------------+ + .. _class_Environment_ssao_enabled: - :ref:`bool` **ssao_enabled** ++----------+-------------------------+ +| *Setter* | set_ssao_enabled(value) | ++----------+-------------------------+ +| *Getter* | is_ssao_enabled() | ++----------+-------------------------+ + .. _class_Environment_ssao_intensity: - :ref:`float` **ssao_intensity** ++----------+---------------------------+ +| *Setter* | set_ssao_intensity(value) | ++----------+---------------------------+ +| *Getter* | get_ssao_intensity() | ++----------+---------------------------+ + .. _class_Environment_ssao_intensity2: - :ref:`float` **ssao_intensity2** ++----------+----------------------------+ +| *Setter* | set_ssao_intensity2(value) | ++----------+----------------------------+ +| *Getter* | get_ssao_intensity2() | ++----------+----------------------------+ + .. _class_Environment_ssao_light_affect: - :ref:`float` **ssao_light_affect** ++----------+-------------------------------------+ +| *Setter* | set_ssao_direct_light_affect(value) | ++----------+-------------------------------------+ +| *Getter* | get_ssao_direct_light_affect() | ++----------+-------------------------------------+ + .. _class_Environment_ssao_quality: - :ref:`SSAOQuality` **ssao_quality** ++----------+-------------------------+ +| *Setter* | set_ssao_quality(value) | ++----------+-------------------------+ +| *Getter* | get_ssao_quality() | ++----------+-------------------------+ + .. _class_Environment_ssao_radius: - :ref:`float` **ssao_radius** ++----------+------------------------+ +| *Setter* | set_ssao_radius(value) | ++----------+------------------------+ +| *Getter* | get_ssao_radius() | ++----------+------------------------+ + .. _class_Environment_ssao_radius2: - :ref:`float` **ssao_radius2** ++----------+-------------------------+ +| *Setter* | set_ssao_radius2(value) | ++----------+-------------------------+ +| *Getter* | get_ssao_radius2() | ++----------+-------------------------+ + .. _class_Environment_tonemap_exposure: -- :ref:`float` **tonemap_exposure** - Default exposure for tonemap. +- :ref:`float` **tonemap_exposure** + ++----------+-----------------------------+ +| *Setter* | set_tonemap_exposure(value) | ++----------+-----------------------------+ +| *Getter* | get_tonemap_exposure() | ++----------+-----------------------------+ + +Default exposure for tonemap. .. _class_Environment_tonemap_mode: -- :ref:`ToneMapper` **tonemap_mode** - Tonemapping mode. +- :ref:`ToneMapper` **tonemap_mode** + ++----------+-----------------------+ +| *Setter* | set_tonemapper(value) | ++----------+-----------------------+ +| *Getter* | get_tonemapper() | ++----------+-----------------------+ + +Tonemapping mode. .. _class_Environment_tonemap_white: -- :ref:`float` **tonemap_white** - White reference value for tonemap. +- :ref:`float` **tonemap_white** ++----------+--------------------------+ +| *Setter* | set_tonemap_white(value) | ++----------+--------------------------+ +| *Getter* | get_tonemap_white() | ++----------+--------------------------+ + +White reference value for tonemap. diff --git a/classes/class_expression.rst b/classes/class_expression.rst index 534a0b317..230fb462a 100644 --- a/classes/class_expression.rst +++ b/classes/class_expression.rst @@ -8,6 +8,7 @@ Expression ========== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -31,20 +32,19 @@ Methods Method Descriptions ------------------- -.. _class_Expression_execute: + .. _class_Expression_execute: - :ref:`Variant` **execute** **(** :ref:`Array` inputs=[ ], :ref:`Object` base_instance=null, :ref:`bool` show_error=true **)** -.. _class_Expression_get_error_text: + .. _class_Expression_get_error_text: - :ref:`String` **get_error_text** **(** **)** const -.. _class_Expression_has_execute_failed: + .. _class_Expression_has_execute_failed: - :ref:`bool` **has_execute_failed** **(** **)** const -.. _class_Expression_parse: + .. _class_Expression_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 fa8ce10b8..99de8ad84 100644 --- a/classes/class_file.rst +++ b/classes/class_file.rst @@ -8,6 +8,7 @@ File ==== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Type to handle file reading and writing operations. +Properties +---------- + ++-------------------------+--------------------------------------------+ +| :ref:`bool` | :ref:`endian_swap` | ++-------------------------+--------------------------------------------+ + Methods ------- @@ -111,7 +119,7 @@ Enumerations .. _enum_File_CompressionMode: -enum **CompressionMode** +enum **CompressionMode**: - **COMPRESSION_FASTLZ** = **0** --- Uses the FastLZ compression method. - **COMPRESSION_DEFLATE** = **1** --- Uses the Deflate compression method. @@ -120,14 +128,13 @@ enum **CompressionMode** .. _enum_File_ModeFlags: -enum **ModeFlags** +enum **ModeFlags**: - **READ** = **1** --- Opens the file for read operations. - **WRITE** = **2** --- Opens the file for write operations. Create it if the file does not exist and truncate if it exists. - **READ_WRITE** = **3** --- Opens the file for read and write operations. Does not truncate the file. - **WRITE_READ** = **7** --- Opens the file for read and write operations. Create it if the file does not exist and truncate if it exists. - Description ----------- @@ -154,276 +161,281 @@ Tutorials --------- - :doc:`../getting_started/step_by_step/filesystem` - Property Descriptions --------------------- .. _class_File_endian_swap: -- :ref:`bool` **endian_swap** - If ``true`` the file's endianness is swapped. Use this if you're dealing with files written in big endian machines. +- :ref:`bool` **endian_swap** + ++----------+------------------------+ +| *Setter* | set_endian_swap(value) | ++----------+------------------------+ +| *Getter* | get_endian_swap() | ++----------+------------------------+ + +If ``true`` the file's endianness is swapped. Use this if you're dealing with files written in big endian machines. Note that this is about the file format, not CPU type. This is always reset to ``false`` whenever you open the file. - Method Descriptions ------------------- -.. _class_File_close: + .. _class_File_close: - void **close** **(** **)** Closes the currently opened file. -.. _class_File_eof_reached: + .. _class_File_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_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_get_16: - :ref:`int` **get_16** **(** **)** const Returns the next 16 bits from the file as an integer. -.. _class_File_get_32: + .. _class_File_get_32: - :ref:`int` **get_32** **(** **)** const Returns the next 32 bits from the file as an integer. -.. _class_File_get_64: + .. _class_File_get_64: - :ref:`int` **get_64** **(** **)** const Returns the next 64 bits from the file as an integer. -.. _class_File_get_8: + .. _class_File_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_get_as_text: - :ref:`String` **get_as_text** **(** **)** const Returns the whole file as a :ref:`String`. -.. _class_File_get_buffer: + .. _class_File_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_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). -.. _class_File_get_double: + .. _class_File_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_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_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_get_len: - :ref:`int` **get_len** **(** **)** const Returns the size of the file in bytes. -.. _class_File_get_line: + .. _class_File_get_line: - :ref:`String` **get_line** **(** **)** const Returns the next line of the file as a :ref:`String`. -.. _class_File_get_md5: + .. _class_File_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_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`. -.. _class_File_get_pascal_string: + .. _class_File_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_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_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_get_position: - :ref:`int` **get_position** **(** **)** const Returns the file cursor's position. -.. _class_File_get_real: + .. _class_File_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_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_get_var: - :ref:`Variant` **get_var** **(** **)** const Returns the next :ref:`Variant` value from the file. -.. _class_File_is_open: + .. _class_File_is_open: - :ref:`bool` **is_open** **(** **)** const Returns ``true`` if the file is currently opened. -.. _class_File_open: + .. _class_File_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_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_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_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_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_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_store_16: - void **store_16** **(** :ref:`int` value **)** Stores an integer as 16 bits in the file. -.. _class_File_store_32: + .. _class_File_store_32: - void **store_32** **(** :ref:`int` value **)** Stores an integer as 32 bits in the file. -.. _class_File_store_64: + .. _class_File_store_64: - void **store_64** **(** :ref:`int` value **)** Stores an integer as 64 bits in the file. -.. _class_File_store_8: + .. _class_File_store_8: - void **store_8** **(** :ref:`int` value **)** Stores an integer as 8 bits in the file. -.. _class_File_store_buffer: + .. _class_File_store_buffer: - void **store_buffer** **(** :ref:`PoolByteArray` buffer **)** Stores the given array of bytes in the file. -.. _class_File_store_double: + .. _class_File_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_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_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_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_store_real: - void **store_real** **(** :ref:`float` value **)** Stores a floating point number in the file. -.. _class_File_store_string: + .. _class_File_store_string: - void **store_string** **(** :ref:`String` string **)** Stores the given :ref:`String` in the file. -.. _class_File_store_var: + .. _class_File_store_var: - void **store_var** **(** :ref:`Variant` value **)** Stores any Variant value in the file. - diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index 89f088d7b..28d29ea3a 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -8,6 +8,7 @@ FileDialog ========== **Inherits:** :ref:`ConfirmationDialog` **<** :ref:`AcceptDialog` **<** :ref:`WindowDialog` **<** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,27 @@ Brief Description 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` | ++-----------------------------------------------+--------------------------------------------------------------------+ + Methods ------- @@ -32,34 +54,46 @@ Methods | void | :ref:`invalidate` **(** **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------+ +Theme Properties +---------------- + ++-------------------------------+--------------------------------------------------------+ +| :ref:`Color` | :ref:`files_disabled` | ++-------------------------------+--------------------------------------------------------+ +| :ref:`Texture` | :ref:`folder` | ++-------------------------------+--------------------------------------------------------+ +| :ref:`Texture` | :ref:`parent_folder` | ++-------------------------------+--------------------------------------------------------+ +| :ref:`Texture` | :ref:`reload` | ++-------------------------------+--------------------------------------------------------+ + Signals ------- -.. _class_FileDialog_dir_selected: + .. _class_FileDialog_dir_selected: - **dir_selected** **(** :ref:`String` dir **)** Event emitted when the user selects a directory. -.. _class_FileDialog_file_selected: + .. _class_FileDialog_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_files_selected: - **files_selected** **(** :ref:`PoolStringArray` paths **)** Event emitted when the user selects multiple files. - Enumerations ------------ .. _enum_FileDialog_Access: -enum **Access** +enum **Access**: - **ACCESS_RESOURCES** = **0** --- The dialog allows the selection of file and directory. - **ACCESS_USERDATA** = **1** --- The dialog allows access files under :ref:`Resource` path(res://) . @@ -67,7 +101,7 @@ enum **Access** .. _enum_FileDialog_Mode: -enum **Mode** +enum **Mode**: - **MODE_OPEN_FILE** = **0** --- The dialog allows the selection of one, and only one file. - **MODE_OPEN_FILES** = **1** --- The dialog allows the selection of multiple files. @@ -75,7 +109,6 @@ enum **Mode** - **MODE_OPEN_ANY** = **3** --- The dialog allows the selection of a file or a directory. - **MODE_SAVE_FILE** = **4** --- The dialog will warn when a file exists. - Description ----------- @@ -88,68 +121,122 @@ Property Descriptions - :ref:`Access` **access** ++----------+-------------------+ +| *Setter* | set_access(value) | ++----------+-------------------+ +| *Getter* | get_access() | ++----------+-------------------+ + .. _class_FileDialog_current_dir: -- :ref:`String` **current_dir** - The current working directory of the file dialog. +- :ref:`String` **current_dir** + ++----------+------------------------+ +| *Setter* | set_current_dir(value) | ++----------+------------------------+ +| *Getter* | get_current_dir() | ++----------+------------------------+ + +The current working directory of the file dialog. .. _class_FileDialog_current_file: -- :ref:`String` **current_file** - The currently selected file of the file dialog. +- :ref:`String` **current_file** + ++----------+-------------------------+ +| *Setter* | set_current_file(value) | ++----------+-------------------------+ +| *Getter* | get_current_file() | ++----------+-------------------------+ + +The currently selected file of the file dialog. .. _class_FileDialog_current_path: -- :ref:`String` **current_path** - The currently selected file path of the file dialog. +- :ref:`String` **current_path** + ++----------+-------------------------+ +| *Setter* | set_current_path(value) | ++----------+-------------------------+ +| *Getter* | get_current_path() | ++----------+-------------------------+ + +The currently selected file path of the file dialog. .. _class_FileDialog_filters: - :ref:`PoolStringArray` **filters** ++----------+--------------------+ +| *Setter* | set_filters(value) | ++----------+--------------------+ +| *Getter* | get_filters() | ++----------+--------------------+ + .. _class_FileDialog_mode: - :ref:`Mode` **mode** ++----------+-----------------+ +| *Setter* | set_mode(value) | ++----------+-----------------+ +| *Getter* | get_mode() | ++----------+-----------------+ + .. _class_FileDialog_mode_overrides_title: -- :ref:`bool` **mode_overrides_title** - 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"). +- :ref:`bool` **mode_overrides_title** + ++----------+---------------------------------+ +| *Setter* | set_mode_overrides_title(value) | ++----------+---------------------------------+ +| *Getter* | is_mode_overriding_title() | ++----------+---------------------------------+ + +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: - :ref:`bool` **show_hidden_files** ++----------+------------------------------+ +| *Setter* | set_show_hidden_files(value) | ++----------+------------------------------+ +| *Getter* | is_showing_hidden_files() | ++----------+------------------------------+ Method Descriptions ------------------- -.. _class_FileDialog_add_filter: + .. _class_FileDialog_add_filter: - void **add_filter** **(** :ref:`String` filter **)** Add a custom filter. Filter format is: "mask ; description", example (C++): dialog->add_filter("\*.png ; PNG Images"); -.. _class_FileDialog_clear_filters: + .. _class_FileDialog_clear_filters: - void **clear_filters** **(** **)** Clear all the added filters in the dialog. -.. _class_FileDialog_deselect_items: + .. _class_FileDialog_deselect_items: - void **deselect_items** **(** **)** -.. _class_FileDialog_get_line_edit: + .. _class_FileDialog_get_line_edit: - :ref:`LineEdit` **get_line_edit** **(** **)** -.. _class_FileDialog_get_vbox: + .. _class_FileDialog_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_invalidate: - void **invalidate** **(** **)** Invalidate and update the current dialog content list. - diff --git a/classes/class_float.rst b/classes/class_float.rst index d905790c6..20e6f2993 100644 --- a/classes/class_float.rst +++ b/classes/class_float.rst @@ -33,22 +33,21 @@ Float built-in type. Method Descriptions ------------------- -.. _class_float_float: + .. _class_float_float: - :ref:`float` **float** **(** :ref:`bool` from **)** Cast a :ref:`bool` value to a floating point value, ``float(true)`` will be equals to 1.0 and ``float(false)`` will be equals to 0.0. -.. _class_float_float: + .. _class_float_float: - :ref:`float` **float** **(** :ref:`int` from **)** Cast an :ref:`int` value to a floating point value, ``float(1)`` will be equals to 1.0. -.. _class_float_float: + .. _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 560e48d7b..9d3e1fcd3 100644 --- a/classes/class_font.rst +++ b/classes/class_font.rst @@ -8,7 +8,9 @@ Font ==== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`DynamicFont`, :ref:`BitmapFont` + **Category:** Core Brief Description @@ -47,54 +49,53 @@ Font contains a unicode compatible character set, as well as the ability to draw Method Descriptions ------------------- -.. _class_Font_draw: + .. _class_Font_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_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_get_ascent: - :ref:`float` **get_ascent** **(** **)** const Return the font ascent (number of pixels above the baseline). -.. _class_Font_get_descent: + .. _class_Font_get_descent: - :ref:`float` **get_descent** **(** **)** const Return the font descent (number of pixels below the baseline). -.. _class_Font_get_height: + .. _class_Font_get_height: - :ref:`float` **get_height** **(** **)** const Return the total font height (ascent plus descent) in pixels. -.. _class_Font_get_string_size: + .. _class_Font_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_has_outline: - :ref:`bool` **has_outline** **(** **)** const -.. _class_Font_is_distance_field_hint: + .. _class_Font_is_distance_field_hint: - :ref:`bool` **is_distance_field_hint** **(** **)** const -.. _class_Font_update_changes: + .. _class_Font_update_changes: - void **update_changes** **(** **)** After editing a font (changing size, ascent, char rects, etc.). Call this function to propagate changes to controls that might use it. - diff --git a/classes/class_funcref.rst b/classes/class_funcref.rst index 0ee20b282..64dcfd8e1 100644 --- a/classes/class_funcref.rst +++ b/classes/class_funcref.rst @@ -8,6 +8,7 @@ FuncRef ======= **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -36,22 +37,21 @@ However, by creating a ``FuncRef`` using the :ref:`@GDScript.funcref` **call_func** **(** **)** vararg Calls the referenced function previously set by :ref:`set_function` or :ref:`@GDScript.funcref`. -.. _class_FuncRef_set_function: + .. _class_FuncRef_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_set_instance: - void **set_instance** **(** :ref:`Object` instance **)** The object containing the referenced function. This object must be of a type actually inheriting from :ref:`Object`, not a built-in type such as :ref:`int`, :ref:`Vector2` or :ref:`Dictionary`. - diff --git a/classes/class_gdnative.rst b/classes/class_gdnative.rst index 3511369cb..887196dd3 100644 --- a/classes/class_gdnative.rst +++ b/classes/class_gdnative.rst @@ -8,6 +8,7 @@ GDNative ======== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description +Properties +---------- + ++-----------------------------------------------+----------------------------------------+ +| :ref:`GDNativeLibrary` | :ref:`library` | ++-----------------------------------------------+----------------------------------------+ + Methods ------- @@ -33,20 +41,24 @@ Property Descriptions - :ref:`GDNativeLibrary` **library** ++----------+--------------------+ +| *Setter* | set_library(value) | ++----------+--------------------+ +| *Getter* | get_library() | ++----------+--------------------+ Method Descriptions ------------------- -.. _class_GDNative_call_native: + .. _class_GDNative_call_native: - :ref:`Variant` **call_native** **(** :ref:`String` calling_type, :ref:`String` procedure_name, :ref:`Array` arguments **)** -.. _class_GDNative_initialize: + .. _class_GDNative_initialize: - :ref:`bool` **initialize** **(** **)** -.. _class_GDNative_terminate: + .. _class_GDNative_terminate: - :ref:`bool` **terminate** **(** **)** - diff --git a/classes/class_gdnativelibrary.rst b/classes/class_gdnativelibrary.rst index ca7519620..faf253567 100644 --- a/classes/class_gdnativelibrary.rst +++ b/classes/class_gdnativelibrary.rst @@ -8,6 +8,7 @@ GDNativeLibrary =============== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,21 @@ 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` | ++-------------------------------------+-----------------------------------------------------------+ + Methods ------- @@ -31,32 +47,60 @@ Property Descriptions - :ref:`ConfigFile` **config_file** ++----------+------------------------+ +| *Setter* | set_config_file(value) | ++----------+------------------------+ +| *Getter* | get_config_file() | ++----------+------------------------+ + .. _class_GDNativeLibrary_load_once: - :ref:`bool` **load_once** ++----------+----------------------+ +| *Setter* | set_load_once(value) | ++----------+----------------------+ +| *Getter* | should_load_once() | ++----------+----------------------+ + .. _class_GDNativeLibrary_reloadable: - :ref:`bool` **reloadable** ++----------+-----------------------+ +| *Setter* | set_reloadable(value) | ++----------+-----------------------+ +| *Getter* | is_reloadable() | ++----------+-----------------------+ + .. _class_GDNativeLibrary_singleton: - :ref:`bool` **singleton** ++----------+----------------------+ +| *Setter* | set_singleton(value) | ++----------+----------------------+ +| *Getter* | is_singleton() | ++----------+----------------------+ + .. _class_GDNativeLibrary_symbol_prefix: - :ref:`String` **symbol_prefix** ++----------+--------------------------+ +| *Setter* | set_symbol_prefix(value) | ++----------+--------------------------+ +| *Getter* | get_symbol_prefix() | ++----------+--------------------------+ Method Descriptions ------------------- -.. _class_GDNativeLibrary_get_current_dependencies: + .. _class_GDNativeLibrary_get_current_dependencies: - :ref:`PoolStringArray` **get_current_dependencies** **(** **)** const -.. _class_GDNativeLibrary_get_current_library_path: + .. _class_GDNativeLibrary_get_current_library_path: - :ref:`String` **get_current_library_path** **(** **)** const - diff --git a/classes/class_gdscript.rst b/classes/class_gdscript.rst index 8ee2ea3cd..174043c4f 100644 --- a/classes/class_gdscript.rst +++ b/classes/class_gdscript.rst @@ -8,6 +8,7 @@ GDScript ======== **Inherits:** :ref:`Script` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -35,17 +36,16 @@ Tutorials --------- - :doc:`../getting_started/scripting/gdscript/index` - Method Descriptions ------------------- -.. _class_GDScript_get_as_byte_code: + .. _class_GDScript_get_as_byte_code: - :ref:`PoolByteArray` **get_as_byte_code** **(** **)** const Returns byte code for the script source code. -.. _class_GDScript_new: + .. _class_GDScript_new: - :ref:`Object` **new** **(** **)** vararg @@ -59,4 +59,3 @@ For example: var instance = MyClass.new() assert(instance.get_script() == MyClass) - diff --git a/classes/class_gdscriptfunctionstate.rst b/classes/class_gdscriptfunctionstate.rst index 8e4c2fd93..5b4310a1b 100644 --- a/classes/class_gdscriptfunctionstate.rst +++ b/classes/class_gdscriptfunctionstate.rst @@ -8,6 +8,7 @@ GDScriptFunctionState ===================== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -27,11 +28,10 @@ Methods Signals ------- -.. _class_GDScriptFunctionState_completed: + .. _class_GDScriptFunctionState_completed: - **completed** **(** :ref:`Nil` result **)** - Description ----------- @@ -40,7 +40,7 @@ Calling :ref:`@GDScript.yield` within a function will cau Method Descriptions ------------------- -.. _class_GDScriptFunctionState_is_valid: + .. _class_GDScriptFunctionState_is_valid: - :ref:`bool` **is_valid** **(** :ref:`bool` extended_check=false **)** const @@ -48,7 +48,7 @@ Check whether the function call may be resumed. This is not the case if the func If ``extended_check`` is enabled, it also checks if the associated script and object still exist. The extended check is done in debug mode as part of :ref:`GDScriptFunctionState.resume`, but you can use this if you know you may be trying to resume without knowing for sure the object and/or script have survived up to that point. -.. _class_GDScriptFunctionState_resume: + .. _class_GDScriptFunctionState_resume: - :ref:`Variant` **resume** **(** :ref:`Variant` arg=null **)** @@ -58,4 +58,3 @@ If handed an argument, return the argument from the :ref:`@GDScript.yield` **<** :ref:`Object` + **Category:** Core Brief Description @@ -25,8 +26,7 @@ Methods Method Descriptions ------------------- -.. _class_GDScriptNativeClass_new: + .. _class_GDScriptNativeClass_new: - :ref:`Variant` **new** **(** **)** - diff --git a/classes/class_generic6dofjoint.rst b/classes/class_generic6dofjoint.rst index f52027928..4c16e365b 100644 --- a/classes/class_generic6dofjoint.rst +++ b/classes/class_generic6dofjoint.rst @@ -8,6 +8,7 @@ Generic6DOFJoint ================ **Inherits:** :ref:`Joint` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,12 +16,137 @@ Brief Description The generic 6 degrees of freedom joint can implement a variety of joint-types by locking certain axes' rotation or translation. +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:`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` | ++---------------------------+------------------------------------------------------------------------------------------------+ + Enumerations ------------ .. _enum_Generic6DOFJoint_Flag: -enum **Flag** +enum **Flag**: - **FLAG_ENABLE_LINEAR_LIMIT** = **0** --- If ``set`` there is linear motion possible within the given limits. - **FLAG_ENABLE_ANGULAR_LIMIT** = **1** --- If ``set`` there is rotational motion possible. @@ -30,7 +156,7 @@ enum **Flag** .. _enum_Generic6DOFJoint_Param: -enum **Param** +enum **Param**: - **PARAM_LINEAR_LOWER_LIMIT** = **0** --- The minimum difference between the pivot points' axes. - **PARAM_LINEAR_UPPER_LIMIT** = **1** --- The maximum difference between the pivot points' axes. @@ -50,7 +176,6 @@ enum **Param** - **PARAM_ANGULAR_MOTOR_FORCE_LIMIT** = **15** --- Maximum acceleration for the motor at the axes. - **PARAM_MAX** = **16** --- End flag of PARAM\_\* constants, used internally. - Description ----------- @@ -61,244 +186,687 @@ Property Descriptions .. _class_Generic6DOFJoint_angular_limit_x/damping: -- :ref:`float` **angular_limit_x/damping** - The amount of rotational damping across the x-axis. +- :ref:`float` **angular_limit_x/damping** + ++----------+--------------------+ +| *Setter* | set_param_x(value) | ++----------+--------------------+ +| *Getter* | get_param_x() | ++----------+--------------------+ + +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: -- :ref:`bool` **angular_limit_x/enabled** - If ``true`` rotation across the x-axis is limited. +- :ref:`bool` **angular_limit_x/enabled** + ++----------+-------------------+ +| *Setter* | set_flag_x(value) | ++----------+-------------------+ +| *Getter* | get_flag_x() | ++----------+-------------------+ + +If ``true`` rotation across the x-axis is limited. .. _class_Generic6DOFJoint_angular_limit_x/erp: -- :ref:`float` **angular_limit_x/erp** - When rotating across x-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. +- :ref:`float` **angular_limit_x/erp** + ++----------+--------------------+ +| *Setter* | set_param_x(value) | ++----------+--------------------+ +| *Getter* | get_param_x() | ++----------+--------------------+ + +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: -- :ref:`float` **angular_limit_x/force_limit** - The maximum amount of force that can occur, when rotating around x-axis. +- :ref:`float` **angular_limit_x/force_limit** + ++----------+--------------------+ +| *Setter* | set_param_x(value) | ++----------+--------------------+ +| *Getter* | get_param_x() | ++----------+--------------------+ + +The maximum amount of force that can occur, when rotating around x-axis. .. _class_Generic6DOFJoint_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. +- :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: -- :ref:`float` **angular_limit_x/restitution** - The amount of rotational restitution across the x-axis. The lower, the more restitution occurs. +- :ref:`float` **angular_limit_x/restitution** + ++----------+--------------------+ +| *Setter* | set_param_x(value) | ++----------+--------------------+ +| *Getter* | get_param_x() | ++----------+--------------------+ + +The amount of rotational restitution across the x-axis. The lower, the more restitution occurs. .. _class_Generic6DOFJoint_angular_limit_x/softness: -- :ref:`float` **angular_limit_x/softness** - The speed of all rotations across the x-axis. +- :ref:`float` **angular_limit_x/softness** + ++----------+--------------------+ +| *Setter* | set_param_x(value) | ++----------+--------------------+ +| *Getter* | get_param_x() | ++----------+--------------------+ + +The speed of all rotations across the x-axis. .. _class_Generic6DOFJoint_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. +- :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: -- :ref:`float` **angular_limit_y/damping** - The amount of rotational damping across the y-axis. The lower, the more dampening occurs. +- :ref:`float` **angular_limit_y/damping** + ++----------+--------------------+ +| *Setter* | set_param_y(value) | ++----------+--------------------+ +| *Getter* | get_param_y() | ++----------+--------------------+ + +The amount of rotational damping across the y-axis. The lower, the more dampening occurs. .. _class_Generic6DOFJoint_angular_limit_y/enabled: -- :ref:`bool` **angular_limit_y/enabled** - If ``true`` rotation across the y-axis is limited. +- :ref:`bool` **angular_limit_y/enabled** + ++----------+-------------------+ +| *Setter* | set_flag_y(value) | ++----------+-------------------+ +| *Getter* | get_flag_y() | ++----------+-------------------+ + +If ``true`` rotation across the y-axis is limited. .. _class_Generic6DOFJoint_angular_limit_y/erp: -- :ref:`float` **angular_limit_y/erp** - When rotating across y-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. +- :ref:`float` **angular_limit_y/erp** + ++----------+--------------------+ +| *Setter* | set_param_y(value) | ++----------+--------------------+ +| *Getter* | get_param_y() | ++----------+--------------------+ + +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: -- :ref:`float` **angular_limit_y/force_limit** - The maximum amount of force that can occur, when rotating around y-axis. +- :ref:`float` **angular_limit_y/force_limit** + ++----------+--------------------+ +| *Setter* | set_param_y(value) | ++----------+--------------------+ +| *Getter* | get_param_y() | ++----------+--------------------+ + +The maximum amount of force that can occur, when rotating around y-axis. .. _class_Generic6DOFJoint_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. +- :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: -- :ref:`float` **angular_limit_y/restitution** - The amount of rotational restitution across the y-axis. The lower, the more restitution occurs. +- :ref:`float` **angular_limit_y/restitution** + ++----------+--------------------+ +| *Setter* | set_param_y(value) | ++----------+--------------------+ +| *Getter* | get_param_y() | ++----------+--------------------+ + +The amount of rotational restitution across the y-axis. The lower, the more restitution occurs. .. _class_Generic6DOFJoint_angular_limit_y/softness: -- :ref:`float` **angular_limit_y/softness** - The speed of all rotations across the y-axis. +- :ref:`float` **angular_limit_y/softness** + ++----------+--------------------+ +| *Setter* | set_param_y(value) | ++----------+--------------------+ +| *Getter* | get_param_y() | ++----------+--------------------+ + +The speed of all rotations across the y-axis. .. _class_Generic6DOFJoint_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. +- :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: -- :ref:`float` **angular_limit_z/damping** - The amount of rotational damping across the z-axis. The lower, the more dampening occurs. +- :ref:`float` **angular_limit_z/damping** + ++----------+--------------------+ +| *Setter* | set_param_z(value) | ++----------+--------------------+ +| *Getter* | get_param_z() | ++----------+--------------------+ + +The amount of rotational damping across the z-axis. The lower, the more dampening occurs. .. _class_Generic6DOFJoint_angular_limit_z/enabled: -- :ref:`bool` **angular_limit_z/enabled** - If ``true`` rotation across the z-axis is limited. +- :ref:`bool` **angular_limit_z/enabled** + ++----------+-------------------+ +| *Setter* | set_flag_z(value) | ++----------+-------------------+ +| *Getter* | get_flag_z() | ++----------+-------------------+ + +If ``true`` rotation across the z-axis is limited. .. _class_Generic6DOFJoint_angular_limit_z/erp: -- :ref:`float` **angular_limit_z/erp** - When rotating across z-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. +- :ref:`float` **angular_limit_z/erp** + ++----------+--------------------+ +| *Setter* | set_param_z(value) | ++----------+--------------------+ +| *Getter* | get_param_z() | ++----------+--------------------+ + +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: -- :ref:`float` **angular_limit_z/force_limit** - The maximum amount of force that can occur, when rotating around z-axis. +- :ref:`float` **angular_limit_z/force_limit** + ++----------+--------------------+ +| *Setter* | set_param_z(value) | ++----------+--------------------+ +| *Getter* | get_param_z() | ++----------+--------------------+ + +The maximum amount of force that can occur, when rotating around z-axis. .. _class_Generic6DOFJoint_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. +- :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: -- :ref:`float` **angular_limit_z/restitution** - The amount of rotational restitution across the z-axis. The lower, the more restitution occurs. +- :ref:`float` **angular_limit_z/restitution** + ++----------+--------------------+ +| *Setter* | set_param_z(value) | ++----------+--------------------+ +| *Getter* | get_param_z() | ++----------+--------------------+ + +The amount of rotational restitution across the z-axis. The lower, the more restitution occurs. .. _class_Generic6DOFJoint_angular_limit_z/softness: -- :ref:`float` **angular_limit_z/softness** - The speed of all rotations across the z-axis. +- :ref:`float` **angular_limit_z/softness** + ++----------+--------------------+ +| *Setter* | set_param_z(value) | ++----------+--------------------+ +| *Getter* | get_param_z() | ++----------+--------------------+ + +The speed of all rotations across the z-axis. .. _class_Generic6DOFJoint_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. +- :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: -- :ref:`bool` **angular_motor_x/enabled** - If ``true`` a rotating motor at the x-axis is enabled. +- :ref:`bool` **angular_motor_x/enabled** + ++----------+-------------------+ +| *Setter* | set_flag_x(value) | ++----------+-------------------+ +| *Getter* | get_flag_x() | ++----------+-------------------+ + +If ``true`` a rotating motor at the x-axis is enabled. .. _class_Generic6DOFJoint_angular_motor_x/force_limit: -- :ref:`float` **angular_motor_x/force_limit** - Maximum acceleration for the motor at the x-axis. +- :ref:`float` **angular_motor_x/force_limit** + ++----------+--------------------+ +| *Setter* | set_param_x(value) | ++----------+--------------------+ +| *Getter* | get_param_x() | ++----------+--------------------+ + +Maximum acceleration for the motor at the x-axis. .. _class_Generic6DOFJoint_angular_motor_x/target_velocity: -- :ref:`float` **angular_motor_x/target_velocity** - Target speed for the motor at the x-axis. +- :ref:`float` **angular_motor_x/target_velocity** + ++----------+--------------------+ +| *Setter* | set_param_x(value) | ++----------+--------------------+ +| *Getter* | get_param_x() | ++----------+--------------------+ + +Target speed for the motor at the x-axis. .. _class_Generic6DOFJoint_angular_motor_y/enabled: -- :ref:`bool` **angular_motor_y/enabled** - If ``true`` a rotating motor at the y-axis is enabled. +- :ref:`bool` **angular_motor_y/enabled** + ++----------+-------------------+ +| *Setter* | set_flag_y(value) | ++----------+-------------------+ +| *Getter* | get_flag_y() | ++----------+-------------------+ + +If ``true`` a rotating motor at the y-axis is enabled. .. _class_Generic6DOFJoint_angular_motor_y/force_limit: -- :ref:`float` **angular_motor_y/force_limit** - Maximum acceleration for the motor at the y-axis. +- :ref:`float` **angular_motor_y/force_limit** + ++----------+--------------------+ +| *Setter* | set_param_y(value) | ++----------+--------------------+ +| *Getter* | get_param_y() | ++----------+--------------------+ + +Maximum acceleration for the motor at the y-axis. .. _class_Generic6DOFJoint_angular_motor_y/target_velocity: -- :ref:`float` **angular_motor_y/target_velocity** - Target speed for the motor at the y-axis. +- :ref:`float` **angular_motor_y/target_velocity** + ++----------+--------------------+ +| *Setter* | set_param_y(value) | ++----------+--------------------+ +| *Getter* | get_param_y() | ++----------+--------------------+ + +Target speed for the motor at the y-axis. .. _class_Generic6DOFJoint_angular_motor_z/enabled: -- :ref:`bool` **angular_motor_z/enabled** - If ``true`` a rotating motor at the z-axis is enabled. +- :ref:`bool` **angular_motor_z/enabled** + ++----------+-------------------+ +| *Setter* | set_flag_z(value) | ++----------+-------------------+ +| *Getter* | get_flag_z() | ++----------+-------------------+ + +If ``true`` a rotating motor at the z-axis is enabled. .. _class_Generic6DOFJoint_angular_motor_z/force_limit: -- :ref:`float` **angular_motor_z/force_limit** - Maximum acceleration for the motor at the z-axis. +- :ref:`float` **angular_motor_z/force_limit** + ++----------+--------------------+ +| *Setter* | set_param_z(value) | ++----------+--------------------+ +| *Getter* | get_param_z() | ++----------+--------------------+ + +Maximum acceleration for the motor at the z-axis. .. _class_Generic6DOFJoint_angular_motor_z/target_velocity: -- :ref:`float` **angular_motor_z/target_velocity** - Target speed for the motor at the z-axis. +- :ref:`float` **angular_motor_z/target_velocity** + ++----------+--------------------+ +| *Setter* | set_param_z(value) | ++----------+--------------------+ +| *Getter* | get_param_z() | ++----------+--------------------+ + +Target speed for the motor at the z-axis. .. _class_Generic6DOFJoint_linear_limit_x/damping: -- :ref:`float` **linear_limit_x/damping** - The amount of damping that happens at the x-motion. +- :ref:`float` **linear_limit_x/damping** + ++----------+--------------------+ +| *Setter* | set_param_x(value) | ++----------+--------------------+ +| *Getter* | get_param_x() | ++----------+--------------------+ + +The amount of damping that happens at the x-motion. .. _class_Generic6DOFJoint_linear_limit_x/enabled: -- :ref:`bool` **linear_limit_x/enabled** - If ``true`` the linear motion across the x-axis is limited. +- :ref:`bool` **linear_limit_x/enabled** + ++----------+-------------------+ +| *Setter* | set_flag_x(value) | ++----------+-------------------+ +| *Getter* | get_flag_x() | ++----------+-------------------+ + +If ``true`` the linear motion across the x-axis is limited. .. _class_Generic6DOFJoint_linear_limit_x/lower_distance: -- :ref:`float` **linear_limit_x/lower_distance** - The minimum difference between the pivot points' x-axis. +- :ref:`float` **linear_limit_x/lower_distance** + ++----------+--------------------+ +| *Setter* | set_param_x(value) | ++----------+--------------------+ +| *Getter* | get_param_x() | ++----------+--------------------+ + +The minimum difference between the pivot points' x-axis. .. _class_Generic6DOFJoint_linear_limit_x/restitution: -- :ref:`float` **linear_limit_x/restitution** - The amount of restitution on the x-axis movement The lower, the more momentum gets lost. +- :ref:`float` **linear_limit_x/restitution** + ++----------+--------------------+ +| *Setter* | set_param_x(value) | ++----------+--------------------+ +| *Getter* | get_param_x() | ++----------+--------------------+ + +The amount of restitution on the x-axis movement The lower, the more momentum gets lost. .. _class_Generic6DOFJoint_linear_limit_x/softness: -- :ref:`float` **linear_limit_x/softness** - A factor applied to the movement across the x-axis The lower, the slower the movement. +- :ref:`float` **linear_limit_x/softness** + ++----------+--------------------+ +| *Setter* | set_param_x(value) | ++----------+--------------------+ +| *Getter* | get_param_x() | ++----------+--------------------+ + +A factor applied to the movement across the x-axis The lower, the slower the movement. .. _class_Generic6DOFJoint_linear_limit_x/upper_distance: -- :ref:`float` **linear_limit_x/upper_distance** - The maximum difference between the pivot points' x-axis. +- :ref:`float` **linear_limit_x/upper_distance** + ++----------+--------------------+ +| *Setter* | set_param_x(value) | ++----------+--------------------+ +| *Getter* | get_param_x() | ++----------+--------------------+ + +The maximum difference between the pivot points' x-axis. .. _class_Generic6DOFJoint_linear_limit_y/damping: -- :ref:`float` **linear_limit_y/damping** - The amount of damping that happens at the y-motion. +- :ref:`float` **linear_limit_y/damping** + ++----------+--------------------+ +| *Setter* | set_param_y(value) | ++----------+--------------------+ +| *Getter* | get_param_y() | ++----------+--------------------+ + +The amount of damping that happens at the y-motion. .. _class_Generic6DOFJoint_linear_limit_y/enabled: -- :ref:`bool` **linear_limit_y/enabled** - If ``true`` the linear motion across the y-axis is limited. +- :ref:`bool` **linear_limit_y/enabled** + ++----------+-------------------+ +| *Setter* | set_flag_y(value) | ++----------+-------------------+ +| *Getter* | get_flag_y() | ++----------+-------------------+ + +If ``true`` the linear motion across the y-axis is limited. .. _class_Generic6DOFJoint_linear_limit_y/lower_distance: -- :ref:`float` **linear_limit_y/lower_distance** - The minimum difference between the pivot points' y-axis. +- :ref:`float` **linear_limit_y/lower_distance** + ++----------+--------------------+ +| *Setter* | set_param_y(value) | ++----------+--------------------+ +| *Getter* | get_param_y() | ++----------+--------------------+ + +The minimum difference between the pivot points' y-axis. .. _class_Generic6DOFJoint_linear_limit_y/restitution: -- :ref:`float` **linear_limit_y/restitution** - The amount of restitution on the y-axis movement The lower, the more momentum gets lost. +- :ref:`float` **linear_limit_y/restitution** + ++----------+--------------------+ +| *Setter* | set_param_y(value) | ++----------+--------------------+ +| *Getter* | get_param_y() | ++----------+--------------------+ + +The amount of restitution on the y-axis movement The lower, the more momentum gets lost. .. _class_Generic6DOFJoint_linear_limit_y/softness: -- :ref:`float` **linear_limit_y/softness** - A factor applied to the movement across the y-axis The lower, the slower the movement. +- :ref:`float` **linear_limit_y/softness** + ++----------+--------------------+ +| *Setter* | set_param_y(value) | ++----------+--------------------+ +| *Getter* | get_param_y() | ++----------+--------------------+ + +A factor applied to the movement across the y-axis The lower, the slower the movement. .. _class_Generic6DOFJoint_linear_limit_y/upper_distance: -- :ref:`float` **linear_limit_y/upper_distance** - The maximum difference between the pivot points' y-axis. +- :ref:`float` **linear_limit_y/upper_distance** + ++----------+--------------------+ +| *Setter* | set_param_y(value) | ++----------+--------------------+ +| *Getter* | get_param_y() | ++----------+--------------------+ + +The maximum difference between the pivot points' y-axis. .. _class_Generic6DOFJoint_linear_limit_z/damping: -- :ref:`float` **linear_limit_z/damping** - The amount of damping that happens at the z-motion. +- :ref:`float` **linear_limit_z/damping** + ++----------+--------------------+ +| *Setter* | set_param_z(value) | ++----------+--------------------+ +| *Getter* | get_param_z() | ++----------+--------------------+ + +The amount of damping that happens at the z-motion. .. _class_Generic6DOFJoint_linear_limit_z/enabled: -- :ref:`bool` **linear_limit_z/enabled** - If ``true`` the linear motion across the z-axis is limited. +- :ref:`bool` **linear_limit_z/enabled** + ++----------+-------------------+ +| *Setter* | set_flag_z(value) | ++----------+-------------------+ +| *Getter* | get_flag_z() | ++----------+-------------------+ + +If ``true`` the linear motion across the z-axis is limited. .. _class_Generic6DOFJoint_linear_limit_z/lower_distance: -- :ref:`float` **linear_limit_z/lower_distance** - The minimum difference between the pivot points' z-axis. +- :ref:`float` **linear_limit_z/lower_distance** + ++----------+--------------------+ +| *Setter* | set_param_z(value) | ++----------+--------------------+ +| *Getter* | get_param_z() | ++----------+--------------------+ + +The minimum difference between the pivot points' z-axis. .. _class_Generic6DOFJoint_linear_limit_z/restitution: -- :ref:`float` **linear_limit_z/restitution** - The amount of restitution on the z-axis movement The lower, the more momentum gets lost. +- :ref:`float` **linear_limit_z/restitution** + ++----------+--------------------+ +| *Setter* | set_param_z(value) | ++----------+--------------------+ +| *Getter* | get_param_z() | ++----------+--------------------+ + +The amount of restitution on the z-axis movement The lower, the more momentum gets lost. .. _class_Generic6DOFJoint_linear_limit_z/softness: -- :ref:`float` **linear_limit_z/softness** - A factor applied to the movement across the z-axis The lower, the slower the movement. +- :ref:`float` **linear_limit_z/softness** + ++----------+--------------------+ +| *Setter* | set_param_z(value) | ++----------+--------------------+ +| *Getter* | get_param_z() | ++----------+--------------------+ + +A factor applied to the movement across the z-axis The lower, the slower the movement. .. _class_Generic6DOFJoint_linear_limit_z/upper_distance: -- :ref:`float` **linear_limit_z/upper_distance** - The maximum difference between the pivot points' z-axis. +- :ref:`float` **linear_limit_z/upper_distance** + ++----------+--------------------+ +| *Setter* | set_param_z(value) | ++----------+--------------------+ +| *Getter* | get_param_z() | ++----------+--------------------+ + +The maximum difference between the pivot points' z-axis. .. _class_Generic6DOFJoint_linear_motor_x/enabled: -- :ref:`bool` **linear_motor_x/enabled** - 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. +- :ref:`bool` **linear_motor_x/enabled** + ++----------+-------------------+ +| *Setter* | set_flag_x(value) | ++----------+-------------------+ +| *Getter* | get_flag_x() | ++----------+-------------------+ + +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: -- :ref:`float` **linear_motor_x/force_limit** - The maximum force the linear motor can apply on the x-axis while trying to reach the target velocity. +- :ref:`float` **linear_motor_x/force_limit** + ++----------+--------------------+ +| *Setter* | set_param_x(value) | ++----------+--------------------+ +| *Getter* | get_param_x() | ++----------+--------------------+ + +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: -- :ref:`float` **linear_motor_x/target_velocity** - The speed that the linear motor will attempt to reach on the x-axis. +- :ref:`float` **linear_motor_x/target_velocity** + ++----------+--------------------+ +| *Setter* | set_param_x(value) | ++----------+--------------------+ +| *Getter* | get_param_x() | ++----------+--------------------+ + +The speed that the linear motor will attempt to reach on the x-axis. .. _class_Generic6DOFJoint_linear_motor_y/enabled: -- :ref:`bool` **linear_motor_y/enabled** - 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. +- :ref:`bool` **linear_motor_y/enabled** + ++----------+-------------------+ +| *Setter* | set_flag_y(value) | ++----------+-------------------+ +| *Getter* | get_flag_y() | ++----------+-------------------+ + +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: -- :ref:`float` **linear_motor_y/force_limit** - The maximum force the linear motor can apply on the y-axis while trying to reach the target velocity. +- :ref:`float` **linear_motor_y/force_limit** + ++----------+--------------------+ +| *Setter* | set_param_y(value) | ++----------+--------------------+ +| *Getter* | get_param_y() | ++----------+--------------------+ + +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: -- :ref:`float` **linear_motor_y/target_velocity** - The speed that the linear motor will attempt to reach on the y-axis. +- :ref:`float` **linear_motor_y/target_velocity** + ++----------+--------------------+ +| *Setter* | set_param_y(value) | ++----------+--------------------+ +| *Getter* | get_param_y() | ++----------+--------------------+ + +The speed that the linear motor will attempt to reach on the y-axis. .. _class_Generic6DOFJoint_linear_motor_z/enabled: -- :ref:`bool` **linear_motor_z/enabled** - 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. +- :ref:`bool` **linear_motor_z/enabled** + ++----------+-------------------+ +| *Setter* | set_flag_z(value) | ++----------+-------------------+ +| *Getter* | get_flag_z() | ++----------+-------------------+ + +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: -- :ref:`float` **linear_motor_z/force_limit** - The maximum force the linear motor can apply on the z-axis while trying to reach the target velocity. +- :ref:`float` **linear_motor_z/force_limit** + ++----------+--------------------+ +| *Setter* | set_param_z(value) | ++----------+--------------------+ +| *Getter* | get_param_z() | ++----------+--------------------+ + +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: -- :ref:`float` **linear_motor_z/target_velocity** - The speed that the linear motor will attempt to reach on the z-axis. +- :ref:`float` **linear_motor_z/target_velocity** ++----------+--------------------+ +| *Setter* | set_param_z(value) | ++----------+--------------------+ +| *Getter* | get_param_z() | ++----------+--------------------+ + +The speed that the linear motor will attempt to reach on the z-axis. diff --git a/classes/class_geometry.rst b/classes/class_geometry.rst index c40fefc88..f84c16b8c 100644 --- a/classes/class_geometry.rst +++ b/classes/class_geometry.rst @@ -8,6 +8,7 @@ Geometry ======== **Inherits:** :ref:`Object` + **Category:** Core Brief Description @@ -69,140 +70,139 @@ Methods Method Descriptions ------------------- -.. _class_Geometry_build_box_planes: + .. _class_Geometry_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_build_capsule_planes: - :ref:`Array` **build_capsule_planes** **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, :ref:`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_build_cylinder_planes: - :ref:`Array` **build_cylinder_planes** **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`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_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_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_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_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_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_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_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_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_get_uv84_normal_bit: - :ref:`int` **get_uv84_normal_bit** **(** :ref:`Vector3` normal **)** -.. _class_Geometry_line_intersects_line_2d: + .. _class_Geometry_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_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_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_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_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_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_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_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_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_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_triangulate_polygon: - :ref:`PoolIntArray` **triangulate_polygon** **(** :ref:`PoolVector2Array` polygon **)** Triangulates the polygon specified by the points in ``polygon``. Returns a :ref:`PoolIntArray` where each triangle consists of three consecutive point indices into ``polygon`` (i.e. the returned array will have ``n * 3`` elements, with ``n`` being the number of found triangles). If the triangulation did not succeed, an empty :ref:`PoolIntArray` is returned. - diff --git a/classes/class_geometryinstance.rst b/classes/class_geometryinstance.rst index 39d4e2d91..367e6213d 100644 --- a/classes/class_geometryinstance.rst +++ b/classes/class_geometryinstance.rst @@ -8,7 +8,9 @@ GeometryInstance ================ **Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`MultiMeshInstance`, :ref:`Particles`, :ref:`MeshInstance`, :ref:`SpriteBase3D`, :ref:`ImmediateGeometry`, :ref:`CPUParticles` + **Category:** Core Brief Description @@ -16,12 +18,33 @@ Brief Description 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` | ++-------------------------------------------------------------------------+----------------------------------------------------------------------+ + Enumerations ------------ .. _enum_GeometryInstance_Flags: -enum **Flags** +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. @@ -30,7 +53,7 @@ Added documentation for GeometryInstance and VisualInstance .. _enum_GeometryInstance_ShadowCastingSetting: -enum **ShadowCastingSetting** +enum **ShadowCastingSetting**: - **SHADOW_CASTING_SETTING_OFF** = **0** --- Will not cast any shadows. - **SHADOW_CASTING_SETTING_ON** = **1** --- Will cast shadows from all visible faces in the GeometryInstance. @@ -43,7 +66,6 @@ Will not take culling into account, so all faces will be taken into account when In other words: The actual mesh will not be visible, only the shadows casted from the mesh. - Description ----------- @@ -54,36 +76,99 @@ Property Descriptions .. _class_GeometryInstance_cast_shadow: -- :ref:`ShadowCastingSetting` **cast_shadow** - The selected shadow casting flag. See SHADOW_CASTING_SETTING\_\* constants for values. +- :ref:`ShadowCastingSetting` **cast_shadow** + ++----------+---------------------------------+ +| *Setter* | set_cast_shadows_setting(value) | ++----------+---------------------------------+ +| *Getter* | get_cast_shadows_setting() | ++----------+---------------------------------+ + +The selected shadow casting flag. See SHADOW_CASTING_SETTING\_\* constants for values. .. _class_GeometryInstance_extra_cull_margin: -- :ref:`float` **extra_cull_margin** - The extra distance added to the GeometryInstance's bounding box (:ref:`AABB`) to increase its cull box. +- :ref:`float` **extra_cull_margin** + ++----------+------------------------------+ +| *Setter* | set_extra_cull_margin(value) | ++----------+------------------------------+ +| *Getter* | get_extra_cull_margin() | ++----------+------------------------------+ + +The extra distance added to the GeometryInstance's bounding box (:ref:`AABB`) to increase its cull box. .. _class_GeometryInstance_lod_max_distance: -- :ref:`float` **lod_max_distance** - The GeometryInstance's max LOD distance. +- :ref:`float` **lod_max_distance** + ++----------+-----------------------------+ +| *Setter* | set_lod_max_distance(value) | ++----------+-----------------------------+ +| *Getter* | get_lod_max_distance() | ++----------+-----------------------------+ + +The GeometryInstance's max LOD distance. .. _class_GeometryInstance_lod_max_hysteresis: -- :ref:`float` **lod_max_hysteresis** - The GeometryInstance's max LOD margin. +- :ref:`float` **lod_max_hysteresis** + ++----------+-------------------------------+ +| *Setter* | set_lod_max_hysteresis(value) | ++----------+-------------------------------+ +| *Getter* | get_lod_max_hysteresis() | ++----------+-------------------------------+ + +The GeometryInstance's max LOD margin. .. _class_GeometryInstance_lod_min_distance: -- :ref:`float` **lod_min_distance** - The GeometryInstance's min LOD distance. +- :ref:`float` **lod_min_distance** + ++----------+-----------------------------+ +| *Setter* | set_lod_min_distance(value) | ++----------+-----------------------------+ +| *Getter* | get_lod_min_distance() | ++----------+-----------------------------+ + +The GeometryInstance's min LOD distance. .. _class_GeometryInstance_lod_min_hysteresis: -- :ref:`float` **lod_min_hysteresis** - The GeometryInstance's min LOD margin. +- :ref:`float` **lod_min_hysteresis** + ++----------+-------------------------------+ +| *Setter* | set_lod_min_hysteresis(value) | ++----------+-------------------------------+ +| *Getter* | get_lod_min_hysteresis() | ++----------+-------------------------------+ + +The GeometryInstance's min LOD margin. .. _class_GeometryInstance_material_override: -- :ref:`Material` **material_override** - The material override for the whole geometry. +- :ref:`Material` **material_override** + ++----------+------------------------------+ +| *Setter* | set_material_override(value) | ++----------+------------------------------+ +| *Getter* | get_material_override() | ++----------+------------------------------+ + +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: -- :ref:`bool` **use_in_baked_light** - If ``true`` this GeometryInstance will be used when baking lights using a :ref:`GIProbe` and/or any other form of baked lighting. +- :ref:`bool` **use_in_baked_light** ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ + +If ``true`` this GeometryInstance will be used when baking lights using a :ref:`GIProbe` and/or any other form of baked lighting. diff --git a/classes/class_giprobe.rst b/classes/class_giprobe.rst index 914732149..e984645ee 100644 --- a/classes/class_giprobe.rst +++ b/classes/class_giprobe.rst @@ -8,6 +8,7 @@ GIProbe ======= **Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,31 @@ 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` | ++---------------------------------------+---------------------------------------------------+ + Methods ------- @@ -29,7 +55,7 @@ Enumerations .. _enum_GIProbe_Subdiv: -enum **Subdiv** +enum **Subdiv**: - **SUBDIV_64** = **0** - **SUBDIV_128** = **1** @@ -37,12 +63,10 @@ enum **Subdiv** - **SUBDIV_512** = **3** - **SUBDIV_MAX** = **4** - Tutorials --------- - :doc:`../tutorials/3d/gi_probes` - Property Descriptions --------------------- @@ -50,52 +74,110 @@ Property Descriptions - :ref:`float` **bias** ++----------+-----------------+ +| *Setter* | set_bias(value) | ++----------+-----------------+ +| *Getter* | get_bias() | ++----------+-----------------+ + .. _class_GIProbe_compress: - :ref:`bool` **compress** ++----------+---------------------+ +| *Setter* | set_compress(value) | ++----------+---------------------+ +| *Getter* | is_compressed() | ++----------+---------------------+ + .. _class_GIProbe_data: - :ref:`GIProbeData` **data** ++----------+-----------------------+ +| *Setter* | set_probe_data(value) | ++----------+-----------------------+ +| *Getter* | get_probe_data() | ++----------+-----------------------+ + .. _class_GIProbe_dynamic_range: - :ref:`int` **dynamic_range** ++----------+--------------------------+ +| *Setter* | set_dynamic_range(value) | ++----------+--------------------------+ +| *Getter* | get_dynamic_range() | ++----------+--------------------------+ + .. _class_GIProbe_energy: - :ref:`float` **energy** ++----------+-------------------+ +| *Setter* | set_energy(value) | ++----------+-------------------+ +| *Getter* | get_energy() | ++----------+-------------------+ + .. _class_GIProbe_extents: - :ref:`Vector3` **extents** ++----------+--------------------+ +| *Setter* | set_extents(value) | ++----------+--------------------+ +| *Getter* | get_extents() | ++----------+--------------------+ + .. _class_GIProbe_interior: - :ref:`bool` **interior** ++----------+---------------------+ +| *Setter* | set_interior(value) | ++----------+---------------------+ +| *Getter* | is_interior() | ++----------+---------------------+ + .. _class_GIProbe_normal_bias: - :ref:`float` **normal_bias** ++----------+------------------------+ +| *Setter* | set_normal_bias(value) | ++----------+------------------------+ +| *Getter* | get_normal_bias() | ++----------+------------------------+ + .. _class_GIProbe_propagation: - :ref:`float` **propagation** ++----------+------------------------+ +| *Setter* | set_propagation(value) | ++----------+------------------------+ +| *Getter* | get_propagation() | ++----------+------------------------+ + .. _class_GIProbe_subdiv: - :ref:`Subdiv` **subdiv** ++----------+-------------------+ +| *Setter* | set_subdiv(value) | ++----------+-------------------+ +| *Getter* | get_subdiv() | ++----------+-------------------+ Method Descriptions ------------------- -.. _class_GIProbe_bake: + .. _class_GIProbe_bake: - void **bake** **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** -.. _class_GIProbe_debug_bake: + .. _class_GIProbe_debug_bake: - void **debug_bake** **(** **)** - diff --git a/classes/class_giprobedata.rst b/classes/class_giprobedata.rst index 281bb2899..c7e8a9466 100644 --- a/classes/class_giprobedata.rst +++ b/classes/class_giprobedata.rst @@ -8,6 +8,7 @@ GIProbeData =========== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,33 @@ 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` | ++-----------------------------------------+-------------------------------------------------------+ + Property Descriptions --------------------- @@ -22,44 +50,109 @@ Property Descriptions - :ref:`float` **bias** ++----------+-----------------+ +| *Setter* | set_bias(value) | ++----------+-----------------+ +| *Getter* | get_bias() | ++----------+-----------------+ + .. _class_GIProbeData_bounds: - :ref:`AABB` **bounds** ++----------+-------------------+ +| *Setter* | set_bounds(value) | ++----------+-------------------+ +| *Getter* | get_bounds() | ++----------+-------------------+ + .. _class_GIProbeData_cell_size: - :ref:`float` **cell_size** ++----------+----------------------+ +| *Setter* | set_cell_size(value) | ++----------+----------------------+ +| *Getter* | get_cell_size() | ++----------+----------------------+ + .. _class_GIProbeData_compress: - :ref:`bool` **compress** ++----------+---------------------+ +| *Setter* | set_compress(value) | ++----------+---------------------+ +| *Getter* | is_compressed() | ++----------+---------------------+ + .. _class_GIProbeData_dynamic_data: - :ref:`PoolIntArray` **dynamic_data** ++----------+-------------------------+ +| *Setter* | set_dynamic_data(value) | ++----------+-------------------------+ +| *Getter* | get_dynamic_data() | ++----------+-------------------------+ + .. _class_GIProbeData_dynamic_range: - :ref:`int` **dynamic_range** ++----------+--------------------------+ +| *Setter* | set_dynamic_range(value) | ++----------+--------------------------+ +| *Getter* | get_dynamic_range() | ++----------+--------------------------+ + .. _class_GIProbeData_energy: - :ref:`float` **energy** ++----------+-------------------+ +| *Setter* | set_energy(value) | ++----------+-------------------+ +| *Getter* | get_energy() | ++----------+-------------------+ + .. _class_GIProbeData_interior: - :ref:`bool` **interior** ++----------+---------------------+ +| *Setter* | set_interior(value) | ++----------+---------------------+ +| *Getter* | is_interior() | ++----------+---------------------+ + .. _class_GIProbeData_normal_bias: - :ref:`float` **normal_bias** ++----------+------------------------+ +| *Setter* | set_normal_bias(value) | ++----------+------------------------+ +| *Getter* | get_normal_bias() | ++----------+------------------------+ + .. _class_GIProbeData_propagation: - :ref:`float` **propagation** ++----------+------------------------+ +| *Setter* | set_propagation(value) | ++----------+------------------------+ +| *Getter* | get_propagation() | ++----------+------------------------+ + .. _class_GIProbeData_to_cell_xform: - :ref:`Transform` **to_cell_xform** ++----------+--------------------------+ +| *Setter* | set_to_cell_xform(value) | ++----------+--------------------------+ +| *Getter* | get_to_cell_xform() | ++----------+--------------------------+ diff --git a/classes/class_godotsharp.rst b/classes/class_godotsharp.rst index 124712240..a2bce4bfb 100644 --- a/classes/class_godotsharp.rst +++ b/classes/class_godotsharp.rst @@ -8,6 +8,7 @@ GodotSharp ========== **Inherits:** :ref:`Object` + **Category:** Core Brief Description @@ -31,28 +32,27 @@ Methods Method Descriptions ------------------- -.. _class_GodotSharp_attach_thread: + .. _class_GodotSharp_attach_thread: - void **attach_thread** **(** **)** Attaches the current thread to the mono runtime. -.. _class_GodotSharp_detach_thread: + .. _class_GodotSharp_detach_thread: - void **detach_thread** **(** **)** Detaches the current thread from the mono runtime. -.. _class_GodotSharp_is_domain_loaded: + .. _class_GodotSharp_is_domain_loaded: - :ref:`bool` **is_domain_loaded** **(** **)** Returns whether the scripts domain is loaded. -.. _class_GodotSharp_is_finalizing_domain: + .. _class_GodotSharp_is_finalizing_domain: - :ref:`bool` **is_finalizing_domain** **(** **)** Returns whether the scripts domain is being finalized. - diff --git a/classes/class_gradient.rst b/classes/class_gradient.rst index 31edecbe7..256c89860 100644 --- a/classes/class_gradient.rst +++ b/classes/class_gradient.rst @@ -8,6 +8,7 @@ Gradient ======== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description Color interpolator node. +Properties +---------- + ++---------------------------------------------+----------------------------------------+ +| :ref:`PoolColorArray` | :ref:`colors` | ++---------------------------------------------+----------------------------------------+ +| :ref:`PoolRealArray` | :ref:`offsets` | ++---------------------------------------------+----------------------------------------+ + Methods ------- @@ -46,62 +56,76 @@ Property Descriptions .. _class_Gradient_colors: -- :ref:`PoolColorArray` **colors** - Gradient's colors returned as a :ref:`PoolColorArray`. +- :ref:`PoolColorArray` **colors** + ++----------+-------------------+ +| *Setter* | set_colors(value) | ++----------+-------------------+ +| *Getter* | get_colors() | ++----------+-------------------+ + +Gradient's colors returned as a :ref:`PoolColorArray`. .. _class_Gradient_offsets: -- :ref:`PoolRealArray` **offsets** - Gradient's offsets returned as a :ref:`PoolRealArray`. +- :ref:`PoolRealArray` **offsets** ++----------+--------------------+ +| *Setter* | set_offsets(value) | ++----------+--------------------+ +| *Getter* | get_offsets() | ++----------+--------------------+ + +Gradient's offsets returned as a :ref:`PoolRealArray`. Method Descriptions ------------------- -.. _class_Gradient_add_point: + .. _class_Gradient_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_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_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_get_point_count: - :ref:`int` **get_point_count** **(** **)** const Returns the number of colors in the ramp -.. _class_Gradient_interpolate: + .. _class_Gradient_interpolate: - :ref:`Color` **interpolate** **(** :ref:`float` offset **)** Returns the interpolated color specified by *offset* -.. _class_Gradient_remove_point: + .. _class_Gradient_remove_point: - void **remove_point** **(** :ref:`int` offset **)** Removes the color at the index *offset* -.. _class_Gradient_set_color: + .. _class_Gradient_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_set_offset: - void **set_offset** **(** :ref:`int` point, :ref:`float` offset **)** Sets the offset for the ramp color at index *point* - diff --git a/classes/class_gradienttexture.rst b/classes/class_gradienttexture.rst index 8493dd9f4..94e02867d 100644 --- a/classes/class_gradienttexture.rst +++ b/classes/class_gradienttexture.rst @@ -8,6 +8,7 @@ GradientTexture =============== **Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description Gradient filled texture. +Properties +---------- + ++---------------------------------+-------------------------------------------------+ +| :ref:`Gradient` | :ref:`gradient` | ++---------------------------------+-------------------------------------------------+ +| :ref:`int` | :ref:`width` | ++---------------------------------+-------------------------------------------------+ + Description ----------- @@ -25,10 +35,25 @@ Property Descriptions .. _class_GradientTexture_gradient: -- :ref:`Gradient` **gradient** - The :ref:`Gradient` that will be used to fill the texture. +- :ref:`Gradient` **gradient** + ++----------+---------------------+ +| *Setter* | set_gradient(value) | ++----------+---------------------+ +| *Getter* | get_gradient() | ++----------+---------------------+ + +The :ref:`Gradient` that will be used to fill the texture. .. _class_GradientTexture_width: -- :ref:`int` **width** - The number of color samples that will be obtained from the :ref:`Gradient`. +- :ref:`int` **width** ++----------+------------------+ +| *Setter* | set_width(value) | ++----------+------------------+ +| *Getter* | get_width() | ++----------+------------------+ + +The number of color samples that will be obtained from the :ref:`Gradient`. diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index 35201fa2a..65d0da3ca 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -8,6 +8,7 @@ GraphEdit ========= **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,21 @@ Brief Description GraphEdit is an area capable of showing various GraphNodes. It manages connection events between them. +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` | ++-------------------------------+-------------------------------------------------------------+ + Methods ------- @@ -50,66 +66,94 @@ Methods | 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` | ++---------------------------------+-------------------------------------------------------------------------------------+ + Signals ------- -.. _class_GraphEdit__begin_node_move: + .. _class_GraphEdit__begin_node_move: - **_begin_node_move** **(** **)** Signal sent at the beginning of a GraphNode movement. -.. _class_GraphEdit__end_node_move: + .. _class_GraphEdit__end_node_move: - **_end_node_move** **(** **)** Signal sent at the end of a GraphNode movement. -.. _class_GraphEdit_connection_request: + .. _class_GraphEdit_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_connection_to_empty: - **connection_to_empty** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`Vector2` release_position **)** -.. _class_GraphEdit_delete_nodes_request: + .. _class_GraphEdit_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_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_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_node_selected: - **node_selected** **(** :ref:`Node` node **)** Emitted when a GraphNode is selected. -.. _class_GraphEdit_popup_request: + .. _class_GraphEdit_popup_request: - **popup_request** **(** :ref:`Vector2` p_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_scroll_offset_changed: - **scroll_offset_changed** **(** :ref:`Vector2` ofs **)** - Description ----------- @@ -122,112 +166,150 @@ Property Descriptions .. _class_GraphEdit_right_disconnects: -- :ref:`bool` **right_disconnects** - If ``true``, enables disconnection of existing connections in the GraphEdit by dragging the right end. +- :ref:`bool` **right_disconnects** + ++----------+--------------------------------+ +| *Setter* | set_right_disconnects(value) | ++----------+--------------------------------+ +| *Getter* | is_right_disconnects_enabled() | ++----------+--------------------------------+ + +If ``true``, enables disconnection of existing connections in the GraphEdit by dragging the right end. .. _class_GraphEdit_scroll_offset: -- :ref:`Vector2` **scroll_offset** - The scroll offset. +- :ref:`Vector2` **scroll_offset** + ++----------+-----------------------+ +| *Setter* | set_scroll_ofs(value) | ++----------+-----------------------+ +| *Getter* | get_scroll_ofs() | ++----------+-----------------------+ + +The scroll offset. .. _class_GraphEdit_snap_distance: -- :ref:`int` **snap_distance** - The snapping distance in pixels. +- :ref:`int` **snap_distance** + ++----------+-----------------+ +| *Setter* | set_snap(value) | ++----------+-----------------+ +| *Getter* | get_snap() | ++----------+-----------------+ + +The snapping distance in pixels. .. _class_GraphEdit_use_snap: -- :ref:`bool` **use_snap** - If ``true``, enables snapping. +- :ref:`bool` **use_snap** + ++----------+---------------------+ +| *Setter* | set_use_snap(value) | ++----------+---------------------+ +| *Getter* | is_using_snap() | ++----------+---------------------+ + +If ``true``, enables snapping. .. _class_GraphEdit_zoom: -- :ref:`float` **zoom** - The current zoom value. +- :ref:`float` **zoom** ++----------+-----------------+ +| *Setter* | set_zoom(value) | ++----------+-----------------+ +| *Getter* | get_zoom() | ++----------+-----------------+ + +The current zoom value. Method Descriptions ------------------- -.. _class_GraphEdit_add_valid_connection_type: + .. _class_GraphEdit_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. -.. _class_GraphEdit_add_valid_left_disconnect_type: + .. _class_GraphEdit_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_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_clear_connections: - void **clear_connections** **(** **)** Remove all connections between nodes. -.. _class_GraphEdit_connect_node: + .. _class_GraphEdit_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_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_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_slot: 0, from: "GraphNode name 0", to_slot: 1, to: "GraphNode name 1" } -.. _class_GraphEdit_get_zoom_hbox: + .. _class_GraphEdit_get_zoom_hbox: - :ref:`HBoxContainer` **get_zoom_hbox** **(** **)** -.. _class_GraphEdit_is_node_connected: + .. _class_GraphEdit_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_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_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. -.. _class_GraphEdit_remove_valid_left_disconnect_type: + .. _class_GraphEdit_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_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_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_set_selected: - void **set_selected** **(** :ref:`Node` node **)** Sets the specified ``node`` as the one selected. - diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index 7947eb338..24650316d 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -8,6 +8,7 @@ GraphNode ========= **Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,25 @@ Brief Description A GraphNode is a container with several input and output slots allowing connections between GraphNodes. Slots can have different, incompatible types. +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` | ++----------------------------------------+-----------------------------------------------+ + Methods ------- @@ -54,50 +74,87 @@ Methods | 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:`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` | ++---------------------------------+-----------------------------------------------------+ + Signals ------- -.. _class_GraphNode_close_request: + .. _class_GraphNode_close_request: - **close_request** **(** **)** Signal sent on closing the GraphNode. -.. _class_GraphNode_dragged: + .. _class_GraphNode_dragged: - **dragged** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** Signal sent when the GraphNode is dragged. -.. _class_GraphNode_offset_changed: + .. _class_GraphNode_offset_changed: - **offset_changed** **(** **)** Signal sent when the GraphNode is moved. -.. _class_GraphNode_raise_request: + .. _class_GraphNode_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_resize_request: - **resize_request** **(** :ref:`Vector2` new_minsize **)** - Enumerations ------------ .. _enum_GraphNode_Overlay: -enum **Overlay** +enum **Overlay**: - **OVERLAY_DISABLED** = **0** - **OVERLAY_BREAKPOINT** = **1** - **OVERLAY_POSITION** = **2** - Description ----------- @@ -110,132 +167,174 @@ Property Descriptions - :ref:`bool` **comment** ++----------+--------------------+ +| *Setter* | set_comment(value) | ++----------+--------------------+ +| *Getter* | is_comment() | ++----------+--------------------+ + .. _class_GraphNode_offset: -- :ref:`Vector2` **offset** - 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`. +- :ref:`Vector2` **offset** + ++----------+-------------------+ +| *Setter* | set_offset(value) | ++----------+-------------------+ +| *Getter* | get_offset() | ++----------+-------------------+ + +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: - :ref:`Overlay` **overlay** ++----------+--------------------+ +| *Setter* | set_overlay(value) | ++----------+--------------------+ +| *Getter* | get_overlay() | ++----------+--------------------+ + .. _class_GraphNode_resizable: - :ref:`bool` **resizable** ++----------+----------------------+ +| *Setter* | set_resizable(value) | ++----------+----------------------+ +| *Getter* | is_resizable() | ++----------+----------------------+ + .. _class_GraphNode_selected: - :ref:`bool` **selected** ++----------+---------------------+ +| *Setter* | set_selected(value) | ++----------+---------------------+ +| *Getter* | is_selected() | ++----------+---------------------+ + .. _class_GraphNode_show_close: - :ref:`bool` **show_close** ++----------+------------------------------+ +| *Setter* | set_show_close_button(value) | ++----------+------------------------------+ +| *Getter* | is_close_button_visible() | ++----------+------------------------------+ + .. _class_GraphNode_title: - :ref:`String` **title** ++----------+------------------+ +| *Setter* | set_title(value) | ++----------+------------------+ +| *Getter* | get_title() | ++----------+------------------+ Method Descriptions ------------------- -.. _class_GraphNode_clear_all_slots: + .. _class_GraphNode_clear_all_slots: - void **clear_all_slots** **(** **)** Disable all input and output slots of the GraphNode. -.. _class_GraphNode_clear_slot: + .. _class_GraphNode_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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 4f96bfe9b..bd4156069 100644 --- a/classes/class_gridcontainer.rst +++ b/classes/class_gridcontainer.rst @@ -8,6 +8,7 @@ GridContainer ============= **Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Grid container used to arrange elements in a grid like layout. +Properties +---------- + ++-----------------------+---------------------------------------------+ +| :ref:`int` | :ref:`columns` | ++-----------------------+---------------------------------------------+ + Methods ------- @@ -22,6 +30,15 @@ Methods | :ref:`Control` | :ref:`get_child_control_at_cell` **(** :ref:`int` row, :ref:`int` column **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +Theme Properties +---------------- + ++-----------------------+-----------------------------------------------------+ +| :ref:`int` | :ref:`hseparation` | ++-----------------------+-----------------------------------------------------+ +| :ref:`int` | :ref:`vseparation` | ++-----------------------+-----------------------------------------------------+ + Description ----------- @@ -32,14 +49,20 @@ Property Descriptions .. _class_GridContainer_columns: -- :ref:`int` **columns** - The number of columns in the ``GridContainer``. If modified, ``GridContainer`` reorders its children to accommodate the new layout. +- :ref:`int` **columns** ++----------+--------------------+ +| *Setter* | set_columns(value) | ++----------+--------------------+ +| *Getter* | get_columns() | ++----------+--------------------+ + +The number of columns in the ``GridContainer``. If modified, ``GridContainer`` reorders its children to accommodate the new layout. Method Descriptions ------------------- -.. _class_GridContainer_get_child_control_at_cell: + .. _class_GridContainer_get_child_control_at_cell: - :ref:`Control` **get_child_control_at_cell** **(** :ref:`int` row, :ref:`int` column **)** - diff --git a/classes/class_gridmap.rst b/classes/class_gridmap.rst index a14d25d1b..e94f31612 100644 --- a/classes/class_gridmap.rst +++ b/classes/class_gridmap.rst @@ -8,6 +8,7 @@ GridMap ======= **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,31 @@ Brief Description 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` | ++---------------------------------------+---------------------------------------------------------+ + Methods ------- @@ -60,7 +86,6 @@ 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`). - Description ----------- @@ -76,117 +101,189 @@ Tutorials --------- - :doc:`../tutorials/3d/using_gridmaps` - Property Descriptions --------------------- .. _class_GridMap_cell_center_x: -- :ref:`bool` **cell_center_x** - If ``true`` grid items are centered on the X axis. +- :ref:`bool` **cell_center_x** + ++----------+---------------------+ +| *Setter* | set_center_x(value) | ++----------+---------------------+ +| *Getter* | get_center_x() | ++----------+---------------------+ + +If ``true`` grid items are centered on the X axis. .. _class_GridMap_cell_center_y: -- :ref:`bool` **cell_center_y** - If ``true`` grid items are centered on the Y axis. +- :ref:`bool` **cell_center_y** + ++----------+---------------------+ +| *Setter* | set_center_y(value) | ++----------+---------------------+ +| *Getter* | get_center_y() | ++----------+---------------------+ + +If ``true`` grid items are centered on the Y axis. .. _class_GridMap_cell_center_z: -- :ref:`bool` **cell_center_z** - If ``true`` grid items are centered on the Z axis. +- :ref:`bool` **cell_center_z** + ++----------+---------------------+ +| *Setter* | set_center_z(value) | ++----------+---------------------+ +| *Getter* | get_center_z() | ++----------+---------------------+ + +If ``true`` grid items are centered on the Z axis. .. _class_GridMap_cell_octant_size: -- :ref:`int` **cell_octant_size** - The size of each octant measured in number of cells. This applies to all three axis. +- :ref:`int` **cell_octant_size** + ++----------+------------------------+ +| *Setter* | set_octant_size(value) | ++----------+------------------------+ +| *Getter* | get_octant_size() | ++----------+------------------------+ + +The size of each octant measured in number of cells. This applies to all three axis. .. _class_GridMap_cell_scale: - :ref:`float` **cell_scale** ++----------+-----------------------+ +| *Setter* | set_cell_scale(value) | ++----------+-----------------------+ +| *Getter* | get_cell_scale() | ++----------+-----------------------+ + .. _class_GridMap_cell_size: -- :ref:`Vector3` **cell_size** - The dimensions of the grid's cells. +- :ref:`Vector3` **cell_size** + ++----------+----------------------+ +| *Setter* | set_cell_size(value) | ++----------+----------------------+ +| *Getter* | get_cell_size() | ++----------+----------------------+ + +The dimensions of the grid's cells. .. _class_GridMap_collision_layer: - :ref:`int` **collision_layer** ++----------+----------------------------+ +| *Setter* | set_collision_layer(value) | ++----------+----------------------------+ +| *Getter* | get_collision_layer() | ++----------+----------------------------+ + .. _class_GridMap_collision_mask: - :ref:`int` **collision_mask** ++----------+---------------------------+ +| *Setter* | set_collision_mask(value) | ++----------+---------------------------+ +| *Getter* | get_collision_mask() | ++----------+---------------------------+ + .. _class_GridMap_mesh_library: -- :ref:`MeshLibrary` **mesh_library** - The assigned :ref:`MeshLibrary`. +- :ref:`MeshLibrary` **mesh_library** + ++----------+-------------------------+ +| *Setter* | set_mesh_library(value) | ++----------+-------------------------+ +| *Getter* | get_mesh_library() | ++----------+-------------------------+ + +The assigned :ref:`MeshLibrary`. .. _class_GridMap_theme: -- :ref:`MeshLibrary` **theme** - Deprecated, use :ref:`mesh_library` instead. +- :ref:`MeshLibrary` **theme** ++----------+------------------+ +| *Setter* | set_theme(value) | ++----------+------------------+ +| *Getter* | get_theme() | ++----------+------------------+ + +Deprecated, use :ref:`mesh_library` instead. Method Descriptions ------------------- -.. _class_GridMap_clear: + .. _class_GridMap_clear: - void **clear** **(** **)** Clear all cells. -.. _class_GridMap_clear_baked_meshes: + .. _class_GridMap_clear_baked_meshes: - void **clear_baked_meshes** **(** **)** -.. _class_GridMap_get_bake_mesh_instance: + .. _class_GridMap_get_bake_mesh_instance: - :ref:`RID` **get_bake_mesh_instance** **(** :ref:`int` idx **)** -.. _class_GridMap_get_bake_meshes: + .. _class_GridMap_get_bake_meshes: - :ref:`Array` **get_bake_meshes** **(** **)** -.. _class_GridMap_get_cell_item: + .. _class_GridMap_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, INVALID_CELL_ITEM will be returned. -.. _class_GridMap_get_cell_item_orientation: + .. _class_GridMap_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 retuned if the cell is empty. +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_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const -.. _class_GridMap_get_collision_mask_bit: + .. _class_GridMap_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const -.. _class_GridMap_get_meshes: + .. _class_GridMap_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_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_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_map_to_world: - :ref:`Vector3` **map_to_world** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const -.. _class_GridMap_resource_changed: + .. _class_GridMap_resource_changed: - void **resource_changed** **(** :ref:`Resource` resource **)** -.. _class_GridMap_set_cell_item: + .. _class_GridMap_set_cell_item: - void **set_cell_item** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` item, :ref:`int` orientation=0 **)** @@ -196,20 +293,19 @@ A negative item index will clear the cell. Optionally, the item's orientation can be passed. -.. _class_GridMap_set_clip: + .. _class_GridMap_set_clip: - void **set_clip** **(** :ref:`bool` enabled, :ref:`bool` clipabove=true, :ref:`int` floor=0, :ref:`Axis` axis=0 **)** -.. _class_GridMap_set_collision_layer_bit: + .. _class_GridMap_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** -.. _class_GridMap_set_collision_mask_bit: + .. _class_GridMap_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** -.. _class_GridMap_world_to_map: + .. _class_GridMap_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 de30d65e5..13be9f83e 100644 --- a/classes/class_groovejoint2d.rst +++ b/classes/class_groovejoint2d.rst @@ -8,6 +8,7 @@ GrooveJoint2D ============= **Inherits:** :ref:`Joint2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description Groove constraint for 2D physics. +Properties +---------- + ++---------------------------+-----------------------------------------------------------+ +| :ref:`float` | :ref:`initial_offset` | ++---------------------------+-----------------------------------------------------------+ +| :ref:`float` | :ref:`length` | ++---------------------------+-----------------------------------------------------------+ + Description ----------- @@ -25,10 +35,25 @@ Property Descriptions .. _class_GrooveJoint2D_initial_offset: -- :ref:`float` **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`` +- :ref:`float` **initial_offset** + ++----------+---------------------------+ +| *Setter* | set_initial_offset(value) | ++----------+---------------------------+ +| *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`` .. _class_GrooveJoint2D_length: -- :ref:`float` **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`` +- :ref:`float` **length** ++----------+-------------------+ +| *Setter* | set_length(value) | ++----------+-------------------+ +| *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`` diff --git a/classes/class_hboxcontainer.rst b/classes/class_hboxcontainer.rst index e5ed770b4..d2225a6b3 100644 --- a/classes/class_hboxcontainer.rst +++ b/classes/class_hboxcontainer.rst @@ -8,6 +8,7 @@ HBoxContainer ============= **Inherits:** :ref:`BoxContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Horizontal box container. +Theme Properties +---------------- + ++-----------------------+---------------------------------------------------+ +| :ref:`int` | :ref:`separation` | ++-----------------------+---------------------------------------------------+ + Description ----------- diff --git a/classes/class_hingejoint.rst b/classes/class_hingejoint.rst index c819bae6f..c25c91c2e 100644 --- a/classes/class_hingejoint.rst +++ b/classes/class_hingejoint.rst @@ -8,6 +8,7 @@ HingeJoint ========== **Inherits:** :ref:`Joint` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,12 +16,37 @@ Brief Description 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` | ++---------------------------+----------------------------------------------------------------------------+ + Enumerations ------------ .. _enum_HingeJoint_Flag: -enum **Flag** +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_ENABLE_MOTOR** = **1** --- When activated, a motor turns the hinge. @@ -28,7 +54,7 @@ enum **Flag** .. _enum_HingeJoint_Param: -enum **Param** +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``. @@ -40,7 +66,6 @@ enum **Param** - **PARAM_MOTOR_MAX_IMPULSE** = **7** --- Maximum acceleration for the motor. - **PARAM_MAX** = **8** --- End flag of PARAM\_\* constants, used internally. - Description ----------- @@ -51,42 +76,107 @@ Property Descriptions .. _class_HingeJoint_angular_limit/bias: -- :ref:`float` **angular_limit/bias** - The speed with which the rotation across the axis perpendicular to the hinge gets corrected. +- :ref:`float` **angular_limit/bias** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +The speed with which the rotation across the axis perpendicular to the hinge gets corrected. .. _class_HingeJoint_angular_limit/enable: -- :ref:`bool` **angular_limit/enable** - If ``true`` the hinges maximum and minimum rotation, defined by :ref:`angular_limit/lower` and :ref:`angular_limit/upper` has effects. +- :ref:`bool` **angular_limit/enable** + ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ + +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: -- :ref:`float` **angular_limit/lower** - The minimum rotation. only active if :ref:`angular_limit/enable` is ``true``. +- :ref:`float` **angular_limit/lower** + +The minimum rotation. only active if :ref:`angular_limit/enable` is ``true``. .. _class_HingeJoint_angular_limit/relaxation: -- :ref:`float` **angular_limit/relaxation** - The lower this value, the more the rotation gets slowed down. +- :ref:`float` **angular_limit/relaxation** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +The lower this value, the more the rotation gets slowed down. .. _class_HingeJoint_angular_limit/softness: - :ref:`float` **angular_limit/softness** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + .. _class_HingeJoint_angular_limit/upper: -- :ref:`float` **angular_limit/upper** - The maximum rotation. only active if :ref:`angular_limit/enable` is ``true``. +- :ref:`float` **angular_limit/upper** + +The maximum rotation. only active if :ref:`angular_limit/enable` is ``true``. .. _class_HingeJoint_motor/enable: -- :ref:`bool` **motor/enable** - When activated, a motor turns the hinge. +- :ref:`bool` **motor/enable** + ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ + +When activated, a motor turns the hinge. .. _class_HingeJoint_motor/max_impulse: -- :ref:`float` **motor/max_impulse** - Maximum acceleration for the motor. +- :ref:`float` **motor/max_impulse** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +Maximum acceleration for the motor. .. _class_HingeJoint_motor/target_velocity: -- :ref:`float` **motor/target_velocity** - Target speed for the motor. +- :ref:`float` **motor/target_velocity** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +Target speed for the motor. .. _class_HingeJoint_params/bias: -- :ref:`float` **params/bias** - The speed with which the two bodies get pulled together when they move in different directions. +- :ref:`float` **params/bias** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +The speed with which the two bodies get pulled together when they move in different directions. diff --git a/classes/class_hscrollbar.rst b/classes/class_hscrollbar.rst index 6643b0f6d..674e1b039 100644 --- a/classes/class_hscrollbar.rst +++ b/classes/class_hscrollbar.rst @@ -8,6 +8,7 @@ HScrollBar ========== **Inherits:** :ref:`ScrollBar` **<** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,29 @@ Brief Description 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` | ++---------------------------------+------------------------------------------------------------------+ + Description ----------- diff --git a/classes/class_hseparator.rst b/classes/class_hseparator.rst index 8d09d5855..79c9a860a 100644 --- a/classes/class_hseparator.rst +++ b/classes/class_hseparator.rst @@ -8,6 +8,7 @@ HSeparator ========== **Inherits:** :ref:`Separator` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description Horizontal separator. +Theme Properties +---------------- + ++---------------------------------+------------------------------------------------+ +| :ref:`int` | :ref:`separation` | ++---------------------------------+------------------------------------------------+ +| :ref:`StyleBox` | :ref:`separator` | ++---------------------------------+------------------------------------------------+ + Description ----------- diff --git a/classes/class_hslider.rst b/classes/class_hslider.rst index 89265490c..30a1f4d45 100644 --- a/classes/class_hslider.rst +++ b/classes/class_hslider.rst @@ -8,6 +8,7 @@ HSlider ======= **Inherits:** :ref:`Slider` **<** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,29 @@ Brief Description 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` | ++---------------------------------+-----------------------------------------------------------+ + Description ----------- diff --git a/classes/class_hsplitcontainer.rst b/classes/class_hsplitcontainer.rst index a797c26f5..5b62e36c0 100644 --- a/classes/class_hsplitcontainer.rst +++ b/classes/class_hsplitcontainer.rst @@ -8,6 +8,7 @@ HSplitContainer =============== **Inherits:** :ref:`SplitContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,19 @@ Brief Description Horizontal split container. +Theme Properties +---------------- + ++---------------------------------+-----------------------------------------------------+ +| :ref:`int` | :ref:`autohide` | ++---------------------------------+-----------------------------------------------------+ +| :ref:`StyleBox` | :ref:`bg` | ++---------------------------------+-----------------------------------------------------+ +| :ref:`Texture` | :ref:`grabber` | ++---------------------------------+-----------------------------------------------------+ +| :ref:`int` | :ref:`separation` | ++---------------------------------+-----------------------------------------------------+ + Description ----------- diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index 51f252a43..a9202e11e 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -8,6 +8,7 @@ HTTPClient ========== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description Hyper-text transfer protocol client. +Properties +---------- + ++-------------------------------------+----------------------------------------------------------------------+ +| :ref:`bool` | :ref:`blocking_mode_enabled` | ++-------------------------------------+----------------------------------------------------------------------+ +| :ref:`StreamPeer` | :ref:`connection` | ++-------------------------------------+----------------------------------------------------------------------+ + Methods ------- @@ -55,7 +65,7 @@ Enumerations .. _enum_HTTPClient_Status: -enum **Status** +enum **Status**: - **STATUS_DISCONNECTED** = **0** --- Status: Disconnected from the server. - **STATUS_RESOLVING** = **1** --- Status: Currently resolving the hostname for the given URL into an IP. @@ -70,7 +80,7 @@ enum **Status** .. _enum_HTTPClient_Method: -enum **Method** +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. - **METHOD_HEAD** = **1** --- HTTP HEAD method. The HEAD method asks for a response identical to that of a GET request, but without the response body. This is useful to request metadata like HTTP headers or to check if a resource exists. @@ -85,7 +95,7 @@ enum **Method** .. _enum_HTTPClient_ResponseCode: -enum **ResponseCode** +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). - **RESPONSE_SWITCHING_PROTOCOLS** = **101** --- HTTP status code ``101 Switching Protocol``. Sent in response to an ``Upgrade`` request header by the client. Indicates the protocol the server is switching to. @@ -149,7 +159,6 @@ enum **ResponseCode** - **RESPONSE_NOT_EXTENDED** = **510** --- HTTP status code ``510 Not Extended``. The policy for accessing the resource has not been met in the request. The server should send back all the information necessary for the client to issue an extended request. - **RESPONSE_NETWORK_AUTH_REQUIRED** = **511** --- HTTP status code ``511 Network Authentication Required``. The client needs to authenticate to gain network access. - Description ----------- @@ -166,29 +175,43 @@ Tutorials - :doc:`../tutorials/networking/http_client_class` - :doc:`../tutorials/networking/ssl_certificates` - Property Descriptions --------------------- .. _class_HTTPClient_blocking_mode_enabled: -- :ref:`bool` **blocking_mode_enabled** - If ``true``, execution will block until all data is read from the response. +- :ref:`bool` **blocking_mode_enabled** + ++----------+----------------------------+ +| *Setter* | set_blocking_mode(value) | ++----------+----------------------------+ +| *Getter* | is_blocking_mode_enabled() | ++----------+----------------------------+ + +If ``true``, execution will block until all data is read from the response. .. _class_HTTPClient_connection: -- :ref:`StreamPeer` **connection** - The connection to use for this client. +- :ref:`StreamPeer` **connection** ++----------+-----------------------+ +| *Setter* | set_connection(value) | ++----------+-----------------------+ +| *Getter* | get_connection() | ++----------+-----------------------+ + +The connection to use for this client. Method Descriptions ------------------- -.. _class_HTTPClient_close: + .. _class_HTTPClient_close: - void **close** **(** **)** Closes the current connection, allowing reuse of this ``HTTPClient``. -.. _class_HTTPClient_connect_to_host: + .. _class_HTTPClient_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 **)** @@ -200,25 +223,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_get_response_body_length: - :ref:`int` **get_response_body_length** **(** **)** const Returns the response's body length. -.. _class_HTTPClient_get_response_code: + .. _class_HTTPClient_get_response_code: - :ref:`int` **get_response_code** **(** **)** const Returns the response's HTTP status code. -.. _class_HTTPClient_get_response_headers: + .. _class_HTTPClient_get_response_headers: - :ref:`PoolStringArray` **get_response_headers** **(** **)** Returns the response headers. -.. _class_HTTPClient_get_response_headers_as_dictionary: + .. _class_HTTPClient_get_response_headers_as_dictionary: - :ref:`Dictionary` **get_response_headers_as_dictionary** **(** **)** @@ -228,31 +251,31 @@ Structure: ("key":"value1; value2") Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) -.. _class_HTTPClient_get_status: + .. _class_HTTPClient_get_status: - :ref:`Status` **get_status** **(** **)** const Returns a STATUS\_\* enum constant. Need to call :ref:`poll` in order to get status updates. -.. _class_HTTPClient_has_response: + .. _class_HTTPClient_has_response: - :ref:`bool` **has_response** **(** **)** const If ``true`` this ``HTTPClient`` has a response available. -.. _class_HTTPClient_is_response_chunked: + .. _class_HTTPClient_is_response_chunked: - :ref:`bool` **is_response_chunked** **(** **)** const If ``true`` this ``HTTPClient`` has a response that is chunked. -.. _class_HTTPClient_poll: + .. _class_HTTPClient_poll: - :ref:`Error` **poll** **(** **)** 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_query_string_from_dict: - :ref:`String` **query_string_from_dict** **(** :ref:`Dictionary` fields **)** @@ -272,13 +295,13 @@ Furthermore, if a key has a null value, only the key itself is added, without eq String queryString = httpClient.query_string_from_dict(fields) returns:= "single=123¬_valued&multiple=22&multiple=33&multiple=44" -.. _class_HTTPClient_read_response_body_chunk: + .. _class_HTTPClient_read_response_body_chunk: - :ref:`PoolByteArray` **read_response_body_chunk** **(** **)** Reads one chunk from the response. -.. _class_HTTPClient_request: + .. _class_HTTPClient_request: - :ref:`Error` **request** **(** :ref:`Method` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`String` body="" **)** @@ -295,7 +318,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(queryString.length())] var result = httpClient.request(httpClient.METHOD_POST, "index.php", headers, queryString) -.. _class_HTTPClient_request_raw: + .. _class_HTTPClient_request_raw: - :ref:`Error` **request_raw** **(** :ref:`Method` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** @@ -305,10 +328,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_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` - diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index 65354e1cd..7840ea1c0 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -8,6 +8,7 @@ HTTPRequest =========== **Inherits:** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,19 @@ Brief Description 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` | ++-----------------------------+-----------------------------------------------------------+ + Methods ------- @@ -33,19 +47,18 @@ Methods Signals ------- -.. _class_HTTPRequest_request_completed: + .. _class_HTTPRequest_request_completed: - **request_completed** **(** :ref:`int` result, :ref:`int` response_code, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** This signal is emitted upon request completion. - Enumerations ------------ .. _enum_HTTPRequest_Result: -enum **Result** +enum **Result**: - **RESULT_SUCCESS** = **0** --- Request successful. - **RESULT_CHUNKED_BODY_SIZE_MISMATCH** = **1** @@ -60,7 +73,6 @@ 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:`set_max_redirects`. - Description ----------- @@ -72,55 +84,85 @@ Tutorials --------- - :doc:`../tutorials/networking/ssl_certificates` - Property Descriptions --------------------- .. _class_HTTPRequest_body_size_limit: -- :ref:`int` **body_size_limit** - Maximum allowed size for response bodies. +- :ref:`int` **body_size_limit** + ++----------+----------------------------+ +| *Setter* | set_body_size_limit(value) | ++----------+----------------------------+ +| *Getter* | get_body_size_limit() | ++----------+----------------------------+ + +Maximum allowed size for response bodies. .. _class_HTTPRequest_download_file: -- :ref:`String` **download_file** - The file to download into. Will output any received file into it. +- :ref:`String` **download_file** + ++----------+--------------------------+ +| *Setter* | set_download_file(value) | ++----------+--------------------------+ +| *Getter* | get_download_file() | ++----------+--------------------------+ + +The file to download into. Will output any received file into it. .. _class_HTTPRequest_max_redirects: -- :ref:`int` **max_redirects** - Maximum number of allowed redirects. +- :ref:`int` **max_redirects** + ++----------+--------------------------+ +| *Setter* | set_max_redirects(value) | ++----------+--------------------------+ +| *Getter* | get_max_redirects() | ++----------+--------------------------+ + +Maximum number of allowed redirects. .. _class_HTTPRequest_use_threads: -- :ref:`bool` **use_threads** - If ``true`` multithreading is used to improve performance. +- :ref:`bool` **use_threads** ++----------+------------------------+ +| *Setter* | set_use_threads(value) | ++----------+------------------------+ +| *Getter* | is_using_threads() | ++----------+------------------------+ + +If ``true`` multithreading is used to improve performance. Method Descriptions ------------------- -.. _class_HTTPRequest_cancel_request: + .. _class_HTTPRequest_cancel_request: - void **cancel_request** **(** **)** Cancels the current request. -.. _class_HTTPRequest_get_body_size: + .. _class_HTTPRequest_get_body_size: - :ref:`int` **get_body_size** **(** **)** const Returns the response body length. -.. _class_HTTPRequest_get_downloaded_bytes: + .. _class_HTTPRequest_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_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_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="" **)** @@ -128,4 +170,3 @@ Creates request on the underlying :ref:`HTTPClient`. If there 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 581f14088..c18380944 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -8,6 +8,7 @@ Image ===== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Image datatype. +Properties +---------- + ++-------------------------------------+-------------------------------+ +| :ref:`Dictionary` | :ref:`data` | ++-------------------------------------+-------------------------------+ + Methods ------- @@ -125,7 +133,7 @@ Enumerations .. _enum_Image_CompressMode: -enum **CompressMode** +enum **CompressMode**: - **COMPRESS_S3TC** = **0** - **COMPRESS_PVRTC2** = **1** @@ -135,7 +143,7 @@ enum **CompressMode** .. _enum_Image_Interpolation: -enum **Interpolation** +enum **Interpolation**: - **INTERPOLATE_NEAREST** = **0** - **INTERPOLATE_BILINEAR** = **1** @@ -150,7 +158,7 @@ On the other hand, if the image already has mipmaps, they will be used, and a ne .. _enum_Image_AlphaMode: -enum **AlphaMode** +enum **AlphaMode**: - **ALPHA_NONE** = **0** - **ALPHA_BIT** = **1** @@ -158,7 +166,7 @@ enum **AlphaMode** .. _enum_Image_CompressSource: -enum **CompressSource** +enum **CompressSource**: - **COMPRESS_SOURCE_GENERIC** = **0** - **COMPRESS_SOURCE_SRGB** = **1** @@ -166,7 +174,7 @@ enum **CompressSource** .. _enum_Image_Format: -enum **Format** +enum **Format**: - **FORMAT_L8** = **0** - **FORMAT_LA8** = **1** @@ -207,7 +215,6 @@ enum **Format** - **FORMAT_ETC2_RGB8A1** = **36** --- Ericsson Texture Compression format 2 variant RGB8_PUNCHTHROUGH_ALPHA1, which compresses RGBA data to make alpha either fully transparent or fully opaque. - **FORMAT_MAX** = **37** - Description ----------- @@ -218,277 +225,278 @@ Property Descriptions .. _class_Image_data: -- :ref:`Dictionary` **data** - Holds all of the image's color data in a given format. See ``FORMAT_*`` constants. +- :ref:`Dictionary` **data** +Holds all of the image's color data in a given format. See ``FORMAT_*`` constants. Method Descriptions ------------------- -.. _class_Image_blend_rect: + .. _class_Image_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_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_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_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_bumpmap_to_normalmap: - void **bumpmap_to_normalmap** **(** :ref:`float` bump_scale=1.0 **)** -.. _class_Image_clear_mipmaps: + .. _class_Image_clear_mipmaps: - void **clear_mipmaps** **(** **)** Removes the image's mipmaps. -.. _class_Image_compress: + .. _class_Image_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_convert: - void **convert** **(** :ref:`Format` format **)** Converts the image's format. See ``FORMAT_*`` constants. -.. _class_Image_copy_from: + .. _class_Image_copy_from: - void **copy_from** **(** :ref:`Image` src **)** Copies ``src`` image to this image. -.. _class_Image_create: + .. _class_Image_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_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_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_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_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_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_fill: - void **fill** **(** :ref:`Color` color **)** Fills the image with a given :ref:`Color`. -.. _class_Image_fix_alpha_edges: + .. _class_Image_fix_alpha_edges: - void **fix_alpha_edges** **(** **)** Blends low-alpha pixels with nearby pixels. -.. _class_Image_flip_x: + .. _class_Image_flip_x: - void **flip_x** **(** **)** Flips the image horizontally. -.. _class_Image_flip_y: + .. _class_Image_flip_y: - void **flip_y** **(** **)** Flips the image vertically. -.. _class_Image_generate_mipmaps: + .. _class_Image_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_get_data: - :ref:`PoolByteArray` **get_data** **(** **)** const Returns the image's raw data. -.. _class_Image_get_format: + .. _class_Image_get_format: - :ref:`Format` **get_format** **(** **)** const Returns the image’s format. See ``FORMAT_*`` constants. -.. _class_Image_get_height: + .. _class_Image_get_height: - :ref:`int` **get_height** **(** **)** const Returns the image's height. -.. _class_Image_get_mipmap_offset: + .. _class_Image_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_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_get_pixelv: - :ref:`Color` **get_pixelv** **(** :ref:`Vector2` src **)** const -.. _class_Image_get_rect: + .. _class_Image_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_get_size: - :ref:`Vector2` **get_size** **(** **)** const Returns the image's size (width and height). -.. _class_Image_get_used_rect: + .. _class_Image_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_get_width: - :ref:`int` **get_width** **(** **)** const Returns the image's width. -.. _class_Image_has_mipmaps: + .. _class_Image_has_mipmaps: - :ref:`bool` **has_mipmaps** **(** **)** const Returns ``true`` if the image has generated mipmaps. -.. _class_Image_is_compressed: + .. _class_Image_is_compressed: - :ref:`bool` **is_compressed** **(** **)** const Returns ``true`` if the image is compressed. -.. _class_Image_is_empty: + .. _class_Image_is_empty: - :ref:`bool` **is_empty** **(** **)** const Returns ``true`` if the image has no data. -.. _class_Image_is_invisible: + .. _class_Image_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_load: - :ref:`Error` **load** **(** :ref:`String` path **)** Loads an image from file ``path``. -.. _class_Image_load_jpg_from_buffer: + .. _class_Image_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_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_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_lock: - void **lock** **(** **)** Locks the data for writing access. -.. _class_Image_normalmap_to_xy: + .. _class_Image_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_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_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_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_rgbe_to_srgb: - :ref:`Image` **rgbe_to_srgb** **(** **)** -.. _class_Image_save_png: + .. _class_Image_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_set_pixel: - void **set_pixel** **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color **)** @@ -503,26 +511,25 @@ 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_set_pixelv: - void **set_pixelv** **(** :ref:`Vector2` dst, :ref:`Color` color **)** -.. _class_Image_shrink_x2: + .. _class_Image_shrink_x2: - void **shrink_x2** **(** **)** Shrinks the image by a factor of 2. -.. _class_Image_srgb_to_linear: + .. _class_Image_srgb_to_linear: - void **srgb_to_linear** **(** **)** Converts the raw data from the sRGB colorspace to a linear scale. -.. _class_Image_unlock: + .. _class_Image_unlock: - void **unlock** **(** **)** Unlocks the data and prevents changes. - diff --git a/classes/class_imagetexture.rst b/classes/class_imagetexture.rst index 5ec8aeaa7..88ba28384 100644 --- a/classes/class_imagetexture.rst +++ b/classes/class_imagetexture.rst @@ -8,6 +8,7 @@ ImageTexture ============ **Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description A :ref:`Texture` based on an :ref:`Image`. +Properties +---------- + ++-------------------------------------------+--------------------------------------------------------+ +| :ref:`float` | :ref:`lossy_quality` | ++-------------------------------------------+--------------------------------------------------------+ +| :ref:`Storage` | :ref:`storage` | ++-------------------------------------------+--------------------------------------------------------+ + Methods ------- @@ -37,13 +47,12 @@ Enumerations .. _enum_ImageTexture_Storage: -enum **Storage** +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:`set_lossy_storage_quality`. - **STORAGE_COMPRESS_LOSSLESS** = **2** --- :ref:`Image` data is compressed with a lossless algorithm. - Description ----------- @@ -54,17 +63,32 @@ Property Descriptions .. _class_ImageTexture_lossy_quality: -- :ref:`float` **lossy_quality** - The storage quality for ``ImageTexture``.STORAGE_COMPRESS_LOSSY. +- :ref:`float` **lossy_quality** + ++----------+----------------------------------+ +| *Setter* | set_lossy_storage_quality(value) | ++----------+----------------------------------+ +| *Getter* | get_lossy_storage_quality() | ++----------+----------------------------------+ + +The storage quality for ``ImageTexture``.STORAGE_COMPRESS_LOSSY. .. _class_ImageTexture_storage: -- :ref:`Storage` **storage** - The storage type (raw, lossy, or compressed). +- :ref:`Storage` **storage** ++----------+--------------------+ +| *Setter* | set_storage(value) | ++----------+--------------------+ +| *Getter* | get_storage() | ++----------+--------------------+ + +The storage type (raw, lossy, or compressed). Method Descriptions ------------------- -.. _class_ImageTexture_create: + .. _class_ImageTexture_create: - void **create** **(** :ref:`int` width, :ref:`int` height, :ref:`Format` format, :ref:`int` flags=7 **)** @@ -74,34 +98,33 @@ Create a new ``ImageTexture`` with "width" and "height". "flags" one or more of :ref:`Texture`.FLAG\_\*. -.. _class_ImageTexture_create_from_image: + .. _class_ImageTexture_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:`Texture`.FLAG\_\*. -.. _class_ImageTexture_get_format: + .. _class_ImageTexture_get_format: - :ref:`Format` **get_format** **(** **)** const Return the format of the ``ImageTexture``, one of :ref:`Image`.FORMAT\_\*. -.. _class_ImageTexture_load: + .. _class_ImageTexture_load: - :ref:`Error` **load** **(** :ref:`String` path **)** Load an ``ImageTexture`` from a file path. -.. _class_ImageTexture_set_data: + .. _class_ImageTexture_set_data: - void **set_data** **(** :ref:`Image` image **)** Set the :ref:`Image` of this ``ImageTexture``. -.. _class_ImageTexture_set_size_override: + .. _class_ImageTexture_set_size_override: - void **set_size_override** **(** :ref:`Vector2` size **)** Resizes the ``ImageTexture`` to the specified dimensions. - diff --git a/classes/class_immediategeometry.rst b/classes/class_immediategeometry.rst index ae4d329b7..ca68861ab 100644 --- a/classes/class_immediategeometry.rst +++ b/classes/class_immediategeometry.rst @@ -8,6 +8,7 @@ ImmediateGeometry ================= **Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -48,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_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_add_vertex: - void **add_vertex** **(** :ref:`Vector3` position **)** Adds a vertex with the currently set color/uv/etc. -.. _class_ImmediateGeometry_begin: + .. _class_ImmediateGeometry_begin: - void **begin** **(** :ref:`PrimitiveType` primitive, :ref:`Texture` texture=null **)** @@ -68,46 +69,45 @@ 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_clear: - void **clear** **(** **)** Clears everything that was drawn using begin/end. -.. _class_ImmediateGeometry_end: + .. _class_ImmediateGeometry_end: - void **end** **(** **)** Ends a drawing context and displays the results. -.. _class_ImmediateGeometry_set_color: + .. _class_ImmediateGeometry_set_color: - void **set_color** **(** :ref:`Color` color **)** The current drawing color. -.. _class_ImmediateGeometry_set_normal: + .. _class_ImmediateGeometry_set_normal: - void **set_normal** **(** :ref:`Vector3` normal **)** The next vertex's normal. -.. _class_ImmediateGeometry_set_tangent: + .. _class_ImmediateGeometry_set_tangent: - void **set_tangent** **(** :ref:`Plane` tangent **)** The next vertex's tangent (and binormal facing). -.. _class_ImmediateGeometry_set_uv: + .. _class_ImmediateGeometry_set_uv: - void **set_uv** **(** :ref:`Vector2` uv **)** The next vertex's UV. -.. _class_ImmediateGeometry_set_uv2: + .. _class_ImmediateGeometry_set_uv2: - void **set_uv2** **(** :ref:`Vector2` uv **)** The next vertex's second layer UV. - diff --git a/classes/class_input.rst b/classes/class_input.rst index a3b86f9d1..21dc0d83b 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -8,7 +8,9 @@ Input ===== **Inherits:** :ref:`Object` + **Inherited By:** :ref:`InputDefault` + **Category:** Core Brief Description @@ -98,19 +100,18 @@ Methods Signals ------- -.. _class_Input_joy_connection_changed: + .. _class_Input_joy_connection_changed: - **joy_connection_changed** **(** :ref:`int` device, :ref:`bool` connected **)** Emitted when a joypad device has been connected or disconnected. - Enumerations ------------ .. _enum_Input_MouseMode: -enum **MouseMode** +enum **MouseMode**: - **MOUSE_MODE_VISIBLE** = **0** --- Makes the mouse cursor visible if it is hidden. - **MOUSE_MODE_HIDDEN** = **1** --- Makes the mouse cursor hidden if it is visible. @@ -119,7 +120,7 @@ enum **MouseMode** .. _enum_Input_CursorShape: -enum **CursorShape** +enum **CursorShape**: - **CURSOR_ARROW** = **0** --- Arrow cursor. Standard, default pointing cursor. - **CURSOR_IBEAM** = **1** --- I-beam cursor. Usually used to show where the text cursor will appear when the mouse is clicked. @@ -139,7 +140,6 @@ enum **CursorShape** - **CURSOR_HSPLIT** = **15** --- Horizontal split mouse cursor. On Windows, it's the same as ``CURSOR_HSIZE``. - **CURSOR_HELP** = **16** --- Help cursor. Usually a question mark. - Description ----------- @@ -149,29 +149,28 @@ Tutorials --------- - :doc:`../tutorials/inputs/index` - Method Descriptions ------------------- -.. _class_Input_action_press: + .. _class_Input_action_press: - void **action_press** **(** :ref:`String` action **)** This will simulate pressing the specified action. -.. _class_Input_action_release: + .. _class_Input_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_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_get_accelerometer: - :ref:`Vector3` **get_accelerometer** **(** **)** const @@ -179,99 +178,99 @@ 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_get_action_strength: - :ref:`float` **get_action_strength** **(** :ref:`String` action **)** const -.. _class_Input_get_connected_joypads: + .. _class_Input_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_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_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_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_get_joy_axis_index_from_string: - :ref:`int` **get_joy_axis_index_from_string** **(** :ref:`String` axis **)** -.. _class_Input_get_joy_axis_string: + .. _class_Input_get_joy_axis_string: - :ref:`String` **get_joy_axis_string** **(** :ref:`int` axis_index **)** -.. _class_Input_get_joy_button_index_from_string: + .. _class_Input_get_joy_button_index_from_string: - :ref:`int` **get_joy_button_index_from_string** **(** :ref:`String` button **)** -.. _class_Input_get_joy_button_string: + .. _class_Input_get_joy_button_string: - :ref:`String` **get_joy_button_string** **(** :ref:`int` button_index **)** -.. _class_Input_get_joy_guid: + .. _class_Input_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_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_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_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_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_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_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_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_is_action_just_pressed: - :ref:`bool` **is_action_just_pressed** **(** :ref:`String` action **)** const @@ -279,59 +278,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_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_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_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_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_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_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_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_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_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_set_custom_mouse_cursor: - void **set_custom_mouse_cursor** **(** :ref:`Resource` image, :ref:`CursorShape` shape=0, :ref:`Vector2` hotspot=Vector2( 0, 0 ) **)** @@ -341,17 +340,17 @@ Set a custom mouse cursor image, which is only visible inside the game window. T ``hotspot`` must be within ``image``'s size. -.. _class_Input_set_default_cursor_shape: + .. _class_Input_set_default_cursor_shape: - void **set_default_cursor_shape** **(** :ref:`CursorShape` shape=0 **)** -.. _class_Input_set_mouse_mode: + .. _class_Input_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_start_joy_vibration: - void **start_joy_vibration** **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=0 **)** @@ -359,16 +358,15 @@ 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_stop_joy_vibration: - void **stop_joy_vibration** **(** :ref:`int` device **)** Stops the vibration of the joypad. -.. _class_Input_warp_mouse_position: + .. _class_Input_warp_mouse_position: - void **warp_mouse_position** **(** :ref:`Vector2` to **)** Sets the mouse position to the specified vector. - diff --git a/classes/class_inputdefault.rst b/classes/class_inputdefault.rst index fe30dc3c5..d6c82b1a7 100644 --- a/classes/class_inputdefault.rst +++ b/classes/class_inputdefault.rst @@ -8,6 +8,7 @@ InputDefault ============ **Inherits:** :ref:`Input` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_inputevent.rst b/classes/class_inputevent.rst index 5f2b643e2..fe1d8dc20 100644 --- a/classes/class_inputevent.rst +++ b/classes/class_inputevent.rst @@ -8,7 +8,9 @@ InputEvent ========== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`InputEventScreenTouch`, :ref:`InputEventWithModifiers`, :ref:`InputEventScreenDrag`, :ref:`InputEventJoypadMotion`, :ref:`InputEventJoypadButton`, :ref:`InputEventAction` + **Category:** Core Brief Description @@ -16,6 +18,13 @@ Brief Description Generic input event +Properties +---------- + ++-----------------------+----------------------------------------+ +| :ref:`int` | :ref:`device` | ++-----------------------+----------------------------------------+ + Methods ------- @@ -51,70 +60,75 @@ Tutorials - :doc:`../tutorials/inputs/inputevent` - :doc:`../tutorials/2d/2d_transforms` - Property Descriptions --------------------- .. _class_InputEvent_device: -- :ref:`int` **device** - The event's device ID. +- :ref:`int` **device** ++----------+-------------------+ +| *Setter* | set_device(value) | ++----------+-------------------+ +| *Getter* | get_device() | ++----------+-------------------+ + +The event's device ID. Method Descriptions ------------------- -.. _class_InputEvent_as_text: + .. _class_InputEvent_as_text: - :ref:`String` **as_text** **(** **)** const Returns a :ref:`String` representation of the event. -.. _class_InputEvent_get_action_strength: + .. _class_InputEvent_get_action_strength: - :ref:`float` **get_action_strength** **(** :ref:`String` action **)** const -.. _class_InputEvent_is_action: + .. _class_InputEvent_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_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_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_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_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_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_shortcut_match: - :ref:`bool` **shortcut_match** **(** :ref:`InputEvent` event **)** const -.. _class_InputEvent_xformed_by: + .. _class_InputEvent_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 7a7980755..93108ec03 100644 --- a/classes/class_inputeventaction.rst +++ b/classes/class_inputeventaction.rst @@ -8,6 +8,7 @@ InputEventAction ================ **Inherits:** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description Input event type for actions. +Properties +---------- + ++-----------------------------+------------------------------------------------+ +| :ref:`String` | :ref:`action` | ++-----------------------------+------------------------------------------------+ +| :ref:`bool` | :ref:`pressed` | ++-----------------------------+------------------------------------------------+ + Description ----------- @@ -24,16 +34,30 @@ Tutorials --------- - `#actions <../tutorials/inputs/inputevent.html#actions>`_ in :doc:`../tutorials/inputs/inputevent` - Property Descriptions --------------------- .. _class_InputEventAction_action: -- :ref:`String` **action** - The action's name. Actions are accessed via this :ref:`String`. +- :ref:`String` **action** + ++----------+-------------------+ +| *Setter* | set_action(value) | ++----------+-------------------+ +| *Getter* | get_action() | ++----------+-------------------+ + +The action's name. Actions are accessed via this :ref:`String`. .. _class_InputEventAction_pressed: -- :ref:`bool` **pressed** - If ``true`` the action's state is pressed. If ``false`` the action's state is released. +- :ref:`bool` **pressed** ++----------+--------------------+ +| *Setter* | set_pressed(value) | ++----------+--------------------+ +| *Getter* | is_pressed() | ++----------+--------------------+ + +If ``true`` the action's state is pressed. If ``false`` the action's state is released. diff --git a/classes/class_inputeventgesture.rst b/classes/class_inputeventgesture.rst index 1dca67e83..512a9b0d0 100644 --- a/classes/class_inputeventgesture.rst +++ b/classes/class_inputeventgesture.rst @@ -8,7 +8,9 @@ InputEventGesture ================= **Inherits:** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`InputEventPanGesture`, :ref:`InputEventMagnifyGesture` + **Category:** Core Brief Description @@ -16,6 +18,13 @@ Brief Description +Properties +---------- + ++-------------------------------+---------------------------------------------------+ +| :ref:`Vector2` | :ref:`position` | ++-------------------------------+---------------------------------------------------+ + Property Descriptions --------------------- @@ -23,4 +32,9 @@ Property Descriptions - :ref:`Vector2` **position** ++----------+---------------------+ +| *Setter* | set_position(value) | ++----------+---------------------+ +| *Getter* | get_position() | ++----------+---------------------+ diff --git a/classes/class_inputeventjoypadbutton.rst b/classes/class_inputeventjoypadbutton.rst index 772ec5d2b..96aa70fce 100644 --- a/classes/class_inputeventjoypadbutton.rst +++ b/classes/class_inputeventjoypadbutton.rst @@ -8,6 +8,7 @@ InputEventJoypadButton ====================== **Inherits:** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,17 @@ Brief Description Input event for gamepad buttons. +Properties +---------- + ++---------------------------+----------------------------------------------------------------+ +| :ref:`int` | :ref:`button_index` | ++---------------------------+----------------------------------------------------------------+ +| :ref:`bool` | :ref:`pressed` | ++---------------------------+----------------------------------------------------------------+ +| :ref:`float` | :ref:`pressure` | ++---------------------------+----------------------------------------------------------------+ + Description ----------- @@ -24,20 +36,42 @@ Tutorials --------- - :doc:`../tutorials/inputs/inputevent` - Property Descriptions --------------------- .. _class_InputEventJoypadButton_button_index: -- :ref:`int` **button_index** - Button identifier. One of the ``JOY_BUTTON_*`` constants from :ref:`@GlobalScope`. +- :ref:`int` **button_index** + ++----------+-------------------------+ +| *Setter* | set_button_index(value) | ++----------+-------------------------+ +| *Getter* | get_button_index() | ++----------+-------------------------+ + +Button identifier. One of the ``JOY_BUTTON_*`` constants from :ref:`@GlobalScope`. .. _class_InputEventJoypadButton_pressed: -- :ref:`bool` **pressed** - If ``true`` the button's state is pressed. If ``false`` the button's state is released. +- :ref:`bool` **pressed** + ++----------+--------------------+ +| *Setter* | set_pressed(value) | ++----------+--------------------+ +| *Getter* | is_pressed() | ++----------+--------------------+ + +If ``true`` the button's state is pressed. If ``false`` the button's state is released. .. _class_InputEventJoypadButton_pressure: -- :ref:`float` **pressure** - Represents the pressure the user puts on the button with his finger, if the controller supports it. Ranges from ``0`` to ``1``. +- :ref:`float` **pressure** ++----------+---------------------+ +| *Setter* | set_pressure(value) | ++----------+---------------------+ +| *Getter* | get_pressure() | ++----------+---------------------+ + +Represents the pressure the user puts on the button with his finger, if the controller supports it. Ranges from ``0`` to ``1``. diff --git a/classes/class_inputeventjoypadmotion.rst b/classes/class_inputeventjoypadmotion.rst index bf32ea40e..496e2e278 100644 --- a/classes/class_inputeventjoypadmotion.rst +++ b/classes/class_inputeventjoypadmotion.rst @@ -8,6 +8,7 @@ InputEventJoypadMotion ====================== **Inherits:** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description Input event type for gamepad joysticks and other motions. For buttons see ``InputEventJoypadButton``. +Properties +---------- + ++---------------------------+------------------------------------------------------------+ +| :ref:`int` | :ref:`axis` | ++---------------------------+------------------------------------------------------------+ +| :ref:`float` | :ref:`axis_value` | ++---------------------------+------------------------------------------------------------+ + Description ----------- @@ -24,16 +34,30 @@ Tutorials --------- - :doc:`../tutorials/inputs/inputevent` - Property Descriptions --------------------- .. _class_InputEventJoypadMotion_axis: -- :ref:`int` **axis** - Axis identifier. Use one of the ``JOY_AXIS_*`` constants in :ref:`@GlobalScope`. +- :ref:`int` **axis** + ++----------+-----------------+ +| *Setter* | set_axis(value) | ++----------+-----------------+ +| *Getter* | get_axis() | ++----------+-----------------+ + +Axis identifier. Use one of the ``JOY_AXIS_*`` constants in :ref:`@GlobalScope`. .. _class_InputEventJoypadMotion_axis_value: -- :ref:`float` **axis_value** - Current position of the joystick on the given axis. The value ranges from ``-1.0`` to ``1.0``. A value of ``0`` means the axis is in its resting position. +- :ref:`float` **axis_value** ++----------+-----------------------+ +| *Setter* | set_axis_value(value) | ++----------+-----------------------+ +| *Getter* | get_axis_value() | ++----------+-----------------------+ + +Current position of the joystick on the given axis. The value ranges from ``-1.0`` to ``1.0``. A value of ``0`` means the axis is in its resting position. diff --git a/classes/class_inputeventkey.rst b/classes/class_inputeventkey.rst index b0b0be9ef..a92c5bf35 100644 --- a/classes/class_inputeventkey.rst +++ b/classes/class_inputeventkey.rst @@ -8,6 +8,7 @@ InputEventKey ============= **Inherits:** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,19 @@ Brief Description Input event type for keyboard events. +Properties +---------- + ++-------------------------+-----------------------------------------------+ +| :ref:`bool` | :ref:`echo` | ++-------------------------+-----------------------------------------------+ +| :ref:`bool` | :ref:`pressed` | ++-------------------------+-----------------------------------------------+ +| :ref:`int` | :ref:`scancode` | ++-------------------------+-----------------------------------------------+ +| :ref:`int` | :ref:`unicode` | ++-------------------------+-----------------------------------------------+ + Methods ------- @@ -31,34 +45,63 @@ Tutorials --------- - :doc:`../tutorials/inputs/inputevent` - Property Descriptions --------------------- .. _class_InputEventKey_echo: -- :ref:`bool` **echo** - If ``true`` the key was already pressed before this event. It means the user is holding the key down. +- :ref:`bool` **echo** + ++----------+-----------------+ +| *Setter* | set_echo(value) | ++----------+-----------------+ +| *Getter* | is_echo() | ++----------+-----------------+ + +If ``true`` the key was already pressed before this event. It means the user is holding the key down. .. _class_InputEventKey_pressed: -- :ref:`bool` **pressed** - If ``true`` the key's state is pressed. If ``false`` the key's state is released. +- :ref:`bool` **pressed** + ++----------+--------------------+ +| *Setter* | set_pressed(value) | ++----------+--------------------+ +| *Getter* | is_pressed() | ++----------+--------------------+ + +If ``true`` the key's state is pressed. If ``false`` the key's state is released. .. _class_InputEventKey_scancode: -- :ref:`int` **scancode** - Key scancode, one of the ``KEY_*`` constants in :ref:`@GlobalScope`. +- :ref:`int` **scancode** + ++----------+---------------------+ +| *Setter* | set_scancode(value) | ++----------+---------------------+ +| *Getter* | get_scancode() | ++----------+---------------------+ + +Key scancode, one of the ``KEY_*`` constants in :ref:`@GlobalScope`. .. _class_InputEventKey_unicode: -- :ref:`int` **unicode** - Key unicode identifier when relevant. +- :ref:`int` **unicode** ++----------+--------------------+ +| *Setter* | set_unicode(value) | ++----------+--------------------+ +| *Getter* | get_unicode() | ++----------+--------------------+ + +Key unicode identifier when relevant. Method Descriptions ------------------- -.. _class_InputEventKey_get_scancode_with_modifiers: + .. _class_InputEventKey_get_scancode_with_modifiers: - :ref:`int` **get_scancode_with_modifiers** **(** **)** const Returns the scancode combined with modifier keys such as ``Shift`` or ``Alt``. See also :ref:`InputEventWithModifiers`. - diff --git a/classes/class_inputeventmagnifygesture.rst b/classes/class_inputeventmagnifygesture.rst index f397505c8..70c1d48f3 100644 --- a/classes/class_inputeventmagnifygesture.rst +++ b/classes/class_inputeventmagnifygesture.rst @@ -8,6 +8,7 @@ InputEventMagnifyGesture ======================== **Inherits:** :ref:`InputEventGesture` **<** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description +Properties +---------- + ++---------------------------+------------------------------------------------------+ +| :ref:`float` | :ref:`factor` | ++---------------------------+------------------------------------------------------+ + Property Descriptions --------------------- @@ -22,4 +30,9 @@ Property Descriptions - :ref:`float` **factor** ++----------+-------------------+ +| *Setter* | set_factor(value) | ++----------+-------------------+ +| *Getter* | get_factor() | ++----------+-------------------+ diff --git a/classes/class_inputeventmouse.rst b/classes/class_inputeventmouse.rst index 5fbec78ac..fb2c35d7c 100644 --- a/classes/class_inputeventmouse.rst +++ b/classes/class_inputeventmouse.rst @@ -8,7 +8,9 @@ InputEventMouse =============== **Inherits:** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`InputEventMouseMotion`, :ref:`InputEventMouseButton` + **Category:** Core Brief Description @@ -16,6 +18,17 @@ Brief Description Base input event type for mouse events. +Properties +---------- + ++-------------------------------+---------------------------------------------------------------+ +| :ref:`int` | :ref:`button_mask` | ++-------------------------------+---------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`global_position` | ++-------------------------------+---------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`position` | ++-------------------------------+---------------------------------------------------------------+ + Description ----------- @@ -25,20 +38,42 @@ Tutorials --------- - :doc:`../tutorials/inputs/inputevent` - Property Descriptions --------------------- .. _class_InputEventMouse_button_mask: -- :ref:`int` **button_mask** - Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK\_\* constants in :ref:`@GlobalScope`. +- :ref:`int` **button_mask** + ++----------+------------------------+ +| *Setter* | set_button_mask(value) | ++----------+------------------------+ +| *Getter* | get_button_mask() | ++----------+------------------------+ + +Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK\_\* constants in :ref:`@GlobalScope`. .. _class_InputEventMouse_global_position: -- :ref:`Vector2` **global_position** - Mouse position relative to the current :ref:`Viewport` when used in :ref:`Control._gui_input`, otherwise is at 0,0. +- :ref:`Vector2` **global_position** + ++----------+----------------------------+ +| *Setter* | set_global_position(value) | ++----------+----------------------------+ +| *Getter* | get_global_position() | ++----------+----------------------------+ + +Mouse position relative to the current :ref:`Viewport` when used in :ref:`Control._gui_input`, otherwise is at 0,0. .. _class_InputEventMouse_position: -- :ref:`Vector2` **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. +- :ref:`Vector2` **position** ++----------+---------------------+ +| *Setter* | set_position(value) | ++----------+---------------------+ +| *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. diff --git a/classes/class_inputeventmousebutton.rst b/classes/class_inputeventmousebutton.rst index 52559d920..c00fd8b3f 100644 --- a/classes/class_inputeventmousebutton.rst +++ b/classes/class_inputeventmousebutton.rst @@ -8,6 +8,7 @@ InputEventMouseButton ===================== **Inherits:** :ref:`InputEventMouse` **<** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,19 @@ Brief Description 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` | ++---------------------------+---------------------------------------------------------------+ + Description ----------- @@ -24,24 +38,54 @@ Tutorials --------- - :doc:`../tutorials/inputs/mouse_and_input_coordinates` - Property Descriptions --------------------- .. _class_InputEventMouseButton_button_index: -- :ref:`int` **button_index** - Mouse button identifier, one of the BUTTON\_\* or BUTTON_WHEEL\_\* constants in :ref:`@GlobalScope`. +- :ref:`int` **button_index** + ++----------+-------------------------+ +| *Setter* | set_button_index(value) | ++----------+-------------------------+ +| *Getter* | get_button_index() | ++----------+-------------------------+ + +Mouse button identifier, one of the BUTTON\_\* or BUTTON_WHEEL\_\* constants in :ref:`@GlobalScope`. .. _class_InputEventMouseButton_doubleclick: -- :ref:`bool` **doubleclick** - If ``true`` the mouse button's state is a double-click. If ``false`` the mouse button's state is released. +- :ref:`bool` **doubleclick** + ++----------+------------------------+ +| *Setter* | set_doubleclick(value) | ++----------+------------------------+ +| *Getter* | is_doubleclick() | ++----------+------------------------+ + +If ``true`` the mouse button's state is a double-click. If ``false`` the mouse button's state is released. .. _class_InputEventMouseButton_factor: -- :ref:`float` **factor** - 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. +- :ref:`float` **factor** + ++----------+-------------------+ +| *Setter* | set_factor(value) | ++----------+-------------------+ +| *Getter* | get_factor() | ++----------+-------------------+ + +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: -- :ref:`bool` **pressed** - If ``true`` the mouse button's state is pressed. If ``false`` the mouse button's state is released. +- :ref:`bool` **pressed** ++----------+--------------------+ +| *Setter* | set_pressed(value) | ++----------+--------------------+ +| *Getter* | is_pressed() | ++----------+--------------------+ + +If ``true`` the mouse button's state is pressed. If ``false`` the mouse button's state is released. diff --git a/classes/class_inputeventmousemotion.rst b/classes/class_inputeventmousemotion.rst index 0099415db..2214ecf04 100644 --- a/classes/class_inputeventmousemotion.rst +++ b/classes/class_inputeventmousemotion.rst @@ -8,6 +8,7 @@ InputEventMouseMotion ===================== **Inherits:** :ref:`InputEventMouse` **<** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description Input event type for mouse motion events. +Properties +---------- + ++-------------------------------+-------------------------------------------------------+ +| :ref:`Vector2` | :ref:`relative` | ++-------------------------------+-------------------------------------------------------+ +| :ref:`Vector2` | :ref:`speed` | ++-------------------------------+-------------------------------------------------------+ + Description ----------- @@ -24,16 +34,30 @@ Tutorials --------- - :doc:`../tutorials/inputs/mouse_and_input_coordinates` - Property Descriptions --------------------- .. _class_InputEventMouseMotion_relative: -- :ref:`Vector2` **relative** - Mouse position relative to the previous position (position at the last frame). +- :ref:`Vector2` **relative** + ++----------+---------------------+ +| *Setter* | set_relative(value) | ++----------+---------------------+ +| *Getter* | get_relative() | ++----------+---------------------+ + +Mouse position relative to the previous position (position at the last frame). .. _class_InputEventMouseMotion_speed: -- :ref:`Vector2` **speed** - Mouse speed. +- :ref:`Vector2` **speed** ++----------+------------------+ +| *Setter* | set_speed(value) | ++----------+------------------+ +| *Getter* | get_speed() | ++----------+------------------+ + +Mouse speed. diff --git a/classes/class_inputeventpangesture.rst b/classes/class_inputeventpangesture.rst index eef299ae1..21ba1d94d 100644 --- a/classes/class_inputeventpangesture.rst +++ b/classes/class_inputeventpangesture.rst @@ -8,6 +8,7 @@ InputEventPanGesture ==================== **Inherits:** :ref:`InputEventGesture` **<** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description +Properties +---------- + ++-------------------------------+------------------------------------------------+ +| :ref:`Vector2` | :ref:`delta` | ++-------------------------------+------------------------------------------------+ + Property Descriptions --------------------- @@ -22,4 +30,9 @@ Property Descriptions - :ref:`Vector2` **delta** ++----------+------------------+ +| *Setter* | set_delta(value) | ++----------+------------------+ +| *Getter* | get_delta() | ++----------+------------------+ diff --git a/classes/class_inputeventscreendrag.rst b/classes/class_inputeventscreendrag.rst index d59918fca..66782ba3f 100644 --- a/classes/class_inputeventscreendrag.rst +++ b/classes/class_inputeventscreendrag.rst @@ -8,6 +8,7 @@ InputEventScreenDrag ==================== **Inherits:** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -17,6 +18,19 @@ Input event type for screen drag events. (only available on mobile devices) +Properties +---------- + ++-------------------------------+------------------------------------------------------+ +| :ref:`int` | :ref:`index` | ++-------------------------------+------------------------------------------------------+ +| :ref:`Vector2` | :ref:`position` | ++-------------------------------+------------------------------------------------------+ +| :ref:`Vector2` | :ref:`relative` | ++-------------------------------+------------------------------------------------------+ +| :ref:`Vector2` | :ref:`speed` | ++-------------------------------+------------------------------------------------------+ + Description ----------- @@ -26,24 +40,54 @@ Tutorials --------- - :doc:`../tutorials/inputs/inputevent` - Property Descriptions --------------------- .. _class_InputEventScreenDrag_index: -- :ref:`int` **index** - Drag event index in the case of a multi-drag event. +- :ref:`int` **index** + ++----------+------------------+ +| *Setter* | set_index(value) | ++----------+------------------+ +| *Getter* | get_index() | ++----------+------------------+ + +Drag event index in the case of a multi-drag event. .. _class_InputEventScreenDrag_position: -- :ref:`Vector2` **position** - Drag position. +- :ref:`Vector2` **position** + ++----------+---------------------+ +| *Setter* | set_position(value) | ++----------+---------------------+ +| *Getter* | get_position() | ++----------+---------------------+ + +Drag position. .. _class_InputEventScreenDrag_relative: -- :ref:`Vector2` **relative** - Drag position relative to its start position. +- :ref:`Vector2` **relative** + ++----------+---------------------+ +| *Setter* | set_relative(value) | ++----------+---------------------+ +| *Getter* | get_relative() | ++----------+---------------------+ + +Drag position relative to its start position. .. _class_InputEventScreenDrag_speed: -- :ref:`Vector2` **speed** - Drag speed. +- :ref:`Vector2` **speed** ++----------+------------------+ +| *Setter* | set_speed(value) | ++----------+------------------+ +| *Getter* | get_speed() | ++----------+------------------+ + +Drag speed. diff --git a/classes/class_inputeventscreentouch.rst b/classes/class_inputeventscreentouch.rst index 6e51fb6c5..819b7080f 100644 --- a/classes/class_inputeventscreentouch.rst +++ b/classes/class_inputeventscreentouch.rst @@ -8,6 +8,7 @@ InputEventScreenTouch ===================== **Inherits:** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -17,6 +18,17 @@ Input event type for screen touch events. (only available on mobile devices) +Properties +---------- + ++-------------------------------+-------------------------------------------------------+ +| :ref:`int` | :ref:`index` | ++-------------------------------+-------------------------------------------------------+ +| :ref:`Vector2` | :ref:`position` | ++-------------------------------+-------------------------------------------------------+ +| :ref:`bool` | :ref:`pressed` | ++-------------------------------+-------------------------------------------------------+ + Description ----------- @@ -26,20 +38,42 @@ Tutorials --------- - :doc:`../tutorials/inputs/inputevent` - Property Descriptions --------------------- .. _class_InputEventScreenTouch_index: -- :ref:`int` **index** - Touch index in the case of a multi-touch event. One index = one finger. +- :ref:`int` **index** + ++----------+------------------+ +| *Setter* | set_index(value) | ++----------+------------------+ +| *Getter* | get_index() | ++----------+------------------+ + +Touch index in the case of a multi-touch event. One index = one finger. .. _class_InputEventScreenTouch_position: -- :ref:`Vector2` **position** - Touch position. +- :ref:`Vector2` **position** + ++----------+---------------------+ +| *Setter* | set_position(value) | ++----------+---------------------+ +| *Getter* | get_position() | ++----------+---------------------+ + +Touch position. .. _class_InputEventScreenTouch_pressed: -- :ref:`bool` **pressed** - If ``true`` the touch's state is pressed. If ``false`` the touch's state is released. +- :ref:`bool` **pressed** ++----------+--------------------+ +| *Setter* | set_pressed(value) | ++----------+--------------------+ +| *Getter* | is_pressed() | ++----------+--------------------+ + +If ``true`` the touch's state is pressed. If ``false`` the touch's state is released. diff --git a/classes/class_inputeventwithmodifiers.rst b/classes/class_inputeventwithmodifiers.rst index d7d2c7f3f..1d9fe71d0 100644 --- a/classes/class_inputeventwithmodifiers.rst +++ b/classes/class_inputeventwithmodifiers.rst @@ -8,7 +8,9 @@ InputEventWithModifiers ======================= **Inherits:** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`InputEventKey`, :ref:`InputEventMouse`, :ref:`InputEventGesture` + **Category:** Core Brief Description @@ -16,6 +18,21 @@ Brief Description 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` | ++-------------------------+-------------------------------------------------------+ + Description ----------- @@ -25,28 +42,66 @@ Tutorials --------- - :doc:`../tutorials/inputs/inputevent` - Property Descriptions --------------------- .. _class_InputEventWithModifiers_alt: -- :ref:`bool` **alt** - State of the Alt modifier. +- :ref:`bool` **alt** + ++----------+----------------+ +| *Setter* | set_alt(value) | ++----------+----------------+ +| *Getter* | get_alt() | ++----------+----------------+ + +State of the Alt modifier. .. _class_InputEventWithModifiers_command: -- :ref:`bool` **command** - State of the Command modifier. +- :ref:`bool` **command** + ++----------+--------------------+ +| *Setter* | set_command(value) | ++----------+--------------------+ +| *Getter* | get_command() | ++----------+--------------------+ + +State of the Command modifier. .. _class_InputEventWithModifiers_control: -- :ref:`bool` **control** - State of the Ctrl modifier. +- :ref:`bool` **control** + ++----------+--------------------+ +| *Setter* | set_control(value) | ++----------+--------------------+ +| *Getter* | get_control() | ++----------+--------------------+ + +State of the Ctrl modifier. .. _class_InputEventWithModifiers_meta: -- :ref:`bool` **meta** - State of the Meta modifier. +- :ref:`bool` **meta** + ++----------+--------------------+ +| *Setter* | set_metakey(value) | ++----------+--------------------+ +| *Getter* | get_metakey() | ++----------+--------------------+ + +State of the Meta modifier. .. _class_InputEventWithModifiers_shift: -- :ref:`bool` **shift** - State of the Shift modifier. +- :ref:`bool` **shift** ++----------+------------------+ +| *Setter* | set_shift(value) | ++----------+------------------+ +| *Getter* | get_shift() | ++----------+------------------+ + +State of the Shift modifier. diff --git a/classes/class_inputmap.rst b/classes/class_inputmap.rst index d557a879a..f4b9ea353 100644 --- a/classes/class_inputmap.rst +++ b/classes/class_inputmap.rst @@ -8,6 +8,7 @@ InputMap ======== **Inherits:** :ref:`Object` + **Category:** Core Brief Description @@ -53,39 +54,38 @@ Tutorials --------- - `#inputmap <../tutorials/inputs/inputevent.html#inputmap>`_ in :doc:`../tutorials/inputs/inputevent` - Method Descriptions ------------------- -.. _class_InputMap_action_add_event: + .. _class_InputMap_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_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_action_erase_events: - void **action_erase_events** **(** :ref:`String` action **)** Removes all events from an action. -.. _class_InputMap_action_has_event: + .. _class_InputMap_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_action_set_deadzone: - void **action_set_deadzone** **(** :ref:`String` action, :ref:`float` deadzone **)** -.. _class_InputMap_add_action: + .. _class_InputMap_add_action: - void **add_action** **(** :ref:`String` action, :ref:`float` deadzone=0.5 **)** @@ -93,40 +93,39 @@ 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`. -.. _class_InputMap_erase_action: + .. _class_InputMap_erase_action: - void **erase_action** **(** :ref:`String` action **)** Removes an action from the ``InputMap``. -.. _class_InputMap_event_is_action: + .. _class_InputMap_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. -.. _class_InputMap_get_action_list: + .. _class_InputMap_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_get_actions: - :ref:`Array` **get_actions** **(** **)** Returns an array of all actions in the ``InputMap``. -.. _class_InputMap_has_action: + .. _class_InputMap_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_load_from_globals: - void **load_from_globals** **(** **)** Clears all :ref:`InputEventAction` in the ``InputMap`` and load it anew from :ref:`ProjectSettings`. - diff --git a/classes/class_instanceplaceholder.rst b/classes/class_instanceplaceholder.rst index 44f60ae9f..bb28825ca 100644 --- a/classes/class_instanceplaceholder.rst +++ b/classes/class_instanceplaceholder.rst @@ -8,6 +8,7 @@ InstancePlaceholder =================== **Inherits:** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -38,24 +39,23 @@ The InstancePlaceholder does not have a transform. This causes any child nodes t Method Descriptions ------------------- -.. _class_InstancePlaceholder_create_instance: + .. _class_InstancePlaceholder_create_instance: - :ref:`Node` **create_instance** **(** :ref:`bool` replace=false, :ref:`PackedScene` custom_scene=null **)** -.. _class_InstancePlaceholder_get_instance_path: + .. _class_InstancePlaceholder_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`. -.. _class_InstancePlaceholder_get_stored_values: + .. _class_InstancePlaceholder_get_stored_values: - :ref:`Dictionary` **get_stored_values** **(** :ref:`bool` with_order=false **)** -.. _class_InstancePlaceholder_replace_by_instance: + .. _class_InstancePlaceholder_replace_by_instance: - void **replace_by_instance** **(** :ref:`PackedScene` custom_scene=null **)** Replace this placeholder by the scene handed as an argument, or the original scene if no argument is given. As for all resources, the scene is loaded only if it's not loaded already. By manually loading the scene beforehand, delays caused by this function can be avoided. - diff --git a/classes/class_int.rst b/classes/class_int.rst index 7e5699294..419a3f871 100644 --- a/classes/class_int.rst +++ b/classes/class_int.rst @@ -33,22 +33,21 @@ Integer built-in type. Method Descriptions ------------------- -.. _class_int_int: + .. _class_int_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: + .. _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: + .. _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 b4887642f..a8c50dc67 100644 --- a/classes/class_interpolatedcamera.rst +++ b/classes/class_interpolatedcamera.rst @@ -8,6 +8,7 @@ InterpolatedCamera ================== **Inherits:** :ref:`Camera` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,17 @@ Brief Description Camera which moves toward another node. +Properties +---------- + ++---------------------------------+--------------------------------------------------+ +| :ref:`bool` | :ref:`enabled` | ++---------------------------------+--------------------------------------------------+ +| :ref:`float` | :ref:`speed` | ++---------------------------------+--------------------------------------------------+ +| :ref:`NodePath` | :ref:`target` | ++---------------------------------+--------------------------------------------------+ + Methods ------- @@ -34,24 +46,46 @@ Property Descriptions .. _class_InterpolatedCamera_enabled: -- :ref:`bool` **enabled** - If ``true`` and a target is set, the camera will move automatically. +- :ref:`bool` **enabled** + ++----------+----------------------------------+ +| *Setter* | set_interpolation_enabled(value) | ++----------+----------------------------------+ +| *Getter* | is_interpolation_enabled() | ++----------+----------------------------------+ + +If ``true`` and a target is set, the camera will move automatically. .. _class_InterpolatedCamera_speed: -- :ref:`float` **speed** - How quickly the camera moves toward its target. Higher values will result in tighter camera motion. +- :ref:`float` **speed** + ++----------+------------------+ +| *Setter* | set_speed(value) | ++----------+------------------+ +| *Getter* | get_speed() | ++----------+------------------+ + +How quickly the camera moves toward its target. Higher values will result in tighter camera motion. .. _class_InterpolatedCamera_target: -- :ref:`NodePath` **target** - The target's :ref:`NodePath`. +- :ref:`NodePath` **target** ++----------+------------------------+ +| *Setter* | set_target_path(value) | ++----------+------------------------+ +| *Getter* | get_target_path() | ++----------+------------------------+ + +The target's :ref:`NodePath`. Method Descriptions ------------------- -.. _class_InterpolatedCamera_set_target: + .. _class_InterpolatedCamera_set_target: - void **set_target** **(** :ref:`Object` target **)** Sets the node to move toward and orient with. - diff --git a/classes/class_ip.rst b/classes/class_ip.rst index 1736a4216..0597944a6 100644 --- a/classes/class_ip.rst +++ b/classes/class_ip.rst @@ -8,7 +8,9 @@ IP == **Inherits:** :ref:`Object` + **Inherited By:** :ref:`IP_Unix` + **Category:** Core Brief Description @@ -40,7 +42,7 @@ Enumerations .. _enum_IP_ResolverStatus: -enum **ResolverStatus** +enum **ResolverStatus**: - **RESOLVER_STATUS_NONE** = **0** --- DNS hostname resolver status: No status. - **RESOLVER_STATUS_WAITING** = **1** --- DNS hostname resolver status: Waiting. @@ -49,20 +51,18 @@ enum **ResolverStatus** .. _enum_IP_Type: -enum **Type** +enum **Type**: - **TYPE_NONE** = **0** --- Address type: None. - **TYPE_IPV4** = **1** --- Address type: Internet protocol version 4 (IPv4). - **TYPE_IPV6** = **2** --- Address type: Internet protocol version 6 (IPv6). - **TYPE_ANY** = **3** --- Address type: Any. - Constants --------- - **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. - Description ----------- @@ -71,46 +71,45 @@ IP contains support functions for the Internet Protocol (IP). TCP/IP support is Method Descriptions ------------------- -.. _class_IP_clear_cache: + .. _class_IP_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_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_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_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`). -.. _class_IP_get_resolve_item_status: + .. _class_IP_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_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_resolve_hostname_queue_item: - :ref:`int` **resolve_hostname_queue_item** **(** :ref:`String` host, :ref:`Type` ip_type=3 **)** Creates a queue item to resolve a hostname to an IPv4 or IPv6 address depending on the TYPE\_\* constant given as "ip_type". Returns the queue ID if successful, or RESOLVER_INVALID_ID on error. - diff --git a/classes/class_ip_unix.rst b/classes/class_ip_unix.rst index 16c2b0e29..ad8cb5f97 100644 --- a/classes/class_ip_unix.rst +++ b/classes/class_ip_unix.rst @@ -8,6 +8,7 @@ IP_Unix ======= **Inherits:** :ref:`IP` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index d4e3208d9..c418ac4c5 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -8,6 +8,7 @@ ItemList ======== **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,33 @@ Brief Description Control that provides a list of selectable items (and/or icons) in a single column, or optionally in multiple columns. +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` | ++---------------------------------------------+--------------------------------------------------------------+ + Methods ------- @@ -96,16 +124,49 @@ Methods | 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` | ++---------------------------------+----------------------------------------------------------------+ + Signals ------- -.. _class_ItemList_item_activated: + .. _class_ItemList_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_item_rmb_selected: - **item_rmb_selected** **(** :ref:`int` index, :ref:`Vector2` at_position **)** @@ -115,45 +176,43 @@ The click position is also provided to allow appropriate popup of context menus at the correct location. -.. _class_ItemList_item_selected: + .. _class_ItemList_item_selected: - **item_selected** **(** :ref:`int` index **)** Fired when specified item has been selected. -.. _class_ItemList_multi_selected: + .. _class_ItemList_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_nothing_selected: - **nothing_selected** **(** **)** -.. _class_ItemList_rmb_clicked: + .. _class_ItemList_rmb_clicked: - **rmb_clicked** **(** :ref:`Vector2` at_position **)** - Enumerations ------------ .. _enum_ItemList_IconMode: -enum **IconMode** +enum **IconMode**: - **ICON_MODE_TOP** = **0** - **ICON_MODE_LEFT** = **1** .. _enum_ItemList_SelectMode: -enum **SelectMode** +enum **SelectMode**: - **SELECT_SINGLE** = **0** - **SELECT_MULTI** = **1** - Description ----------- @@ -166,59 +225,130 @@ Property Descriptions .. _class_ItemList_allow_reselect: -- :ref:`bool` **allow_reselect** - If ``true`` the currently selected item may be selected again. +- :ref:`bool` **allow_reselect** + ++----------+---------------------------+ +| *Setter* | set_allow_reselect(value) | ++----------+---------------------------+ +| *Getter* | get_allow_reselect() | ++----------+---------------------------+ + +If ``true`` the currently selected item may be selected again. .. _class_ItemList_allow_rmb_select: -- :ref:`bool` **allow_rmb_select** - If ``true`` a right mouse button click can select items. +- :ref:`bool` **allow_rmb_select** + ++----------+-----------------------------+ +| *Setter* | set_allow_rmb_select(value) | ++----------+-----------------------------+ +| *Getter* | get_allow_rmb_select() | ++----------+-----------------------------+ + +If ``true`` a right mouse button click can select items. .. _class_ItemList_auto_height: - :ref:`bool` **auto_height** ++----------+------------------------+ +| *Setter* | set_auto_height(value) | ++----------+------------------------+ +| *Getter* | has_auto_height() | ++----------+------------------------+ + .. _class_ItemList_fixed_column_width: - :ref:`int` **fixed_column_width** ++----------+-------------------------------+ +| *Setter* | set_fixed_column_width(value) | ++----------+-------------------------------+ +| *Getter* | get_fixed_column_width() | ++----------+-------------------------------+ + .. _class_ItemList_fixed_icon_size: - :ref:`Vector2` **fixed_icon_size** ++----------+----------------------------+ +| *Setter* | set_fixed_icon_size(value) | ++----------+----------------------------+ +| *Getter* | get_fixed_icon_size() | ++----------+----------------------------+ + .. _class_ItemList_icon_mode: - :ref:`IconMode` **icon_mode** ++----------+----------------------+ +| *Setter* | set_icon_mode(value) | ++----------+----------------------+ +| *Getter* | get_icon_mode() | ++----------+----------------------+ + .. _class_ItemList_icon_scale: - :ref:`float` **icon_scale** ++----------+-----------------------+ +| *Setter* | set_icon_scale(value) | ++----------+-----------------------+ +| *Getter* | get_icon_scale() | ++----------+-----------------------+ + .. _class_ItemList_max_columns: - :ref:`int` **max_columns** ++----------+------------------------+ +| *Setter* | set_max_columns(value) | ++----------+------------------------+ +| *Getter* | get_max_columns() | ++----------+------------------------+ + .. _class_ItemList_max_text_lines: - :ref:`int` **max_text_lines** ++----------+---------------------------+ +| *Setter* | set_max_text_lines(value) | ++----------+---------------------------+ +| *Getter* | get_max_text_lines() | ++----------+---------------------------+ + .. _class_ItemList_same_column_width: - :ref:`bool` **same_column_width** ++----------+------------------------------+ +| *Setter* | set_same_column_width(value) | ++----------+------------------------------+ +| *Getter* | is_same_column_width() | ++----------+------------------------------+ + .. _class_ItemList_select_mode: -- :ref:`SelectMode` **select_mode** - Allow single or multiple selection. See the ``SELECT_*`` constants. +- :ref:`SelectMode` **select_mode** ++----------+------------------------+ +| *Setter* | set_select_mode(value) | ++----------+------------------------+ +| *Getter* | get_select_mode() | ++----------+------------------------+ + +Allow single or multiple selection. See the ``SELECT_*`` constants. Method Descriptions ------------------- -.. _class_ItemList_add_icon_item: + .. _class_ItemList_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_add_item: - void **add_item** **(** :ref:`String` text, :ref:`Texture` icon=null, :ref:`bool` selectable=true **)** @@ -226,123 +356,123 @@ Adds an item to the item list with specified text. Specify an icon of null for If selectable is true the list item will be selectable. -.. _class_ItemList_clear: + .. _class_ItemList_clear: - void **clear** **(** **)** Remove all items from the list. -.. _class_ItemList_ensure_current_is_visible: + .. _class_ItemList_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_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_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_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_get_item_custom_fg_color: - :ref:`Color` **get_item_custom_fg_color** **(** :ref:`int` idx **)** const -.. _class_ItemList_get_item_icon: + .. _class_ItemList_get_item_icon: - :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const -.. _class_ItemList_get_item_icon_modulate: + .. _class_ItemList_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_get_item_icon_region: - :ref:`Rect2` **get_item_icon_region** **(** :ref:`int` idx **)** const -.. _class_ItemList_get_item_metadata: + .. _class_ItemList_get_item_metadata: - :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const -.. _class_ItemList_get_item_text: + .. _class_ItemList_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_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_get_selected_items: - :ref:`PoolIntArray` **get_selected_items** **(** **)** Returns the list of selected indexes. -.. _class_ItemList_get_v_scroll: + .. _class_ItemList_get_v_scroll: - :ref:`VScrollBar` **get_v_scroll** **(** **)** Returns the current vertical scroll bar for the List. -.. _class_ItemList_is_anything_selected: + .. _class_ItemList_is_anything_selected: - :ref:`bool` **is_anything_selected** **(** **)** Returns ``true`` if one or more items are selected. -.. _class_ItemList_is_item_disabled: + .. _class_ItemList_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_selectable: + .. _class_ItemList_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_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_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_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_remove_item: - void **remove_item** **(** :ref:`int` idx **)** Remove item at specified index from the list. -.. _class_ItemList_select: + .. _class_ItemList_select: - void **select** **(** :ref:`int` idx, :ref:`bool` single=true **)** @@ -350,15 +480,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_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_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_set_item_disabled: - void **set_item_disabled** **(** :ref:`int` idx, :ref:`bool` disabled **)** @@ -366,68 +496,67 @@ 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_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_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_set_item_icon_region: - void **set_item_icon_region** **(** :ref:`int` idx, :ref:`Rect2` rect **)** -.. _class_ItemList_set_item_metadata: + .. _class_ItemList_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_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_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_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_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_sort_items_by_text: - void **sort_items_by_text** **(** **)** Sorts items in the list by their text. -.. _class_ItemList_unselect: + .. _class_ItemList_unselect: - void **unselect** **(** :ref:`int` idx **)** Ensure item at specified index is not selected. -.. _class_ItemList_unselect_all: + .. _class_ItemList_unselect_all: - void **unselect_all** **(** **)** Ensure there are no items selected. - diff --git a/classes/class_javascript.rst b/classes/class_javascript.rst index e70d23076..1c808e6ad 100644 --- a/classes/class_javascript.rst +++ b/classes/class_javascript.rst @@ -8,6 +8,7 @@ JavaScript ========== **Inherits:** :ref:`Object` + **Category:** Core Brief Description @@ -31,11 +32,10 @@ Tutorials --------- - `#calling-javascript-from-script <../getting_started/workflow/export/exporting_for_web.html#calling-javascript-from-script>`_ in :doc:`../getting_started/workflow/export/exporting_for_web` - Method Descriptions ------------------- -.. _class_JavaScript_eval: + .. _class_JavaScript_eval: - :ref:`Variant` **eval** **(** :ref:`String` code, :ref:`bool` use_global_execution_context=false **)** @@ -43,4 +43,3 @@ Execute the string ``code`` as JavaScript code within the browser window. This i If ``use_global_execution_context`` is ``true``, the code will be evaluated in the global execution context. Otherwise, it is evaluated in the execution context of a function within the engine's runtime environment. - diff --git a/classes/class_joint.rst b/classes/class_joint.rst index 96e9b0bcb..8008830cd 100644 --- a/classes/class_joint.rst +++ b/classes/class_joint.rst @@ -8,7 +8,9 @@ Joint ===== **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`ConeTwistJoint`, :ref:`Generic6DOFJoint`, :ref:`SliderJoint`, :ref:`HingeJoint`, :ref:`PinJoint` + **Category:** Core Brief Description @@ -16,6 +18,19 @@ Brief Description 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` | ++---------------------------------+---------------------------------------------------------------------+ + Description ----------- @@ -26,18 +41,49 @@ Property Descriptions .. _class_Joint_collision/exclude_nodes: -- :ref:`bool` **collision/exclude_nodes** - If ``true`` the two bodies of the nodes are not able to collide with each other. +- :ref:`bool` **collision/exclude_nodes** + ++----------+-----------------------------------------+ +| *Setter* | set_exclude_nodes_from_collision(value) | ++----------+-----------------------------------------+ +| *Getter* | get_exclude_nodes_from_collision() | ++----------+-----------------------------------------+ + +If ``true`` the two bodies of the nodes are not able to collide with each other. .. _class_Joint_nodes/node_a: -- :ref:`NodePath` **nodes/node_a** - The :ref:`Node`, the first side of the Joint attaches to. +- :ref:`NodePath` **nodes/node_a** + ++----------+-------------------+ +| *Setter* | set_node_a(value) | ++----------+-------------------+ +| *Getter* | get_node_a() | ++----------+-------------------+ + +The :ref:`Node`, the first side of the Joint attaches to. .. _class_Joint_nodes/node_b: -- :ref:`NodePath` **nodes/node_b** - The :ref:`Node`, the second side of the Joint attaches to. +- :ref:`NodePath` **nodes/node_b** + ++----------+-------------------+ +| *Setter* | set_node_b(value) | ++----------+-------------------+ +| *Getter* | get_node_b() | ++----------+-------------------+ + +The :ref:`Node`, the second side of the Joint attaches to. .. _class_Joint_solver/priority: -- :ref:`int` **solver/priority** - The order in which the solver is executed compared to the other Joints, the lower, the earlier. +- :ref:`int` **solver/priority** ++----------+----------------------------+ +| *Setter* | set_solver_priority(value) | ++----------+----------------------------+ +| *Getter* | get_solver_priority() | ++----------+----------------------------+ + +The order in which the solver is executed compared to the other Joints, the lower, the earlier. diff --git a/classes/class_joint2d.rst b/classes/class_joint2d.rst index 7aa951dc4..86914f311 100644 --- a/classes/class_joint2d.rst +++ b/classes/class_joint2d.rst @@ -8,7 +8,9 @@ Joint2D ======= **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`PinJoint2D`, :ref:`DampedSpringJoint2D`, :ref:`GrooveJoint2D` + **Category:** Core Brief Description @@ -16,6 +18,19 @@ Brief Description 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` | ++---------------------------------+-----------------------------------------------------------+ + Description ----------- @@ -26,18 +41,49 @@ Property Descriptions .. _class_Joint2D_bias: -- :ref:`float` **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`` +- :ref:`float` **bias** + ++----------+-----------------+ +| *Setter* | set_bias(value) | ++----------+-----------------+ +| *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`` .. _class_Joint2D_disable_collision: -- :ref:`bool` **disable_collision** - If ``true`` :ref:`node_a` and :ref:`node_b` can collide. Default value: ``false``. +- :ref:`bool` **disable_collision** + ++----------+-----------------------------------------+ +| *Setter* | set_exclude_nodes_from_collision(value) | ++----------+-----------------------------------------+ +| *Getter* | get_exclude_nodes_from_collision() | ++----------+-----------------------------------------+ + +If ``true`` :ref:`node_a` and :ref:`node_b` can collide. Default value: ``false``. .. _class_Joint2D_node_a: -- :ref:`NodePath` **node_a** - The first body attached to the joint. Must derive from :ref:`PhysicsBody2D`. +- :ref:`NodePath` **node_a** + ++----------+-------------------+ +| *Setter* | set_node_a(value) | ++----------+-------------------+ +| *Getter* | get_node_a() | ++----------+-------------------+ + +The first body attached to the joint. Must derive from :ref:`PhysicsBody2D`. .. _class_Joint2D_node_b: -- :ref:`NodePath` **node_b** - The second body attached to the joint. Must derive from :ref:`PhysicsBody2D`. +- :ref:`NodePath` **node_b** ++----------+-------------------+ +| *Setter* | set_node_b(value) | ++----------+-------------------+ +| *Getter* | get_node_b() | ++----------+-------------------+ + +The second body attached to the joint. Must derive from :ref:`PhysicsBody2D`. diff --git a/classes/class_json.rst b/classes/class_json.rst index d32a157dd..b5a286b7a 100644 --- a/classes/class_json.rst +++ b/classes/class_json.rst @@ -8,6 +8,7 @@ JSON ==== **Inherits:** :ref:`Object` + **Category:** Core Brief Description @@ -32,16 +33,15 @@ Helper class for parsing JSON data. For usage example and other important hints, Method Descriptions ------------------- -.. _class_JSON_parse: + .. _class_JSON_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_print: - :ref:`String` **print** **(** :ref:`Variant` value, :ref:`String` indent="", :ref:`bool` sort_keys=false **)** Converts a Variant var to JSON text and returns the result. Useful for serializing data to store or send over the network. - diff --git a/classes/class_jsonparseresult.rst b/classes/class_jsonparseresult.rst index ea6258903..260a3bfd8 100644 --- a/classes/class_jsonparseresult.rst +++ b/classes/class_jsonparseresult.rst @@ -8,6 +8,7 @@ JSONParseResult =============== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,19 @@ Brief Description 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` | ++---------------------------------------+---------------------------------------------------------+ + Description ----------- @@ -25,19 +39,51 @@ Property Descriptions .. _class_JSONParseResult_error: -- :ref:`Error` **error** - The error type if JSON source was not successfully parsed. See :ref:`@GlobalScope` ERR\_\* constants. +- :ref:`Error` **error** + ++----------+------------------+ +| *Setter* | set_error(value) | ++----------+------------------+ +| *Getter* | get_error() | ++----------+------------------+ + +The error type if JSON source was not successfully parsed. See :ref:`@GlobalScope` ERR\_\* constants. .. _class_JSONParseResult_error_line: -- :ref:`int` **error_line** - The line number where the error occurred if JSON source was not successfully parsed. +- :ref:`int` **error_line** + ++----------+-----------------------+ +| *Setter* | set_error_line(value) | ++----------+-----------------------+ +| *Getter* | get_error_line() | ++----------+-----------------------+ + +The line number where the error occurred if JSON source was not successfully parsed. .. _class_JSONParseResult_error_string: -- :ref:`String` **error_string** - The error message if JSON source was not successfully parsed. See :ref:`@GlobalScope` ERR\_\* constants. +- :ref:`String` **error_string** + ++----------+-------------------------+ +| *Setter* | set_error_string(value) | ++----------+-------------------------+ +| *Getter* | get_error_string() | ++----------+-------------------------+ + +The error message if JSON source was not successfully parsed. See :ref:`@GlobalScope` ERR\_\* constants. .. _class_JSONParseResult_result: -- :ref:`Variant` **result** - A :ref:`Variant` containing the parsed JSON. Use typeof() to check if it is what you expect. For example, if JSON source starts with curly braces (``{}``) a :ref:`Dictionary` will be returned, if JSON source starts with braces (``[]``) an :ref:`Array` will be returned. +- :ref:`Variant` **result** + ++----------+-------------------+ +| *Setter* | set_result(value) | ++----------+-------------------+ +| *Getter* | get_result() | ++----------+-------------------+ + +A :ref:`Variant` containing the parsed JSON. Use typeof() to check if it is what you expect. For example, if JSON source starts with curly braces (``{}``) a :ref:`Dictionary` will be returned, if JSON source starts with braces (``[]``) an :ref:`Array` will be returned. *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 float types. @@ -51,4 +97,3 @@ Note that JSON objects do not preserve key order like Godot dictionaries, thus y else: print("unexpected results") - diff --git a/classes/class_kinematicbody.rst b/classes/class_kinematicbody.rst index d1c7e8d9b..9eb4685ad 100644 --- a/classes/class_kinematicbody.rst +++ b/classes/class_kinematicbody.rst @@ -8,6 +8,7 @@ KinematicBody ============= **Inherits:** :ref:`PhysicsBody` **<** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,19 @@ Brief Description 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` | ++---------------------------+-------------------------------------------------------------------------+ + Methods ------- @@ -53,67 +67,91 @@ Tutorials --------- - :doc:`../tutorials/physics/kinematic_character_2d` - Property Descriptions --------------------- .. _class_KinematicBody_collision/safe_margin: -- :ref:`float` **collision/safe_margin** - If the body is at least this close to another body, this body will consider them to be colliding. +- :ref:`float` **collision/safe_margin** + ++----------+------------------------+ +| *Setter* | set_safe_margin(value) | ++----------+------------------------+ +| *Getter* | get_safe_margin() | ++----------+------------------------+ + +If the body is at least this close to another body, this body will consider them to be colliding. .. _class_KinematicBody_move_lock_x: - :ref:`bool` **move_lock_x** ++----------+----------------------+ +| *Setter* | set_axis_lock(value) | ++----------+----------------------+ +| *Getter* | get_axis_lock() | ++----------+----------------------+ + .. _class_KinematicBody_move_lock_y: - :ref:`bool` **move_lock_y** ++----------+----------------------+ +| *Setter* | set_axis_lock(value) | ++----------+----------------------+ +| *Getter* | get_axis_lock() | ++----------+----------------------+ + .. _class_KinematicBody_move_lock_z: - :ref:`bool` **move_lock_z** ++----------+----------------------+ +| *Setter* | set_axis_lock(value) | ++----------+----------------------+ +| *Getter* | get_axis_lock() | ++----------+----------------------+ Method Descriptions ------------------- -.. _class_KinematicBody_get_floor_velocity: + .. _class_KinematicBody_get_floor_velocity: - :ref:`Vector3` **get_floor_velocity** **(** **)** const Returns the velocity of the floor. Only updates when calling :ref:`move_and_slide`. -.. _class_KinematicBody_get_slide_collision: + .. _class_KinematicBody_get_slide_collision: - :ref:`KinematicCollision` **get_slide_collision** **(** :ref:`int` slide_idx **)** Returns a :ref:`KinematicCollision`, which contains information about a collision that 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_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`. -.. _class_KinematicBody_is_on_ceiling: + .. _class_KinematicBody_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`. -.. _class_KinematicBody_is_on_floor: + .. _class_KinematicBody_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`. -.. _class_KinematicBody_is_on_wall: + .. _class_KinematicBody_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`. -.. _class_KinematicBody_move_and_collide: + .. _class_KinematicBody_move_and_collide: - :ref:`KinematicCollision` **move_and_collide** **(** :ref:`Vector3` rel_vec, :ref:`bool` infinite_inertia=true, :ref:`bool` test_only=false **)** @@ -121,7 +159,7 @@ Moves the body along the vector ``rel_vec``. The body will stop if it collides. If ``test_only`` is ``true[/true], the body does not move but the would-be collision information is given. -.. _class_KinematicBody_move_and_slide: + .. _class_KinematicBody_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 **)** @@ -139,7 +177,7 @@ If the body collides, it will change direction a maximum of ``max_slides`` times 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_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` infinite_inertia=true, :ref:`bool` stop_on_slope=false, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** @@ -147,10 +185,9 @@ Moves the body while keeping it attached to slopes. Similar to :ref:`move_and_sl 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_test_move: - :ref:`bool` **test_move** **(** :ref:`Transform` from, :ref:`Vector3` rel_vec, :ref:`bool` infinite_inertia **)** Checks for collisions without moving the body. Virtually sets the node's position, scale and rotation to that of the given :ref:`Transform`, then tries to move the body along the vector ``rel_vec``. Returns ``true`` if a collision would occur. - diff --git a/classes/class_kinematicbody2d.rst b/classes/class_kinematicbody2d.rst index 3a9a1fe0c..3ae36d070 100644 --- a/classes/class_kinematicbody2d.rst +++ b/classes/class_kinematicbody2d.rst @@ -8,6 +8,7 @@ KinematicBody2D =============== **Inherits:** :ref:`PhysicsBody2D` **<** :ref:`CollisionObject2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description Kinematic body 2D node. +Properties +---------- + ++---------------------------+-----------------------------------------------------------------------------+ +| :ref:`float` | :ref:`collision/safe_margin` | ++---------------------------+-----------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`motion/sync_to_physics` | ++---------------------------+-----------------------------------------------------------------------------+ + Methods ------- @@ -54,59 +64,74 @@ Property Descriptions .. _class_KinematicBody2D_collision/safe_margin: -- :ref:`float` **collision/safe_margin** - If the body is at least this close to another body, this body will consider them to be colliding. +- :ref:`float` **collision/safe_margin** + ++----------+------------------------+ +| *Setter* | set_safe_margin(value) | ++----------+------------------------+ +| *Getter* | get_safe_margin() | ++----------+------------------------+ + +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: -- :ref:`bool` **motion/sync_to_physics** - If ``true`` the body's movement will be synchronized to the physics frame. This is useful when animating movement via :ref:`AnimationPlayer`, for example on moving platforms. +- :ref:`bool` **motion/sync_to_physics** ++----------+------------------------------+ +| *Setter* | set_sync_to_physics(value) | ++----------+------------------------------+ +| *Getter* | is_sync_to_physics_enabled() | ++----------+------------------------------+ + +If ``true`` the body's movement will be synchronized to the physics frame. This is useful when animating movement via :ref:`AnimationPlayer`, for example on moving platforms. Method Descriptions ------------------- -.. _class_KinematicBody2D_get_floor_velocity: + .. _class_KinematicBody2D_get_floor_velocity: - :ref:`Vector2` **get_floor_velocity** **(** **)** const Returns the velocity of the floor. Only updates when calling :ref:`move_and_slide`. -.. _class_KinematicBody2D_get_slide_collision: + .. _class_KinematicBody2D_get_slide_collision: - :ref:`KinematicCollision2D` **get_slide_collision** **(** :ref:`int` slide_idx **)** Returns a :ref:`KinematicCollision2D`, which contains information about a collision that 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_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`. -.. _class_KinematicBody2D_is_on_ceiling: + .. _class_KinematicBody2D_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`. -.. _class_KinematicBody2D_is_on_floor: + .. _class_KinematicBody2D_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`. -.. _class_KinematicBody2D_is_on_wall: + .. _class_KinematicBody2D_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`. -.. _class_KinematicBody2D_move_and_collide: + .. _class_KinematicBody2D_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_move_and_slide: - :ref:`Vector2` **move_and_slide** **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`bool` infinite_inertia=true, :ref:`bool` stop_on_slope=false, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** @@ -124,7 +149,7 @@ If the body collides, it will change direction a maximum of ``max_bounces`` time Returns the movement that remained when the body stopped. To get more detailed information about collisions that occurred, use :ref:`get_slide_collision`. -.. _class_KinematicBody2D_move_and_slide_with_snap: + .. _class_KinematicBody2D_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` infinite_inertia=true, :ref:`bool` stop_on_slope=false, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** @@ -132,10 +157,9 @@ Moves the body while keeping it attached to slopes. Similar to :ref:`move_and_sl 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_test_move: - :ref:`bool` **test_move** **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec, :ref:`bool` infinite_inertia **)** Checks for collisions without moving the body. Virtually sets the node's position, scale and rotation to that of the given :ref:`Transform2D`, then tries to move the body along the vector ``rel_vec``. Returns ``true`` if a collision would occur. - diff --git a/classes/class_kinematiccollision.rst b/classes/class_kinematiccollision.rst index 1f9e9ba15..5d88672e7 100644 --- a/classes/class_kinematiccollision.rst +++ b/classes/class_kinematiccollision.rst @@ -8,6 +8,7 @@ KinematicCollision ================== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,33 @@ Brief Description 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` | ++-------------------------------+----------------------------------------------------------------------------+ + Description ----------- @@ -27,46 +55,111 @@ Property Descriptions .. _class_KinematicCollision_collider: -- :ref:`Object` **collider** - The colliding body. +- :ref:`Object` **collider** + ++----------+----------------+ +| *Getter* | get_collider() | ++----------+----------------+ + +The colliding body. .. _class_KinematicCollision_collider_id: -- :ref:`int` **collider_id** - The colliding body's unique :ref:`RID`. +- :ref:`int` **collider_id** + ++----------+-------------------+ +| *Getter* | get_collider_id() | ++----------+-------------------+ + +The colliding body's unique :ref:`RID`. .. _class_KinematicCollision_collider_metadata: -- :ref:`Variant` **collider_metadata** - The colliding body's metadata. See :ref:`Object`. +- :ref:`Variant` **collider_metadata** + ++----------+-------------------------+ +| *Getter* | get_collider_metadata() | ++----------+-------------------------+ + +The colliding body's metadata. See :ref:`Object`. .. _class_KinematicCollision_collider_shape: -- :ref:`Object` **collider_shape** - The colliding body's shape. +- :ref:`Object` **collider_shape** + ++----------+----------------------+ +| *Getter* | get_collider_shape() | ++----------+----------------------+ + +The colliding body's shape. .. _class_KinematicCollision_collider_shape_index: -- :ref:`int` **collider_shape_index** - The colliding shape's index. See :ref:`CollisionObject`. +- :ref:`int` **collider_shape_index** + ++----------+----------------------------+ +| *Getter* | get_collider_shape_index() | ++----------+----------------------------+ + +The colliding shape's index. See :ref:`CollisionObject`. .. _class_KinematicCollision_collider_velocity: -- :ref:`Vector3` **collider_velocity** - The colliding object's velocity. +- :ref:`Vector3` **collider_velocity** + ++----------+-------------------------+ +| *Getter* | get_collider_velocity() | ++----------+-------------------------+ + +The colliding object's velocity. .. _class_KinematicCollision_local_shape: -- :ref:`Object` **local_shape** - The moving object's colliding shape. +- :ref:`Object` **local_shape** + ++----------+-------------------+ +| *Getter* | get_local_shape() | ++----------+-------------------+ + +The moving object's colliding shape. .. _class_KinematicCollision_normal: -- :ref:`Vector3` **normal** - The colliding body's shape's normal at the point of collision. +- :ref:`Vector3` **normal** + ++----------+--------------+ +| *Getter* | get_normal() | ++----------+--------------+ + +The colliding body's shape's normal at the point of collision. .. _class_KinematicCollision_position: -- :ref:`Vector3` **position** - The point of collision. +- :ref:`Vector3` **position** + ++----------+----------------+ +| *Getter* | get_position() | ++----------+----------------+ + +The point of collision. .. _class_KinematicCollision_remainder: -- :ref:`Vector3` **remainder** - The moving object's remaining movement vector. +- :ref:`Vector3` **remainder** + ++----------+-----------------+ +| *Getter* | get_remainder() | ++----------+-----------------+ + +The moving object's remaining movement vector. .. _class_KinematicCollision_travel: -- :ref:`Vector3` **travel** - The distance the moving object traveled before collision. +- :ref:`Vector3` **travel** ++----------+--------------+ +| *Getter* | get_travel() | ++----------+--------------+ + +The distance the moving object traveled before collision. diff --git a/classes/class_kinematiccollision2d.rst b/classes/class_kinematiccollision2d.rst index 1d22b80b1..8bcfeb17d 100644 --- a/classes/class_kinematiccollision2d.rst +++ b/classes/class_kinematiccollision2d.rst @@ -8,6 +8,7 @@ KinematicCollision2D ==================== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,33 @@ Brief Description 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` | ++-------------------------------+------------------------------------------------------------------------------+ + Description ----------- @@ -27,46 +55,111 @@ Property Descriptions .. _class_KinematicCollision2D_collider: -- :ref:`Object` **collider** - The colliding body. +- :ref:`Object` **collider** + ++----------+----------------+ +| *Getter* | get_collider() | ++----------+----------------+ + +The colliding body. .. _class_KinematicCollision2D_collider_id: -- :ref:`int` **collider_id** - The colliding body's unique :ref:`RID`. +- :ref:`int` **collider_id** + ++----------+-------------------+ +| *Getter* | get_collider_id() | ++----------+-------------------+ + +The colliding body's unique :ref:`RID`. .. _class_KinematicCollision2D_collider_metadata: -- :ref:`Variant` **collider_metadata** - The colliding body's metadata. See :ref:`Object`. +- :ref:`Variant` **collider_metadata** + ++----------+-------------------------+ +| *Getter* | get_collider_metadata() | ++----------+-------------------------+ + +The colliding body's metadata. See :ref:`Object`. .. _class_KinematicCollision2D_collider_shape: -- :ref:`Object` **collider_shape** - The colliding body's shape. +- :ref:`Object` **collider_shape** + ++----------+----------------------+ +| *Getter* | get_collider_shape() | ++----------+----------------------+ + +The colliding body's shape. .. _class_KinematicCollision2D_collider_shape_index: -- :ref:`int` **collider_shape_index** - The colliding shape's index. See :ref:`CollisionObject2D`. +- :ref:`int` **collider_shape_index** + ++----------+----------------------------+ +| *Getter* | get_collider_shape_index() | ++----------+----------------------------+ + +The colliding shape's index. See :ref:`CollisionObject2D`. .. _class_KinematicCollision2D_collider_velocity: -- :ref:`Vector2` **collider_velocity** - The colliding object's velocity. +- :ref:`Vector2` **collider_velocity** + ++----------+-------------------------+ +| *Getter* | get_collider_velocity() | ++----------+-------------------------+ + +The colliding object's velocity. .. _class_KinematicCollision2D_local_shape: -- :ref:`Object` **local_shape** - The moving object's colliding shape. +- :ref:`Object` **local_shape** + ++----------+-------------------+ +| *Getter* | get_local_shape() | ++----------+-------------------+ + +The moving object's colliding shape. .. _class_KinematicCollision2D_normal: -- :ref:`Vector2` **normal** - The colliding body's shape's normal at the point of collision. +- :ref:`Vector2` **normal** + ++----------+--------------+ +| *Getter* | get_normal() | ++----------+--------------+ + +The colliding body's shape's normal at the point of collision. .. _class_KinematicCollision2D_position: -- :ref:`Vector2` **position** - The point of collision. +- :ref:`Vector2` **position** + ++----------+----------------+ +| *Getter* | get_position() | ++----------+----------------+ + +The point of collision. .. _class_KinematicCollision2D_remainder: -- :ref:`Vector2` **remainder** - The moving object's remaining movement vector. +- :ref:`Vector2` **remainder** + ++----------+-----------------+ +| *Getter* | get_remainder() | ++----------+-----------------+ + +The moving object's remaining movement vector. .. _class_KinematicCollision2D_travel: -- :ref:`Vector2` **travel** - The distance the moving object traveled before collision. +- :ref:`Vector2` **travel** ++----------+--------------+ +| *Getter* | get_travel() | ++----------+--------------+ + +The distance the moving object traveled before collision. diff --git a/classes/class_label.rst b/classes/class_label.rst index adac244ee..3325304de 100644 --- a/classes/class_label.rst +++ b/classes/class_label.rst @@ -8,6 +8,7 @@ Label ===== **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,31 @@ Brief Description Displays plain text in a line or wrapped inside a rectangle. For formatted text, use :ref:`RichTextLabel`. +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` | ++----------------------------------+-----------------------------------------------------------+ + Methods ------- @@ -28,12 +54,35 @@ Methods | :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` | ++---------------------------------+-----------------------------------------------------------------+ + Enumerations ------------ .. _enum_Label_Align: -enum **Align** +enum **Align**: - **ALIGN_LEFT** = **0** --- Align rows to the left (default). - **ALIGN_CENTER** = **1** --- Align rows centered. @@ -42,14 +91,13 @@ enum **Align** .. _enum_Label_VAlign: -enum **VAlign** +enum **VAlign**: - **VALIGN_TOP** = **0** --- Align the whole text to the top. - **VALIGN_CENTER** = **1** --- Align the whole text to the center. - **VALIGN_BOTTOM** = **2** --- Align the whole text to the bottom. - **VALIGN_FILL** = **3** --- Align the whole text by spreading the rows. - Description ----------- @@ -62,70 +110,148 @@ Property Descriptions .. _class_Label_align: -- :ref:`Align` **align** - Controls the text's horizontal align. Supports left, center, right, and fill, or justify. Set it to one of the ``ALIGN_*`` constants. +- :ref:`Align` **align** + ++----------+------------------+ +| *Setter* | set_align(value) | ++----------+------------------+ +| *Getter* | get_align() | ++----------+------------------+ + +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: -- :ref:`bool` **autowrap** - 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. +- :ref:`bool` **autowrap** + ++----------+---------------------+ +| *Setter* | set_autowrap(value) | ++----------+---------------------+ +| *Getter* | has_autowrap() | ++----------+---------------------+ + +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: -- :ref:`bool` **clip_text** - If ``true``, the Label only shows the text that fits inside its bounding rectangle. It also lets you scale the node down freely. +- :ref:`bool` **clip_text** + ++----------+----------------------+ +| *Setter* | set_clip_text(value) | ++----------+----------------------+ +| *Getter* | is_clipping_text() | ++----------+----------------------+ + +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: -- :ref:`int` **lines_skipped** - The node ignores the first ``lines_skipped`` lines before it starts to display text. +- :ref:`int` **lines_skipped** + ++----------+--------------------------+ +| *Setter* | set_lines_skipped(value) | ++----------+--------------------------+ +| *Getter* | get_lines_skipped() | ++----------+--------------------------+ + +The node ignores the first ``lines_skipped`` lines before it starts to display text. .. _class_Label_max_lines_visible: -- :ref:`int` **max_lines_visible** - Limits the lines of text the node shows on screen. +- :ref:`int` **max_lines_visible** + ++----------+------------------------------+ +| *Setter* | set_max_lines_visible(value) | ++----------+------------------------------+ +| *Getter* | get_max_lines_visible() | ++----------+------------------------------+ + +Limits the lines of text the node shows on screen. .. _class_Label_percent_visible: -- :ref:`float` **percent_visible** - 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. +- :ref:`float` **percent_visible** + ++----------+----------------------------+ +| *Setter* | set_percent_visible(value) | ++----------+----------------------------+ +| *Getter* | get_percent_visible() | ++----------+----------------------------+ + +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: -- :ref:`String` **text** - The text to display on screen. +- :ref:`String` **text** + ++----------+-----------------+ +| *Setter* | set_text(value) | ++----------+-----------------+ +| *Getter* | get_text() | ++----------+-----------------+ + +The text to display on screen. .. _class_Label_uppercase: -- :ref:`bool` **uppercase** - If ``true``, all the text displays as UPPERCASE. +- :ref:`bool` **uppercase** + ++----------+----------------------+ +| *Setter* | set_uppercase(value) | ++----------+----------------------+ +| *Getter* | is_uppercase() | ++----------+----------------------+ + +If ``true``, all the text displays as UPPERCASE. .. _class_Label_valign: -- :ref:`VAlign` **valign** - Controls the text's vertical align. Supports top, center, bottom, and fill. Set it to one of the ``VALIGN_*`` constants. +- :ref:`VAlign` **valign** + ++----------+-------------------+ +| *Setter* | set_valign(value) | ++----------+-------------------+ +| *Getter* | get_valign() | ++----------+-------------------+ + +Controls the text's vertical align. Supports top, center, bottom, and fill. Set it to one of the ``VALIGN_*`` constants. .. _class_Label_visible_characters: -- :ref:`int` **visible_characters** - Restricts the number of characters to display. Set to -1 to disable. +- :ref:`int` **visible_characters** ++----------+-------------------------------+ +| *Setter* | set_visible_characters(value) | ++----------+-------------------------------+ +| *Getter* | get_visible_characters() | ++----------+-------------------------------+ + +Restricts the number of characters to display. Set to -1 to disable. Method Descriptions ------------------- -.. _class_Label_get_line_count: + .. _class_Label_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_get_line_height: - :ref:`int` **get_line_height** **(** **)** const Returns the font size in pixels. -.. _class_Label_get_total_character_count: + .. _class_Label_get_total_character_count: - :ref:`int` **get_total_character_count** **(** **)** const Returns the total length of the text. -.. _class_Label_get_visible_line_count: + .. _class_Label_get_visible_line_count: - :ref:`int` **get_visible_line_count** **(** **)** const Returns the number of lines shown. Useful if the ``Label`` 's height cannot currently display all lines. - diff --git a/classes/class_largetexture.rst b/classes/class_largetexture.rst index a50dcb673..f852406ac 100644 --- a/classes/class_largetexture.rst +++ b/classes/class_largetexture.rst @@ -8,6 +8,7 @@ LargeTexture ============ **Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -46,52 +47,51 @@ You can dynamically add pieces(:ref:`Texture`) to this ``LargeTex Method Descriptions ------------------- -.. _class_LargeTexture_add_piece: + .. _class_LargeTexture_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_clear: - void **clear** **(** **)** Clears the ``LargeTexture``. -.. _class_LargeTexture_get_piece_count: + .. _class_LargeTexture_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_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_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_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_set_piece_texture: - void **set_piece_texture** **(** :ref:`int` idx, :ref:`Texture` texture **)** Sets the :ref:`Texture` of the piece with index "idx" to "ofs". -.. _class_LargeTexture_set_size: + .. _class_LargeTexture_set_size: - void **set_size** **(** :ref:`Vector2` size **)** Sets the size of this ``LargeTexture``. - diff --git a/classes/class_light.rst b/classes/class_light.rst index d21bb929a..47cc86252 100644 --- a/classes/class_light.rst +++ b/classes/class_light.rst @@ -8,7 +8,9 @@ Light ===== **Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`SpotLight`, :ref:`OmniLight`, :ref:`DirectionalLight` + **Category:** Core Brief Description @@ -16,12 +18,43 @@ Brief Description 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` | ++--------------------------------------+-----------------------------------------------------------------------+ + Enumerations ------------ .. _enum_Light_BakeMode: -enum **BakeMode** +enum **BakeMode**: - **BAKE_DISABLED** = **0** --- Light is ignored when baking. Note: hiding a light does *not* affect baking. - **BAKE_INDIRECT** = **1** --- Only indirect lighting will be baked. Default value. @@ -29,7 +62,7 @@ enum **BakeMode** .. _enum_Light_Param: -enum **Param** +enum **Param**: - **PARAM_ENERGY** = **0** - **PARAM_INDIRECT_ENERGY** = **1** @@ -48,7 +81,6 @@ enum **Param** - **PARAM_SHADOW_BIAS_SPLIT_SCALE** = **14** - **PARAM_MAX** = **15** - Description ----------- @@ -58,60 +90,160 @@ Tutorials --------- - :doc:`../tutorials/3d/lights_and_shadows` - Property Descriptions --------------------- .. _class_Light_editor_only: -- :ref:`bool` **editor_only** - If ``true`` the light only appears in the editor and will not be visible at runtime. Default value:``false``. +- :ref:`bool` **editor_only** + ++----------+------------------------+ +| *Setter* | set_editor_only(value) | ++----------+------------------------+ +| *Getter* | is_editor_only() | ++----------+------------------------+ + +If ``true`` the light only appears in the editor and will not be visible at runtime. Default value:``false``. .. _class_Light_light_bake_mode: -- :ref:`BakeMode` **light_bake_mode** - The light's bake mode. See :ref:`BakeMode`. +- :ref:`BakeMode` **light_bake_mode** + ++----------+----------------------+ +| *Setter* | set_bake_mode(value) | ++----------+----------------------+ +| *Getter* | get_bake_mode() | ++----------+----------------------+ + +The light's bake mode. See :ref:`BakeMode`. .. _class_Light_light_color: -- :ref:`Color` **light_color** - The light's color. +- :ref:`Color` **light_color** + ++----------+------------------+ +| *Setter* | set_color(value) | ++----------+------------------+ +| *Getter* | get_color() | ++----------+------------------+ + +The light's color. .. _class_Light_light_cull_mask: -- :ref:`int` **light_cull_mask** - The light will affect objects in the selected layers. +- :ref:`int` **light_cull_mask** + ++----------+----------------------+ +| *Setter* | set_cull_mask(value) | ++----------+----------------------+ +| *Getter* | get_cull_mask() | ++----------+----------------------+ + +The light will affect objects in the selected layers. .. _class_Light_light_energy: -- :ref:`float` **light_energy** - The light's strength multiplier. +- :ref:`float` **light_energy** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +The light's strength multiplier. .. _class_Light_light_indirect_energy: -- :ref:`float` **light_indirect_energy** - Secondary multiplier used with indirect light (light bounces). This works in baked light or GIProbe. +- :ref:`float` **light_indirect_energy** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +Secondary multiplier used with indirect light (light bounces). This works in baked light or GIProbe. .. _class_Light_light_negative: -- :ref:`bool` **light_negative** - If ``true`` the light's effect is reversed, darkening areas and casting bright shadows. Default value: ``false``. +- :ref:`bool` **light_negative** + ++----------+---------------------+ +| *Setter* | set_negative(value) | ++----------+---------------------+ +| *Getter* | is_negative() | ++----------+---------------------+ + +If ``true`` the light's effect is reversed, darkening areas and casting bright shadows. Default value: ``false``. .. _class_Light_light_specular: -- :ref:`float` **light_specular** - The intensity of the specular blob in objects affected by the light. At ``0`` the light becomes a pure diffuse light. +- :ref:`float` **light_specular** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +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: -- :ref:`float` **shadow_bias** - 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. +- :ref:`float` **shadow_bias** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +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: -- :ref:`Color` **shadow_color** - The color of shadows cast by this light. +- :ref:`Color` **shadow_color** + ++----------+-------------------------+ +| *Setter* | set_shadow_color(value) | ++----------+-------------------------+ +| *Getter* | get_shadow_color() | ++----------+-------------------------+ + +The color of shadows cast by this light. .. _class_Light_shadow_contact: -- :ref:`float` **shadow_contact** - Attempts to reduce :ref:`shadow_bias` gap. +- :ref:`float` **shadow_contact** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +Attempts to reduce :ref:`shadow_bias` gap. .. _class_Light_shadow_enabled: -- :ref:`bool` **shadow_enabled** - If ``true`` the light will cast shadows. Default value: ``false``. +- :ref:`bool` **shadow_enabled** + ++----------+-------------------+ +| *Setter* | set_shadow(value) | ++----------+-------------------+ +| *Getter* | has_shadow() | ++----------+-------------------+ + +If ``true`` the light will cast shadows. Default value: ``false``. .. _class_Light_shadow_reverse_cull_face: - :ref:`bool` **shadow_reverse_cull_face** ++----------+-------------------------------------+ +| *Setter* | set_shadow_reverse_cull_face(value) | ++----------+-------------------------------------+ +| *Getter* | get_shadow_reverse_cull_face() | ++----------+-------------------------------------+ diff --git a/classes/class_light2d.rst b/classes/class_light2d.rst index 256fb57c4..b672a4507 100644 --- a/classes/class_light2d.rst +++ b/classes/class_light2d.rst @@ -8,6 +8,7 @@ Light2D ======= **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,12 +16,59 @@ Brief Description 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` | ++------------------------------------------------+---------------------------------------------------------------------+ + Enumerations ------------ .. _enum_Light2D_Mode: -enum **Mode** +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. - **MODE_SUB** = **1** --- Subtracts the value of pixels corresponding to the Light2D to the values of pixels under it, resulting in inversed light effect. @@ -29,7 +77,7 @@ enum **Mode** .. _enum_Light2D_ShadowFilter: -enum **ShadowFilter** +enum **ShadowFilter**: - **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`. @@ -38,7 +86,6 @@ enum **ShadowFilter** - **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`. - Description ----------- @@ -49,86 +96,253 @@ Property Descriptions .. _class_Light2D_color: -- :ref:`Color` **color** - The Light2D's :ref:`Color`. +- :ref:`Color` **color** + ++----------+------------------+ +| *Setter* | set_color(value) | ++----------+------------------+ +| *Getter* | get_color() | ++----------+------------------+ + +The Light2D's :ref:`Color`. .. _class_Light2D_editor_only: -- :ref:`bool` **editor_only** - If ``true`` Light2D will only appear when editing the scene. Default value: ``false``. +- :ref:`bool` **editor_only** + ++----------+------------------------+ +| *Setter* | set_editor_only(value) | ++----------+------------------------+ +| *Getter* | is_editor_only() | ++----------+------------------------+ + +If ``true`` Light2D will only appear when editing the scene. Default value: ``false``. .. _class_Light2D_enabled: -- :ref:`bool` **enabled** - If ``true`` Light2D will emit light. Default value: ``true``. +- :ref:`bool` **enabled** + ++----------+--------------------+ +| *Setter* | set_enabled(value) | ++----------+--------------------+ +| *Getter* | is_enabled() | ++----------+--------------------+ + +If ``true`` Light2D will emit light. Default value: ``true``. .. _class_Light2D_energy: -- :ref:`float` **energy** - The Light2D's energy value. The larger the value, the stronger the light. +- :ref:`float` **energy** + ++----------+-------------------+ +| *Setter* | set_energy(value) | ++----------+-------------------+ +| *Getter* | get_energy() | ++----------+-------------------+ + +The Light2D's energy value. The larger the value, the stronger the light. .. _class_Light2D_mode: -- :ref:`Mode` **mode** - The Light2D's mode. See MODE\_\* constants for values. +- :ref:`Mode` **mode** + ++----------+-----------------+ +| *Setter* | set_mode(value) | ++----------+-----------------+ +| *Getter* | get_mode() | ++----------+-----------------+ + +The Light2D's mode. See MODE\_\* constants for values. .. _class_Light2D_offset: -- :ref:`Vector2` **offset** - The offset of the Light2D's ``texture``. +- :ref:`Vector2` **offset** + ++----------+---------------------------+ +| *Setter* | set_texture_offset(value) | ++----------+---------------------------+ +| *Getter* | get_texture_offset() | ++----------+---------------------------+ + +The offset of the Light2D's ``texture``. .. _class_Light2D_range_height: -- :ref:`float` **range_height** - The height of the Light2D. Used with 2D normal mapping. +- :ref:`float` **range_height** + ++----------+-------------------+ +| *Setter* | set_height(value) | ++----------+-------------------+ +| *Getter* | get_height() | ++----------+-------------------+ + +The height of the Light2D. Used with 2D normal mapping. .. _class_Light2D_range_item_cull_mask: -- :ref:`int` **range_item_cull_mask** - The layer mask. Only objects with a matching mask will be affected by the Light2D. +- :ref:`int` **range_item_cull_mask** + ++----------+---------------------------+ +| *Setter* | set_item_cull_mask(value) | ++----------+---------------------------+ +| *Getter* | get_item_cull_mask() | ++----------+---------------------------+ + +The layer mask. Only objects with a matching mask will be affected by the Light2D. .. _class_Light2D_range_layer_max: -- :ref:`int` **range_layer_max** - Maximum layer value of objects that are affected by the Light2D. Default value: ``0``. +- :ref:`int` **range_layer_max** + ++----------+----------------------------+ +| *Setter* | set_layer_range_max(value) | ++----------+----------------------------+ +| *Getter* | get_layer_range_max() | ++----------+----------------------------+ + +Maximum layer value of objects that are affected by the Light2D. Default value: ``0``. .. _class_Light2D_range_layer_min: -- :ref:`int` **range_layer_min** - Minimum layer value of objects that are affected by the Light2D. Default value: ``0``. +- :ref:`int` **range_layer_min** + ++----------+----------------------------+ +| *Setter* | set_layer_range_min(value) | ++----------+----------------------------+ +| *Getter* | get_layer_range_min() | ++----------+----------------------------+ + +Minimum layer value of objects that are affected by the Light2D. Default value: ``0``. .. _class_Light2D_range_z_max: -- :ref:`int` **range_z_max** - Maximum ``Z`` value of objects that are affected by the Light2D. Default value: ``1024``. +- :ref:`int` **range_z_max** + ++----------+------------------------+ +| *Setter* | set_z_range_max(value) | ++----------+------------------------+ +| *Getter* | get_z_range_max() | ++----------+------------------------+ + +Maximum ``Z`` value of objects that are affected by the Light2D. Default value: ``1024``. .. _class_Light2D_range_z_min: -- :ref:`int` **range_z_min** - Minimum ``z`` value of objects that are affected by the Light2D. Default value: ``-1024``. +- :ref:`int` **range_z_min** + ++----------+------------------------+ +| *Setter* | set_z_range_min(value) | ++----------+------------------------+ +| *Getter* | get_z_range_min() | ++----------+------------------------+ + +Minimum ``z`` value of objects that are affected by the Light2D. Default value: ``-1024``. .. _class_Light2D_shadow_buffer_size: -- :ref:`int` **shadow_buffer_size** - Shadow buffer size. Default value: ``2048``. +- :ref:`int` **shadow_buffer_size** + ++----------+-------------------------------+ +| *Setter* | set_shadow_buffer_size(value) | ++----------+-------------------------------+ +| *Getter* | get_shadow_buffer_size() | ++----------+-------------------------------+ + +Shadow buffer size. Default value: ``2048``. .. _class_Light2D_shadow_color: -- :ref:`Color` **shadow_color** - :ref:`Color` of shadows cast by the Light2D. +- :ref:`Color` **shadow_color** + ++----------+-------------------------+ +| *Setter* | set_shadow_color(value) | ++----------+-------------------------+ +| *Getter* | get_shadow_color() | ++----------+-------------------------+ + +:ref:`Color` of shadows cast by the Light2D. .. _class_Light2D_shadow_enabled: -- :ref:`bool` **shadow_enabled** - If ``true`` the Light2D will cast shadows. Default value: ``false``. +- :ref:`bool` **shadow_enabled** + ++----------+---------------------------+ +| *Setter* | set_shadow_enabled(value) | ++----------+---------------------------+ +| *Getter* | is_shadow_enabled() | ++----------+---------------------------+ + +If ``true`` the Light2D will cast shadows. Default value: ``false``. .. _class_Light2D_shadow_filter: -- :ref:`ShadowFilter` **shadow_filter** - Shadow filter type. Use SHADOW_FILTER\_\* constants to set ``shadow_filter``. Default value: ``None``. +- :ref:`ShadowFilter` **shadow_filter** + ++----------+--------------------------+ +| *Setter* | set_shadow_filter(value) | ++----------+--------------------------+ +| *Getter* | get_shadow_filter() | ++----------+--------------------------+ + +Shadow filter type. Use SHADOW_FILTER\_\* constants to set ``shadow_filter``. Default value: ``None``. .. _class_Light2D_shadow_filter_smooth: -- :ref:`float` **shadow_filter_smooth** - Smoothing value for shadows. +- :ref:`float` **shadow_filter_smooth** + ++----------+--------------------------+ +| *Setter* | set_shadow_smooth(value) | ++----------+--------------------------+ +| *Getter* | get_shadow_smooth() | ++----------+--------------------------+ + +Smoothing value for shadows. .. _class_Light2D_shadow_gradient_length: -- :ref:`float` **shadow_gradient_length** - Smooth shadow gradient length. +- :ref:`float` **shadow_gradient_length** + ++----------+-----------------------------------+ +| *Setter* | set_shadow_gradient_length(value) | ++----------+-----------------------------------+ +| *Getter* | get_shadow_gradient_length() | ++----------+-----------------------------------+ + +Smooth shadow gradient length. .. _class_Light2D_shadow_item_cull_mask: -- :ref:`int` **shadow_item_cull_mask** - The shadow mask. Used with :ref:`LightOccluder2D` to cast shadows. Only occluders with a matching shadow mask will cast shadows. +- :ref:`int` **shadow_item_cull_mask** + ++----------+----------------------------------+ +| *Setter* | set_item_shadow_cull_mask(value) | ++----------+----------------------------------+ +| *Getter* | get_item_shadow_cull_mask() | ++----------+----------------------------------+ + +The shadow mask. Used with :ref:`LightOccluder2D` to cast shadows. Only occluders with a matching shadow mask will cast shadows. .. _class_Light2D_texture: -- :ref:`Texture` **texture** - :ref:`Texture` used for the Light2D's appearance. +- :ref:`Texture` **texture** + ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + +:ref:`Texture` used for the Light2D's appearance. .. _class_Light2D_texture_scale: -- :ref:`float` **texture_scale** - The ``texture``'s scale factor. +- :ref:`float` **texture_scale** ++----------+--------------------------+ +| *Setter* | set_texture_scale(value) | ++----------+--------------------------+ +| *Getter* | get_texture_scale() | ++----------+--------------------------+ + +The ``texture``'s scale factor. diff --git a/classes/class_lightoccluder2d.rst b/classes/class_lightoccluder2d.rst index 95b03da1f..0b6f2e92c 100644 --- a/classes/class_lightoccluder2d.rst +++ b/classes/class_lightoccluder2d.rst @@ -8,6 +8,7 @@ LightOccluder2D =============== **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description Occludes light cast by a Light2D, casting shadows. +Properties +---------- + ++---------------------------------------------------+-----------------------------------------------------+ +| :ref:`int` | :ref:`light_mask` | ++---------------------------------------------------+-----------------------------------------------------+ +| :ref:`OccluderPolygon2D` | :ref:`occluder` | ++---------------------------------------------------+-----------------------------------------------------+ + Description ----------- @@ -25,10 +35,25 @@ Property Descriptions .. _class_LightOccluder2D_light_mask: -- :ref:`int` **light_mask** - The LightOccluder2D's light mask. The LightOccluder2D will cast shadows only from Light2D(s) that have the same light mask(s). +- :ref:`int` **light_mask** + ++----------+--------------------------------+ +| *Setter* | set_occluder_light_mask(value) | ++----------+--------------------------------+ +| *Getter* | get_occluder_light_mask() | ++----------+--------------------------------+ + +The LightOccluder2D's light mask. The LightOccluder2D will cast shadows only from Light2D(s) that have the same light mask(s). .. _class_LightOccluder2D_occluder: -- :ref:`OccluderPolygon2D` **occluder** - The :ref:`OccluderPolygon2D` used to compute the shadow. +- :ref:`OccluderPolygon2D` **occluder** ++----------+-----------------------------+ +| *Setter* | set_occluder_polygon(value) | ++----------+-----------------------------+ +| *Getter* | get_occluder_polygon() | ++----------+-----------------------------+ + +The :ref:`OccluderPolygon2D` used to compute the shadow. diff --git a/classes/class_line2d.rst b/classes/class_line2d.rst index 719ab8883..91e3c6ff4 100644 --- a/classes/class_line2d.rst +++ b/classes/class_line2d.rst @@ -8,6 +8,7 @@ Line2D ====== **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,33 @@ Brief Description 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` | ++-----------------------------------------------------+------------------------------------------------------+ + Methods ------- @@ -35,7 +63,7 @@ Enumerations .. _enum_Line2D_LineCapMode: -enum **LineCapMode** +enum **LineCapMode**: - **LINE_CAP_NONE** = **0** --- Don't have a line cap. - **LINE_CAP_BOX** = **1** --- Draws the line cap as a box. @@ -43,7 +71,7 @@ enum **LineCapMode** .. _enum_Line2D_LineTextureMode: -enum **LineTextureMode** +enum **LineTextureMode**: - **LINE_TEXTURE_NONE** = **0** --- Takes the left pixels of the texture and renders it over the whole line. - **LINE_TEXTURE_TILE** = **1** --- Tiles the texture over the line. The texture need to be imported with Repeat Enabled for it to work properly. @@ -51,13 +79,12 @@ enum **LineTextureMode** .. _enum_Line2D_LineJointMode: -enum **LineJointMode** +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. - **LINE_JOINT_BEVEL** = **1** --- The line's joints will be bevelled/chamfered. - **LINE_JOINT_ROUND** = **2** --- The line's joints will be rounded. - Description ----------- @@ -68,80 +95,166 @@ Property Descriptions .. _class_Line2D_begin_cap_mode: -- :ref:`LineCapMode` **begin_cap_mode** - Controls the style of the line's first point. Use ``LINE_CAP_*`` constants. Default value: ``LINE_CAP_NONE``. +- :ref:`LineCapMode` **begin_cap_mode** + ++----------+---------------------------+ +| *Setter* | set_begin_cap_mode(value) | ++----------+---------------------------+ +| *Getter* | get_begin_cap_mode() | ++----------+---------------------------+ + +Controls the style of the line's first point. Use ``LINE_CAP_*`` constants. Default value: ``LINE_CAP_NONE``. .. _class_Line2D_default_color: -- :ref:`Color` **default_color** - The line's color. Will not be used if a gradient is set. +- :ref:`Color` **default_color** + ++----------+--------------------------+ +| *Setter* | set_default_color(value) | ++----------+--------------------------+ +| *Getter* | get_default_color() | ++----------+--------------------------+ + +The line's color. Will not be used if a gradient is set. .. _class_Line2D_end_cap_mode: -- :ref:`LineCapMode` **end_cap_mode** - Controls the style of the line's last point. Use ``LINE_CAP_*`` constants. Default value: ``LINE_CAP_NONE``. +- :ref:`LineCapMode` **end_cap_mode** + ++----------+-------------------------+ +| *Setter* | set_end_cap_mode(value) | ++----------+-------------------------+ +| *Getter* | get_end_cap_mode() | ++----------+-------------------------+ + +Controls the style of the line's last point. Use ``LINE_CAP_*`` constants. Default value: ``LINE_CAP_NONE``. .. _class_Line2D_gradient: -- :ref:`Gradient` **gradient** - The gradient is drawn through the whole line from start to finish. The default color will not be used if a gradient is set. +- :ref:`Gradient` **gradient** + ++----------+---------------------+ +| *Setter* | set_gradient(value) | ++----------+---------------------+ +| *Getter* | get_gradient() | ++----------+---------------------+ + +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: -- :ref:`LineJointMode` **joint_mode** - The style for the points between the start and the end. +- :ref:`LineJointMode` **joint_mode** + ++----------+-----------------------+ +| *Setter* | set_joint_mode(value) | ++----------+-----------------------+ +| *Getter* | get_joint_mode() | ++----------+-----------------------+ + +The style for the points between the start and the end. .. _class_Line2D_points: -- :ref:`PoolVector2Array` **points** - The points that form the lines. The line is drawn between every point set in this array. +- :ref:`PoolVector2Array` **points** + ++----------+-------------------+ +| *Setter* | set_points(value) | ++----------+-------------------+ +| *Getter* | get_points() | ++----------+-------------------+ + +The points that form the lines. The line is drawn between every point set in this array. .. _class_Line2D_round_precision: -- :ref:`int` **round_precision** - The smoothness of the rounded joints and caps. This is only used if a cap or joint is set as round. +- :ref:`int` **round_precision** + ++----------+----------------------------+ +| *Setter* | set_round_precision(value) | ++----------+----------------------------+ +| *Getter* | get_round_precision() | ++----------+----------------------------+ + +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: -- :ref:`float` **sharp_limit** - The direction difference in radians between vector points. This value is only used if ``joint mode`` is set to ``LINE_JOINT_SHARP``. +- :ref:`float` **sharp_limit** + ++----------+------------------------+ +| *Setter* | set_sharp_limit(value) | ++----------+------------------------+ +| *Getter* | get_sharp_limit() | ++----------+------------------------+ + +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: -- :ref:`Texture` **texture** - The texture used for the line's texture. Uses ``texture_mode`` for drawing style. +- :ref:`Texture` **texture** + ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + +The texture used for the line's texture. Uses ``texture_mode`` for drawing style. .. _class_Line2D_texture_mode: -- :ref:`LineTextureMode` **texture_mode** - The style to render the ``texture`` on the line. Use ``LINE_TEXTURE_*`` constants. Default value: ``LINE_TEXTURE_NONE``. +- :ref:`LineTextureMode` **texture_mode** + ++----------+-------------------------+ +| *Setter* | set_texture_mode(value) | ++----------+-------------------------+ +| *Getter* | get_texture_mode() | ++----------+-------------------------+ + +The style to render the ``texture`` on the line. Use ``LINE_TEXTURE_*`` constants. Default value: ``LINE_TEXTURE_NONE``. .. _class_Line2D_width: -- :ref:`float` **width** - The line's width. +- :ref:`float` **width** ++----------+------------------+ +| *Setter* | set_width(value) | ++----------+------------------+ +| *Getter* | get_width() | ++----------+------------------+ + +The line's width. Method Descriptions ------------------- -.. _class_Line2D_add_point: + .. _class_Line2D_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_get_point_count: - :ref:`int` **get_point_count** **(** **)** const Returns the Line2D's amount of points. -.. _class_Line2D_get_point_position: + .. _class_Line2D_get_point_position: - :ref:`Vector2` **get_point_position** **(** :ref:`int` i **)** const Returns point ``i``'s position. -.. _class_Line2D_remove_point: + .. _class_Line2D_remove_point: - void **remove_point** **(** :ref:`int` i **)** Remove the point at index ``i`` from the line. -.. _class_Line2D_set_point_position: + .. _class_Line2D_set_point_position: - void **set_point_position** **(** :ref:`int` i, :ref:`Vector2` position **)** Overwrites the position in point ``i`` with the supplied ``position``. - diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index af6138039..f45dfd547 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -8,6 +8,7 @@ LineEdit ======== **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,41 @@ Brief Description 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` | ++------------------------------------------+--------------------------------------------------------------------+ + Methods ------- @@ -34,28 +70,56 @@ Methods | 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` | ++---------------------------------+------------------------------------------------------------------------------+ + Signals ------- -.. _class_LineEdit_text_changed: + .. _class_LineEdit_text_changed: - **text_changed** **(** :ref:`String` new_text **)** Emitted when the text changes. -.. _class_LineEdit_text_entered: + .. _class_LineEdit_text_entered: - **text_entered** **(** :ref:`String` new_text **)** Emitted when the user presses KEY_ENTER on the ``LineEdit``. - Enumerations ------------ .. _enum_LineEdit_Align: -enum **Align** +enum **Align**: - **ALIGN_LEFT** = **0** --- Aligns the text on the left hand side of the :ref:`LineEdit`. - **ALIGN_CENTER** = **1** --- Centers the text in the middle of the :ref:`LineEdit`. @@ -64,7 +128,7 @@ enum **Align** .. _enum_LineEdit_MenuItems: -enum **MenuItems** +enum **MenuItems**: - **MENU_CUT** = **0** --- Cuts (Copies and clears) the selected text. - **MENU_COPY** = **1** --- Copies the selected text. @@ -75,7 +139,6 @@ enum **MenuItems** - **MENU_REDO** = **6** - **MENU_MAX** = **7** - Description ----------- @@ -86,99 +149,216 @@ Property Descriptions .. _class_LineEdit_align: -- :ref:`Align` **align** - Text alignment as defined in the ALIGN\_\* enum. +- :ref:`Align` **align** + ++----------+------------------+ +| *Setter* | set_align(value) | ++----------+------------------+ +| *Getter* | get_align() | ++----------+------------------+ + +Text alignment as defined in the ALIGN\_\* enum. .. _class_LineEdit_caret_blink: -- :ref:`bool` **caret_blink** - If ``true`` the caret (visual cursor) blinks. +- :ref:`bool` **caret_blink** + ++----------+---------------------------------+ +| *Setter* | cursor_set_blink_enabled(value) | ++----------+---------------------------------+ +| *Getter* | cursor_get_blink_enabled() | ++----------+---------------------------------+ + +If ``true`` the caret (visual cursor) blinks. .. _class_LineEdit_caret_blink_speed: -- :ref:`float` **caret_blink_speed** - Duration (in seconds) of a caret's blinking cycle. +- :ref:`float` **caret_blink_speed** + ++----------+-------------------------------+ +| *Setter* | cursor_set_blink_speed(value) | ++----------+-------------------------------+ +| *Getter* | cursor_get_blink_speed() | ++----------+-------------------------------+ + +Duration (in seconds) of a caret's blinking cycle. .. _class_LineEdit_caret_position: -- :ref:`int` **caret_position** - The cursor's position inside the ``LineEdit``. When set, the text may scroll to accommodate it. +- :ref:`int` **caret_position** + ++----------+----------------------------+ +| *Setter* | set_cursor_position(value) | ++----------+----------------------------+ +| *Getter* | get_cursor_position() | ++----------+----------------------------+ + +The cursor's position inside the ``LineEdit``. When set, the text may scroll to accommodate it. .. _class_LineEdit_clear_button_enabled: - :ref:`bool` **clear_button_enabled** ++----------+---------------------------------+ +| *Setter* | set_clear_button_enabled(value) | ++----------+---------------------------------+ +| *Getter* | is_clear_button_enabled() | ++----------+---------------------------------+ + .. _class_LineEdit_context_menu_enabled: -- :ref:`bool` **context_menu_enabled** - If ``true`` the context menu will appear when right clicked. +- :ref:`bool` **context_menu_enabled** + ++----------+---------------------------------+ +| *Setter* | set_context_menu_enabled(value) | ++----------+---------------------------------+ +| *Getter* | is_context_menu_enabled() | ++----------+---------------------------------+ + +If ``true`` the context menu will appear when right clicked. .. _class_LineEdit_editable: -- :ref:`bool` **editable** - If ``false`` existing text cannot be modified and new text cannot be added. +- :ref:`bool` **editable** + ++----------+---------------------+ +| *Setter* | set_editable(value) | ++----------+---------------------+ +| *Getter* | is_editable() | ++----------+---------------------+ + +If ``false`` existing text cannot be modified and new text cannot be added. .. _class_LineEdit_expand_to_text_length: -- :ref:`bool` **expand_to_text_length** - If ``true`` the :ref:`LineEdit` width will increase to stay longer than the :ref:`text`. It will **not** compress if the :ref:`text` is shortened. +- :ref:`bool` **expand_to_text_length** + ++----------+----------------------------------+ +| *Setter* | set_expand_to_text_length(value) | ++----------+----------------------------------+ +| *Getter* | get_expand_to_text_length() | ++----------+----------------------------------+ + +If ``true`` the :ref:`LineEdit` width will increase to stay longer than the :ref:`text`. It will **not** compress if the :ref:`text` is shortened. .. _class_LineEdit_focus_mode: -- :ref:`FocusMode` **focus_mode** - Defines how the :ref:`LineEdit` can grab focus (Keyboard and mouse, only keyboard, or none). See ``enum FocusMode`` in :ref:`Control` for details. +- :ref:`FocusMode` **focus_mode** + ++----------+-----------------------+ +| *Setter* | set_focus_mode(value) | ++----------+-----------------------+ +| *Getter* | get_focus_mode() | ++----------+-----------------------+ + +Defines how the :ref:`LineEdit` can grab focus (Keyboard and mouse, only keyboard, or none). See ``enum FocusMode`` in :ref:`Control` for details. .. _class_LineEdit_max_length: -- :ref:`int` **max_length** - Maximum amount of characters that can be entered inside the :ref:`LineEdit`. If ``0``, there is no limit. +- :ref:`int` **max_length** + ++----------+-----------------------+ +| *Setter* | set_max_length(value) | ++----------+-----------------------+ +| *Getter* | get_max_length() | ++----------+-----------------------+ + +Maximum amount of characters that can be entered inside the :ref:`LineEdit`. If ``0``, there is no limit. .. _class_LineEdit_placeholder_alpha: -- :ref:`float` **placeholder_alpha** - Opacity of the :ref:`placeholder_text`. From ``0`` to ``1``. +- :ref:`float` **placeholder_alpha** + ++----------+------------------------------+ +| *Setter* | set_placeholder_alpha(value) | ++----------+------------------------------+ +| *Getter* | get_placeholder_alpha() | ++----------+------------------------------+ + +Opacity of the :ref:`placeholder_text`. From ``0`` to ``1``. .. _class_LineEdit_placeholder_text: -- :ref:`String` **placeholder_text** - Text shown when the :ref:`LineEdit` is empty. It is **not** the :ref:`LineEdit`'s default value (see :ref:`text`). +- :ref:`String` **placeholder_text** + ++----------+------------------------+ +| *Setter* | set_placeholder(value) | ++----------+------------------------+ +| *Getter* | get_placeholder() | ++----------+------------------------+ + +Text shown when the :ref:`LineEdit` is empty. It is **not** the :ref:`LineEdit`'s default value (see :ref:`text`). .. _class_LineEdit_secret: -- :ref:`bool` **secret** - If ``true``, every character is replaced with the secret character (see :ref:`secret_character`). +- :ref:`bool` **secret** + ++----------+-------------------+ +| *Setter* | set_secret(value) | ++----------+-------------------+ +| *Getter* | is_secret() | ++----------+-------------------+ + +If ``true``, every character is replaced with the secret character (see :ref:`secret_character`). .. _class_LineEdit_secret_character: -- :ref:`String` **secret_character** - The character to use to mask secret input (defaults to "\*"). Only a single character can be used as the secret character. +- :ref:`String` **secret_character** + ++----------+-----------------------------+ +| *Setter* | set_secret_character(value) | ++----------+-----------------------------+ +| *Getter* | get_secret_character() | ++----------+-----------------------------+ + +The character to use to mask secret input (defaults to "\*"). Only a single character can be used as the secret character. .. _class_LineEdit_text: -- :ref:`String` **text** - String value of the :ref:`LineEdit`. +- :ref:`String` **text** ++----------+-----------------+ +| *Setter* | set_text(value) | ++----------+-----------------+ +| *Getter* | get_text() | ++----------+-----------------+ + +String value of the :ref:`LineEdit`. Method Descriptions ------------------- -.. _class_LineEdit_append_at_cursor: + .. _class_LineEdit_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. -.. _class_LineEdit_clear: + .. _class_LineEdit_clear: - void **clear** **(** **)** Erases the :ref:`LineEdit` text. -.. _class_LineEdit_deselect: + .. _class_LineEdit_deselect: - void **deselect** **(** **)** Clears the current selection. -.. _class_LineEdit_get_menu: + .. _class_LineEdit_get_menu: - :ref:`PopupMenu` **get_menu** **(** **)** const Returns the :ref:`PopupMenu` of this ``LineEdit``. By default, this menu is displayed when right-clicking on the :ref:`LineEdit`. -.. _class_LineEdit_menu_option: + .. _class_LineEdit_menu_option: - void **menu_option** **(** :ref:`int` option **)** Executes a given action as defined in the MENU\_\* enum. -.. _class_LineEdit_select: + .. _class_LineEdit_select: - void **select** **(** :ref:`int` from=0, :ref:`int` to=-1 **)** @@ -191,10 +371,9 @@ Selects characters inside :ref:`LineEdit` between ``from`` and ` select(4) # ome select(2, 5) # lco -.. _class_LineEdit_select_all: + .. _class_LineEdit_select_all: - void **select_all** **(** **)** Selects the whole :ref:`String`. - diff --git a/classes/class_lineshape2d.rst b/classes/class_lineshape2d.rst index c4b892721..750a156f8 100644 --- a/classes/class_lineshape2d.rst +++ b/classes/class_lineshape2d.rst @@ -8,6 +8,7 @@ LineShape2D =========== **Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description Line shape for 2D collisions. +Properties +---------- + ++-------------------------------+-----------------------------------------+ +| :ref:`float` | :ref:`d` | ++-------------------------------+-----------------------------------------+ +| :ref:`Vector2` | :ref:`normal` | ++-------------------------------+-----------------------------------------+ + Description ----------- @@ -25,10 +35,25 @@ Property Descriptions .. _class_LineShape2D_d: -- :ref:`float` **d** - The line's distance from the origin. +- :ref:`float` **d** + ++----------+--------------+ +| *Setter* | set_d(value) | ++----------+--------------+ +| *Getter* | get_d() | ++----------+--------------+ + +The line's distance from the origin. .. _class_LineShape2D_normal: -- :ref:`Vector2` **normal** - The line's normal. +- :ref:`Vector2` **normal** ++----------+-------------------+ +| *Setter* | set_normal(value) | ++----------+-------------------+ +| *Getter* | get_normal() | ++----------+-------------------+ + +The line's normal. diff --git a/classes/class_linkbutton.rst b/classes/class_linkbutton.rst index 100aa5d06..2d3ad1069 100644 --- a/classes/class_linkbutton.rst +++ b/classes/class_linkbutton.rst @@ -8,6 +8,7 @@ LinkButton ========== **Inherits:** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,18 +16,43 @@ Brief Description Simple button used to represent a link to some resource. +Properties +---------- + ++-----------------------------------------------------+----------------------------------------------+ +| :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` | ++---------------------------------+----------------------------------------------------------------+ + Enumerations ------------ .. _enum_LinkButton_UnderlineMode: -enum **UnderlineMode** +enum **UnderlineMode**: - **UNDERLINE_MODE_ALWAYS** = **0** --- The LinkButton will always show an underline at the bottom of its text - **UNDERLINE_MODE_ON_HOVER** = **1** --- The LinkButton will show an underline at the bottom of its text when the mouse cursor is over it. - **UNDERLINE_MODE_NEVER** = **2** --- The LinkButton will never show an underline at the bottom of its text. - Description ----------- @@ -39,8 +65,19 @@ Property Descriptions - :ref:`String` **text** ++----------+-----------------+ +| *Setter* | set_text(value) | ++----------+-----------------+ +| *Getter* | get_text() | ++----------+-----------------+ + .. _class_LinkButton_underline: - :ref:`UnderlineMode` **underline** ++----------+---------------------------+ +| *Setter* | set_underline_mode(value) | ++----------+---------------------------+ +| *Getter* | get_underline_mode() | ++----------+---------------------------+ diff --git a/classes/class_listener.rst b/classes/class_listener.rst index 190caa12f..27c6321dc 100644 --- a/classes/class_listener.rst +++ b/classes/class_listener.rst @@ -8,6 +8,7 @@ Listener ======== **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -31,20 +32,19 @@ Methods Method Descriptions ------------------- -.. _class_Listener_clear_current: + .. _class_Listener_clear_current: - void **clear_current** **(** **)** -.. _class_Listener_get_listener_transform: + .. _class_Listener_get_listener_transform: - :ref:`Transform` **get_listener_transform** **(** **)** const -.. _class_Listener_is_current: + .. _class_Listener_is_current: - :ref:`bool` **is_current** **(** **)** const -.. _class_Listener_make_current: + .. _class_Listener_make_current: - void **make_current** **(** **)** - diff --git a/classes/class_mainloop.rst b/classes/class_mainloop.rst index 571e2ddb9..4c09be4ec 100644 --- a/classes/class_mainloop.rst +++ b/classes/class_mainloop.rst @@ -8,7 +8,9 @@ MainLoop ======== **Inherits:** :ref:`Object` + **Inherited By:** :ref:`SceneTree` + **Category:** Core Brief Description @@ -61,7 +63,6 @@ Constants - **NOTIFICATION_TRANSLATION_CHANGED** = **90** - **NOTIFICATION_WM_ABOUT** = **91** - **NOTIFICATION_CRASH** = **92** - Description ----------- @@ -70,62 +71,61 @@ Main loop is the abstract main loop base class. All other main loop classes are Method Descriptions ------------------- -.. _class_MainLoop__drop_files: + .. _class_MainLoop__drop_files: - void **_drop_files** **(** :ref:`PoolStringArray` files, :ref:`int` screen **)** virtual -.. _class_MainLoop__finalize: + .. _class_MainLoop__finalize: - void **_finalize** **(** **)** virtual Called before the program exits. -.. _class_MainLoop__idle: + .. _class_MainLoop__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__initialize: - void **_initialize** **(** **)** virtual Called once during initialization. -.. _class_MainLoop__input_event: + .. _class_MainLoop__input_event: - void **_input_event** **(** :ref:`InputEvent` event **)** virtual -.. _class_MainLoop__input_text: + .. _class_MainLoop__input_text: - void **_input_text** **(** :ref:`String` text **)** virtual -.. _class_MainLoop__iteration: + .. _class_MainLoop__iteration: - void **_iteration** **(** :ref:`float` delta **)** virtual -.. _class_MainLoop_finish: + .. _class_MainLoop_finish: - void **finish** **(** **)** -.. _class_MainLoop_idle: + .. _class_MainLoop_idle: - :ref:`bool` **idle** **(** :ref:`float` delta **)** -.. _class_MainLoop_init: + .. _class_MainLoop_init: - void **init** **(** **)** -.. _class_MainLoop_input_event: + .. _class_MainLoop_input_event: - void **input_event** **(** :ref:`InputEvent` event **)** -.. _class_MainLoop_input_text: + .. _class_MainLoop_input_text: - void **input_text** **(** :ref:`String` text **)** -.. _class_MainLoop_iteration: + .. _class_MainLoop_iteration: - :ref:`bool` **iteration** **(** :ref:`float` delta **)** - diff --git a/classes/class_margincontainer.rst b/classes/class_margincontainer.rst index 69038d110..46f18d3c6 100644 --- a/classes/class_margincontainer.rst +++ b/classes/class_margincontainer.rst @@ -8,6 +8,7 @@ MarginContainer =============== **Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,19 @@ Brief Description 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` | ++-----------------------+-----------------------------------------------------------+ + Description ----------- diff --git a/classes/class_marshalls.rst b/classes/class_marshalls.rst index aa12f97d1..907adc39c 100644 --- a/classes/class_marshalls.rst +++ b/classes/class_marshalls.rst @@ -8,6 +8,7 @@ Marshalls ========= **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -40,40 +41,39 @@ Provides data transformation and encoding utility functions. Method Descriptions ------------------- -.. _class_Marshalls_base64_to_raw: + .. _class_Marshalls_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_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_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_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_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_variant_to_base64: - :ref:`String` **variant_to_base64** **(** :ref:`Variant` variant **)** Return base64 encoded String of a given :ref:`Variant`. - diff --git a/classes/class_material.rst b/classes/class_material.rst index 1c8722514..0c4588f8c 100644 --- a/classes/class_material.rst +++ b/classes/class_material.rst @@ -8,7 +8,9 @@ Material ======== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`ParticlesMaterial`, :ref:`ShaderMaterial`, :ref:`SpatialMaterial`, :ref:`CanvasItemMaterial` + **Category:** Core Brief Description @@ -16,12 +18,20 @@ Brief Description Abstract base :ref:`Resource` for coloring and shading geometry. +Properties +---------- + ++---------------------------------+--------------------------------------------------------+ +| :ref:`Material` | :ref:`next_pass` | ++---------------------------------+--------------------------------------------------------+ +| :ref:`int` | :ref:`render_priority` | ++---------------------------------+--------------------------------------------------------+ + Constants --------- - **RENDER_PRIORITY_MAX** = **127** - **RENDER_PRIORITY_MIN** = **-128** - Description ----------- @@ -34,8 +44,19 @@ Property Descriptions - :ref:`Material` **next_pass** ++----------+----------------------+ +| *Setter* | set_next_pass(value) | ++----------+----------------------+ +| *Getter* | get_next_pass() | ++----------+----------------------+ + .. _class_Material_render_priority: - :ref:`int` **render_priority** ++----------+----------------------------+ +| *Setter* | set_render_priority(value) | ++----------+----------------------------+ +| *Getter* | get_render_priority() | ++----------+----------------------------+ diff --git a/classes/class_menubutton.rst b/classes/class_menubutton.rst index ae4149744..65aa1ddea 100644 --- a/classes/class_menubutton.rst +++ b/classes/class_menubutton.rst @@ -8,6 +8,7 @@ MenuButton ========== **Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -24,16 +25,42 @@ Methods | 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` | ++---------------------------------+------------------------------------------------------------------+ + Signals ------- -.. _class_MenuButton_about_to_show: + .. _class_MenuButton_about_to_show: - **about_to_show** **(** **)** Emitted when :ref:`PopupMenu` of this MenuButton is about to show. - Description ----------- @@ -42,14 +69,13 @@ Special button that brings up a :ref:`PopupMenu` when clicked. Method Descriptions ------------------- -.. _class_MenuButton_get_popup: + .. _class_MenuButton_get_popup: - :ref:`PopupMenu` **get_popup** **(** **)** const Return the :ref:`PopupMenu` contained in this button. -.. _class_MenuButton_set_disable_shortcuts: + .. _class_MenuButton_set_disable_shortcuts: - void **set_disable_shortcuts** **(** :ref:`bool` disabled **)** - diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index fdc28ea7e..8aaf27363 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -8,7 +8,9 @@ Mesh ==== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`ArrayMesh`, :ref:`PrimitiveMesh` + **Category:** Core Brief Description @@ -16,6 +18,13 @@ Brief Description A :ref:`Resource` that contains vertex-array based geometry. +Properties +---------- + ++-------------------------------+----------------------------------------------------------+ +| :ref:`Vector2` | :ref:`lightmap_size_hint` | ++-------------------------------+----------------------------------------------------------+ + Methods ------- @@ -44,14 +53,14 @@ Enumerations .. _enum_Mesh_BlendShapeMode: -enum **BlendShapeMode** +enum **BlendShapeMode**: - **BLEND_SHAPE_MODE_NORMALIZED** = **0** - **BLEND_SHAPE_MODE_RELATIVE** = **1** .. _enum_Mesh_ArrayType: -enum **ArrayType** +enum **ArrayType**: - **ARRAY_VERTEX** = **0** --- Array of vertices. - **ARRAY_NORMAL** = **1** --- Array of normals. @@ -66,7 +75,7 @@ enum **ArrayType** .. _enum_Mesh_ArrayFormat: -enum **ArrayFormat** +enum **ArrayFormat**: - **ARRAY_FORMAT_VERTEX** = **1** - **ARRAY_FORMAT_NORMAL** = **2** @@ -93,7 +102,7 @@ enum **ArrayFormat** .. _enum_Mesh_PrimitiveType: -enum **PrimitiveType** +enum **PrimitiveType**: - **PRIMITIVE_POINTS** = **0** --- Render array as points (one vertex equals one point). - **PRIMITIVE_LINES** = **1** --- Render array as lines (every two vertices a line is created). @@ -103,7 +112,6 @@ enum **PrimitiveType** - **PRIMITIVE_TRIANGLE_STRIP** = **5** --- Render array as triangle strips. - **PRIMITIVE_TRIANGLE_FAN** = **6** --- Render array as triangle fans. - Description ----------- @@ -116,62 +124,66 @@ Property Descriptions - :ref:`Vector2` **lightmap_size_hint** ++----------+-------------------------------+ +| *Setter* | set_lightmap_size_hint(value) | ++----------+-------------------------------+ +| *Getter* | get_lightmap_size_hint() | ++----------+-------------------------------+ Method Descriptions ------------------- -.. _class_Mesh_create_convex_shape: + .. _class_Mesh_create_convex_shape: - :ref:`Shape` **create_convex_shape** **(** **)** const Calculate a :ref:`ConvexPolygonShape` from the mesh. -.. _class_Mesh_create_outline: + .. _class_Mesh_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_create_trimesh_shape: - :ref:`Shape` **create_trimesh_shape** **(** **)** const Calculate a :ref:`ConcavePolygonShape` from the mesh. -.. _class_Mesh_generate_triangle_mesh: + .. _class_Mesh_generate_triangle_mesh: - :ref:`TriangleMesh` **generate_triangle_mesh** **(** **)** const Generate a :ref:`TriangleMesh` from the mesh. -.. _class_Mesh_get_faces: + .. _class_Mesh_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_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_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`). -.. _class_Mesh_surface_get_blend_shape_arrays: + .. _class_Mesh_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_surface_get_material: - :ref:`Material` **surface_get_material** **(** :ref:`int` surf_idx **)** const Return a :ref:`Material` in a given surface. Surface is rendered using this material. - diff --git a/classes/class_meshdatatool.rst b/classes/class_meshdatatool.rst index 781e234c5..830a2edb6 100644 --- a/classes/class_meshdatatool.rst +++ b/classes/class_meshdatatool.rst @@ -8,6 +8,7 @@ MeshDataTool ============ **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -99,156 +100,155 @@ Methods Method Descriptions ------------------- -.. _class_MeshDataTool_clear: + .. _class_MeshDataTool_clear: - void **clear** **(** **)** -.. _class_MeshDataTool_commit_to_surface: + .. _class_MeshDataTool_commit_to_surface: - :ref:`Error` **commit_to_surface** **(** :ref:`ArrayMesh` mesh **)** -.. _class_MeshDataTool_create_from_surface: + .. _class_MeshDataTool_create_from_surface: - :ref:`Error` **create_from_surface** **(** :ref:`ArrayMesh` mesh, :ref:`int` surface **)** -.. _class_MeshDataTool_get_edge_count: + .. _class_MeshDataTool_get_edge_count: - :ref:`int` **get_edge_count** **(** **)** const -.. _class_MeshDataTool_get_edge_faces: + .. _class_MeshDataTool_get_edge_faces: - :ref:`PoolIntArray` **get_edge_faces** **(** :ref:`int` idx **)** const -.. _class_MeshDataTool_get_edge_meta: + .. _class_MeshDataTool_get_edge_meta: - :ref:`Variant` **get_edge_meta** **(** :ref:`int` idx **)** const -.. _class_MeshDataTool_get_edge_vertex: + .. _class_MeshDataTool_get_edge_vertex: - :ref:`int` **get_edge_vertex** **(** :ref:`int` idx, :ref:`int` vertex **)** const -.. _class_MeshDataTool_get_face_count: + .. _class_MeshDataTool_get_face_count: - :ref:`int` **get_face_count** **(** **)** const -.. _class_MeshDataTool_get_face_edge: + .. _class_MeshDataTool_get_face_edge: - :ref:`int` **get_face_edge** **(** :ref:`int` idx, :ref:`int` edge **)** const -.. _class_MeshDataTool_get_face_meta: + .. _class_MeshDataTool_get_face_meta: - :ref:`Variant` **get_face_meta** **(** :ref:`int` idx **)** const -.. _class_MeshDataTool_get_face_normal: + .. _class_MeshDataTool_get_face_normal: - :ref:`Vector3` **get_face_normal** **(** :ref:`int` idx **)** const -.. _class_MeshDataTool_get_face_vertex: + .. _class_MeshDataTool_get_face_vertex: - :ref:`int` **get_face_vertex** **(** :ref:`int` idx, :ref:`int` vertex **)** const -.. _class_MeshDataTool_get_format: + .. _class_MeshDataTool_get_format: - :ref:`int` **get_format** **(** **)** const -.. _class_MeshDataTool_get_material: + .. _class_MeshDataTool_get_material: - :ref:`Material` **get_material** **(** **)** const -.. _class_MeshDataTool_get_vertex: + .. _class_MeshDataTool_get_vertex: - :ref:`Vector3` **get_vertex** **(** :ref:`int` idx **)** const -.. _class_MeshDataTool_get_vertex_bones: + .. _class_MeshDataTool_get_vertex_bones: - :ref:`PoolIntArray` **get_vertex_bones** **(** :ref:`int` idx **)** const -.. _class_MeshDataTool_get_vertex_color: + .. _class_MeshDataTool_get_vertex_color: - :ref:`Color` **get_vertex_color** **(** :ref:`int` idx **)** const -.. _class_MeshDataTool_get_vertex_count: + .. _class_MeshDataTool_get_vertex_count: - :ref:`int` **get_vertex_count** **(** **)** const -.. _class_MeshDataTool_get_vertex_edges: + .. _class_MeshDataTool_get_vertex_edges: - :ref:`PoolIntArray` **get_vertex_edges** **(** :ref:`int` idx **)** const -.. _class_MeshDataTool_get_vertex_faces: + .. _class_MeshDataTool_get_vertex_faces: - :ref:`PoolIntArray` **get_vertex_faces** **(** :ref:`int` idx **)** const -.. _class_MeshDataTool_get_vertex_meta: + .. _class_MeshDataTool_get_vertex_meta: - :ref:`Variant` **get_vertex_meta** **(** :ref:`int` idx **)** const -.. _class_MeshDataTool_get_vertex_normal: + .. _class_MeshDataTool_get_vertex_normal: - :ref:`Vector3` **get_vertex_normal** **(** :ref:`int` idx **)** const -.. _class_MeshDataTool_get_vertex_tangent: + .. _class_MeshDataTool_get_vertex_tangent: - :ref:`Plane` **get_vertex_tangent** **(** :ref:`int` idx **)** const -.. _class_MeshDataTool_get_vertex_uv: + .. _class_MeshDataTool_get_vertex_uv: - :ref:`Vector2` **get_vertex_uv** **(** :ref:`int` idx **)** const -.. _class_MeshDataTool_get_vertex_uv2: + .. _class_MeshDataTool_get_vertex_uv2: - :ref:`Vector2` **get_vertex_uv2** **(** :ref:`int` idx **)** const -.. _class_MeshDataTool_get_vertex_weights: + .. _class_MeshDataTool_get_vertex_weights: - :ref:`PoolRealArray` **get_vertex_weights** **(** :ref:`int` idx **)** const -.. _class_MeshDataTool_set_edge_meta: + .. _class_MeshDataTool_set_edge_meta: - void **set_edge_meta** **(** :ref:`int` idx, :ref:`Variant` meta **)** -.. _class_MeshDataTool_set_face_meta: + .. _class_MeshDataTool_set_face_meta: - void **set_face_meta** **(** :ref:`int` idx, :ref:`Variant` meta **)** -.. _class_MeshDataTool_set_material: + .. _class_MeshDataTool_set_material: - void **set_material** **(** :ref:`Material` material **)** -.. _class_MeshDataTool_set_vertex: + .. _class_MeshDataTool_set_vertex: - void **set_vertex** **(** :ref:`int` idx, :ref:`Vector3` vertex **)** -.. _class_MeshDataTool_set_vertex_bones: + .. _class_MeshDataTool_set_vertex_bones: - void **set_vertex_bones** **(** :ref:`int` idx, :ref:`PoolIntArray` bones **)** -.. _class_MeshDataTool_set_vertex_color: + .. _class_MeshDataTool_set_vertex_color: - void **set_vertex_color** **(** :ref:`int` idx, :ref:`Color` color **)** -.. _class_MeshDataTool_set_vertex_meta: + .. _class_MeshDataTool_set_vertex_meta: - void **set_vertex_meta** **(** :ref:`int` idx, :ref:`Variant` meta **)** -.. _class_MeshDataTool_set_vertex_normal: + .. _class_MeshDataTool_set_vertex_normal: - void **set_vertex_normal** **(** :ref:`int` idx, :ref:`Vector3` normal **)** -.. _class_MeshDataTool_set_vertex_tangent: + .. _class_MeshDataTool_set_vertex_tangent: - void **set_vertex_tangent** **(** :ref:`int` idx, :ref:`Plane` tangent **)** -.. _class_MeshDataTool_set_vertex_uv: + .. _class_MeshDataTool_set_vertex_uv: - void **set_vertex_uv** **(** :ref:`int` idx, :ref:`Vector2` uv **)** -.. _class_MeshDataTool_set_vertex_uv2: + .. _class_MeshDataTool_set_vertex_uv2: - void **set_vertex_uv2** **(** :ref:`int` idx, :ref:`Vector2` uv2 **)** -.. _class_MeshDataTool_set_vertex_weights: + .. _class_MeshDataTool_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 33f0d91a6..1db8a51ad 100644 --- a/classes/class_meshinstance.rst +++ b/classes/class_meshinstance.rst @@ -8,7 +8,9 @@ MeshInstance ============ **Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`SoftBody` + **Category:** Core Brief Description @@ -16,6 +18,15 @@ Brief Description Node that instances meshes into a scenario. +Properties +---------- + ++---------------------------------+----------------------------------------------+ +| :ref:`Mesh` | :ref:`mesh` | ++---------------------------------+----------------------------------------------+ +| :ref:`NodePath` | :ref:`skeleton` | ++---------------------------------+----------------------------------------------+ + Methods ------- @@ -41,44 +52,58 @@ Property Descriptions .. _class_MeshInstance_mesh: -- :ref:`Mesh` **mesh** - The :ref:`Mesh` resource for the instance. +- :ref:`Mesh` **mesh** + ++----------+-----------------+ +| *Setter* | set_mesh(value) | ++----------+-----------------+ +| *Getter* | get_mesh() | ++----------+-----------------+ + +The :ref:`Mesh` resource for the instance. .. _class_MeshInstance_skeleton: -- :ref:`NodePath` **skeleton** - :ref:`NodePath` to the :ref:`Skeleton` associated with the instance. +- :ref:`NodePath` **skeleton** ++----------+--------------------------+ +| *Setter* | set_skeleton_path(value) | ++----------+--------------------------+ +| *Getter* | get_skeleton_path() | ++----------+--------------------------+ + +:ref:`NodePath` to the :ref:`Skeleton` associated with the instance. Method Descriptions ------------------- -.. _class_MeshInstance_create_convex_collision: + .. _class_MeshInstance_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_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_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_get_surface_material: - :ref:`Material` **get_surface_material** **(** :ref:`int` surface **)** const Returns the :ref:`Material` for a surface of the :ref:`Mesh` resource. -.. _class_MeshInstance_set_surface_material: + .. _class_MeshInstance_set_surface_material: - void **set_surface_material** **(** :ref:`int` surface, :ref:`Material` material **)** Sets the :ref:`Material` for a surface of the :ref:`Mesh` resource. - diff --git a/classes/class_meshinstance2d.rst b/classes/class_meshinstance2d.rst index c6d450727..3a1e74981 100644 --- a/classes/class_meshinstance2d.rst +++ b/classes/class_meshinstance2d.rst @@ -8,6 +8,7 @@ MeshInstance2D ============== **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,17 @@ Brief Description +Properties +---------- + ++-------------------------------+----------------------------------------------------+ +| :ref:`Mesh` | :ref:`mesh` | ++-------------------------------+----------------------------------------------------+ +| :ref:`Texture` | :ref:`normal_map` | ++-------------------------------+----------------------------------------------------+ +| :ref:`Texture` | :ref:`texture` | ++-------------------------------+----------------------------------------------------+ + Property Descriptions --------------------- @@ -22,12 +34,29 @@ Property Descriptions - :ref:`Mesh` **mesh** ++----------+-----------------+ +| *Setter* | set_mesh(value) | ++----------+-----------------+ +| *Getter* | get_mesh() | ++----------+-----------------+ + .. _class_MeshInstance2D_normal_map: - :ref:`Texture` **normal_map** ++----------+-----------------------+ +| *Setter* | set_normal_map(value) | ++----------+-----------------------+ +| *Getter* | get_normal_map() | ++----------+-----------------------+ + .. _class_MeshInstance2D_texture: - :ref:`Texture` **texture** ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ diff --git a/classes/class_meshlibrary.rst b/classes/class_meshlibrary.rst index a0157aaa2..967abd9ab 100644 --- a/classes/class_meshlibrary.rst +++ b/classes/class_meshlibrary.rst @@ -8,6 +8,7 @@ MeshLibrary =========== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -60,86 +61,85 @@ Library of meshes. Contains a list of :ref:`Mesh` resources, each wi Method Descriptions ------------------- -.. _class_MeshLibrary_clear: + .. _class_MeshLibrary_clear: - void **clear** **(** **)** Clear the library. -.. _class_MeshLibrary_create_item: + .. _class_MeshLibrary_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_find_item_by_name: - :ref:`int` **find_item_by_name** **(** :ref:`String` name **)** const -.. _class_MeshLibrary_get_item_list: + .. _class_MeshLibrary_get_item_list: - :ref:`PoolIntArray` **get_item_list** **(** **)** const Return the list of items. -.. _class_MeshLibrary_get_item_mesh: + .. _class_MeshLibrary_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_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_get_item_navmesh: - :ref:`NavigationMesh` **get_item_navmesh** **(** :ref:`int` id **)** const -.. _class_MeshLibrary_get_item_preview: + .. _class_MeshLibrary_get_item_preview: - :ref:`Texture` **get_item_preview** **(** :ref:`int` id **)** const -.. _class_MeshLibrary_get_item_shapes: + .. _class_MeshLibrary_get_item_shapes: - :ref:`Array` **get_item_shapes** **(** :ref:`int` id **)** const -.. _class_MeshLibrary_get_last_unused_item_id: + .. _class_MeshLibrary_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_remove_item: - void **remove_item** **(** :ref:`int` id **)** Remove the item. -.. _class_MeshLibrary_set_item_mesh: + .. _class_MeshLibrary_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_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_set_item_navmesh: - void **set_item_navmesh** **(** :ref:`int` id, :ref:`NavigationMesh` navmesh **)** -.. _class_MeshLibrary_set_item_preview: + .. _class_MeshLibrary_set_item_preview: - void **set_item_preview** **(** :ref:`int` id, :ref:`Texture` texture **)** -.. _class_MeshLibrary_set_item_shapes: + .. _class_MeshLibrary_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 aa9d08d27..35fd9af3b 100644 --- a/classes/class_mobilevrinterface.rst +++ b/classes/class_mobilevrinterface.rst @@ -8,6 +8,7 @@ MobileVRInterface ================= **Inherits:** :ref:`ARVRInterface` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,23 @@ Brief Description 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` | ++---------------------------+-----------------------------------------------------------------+ + Description ----------- @@ -27,26 +45,73 @@ Property Descriptions .. _class_MobileVRInterface_display_to_lens: -- :ref:`float` **display_to_lens** - The distance between the display and the lenses inside of the device in centimeters. +- :ref:`float` **display_to_lens** + ++----------+----------------------------+ +| *Setter* | set_display_to_lens(value) | ++----------+----------------------------+ +| *Getter* | get_display_to_lens() | ++----------+----------------------------+ + +The distance between the display and the lenses inside of the device in centimeters. .. _class_MobileVRInterface_display_width: -- :ref:`float` **display_width** - The width of the display in centimeters. +- :ref:`float` **display_width** + ++----------+--------------------------+ +| *Setter* | set_display_width(value) | ++----------+--------------------------+ +| *Getter* | get_display_width() | ++----------+--------------------------+ + +The width of the display in centimeters. .. _class_MobileVRInterface_iod: -- :ref:`float` **iod** - The interocular distance, also known as the interpupillary distance. The distance between the pupils of the left and right eye. +- :ref:`float` **iod** + ++----------+----------------+ +| *Setter* | set_iod(value) | ++----------+----------------+ +| *Getter* | get_iod() | ++----------+----------------+ + +The interocular distance, also known as the interpupillary distance. The distance between the pupils of the left and right eye. .. _class_MobileVRInterface_k1: -- :ref:`float` **k1** - 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. +- :ref:`float` **k1** + ++----------+---------------+ +| *Setter* | set_k1(value) | ++----------+---------------+ +| *Getter* | get_k1() | ++----------+---------------+ + +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: -- :ref:`float` **k2** - The k2 lens factor, see k1. +- :ref:`float` **k2** + ++----------+---------------+ +| *Setter* | set_k2(value) | ++----------+---------------+ +| *Getter* | get_k2() | ++----------+---------------+ + +The k2 lens factor, see k1. .. _class_MobileVRInterface_oversample: -- :ref:`float` **oversample** - The oversample setting. Because of the lens distortion we have to render our buffers at a higher resolution then the screen can natively handle. A value between 1.5 and 2.0 often provides good results but at the cost of performance. +- :ref:`float` **oversample** ++----------+-----------------------+ +| *Setter* | set_oversample(value) | ++----------+-----------------------+ +| *Getter* | get_oversample() | ++----------+-----------------------+ + +The oversample setting. Because of the lens distortion we have to render our buffers at a higher resolution then the screen can natively handle. A value between 1.5 and 2.0 often provides good results but at the cost of performance. diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index 5e5277068..1d81d3167 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -8,6 +8,7 @@ MultiMesh ========= **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,21 @@ Brief Description 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` | ++----------------------------------------------------------+---------------------------------------------------------------+ + Methods ------- @@ -39,14 +55,14 @@ Enumerations .. _enum_MultiMesh_TransformFormat: -enum **TransformFormat** +enum **TransformFormat**: - **TRANSFORM_2D** = **0** - **TRANSFORM_3D** = **1** .. _enum_MultiMesh_ColorFormat: -enum **ColorFormat** +enum **ColorFormat**: - **COLOR_NONE** = **0** - **COLOR_8BIT** = **1** @@ -54,13 +70,12 @@ enum **ColorFormat** .. _enum_MultiMesh_CustomDataFormat: -enum **CustomDataFormat** +enum **CustomDataFormat**: - **CUSTOM_DATA_NONE** = **0** - **CUSTOM_DATA_8BIT** = **1** - **CUSTOM_DATA_FLOAT** = **2** - Description ----------- @@ -79,62 +94,90 @@ Property Descriptions - :ref:`ColorFormat` **color_format** ++----------+-------------------------+ +| *Setter* | set_color_format(value) | ++----------+-------------------------+ +| *Getter* | get_color_format() | ++----------+-------------------------+ + .. _class_MultiMesh_custom_data_format: - :ref:`CustomDataFormat` **custom_data_format** ++----------+-------------------------------+ +| *Setter* | set_custom_data_format(value) | ++----------+-------------------------------+ +| *Getter* | get_custom_data_format() | ++----------+-------------------------------+ + .. _class_MultiMesh_instance_count: - :ref:`int` **instance_count** ++----------+---------------------------+ +| *Setter* | set_instance_count(value) | ++----------+---------------------------+ +| *Getter* | get_instance_count() | ++----------+---------------------------+ + .. _class_MultiMesh_mesh: - :ref:`Mesh` **mesh** ++----------+-----------------+ +| *Setter* | set_mesh(value) | ++----------+-----------------+ +| *Getter* | get_mesh() | ++----------+-----------------+ + .. _class_MultiMesh_transform_format: - :ref:`TransformFormat` **transform_format** ++----------+-----------------------------+ +| *Setter* | set_transform_format(value) | ++----------+-----------------------------+ +| *Getter* | get_transform_format() | ++----------+-----------------------------+ Method Descriptions ------------------- -.. _class_MultiMesh_get_aabb: + .. _class_MultiMesh_get_aabb: - :ref:`AABB` **get_aabb** **(** **)** const Return the visibility AABB. -.. _class_MultiMesh_get_instance_color: + .. _class_MultiMesh_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_get_instance_custom_data: - :ref:`Color` **get_instance_custom_data** **(** :ref:`int` instance **)** const -.. _class_MultiMesh_get_instance_transform: + .. _class_MultiMesh_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_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_set_instance_custom_data: - void **set_instance_custom_data** **(** :ref:`int` instance, :ref:`Color` custom_data **)** -.. _class_MultiMesh_set_instance_transform: + .. _class_MultiMesh_set_instance_transform: - void **set_instance_transform** **(** :ref:`int` instance, :ref:`Transform` transform **)** Set the transform for a specific instance. - diff --git a/classes/class_multimeshinstance.rst b/classes/class_multimeshinstance.rst index 77db6b8db..6122615ff 100644 --- a/classes/class_multimeshinstance.rst +++ b/classes/class_multimeshinstance.rst @@ -8,6 +8,7 @@ MultiMeshInstance ================= **Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Node that instances a :ref:`MultiMesh`. +Properties +---------- + ++-----------------------------------+-----------------------------------------------------+ +| :ref:`MultiMesh` | :ref:`multimesh` | ++-----------------------------------+-----------------------------------------------------+ + Description ----------- @@ -27,6 +35,13 @@ Property Descriptions .. _class_MultiMeshInstance_multimesh: -- :ref:`MultiMesh` **multimesh** - The :ref:`MultiMesh` resource that will be used and shared among all instances of the ``MultiMeshInstance``. +- :ref:`MultiMesh` **multimesh** ++----------+----------------------+ +| *Setter* | set_multimesh(value) | ++----------+----------------------+ +| *Getter* | get_multimesh() | ++----------+----------------------+ + +The :ref:`MultiMesh` resource that will be used and shared among all instances of the ``MultiMeshInstance``. diff --git a/classes/class_multiplayerapi.rst b/classes/class_multiplayerapi.rst index b9c7f6d8b..5a3e2b049 100644 --- a/classes/class_multiplayerapi.rst +++ b/classes/class_multiplayerapi.rst @@ -8,6 +8,7 @@ MultiplayerAPI ============== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description High Level Multiplayer API. +Properties +---------- + ++-----------------------------------------------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`NetworkedMultiplayerPeer` | :ref:`network_peer` | ++-----------------------------------------------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`refuse_new_network_connections` | ++-----------------------------------------------------------------+--------------------------------------------------------------------------------------------+ + Methods ------- @@ -41,49 +51,48 @@ Methods Signals ------- -.. _class_MultiplayerAPI_connected_to_server: + .. _class_MultiplayerAPI_connected_to_server: - **connected_to_server** **(** **)** Emitted whenever this MultiplayerAPI's :ref:`network_peer` successfully connected to a server. Only emitted on clients. -.. _class_MultiplayerAPI_connection_failed: + .. _class_MultiplayerAPI_connection_failed: - **connection_failed** **(** **)** 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_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). -.. _class_MultiplayerAPI_network_peer_disconnected: + .. _class_MultiplayerAPI_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. -.. _class_MultiplayerAPI_network_peer_packet: + .. _class_MultiplayerAPI_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. -.. _class_MultiplayerAPI_server_disconnected: + .. _class_MultiplayerAPI_server_disconnected: - **server_disconnected** **(** **)** Emitted whenever this MultiplayerAPI's :ref:`network_peer` disconnects from server. Only emitted on clients. - Enumerations ------------ .. _enum_MultiplayerAPI_RPCMode: -enum **RPCMode** +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_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 slaves. @@ -94,7 +103,6 @@ enum **RPCMode** - **RPC_MODE_MASTERSYNC** = **6** --- Behave like ``RPC_MODE_MASTER`` but also make the call or property change locally. Analogous to the ``mastersync`` keyword. - **RPC_MODE_SLAVESYNC** = **7** --- Behave like ``RPC_MODE_SLAVE`` but also make the call or property change locally. Analogous to the ``slavesync`` keyword. - Description ----------- @@ -109,35 +117,50 @@ Property Descriptions .. _class_MultiplayerAPI_network_peer: -- :ref:`NetworkedMultiplayerPeer` **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 slave. 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. +- :ref:`NetworkedMultiplayerPeer` **network_peer** + ++----------+-------------------------+ +| *Setter* | set_network_peer(value) | ++----------+-------------------------+ +| *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 slave. 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: -- :ref:`bool` **refuse_new_network_connections** - If ``true`` the MultiplayerAPI's :ref:`network_peer` refuses new incoming connections. +- :ref:`bool` **refuse_new_network_connections** ++----------+-------------------------------------------+ +| *Setter* | set_refuse_new_network_connections(value) | ++----------+-------------------------------------------+ +| *Getter* | is_refusing_new_network_connections() | ++----------+-------------------------------------------+ + +If ``true`` the MultiplayerAPI's :ref:`network_peer` refuses new incoming connections. Method Descriptions ------------------- -.. _class_MultiplayerAPI_clear: + .. _class_MultiplayerAPI_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_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`. -.. _class_MultiplayerAPI_get_network_unique_id: + .. _class_MultiplayerAPI_get_network_unique_id: - :ref:`int` **get_network_unique_id** **(** **)** const Returns the unique peer ID of this MultiplayerAPI's :ref:`network_peer`. -.. _class_MultiplayerAPI_get_rpc_sender_id: + .. _class_MultiplayerAPI_get_rpc_sender_id: - :ref:`int` **get_rpc_sender_id** **(** **)** const @@ -145,19 +168,19 @@ 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_has_network_peer: - :ref:`bool` **has_network_peer** **(** **)** const Returns ``true`` if there is a :ref:`network_peer` set. -.. _class_MultiplayerAPI_is_network_server: + .. _class_MultiplayerAPI_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). -.. _class_MultiplayerAPI_poll: + .. _class_MultiplayerAPI_poll: - void **poll** **(** **)** @@ -165,13 +188,13 @@ Method used for polling the MultiplayerAPI. You only need to worry about this if 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_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. -.. _class_MultiplayerAPI_set_root_node: + .. _class_MultiplayerAPI_set_root_node: - void **set_root_node** **(** :ref:`Node` node **)** @@ -179,4 +202,3 @@ Sets the base root node to use for RPCs. Instead of an absolute path, a relative This effectively allows to have different branches of the scene tree to be managed by different MultiplayerAPI, allowing for example to run both client and server in the same scene. - diff --git a/classes/class_multiplayerpeergdnative.rst b/classes/class_multiplayerpeergdnative.rst index b9193a19b..ea7538c01 100644 --- a/classes/class_multiplayerpeergdnative.rst +++ b/classes/class_multiplayerpeergdnative.rst @@ -8,6 +8,7 @@ MultiplayerPeerGDNative ======================= **Inherits:** :ref:`NetworkedMultiplayerPeer` **<** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_mutex.rst b/classes/class_mutex.rst index 406b57b9f..3bf8b93de 100644 --- a/classes/class_mutex.rst +++ b/classes/class_mutex.rst @@ -8,6 +8,7 @@ Mutex ===== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -34,22 +35,21 @@ 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_unlock: - void **unlock** **(** **)** Unlock this ``Mutex``, leaving it to other threads. - diff --git a/classes/class_nativescript.rst b/classes/class_nativescript.rst index 88c82f9a2..c250625c2 100644 --- a/classes/class_nativescript.rst +++ b/classes/class_nativescript.rst @@ -8,6 +8,7 @@ NativeScript ============ **Inherits:** :ref:`Script` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,19 @@ 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` | ++-----------------------------------------------+--------------------------------------------------------------------------+ + Methods ------- @@ -37,47 +51,70 @@ Property Descriptions - :ref:`String` **class_name** ++----------+-----------------------+ +| *Setter* | set_class_name(value) | ++----------+-----------------------+ +| *Getter* | get_class_name() | ++----------+-----------------------+ + .. _class_NativeScript_library: - :ref:`GDNativeLibrary` **library** ++----------+--------------------+ +| *Setter* | set_library(value) | ++----------+--------------------+ +| *Getter* | get_library() | ++----------+--------------------+ + .. _class_NativeScript_script_class_icon_path: - :ref:`String` **script_class_icon_path** ++----------+-----------------------------------+ +| *Setter* | set_script_class_icon_path(value) | ++----------+-----------------------------------+ +| *Getter* | get_script_class_icon_path() | ++----------+-----------------------------------+ + .. _class_NativeScript_script_class_name: - :ref:`String` **script_class_name** ++----------+------------------------------+ +| *Setter* | set_script_class_name(value) | ++----------+------------------------------+ +| *Getter* | get_script_class_name() | ++----------+------------------------------+ Method Descriptions ------------------- -.. _class_NativeScript_get_class_documentation: + .. _class_NativeScript_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_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_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_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_new: - :ref:`Object` **new** **(** **)** vararg @@ -85,4 +122,3 @@ Constructs a new object of the base type with a script of this type already atta *Note*: Any arguments passed to this function will be ignored and not passed to the native constructor function. This will change with in a future API extension. - diff --git a/classes/class_navigation.rst b/classes/class_navigation.rst index dde1ee6a2..df3c9075b 100644 --- a/classes/class_navigation.rst +++ b/classes/class_navigation.rst @@ -8,6 +8,7 @@ Navigation ========== **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Mesh-based navigation and pathfinding node. +Properties +---------- + ++-------------------------------+----------------------------------------------+ +| :ref:`Vector3` | :ref:`up_vector` | ++-------------------------------+----------------------------------------------+ + Methods ------- @@ -46,58 +54,64 @@ Property Descriptions .. _class_Navigation_up_vector: -- :ref:`Vector3` **up_vector** - Defines which direction is up. By default this is ``(0, 1, 0)``, which is the world up direction. +- :ref:`Vector3` **up_vector** ++----------+----------------------+ +| *Setter* | set_up_vector(value) | ++----------+----------------------+ +| *Getter* | get_up_vector() | ++----------+----------------------+ + +Defines which direction is up. By default this is ``(0, 1, 0)``, which is the world up direction. Method Descriptions ------------------- -.. _class_Navigation_get_closest_point: + .. _class_Navigation_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_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_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 NavigtionMeshInstance. 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_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_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_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`. -.. _class_Navigation_navmesh_remove: + .. _class_Navigation_navmesh_remove: - void **navmesh_remove** **(** :ref:`int` id **)** Removes the :ref:`NavigationMesh` with the given ID. -.. _class_Navigation_navmesh_set_transform: + .. _class_Navigation_navmesh_set_transform: - void **navmesh_set_transform** **(** :ref:`int` id, :ref:`Transform` xform **)** Sets the transform applied to the :ref:`NavigationMesh` with the given ID. - diff --git a/classes/class_navigation2d.rst b/classes/class_navigation2d.rst index 51d4bd267..355699215 100644 --- a/classes/class_navigation2d.rst +++ b/classes/class_navigation2d.rst @@ -8,6 +8,7 @@ Navigation2D ============ **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -40,40 +41,39 @@ Navigation2D provides navigation and pathfinding within a 2D area, specified as Method Descriptions ------------------- -.. _class_Navigation2D_get_closest_point: + .. _class_Navigation2D_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_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 NavigtionPolygonInstance. 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_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_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`. -.. _class_Navigation2D_navpoly_remove: + .. _class_Navigation2D_navpoly_remove: - void **navpoly_remove** **(** :ref:`int` id **)** Removes the :ref:`NavigationPolygon` with the given ID. -.. _class_Navigation2D_navpoly_set_transform: + .. _class_Navigation2D_navpoly_set_transform: - void **navpoly_set_transform** **(** :ref:`int` id, :ref:`Transform2D` xform **)** Sets the transform applied to the :ref:`NavigationPolygon` with the given ID. - diff --git a/classes/class_navigationmesh.rst b/classes/class_navigationmesh.rst index 605a20285..b25fbaba4 100644 --- a/classes/class_navigationmesh.rst +++ b/classes/class_navigationmesh.rst @@ -8,6 +8,7 @@ NavigationMesh ============== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,45 @@ 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` | ++---------------------------+----------------------------------------------------------------------------------------------------------------------+ + Methods ------- @@ -40,7 +80,6 @@ Constants - **SAMPLE_PARTITION_WATERSHED** = **0** - **SAMPLE_PARTITION_MONOTONE** = **1** - **SAMPLE_PARTITION_LAYERS** = **2** - Property Descriptions --------------------- @@ -48,100 +87,200 @@ Property Descriptions - :ref:`float` **agent/height** ++----------+-------------------------+ +| *Setter* | set_agent_height(value) | ++----------+-------------------------+ +| *Getter* | get_agent_height() | ++----------+-------------------------+ + .. _class_NavigationMesh_agent/max_climb: - :ref:`float` **agent/max_climb** ++----------+----------------------------+ +| *Setter* | set_agent_max_climb(value) | ++----------+----------------------------+ +| *Getter* | get_agent_max_climb() | ++----------+----------------------------+ + .. _class_NavigationMesh_agent/max_slope: - :ref:`float` **agent/max_slope** ++----------+----------------------------+ +| *Setter* | set_agent_max_slope(value) | ++----------+----------------------------+ +| *Getter* | get_agent_max_slope() | ++----------+----------------------------+ + .. _class_NavigationMesh_agent/radius: - :ref:`float` **agent/radius** ++----------+-------------------------+ +| *Setter* | set_agent_radius(value) | ++----------+-------------------------+ +| *Getter* | get_agent_radius() | ++----------+-------------------------+ + .. _class_NavigationMesh_cell/height: - :ref:`float` **cell/height** ++----------+------------------------+ +| *Setter* | set_cell_height(value) | ++----------+------------------------+ +| *Getter* | get_cell_height() | ++----------+------------------------+ + .. _class_NavigationMesh_cell/size: - :ref:`float` **cell/size** ++----------+----------------------+ +| *Setter* | set_cell_size(value) | ++----------+----------------------+ +| *Getter* | get_cell_size() | ++----------+----------------------+ + .. _class_NavigationMesh_detail/sample_distance: - :ref:`float` **detail/sample_distance** ++----------+-----------------------------------+ +| *Setter* | set_detail_sample_distance(value) | ++----------+-----------------------------------+ +| *Getter* | get_detail_sample_distance() | ++----------+-----------------------------------+ + .. _class_NavigationMesh_detail/sample_max_error: - :ref:`float` **detail/sample_max_error** ++----------+------------------------------------+ +| *Setter* | set_detail_sample_max_error(value) | ++----------+------------------------------------+ +| *Getter* | get_detail_sample_max_error() | ++----------+------------------------------------+ + .. _class_NavigationMesh_edge/max_error: - :ref:`float` **edge/max_error** ++----------+---------------------------+ +| *Setter* | set_edge_max_error(value) | ++----------+---------------------------+ +| *Getter* | get_edge_max_error() | ++----------+---------------------------+ + .. _class_NavigationMesh_edge/max_length: - :ref:`float` **edge/max_length** ++----------+----------------------------+ +| *Setter* | set_edge_max_length(value) | ++----------+----------------------------+ +| *Getter* | get_edge_max_length() | ++----------+----------------------------+ + .. _class_NavigationMesh_filter/filter_walkable_low_height_spans: - :ref:`bool` **filter/filter_walkable_low_height_spans** ++----------+---------------------------------------------+ +| *Setter* | set_filter_walkable_low_height_spans(value) | ++----------+---------------------------------------------+ +| *Getter* | get_filter_walkable_low_height_spans() | ++----------+---------------------------------------------+ + .. _class_NavigationMesh_filter/ledge_spans: - :ref:`bool` **filter/ledge_spans** ++----------+-------------------------------+ +| *Setter* | set_filter_ledge_spans(value) | ++----------+-------------------------------+ +| *Getter* | get_filter_ledge_spans() | ++----------+-------------------------------+ + .. _class_NavigationMesh_filter/low_hanging_obstacles: - :ref:`bool` **filter/low_hanging_obstacles** ++----------+-----------------------------------------+ +| *Setter* | set_filter_low_hanging_obstacles(value) | ++----------+-----------------------------------------+ +| *Getter* | get_filter_low_hanging_obstacles() | ++----------+-----------------------------------------+ + .. _class_NavigationMesh_polygon/verts_per_poly: - :ref:`float` **polygon/verts_per_poly** ++----------+---------------------------+ +| *Setter* | set_verts_per_poly(value) | ++----------+---------------------------+ +| *Getter* | get_verts_per_poly() | ++----------+---------------------------+ + .. _class_NavigationMesh_region/merge_size: - :ref:`float` **region/merge_size** ++----------+------------------------------+ +| *Setter* | set_region_merge_size(value) | ++----------+------------------------------+ +| *Getter* | get_region_merge_size() | ++----------+------------------------------+ + .. _class_NavigationMesh_region/min_size: - :ref:`float` **region/min_size** ++----------+----------------------------+ +| *Setter* | set_region_min_size(value) | ++----------+----------------------------+ +| *Getter* | get_region_min_size() | ++----------+----------------------------+ + .. _class_NavigationMesh_sample_partition_type/sample_partition_type: - :ref:`int` **sample_partition_type/sample_partition_type** ++----------+----------------------------------+ +| *Setter* | set_sample_partition_type(value) | ++----------+----------------------------------+ +| *Getter* | get_sample_partition_type() | ++----------+----------------------------------+ Method Descriptions ------------------- -.. _class_NavigationMesh_add_polygon: + .. _class_NavigationMesh_add_polygon: - void **add_polygon** **(** :ref:`PoolIntArray` polygon **)** -.. _class_NavigationMesh_clear_polygons: + .. _class_NavigationMesh_clear_polygons: - void **clear_polygons** **(** **)** -.. _class_NavigationMesh_create_from_mesh: + .. _class_NavigationMesh_create_from_mesh: - void **create_from_mesh** **(** :ref:`Mesh` mesh **)** -.. _class_NavigationMesh_get_polygon: + .. _class_NavigationMesh_get_polygon: - :ref:`PoolIntArray` **get_polygon** **(** :ref:`int` idx **)** -.. _class_NavigationMesh_get_polygon_count: + .. _class_NavigationMesh_get_polygon_count: - :ref:`int` **get_polygon_count** **(** **)** const -.. _class_NavigationMesh_get_vertices: + .. _class_NavigationMesh_get_vertices: - :ref:`PoolVector3Array` **get_vertices** **(** **)** const -.. _class_NavigationMesh_set_vertices: + .. _class_NavigationMesh_set_vertices: - void **set_vertices** **(** :ref:`PoolVector3Array` vertices **)** - diff --git a/classes/class_navigationmeshinstance.rst b/classes/class_navigationmeshinstance.rst index a6bc9aa52..37416167d 100644 --- a/classes/class_navigationmeshinstance.rst +++ b/classes/class_navigationmeshinstance.rst @@ -8,6 +8,7 @@ NavigationMeshInstance ====================== **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description +Properties +---------- + ++---------------------------------------------+------------------------------------------------------+ +| :ref:`bool` | :ref:`enabled` | ++---------------------------------------------+------------------------------------------------------+ +| :ref:`NavigationMesh` | :ref:`navmesh` | ++---------------------------------------------+------------------------------------------------------+ + Property Descriptions --------------------- @@ -22,8 +32,19 @@ Property Descriptions - :ref:`bool` **enabled** ++----------+--------------------+ +| *Setter* | set_enabled(value) | ++----------+--------------------+ +| *Getter* | is_enabled() | ++----------+--------------------+ + .. _class_NavigationMeshInstance_navmesh: - :ref:`NavigationMesh` **navmesh** ++----------+----------------------------+ +| *Setter* | set_navigation_mesh(value) | ++----------+----------------------------+ +| *Getter* | get_navigation_mesh() | ++----------+----------------------------+ diff --git a/classes/class_navigationpolygon.rst b/classes/class_navigationpolygon.rst index 3688b5720..f02ce13fc 100644 --- a/classes/class_navigationpolygon.rst +++ b/classes/class_navigationpolygon.rst @@ -8,6 +8,7 @@ NavigationPolygon ================= **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -51,60 +52,59 @@ Methods Method Descriptions ------------------- -.. _class_NavigationPolygon_add_outline: + .. _class_NavigationPolygon_add_outline: - void **add_outline** **(** :ref:`PoolVector2Array` outline **)** -.. _class_NavigationPolygon_add_outline_at_index: + .. _class_NavigationPolygon_add_outline_at_index: - void **add_outline_at_index** **(** :ref:`PoolVector2Array` outline, :ref:`int` index **)** -.. _class_NavigationPolygon_add_polygon: + .. _class_NavigationPolygon_add_polygon: - void **add_polygon** **(** :ref:`PoolIntArray` polygon **)** -.. _class_NavigationPolygon_clear_outlines: + .. _class_NavigationPolygon_clear_outlines: - void **clear_outlines** **(** **)** -.. _class_NavigationPolygon_clear_polygons: + .. _class_NavigationPolygon_clear_polygons: - void **clear_polygons** **(** **)** -.. _class_NavigationPolygon_get_outline: + .. _class_NavigationPolygon_get_outline: - :ref:`PoolVector2Array` **get_outline** **(** :ref:`int` idx **)** const -.. _class_NavigationPolygon_get_outline_count: + .. _class_NavigationPolygon_get_outline_count: - :ref:`int` **get_outline_count** **(** **)** const -.. _class_NavigationPolygon_get_polygon: + .. _class_NavigationPolygon_get_polygon: - :ref:`PoolIntArray` **get_polygon** **(** :ref:`int` idx **)** -.. _class_NavigationPolygon_get_polygon_count: + .. _class_NavigationPolygon_get_polygon_count: - :ref:`int` **get_polygon_count** **(** **)** const -.. _class_NavigationPolygon_get_vertices: + .. _class_NavigationPolygon_get_vertices: - :ref:`PoolVector2Array` **get_vertices** **(** **)** const -.. _class_NavigationPolygon_make_polygons_from_outlines: + .. _class_NavigationPolygon_make_polygons_from_outlines: - void **make_polygons_from_outlines** **(** **)** -.. _class_NavigationPolygon_remove_outline: + .. _class_NavigationPolygon_remove_outline: - void **remove_outline** **(** :ref:`int` idx **)** -.. _class_NavigationPolygon_set_outline: + .. _class_NavigationPolygon_set_outline: - void **set_outline** **(** :ref:`int` idx, :ref:`PoolVector2Array` outline **)** -.. _class_NavigationPolygon_set_vertices: + .. _class_NavigationPolygon_set_vertices: - void **set_vertices** **(** :ref:`PoolVector2Array` vertices **)** - diff --git a/classes/class_navigationpolygoninstance.rst b/classes/class_navigationpolygoninstance.rst index fc1f0d2d2..ed0b40852 100644 --- a/classes/class_navigationpolygoninstance.rst +++ b/classes/class_navigationpolygoninstance.rst @@ -8,6 +8,7 @@ NavigationPolygonInstance ========================= **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description +Properties +---------- + ++---------------------------------------------------+---------------------------------------------------------+ +| :ref:`bool` | :ref:`enabled` | ++---------------------------------------------------+---------------------------------------------------------+ +| :ref:`NavigationPolygon` | :ref:`navpoly` | ++---------------------------------------------------+---------------------------------------------------------+ + Property Descriptions --------------------- @@ -22,8 +32,19 @@ Property Descriptions - :ref:`bool` **enabled** ++----------+--------------------+ +| *Setter* | set_enabled(value) | ++----------+--------------------+ +| *Getter* | is_enabled() | ++----------+--------------------+ + .. _class_NavigationPolygonInstance_navpoly: - :ref:`NavigationPolygon` **navpoly** ++----------+-------------------------------+ +| *Setter* | set_navigation_polygon(value) | ++----------+-------------------------------+ +| *Getter* | get_navigation_polygon() | ++----------+-------------------------------+ diff --git a/classes/class_networkedmultiplayerenet.rst b/classes/class_networkedmultiplayerenet.rst index c6a957811..929b4a82b 100644 --- a/classes/class_networkedmultiplayerenet.rst +++ b/classes/class_networkedmultiplayerenet.rst @@ -8,6 +8,7 @@ NetworkedMultiplayerENet ======================== **Inherits:** :ref:`NetworkedMultiplayerPeer` **<** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,19 @@ Brief Description 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` | ++-----------------------------------------------------------------------+--------------------------------------------------------------------------+ + Methods ------- @@ -43,7 +57,7 @@ Enumerations .. _enum_NetworkedMultiplayerENet_CompressionMode: -enum **CompressionMode** +enum **CompressionMode**: - **COMPRESS_NONE** = **0** --- No compression. - **COMPRESS_RANGE_CODER** = **1** --- ENet's buildin range encoding. @@ -51,7 +65,6 @@ enum **CompressionMode** - **COMPRESS_ZLIB** = **3** --- zlib compression. - **COMPRESS_ZSTD** = **4** --- ZStandard compression. - Description ----------- @@ -62,82 +75,111 @@ Tutorials - :doc:`../tutorials/networking/high_level_multiplayer` - `http://enet.bespin.org/usergroup0.html `_ - Property Descriptions --------------------- .. _class_NetworkedMultiplayerENet_always_ordered: -- :ref:`bool` **always_ordered** - Always use ``TRANSFER_MODE_ORDERED`` in place of ``TRANSFER_MODE_UNRELIABLE``. This is the only way to use ordering with the RPC system. +- :ref:`bool` **always_ordered** + ++----------+---------------------------+ +| *Setter* | set_always_ordered(value) | ++----------+---------------------------+ +| *Getter* | is_always_ordered() | ++----------+---------------------------+ + +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: -- :ref:`int` **channel_count** - 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. +- :ref:`int` **channel_count** + ++----------+--------------------------+ +| *Setter* | set_channel_count(value) | ++----------+--------------------------+ +| *Getter* | get_channel_count() | ++----------+--------------------------+ + +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: -- :ref:`CompressionMode` **compression_mode** - 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. +- :ref:`CompressionMode` **compression_mode** + ++----------+-----------------------------+ +| *Setter* | set_compression_mode(value) | ++----------+-----------------------------+ +| *Getter* | get_compression_mode() | ++----------+-----------------------------+ + +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: -- :ref:`int` **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. +- :ref:`int` **transfer_channel** ++----------+-----------------------------+ +| *Setter* | set_transfer_channel(value) | ++----------+-----------------------------+ +| *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. Method Descriptions ------------------- -.. _class_NetworkedMultiplayerENet_close_connection: + .. _class_NetworkedMultiplayerENet_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_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 traveral 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_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. -.. _class_NetworkedMultiplayerENet_disconnect_peer: + .. _class_NetworkedMultiplayerENet_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_get_last_packet_channel: - :ref:`int` **get_last_packet_channel** **(** **)** const Returns the channel of the last packet fetched via :ref:`PacketPeer.get_packet` -.. _class_NetworkedMultiplayerENet_get_packet_channel: + .. _class_NetworkedMultiplayerENet_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_peer` -.. _class_NetworkedMultiplayerENet_get_peer_address: + .. _class_NetworkedMultiplayerENet_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_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_set_bind_ip: - void **set_bind_ip** **(** :ref:`String` ip **)** The IP used when creating a server. This is set to the wildcard ``*`` by default, which binds to all available interfaces. The given IP needs to be in IPv4 or IPv6 address format, for example: ``192.168.1.1``. - diff --git a/classes/class_networkedmultiplayerpeer.rst b/classes/class_networkedmultiplayerpeer.rst index 5259d870f..4b8d997d8 100644 --- a/classes/class_networkedmultiplayerpeer.rst +++ b/classes/class_networkedmultiplayerpeer.rst @@ -8,7 +8,9 @@ NetworkedMultiplayerPeer ======================== **Inherits:** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`MultiplayerPeerGDNative`, :ref:`NetworkedMultiplayerENet`, :ref:`WebSocketMultiplayerPeer` + **Category:** Core Brief Description @@ -16,6 +18,15 @@ Brief Description A high-level network interface to simplify multiplayer interactions. +Properties +---------- + ++-----------------------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`refuse_new_connections` | ++-----------------------------------------------------------------+--------------------------------------------------------------------------------------+ +| :ref:`TransferMode` | :ref:`transfer_mode` | ++-----------------------------------------------------------------+--------------------------------------------------------------------------------------+ + Methods ------- @@ -34,43 +45,42 @@ Methods Signals ------- -.. _class_NetworkedMultiplayerPeer_connection_failed: + .. _class_NetworkedMultiplayerPeer_connection_failed: - **connection_failed** **(** **)** Emitted when a connection attempt fails. -.. _class_NetworkedMultiplayerPeer_connection_succeeded: + .. _class_NetworkedMultiplayerPeer_connection_succeeded: - **connection_succeeded** **(** **)** Emitted when a connection attempt succeeds. -.. _class_NetworkedMultiplayerPeer_peer_connected: + .. _class_NetworkedMultiplayerPeer_peer_connected: - **peer_connected** **(** :ref:`int` id **)** Emitted by the server when a client connects. -.. _class_NetworkedMultiplayerPeer_peer_disconnected: + .. _class_NetworkedMultiplayerPeer_peer_disconnected: - **peer_disconnected** **(** :ref:`int` id **)** Emitted by the server when a client disconnects. -.. _class_NetworkedMultiplayerPeer_server_disconnected: + .. _class_NetworkedMultiplayerPeer_server_disconnected: - **server_disconnected** **(** **)** Emitted by clients when the server disconnects. - Enumerations ------------ .. _enum_NetworkedMultiplayerPeer_TransferMode: -enum **TransferMode** +enum **TransferMode**: - **TRANSFER_MODE_UNRELIABLE** = **0** --- Packets are sent via unordered UDP packets. - **TRANSFER_MODE_UNRELIABLE_ORDERED** = **1** --- Packets are sent via ordered UDP packets. @@ -78,19 +88,17 @@ enum **TransferMode** .. _enum_NetworkedMultiplayerPeer_ConnectionStatus: -enum **ConnectionStatus** +enum **ConnectionStatus**: - **CONNECTION_DISCONNECTED** = **0** --- The ongoing connection disconnected. - **CONNECTION_CONNECTING** = **1** --- A connection attempt is ongoing. - **CONNECTION_CONNECTED** = **2** --- The connection attempt succeeded. - Constants --------- - **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. - Description ----------- @@ -100,47 +108,61 @@ Tutorials --------- - :doc:`../tutorials/networking/high_level_multiplayer` - Property Descriptions --------------------- .. _class_NetworkedMultiplayerPeer_refuse_new_connections: -- :ref:`bool` **refuse_new_connections** - If ``true`` this ``NetworkedMultiplayerPeer`` refuses new connections. Default value: ``false``. +- :ref:`bool` **refuse_new_connections** + ++----------+-----------------------------------+ +| *Setter* | set_refuse_new_connections(value) | ++----------+-----------------------------------+ +| *Getter* | is_refusing_new_connections() | ++----------+-----------------------------------+ + +If ``true`` this ``NetworkedMultiplayerPeer`` refuses new connections. Default value: ``false``. .. _class_NetworkedMultiplayerPeer_transfer_mode: -- :ref:`TransferMode` **transfer_mode** - The manner in which to send packets to the ``target_peer``. See :ref:`TransferMode`. +- :ref:`TransferMode` **transfer_mode** ++----------+--------------------------+ +| *Setter* | set_transfer_mode(value) | ++----------+--------------------------+ +| *Getter* | get_transfer_mode() | ++----------+--------------------------+ + +The manner in which to send packets to the ``target_peer``. See :ref:`TransferMode`. Method Descriptions ------------------- -.. _class_NetworkedMultiplayerPeer_get_connection_status: + .. _class_NetworkedMultiplayerPeer_get_connection_status: - :ref:`ConnectionStatus` **get_connection_status** **(** **)** const Returns the current state of the connection. See :ref:`ConnectionStatus`. -.. _class_NetworkedMultiplayerPeer_get_packet_peer: + .. _class_NetworkedMultiplayerPeer_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_get_unique_id: - :ref:`int` **get_unique_id** **(** **)** const Returns the ID of this ``NetworkedMultiplayerPeer``. -.. _class_NetworkedMultiplayerPeer_poll: + .. _class_NetworkedMultiplayerPeer_poll: - void **poll** **(** **)** Waits up to 1 second to receive a new network event. -.. _class_NetworkedMultiplayerPeer_set_target_peer: + .. _class_NetworkedMultiplayerPeer_set_target_peer: - void **set_target_peer** **(** :ref:`int` id **)** @@ -148,4 +170,3 @@ Sets the peer to which packets will be sent. The ``id`` can be one of: ``TARGET_PEER_BROADCAST`` to send to all connected peers, ``TARGET_PEER_SERVER`` to send to the peer acting as server, a valid peer ID to send to that specific peer, a negative peer ID to send to all peers except that one. Default: ``TARGET_PEER_BROADCAST`` - diff --git a/classes/class_nil.rst b/classes/class_nil.rst index 6f0276b24..869137838 100644 --- a/classes/class_nil.rst +++ b/classes/class_nil.rst @@ -74,108 +74,107 @@ Methods Method Descriptions ------------------- -.. _class_Nil_Nil: + .. _class_Nil_Nil: - void **Nil** **(** :ref:`PoolColorArray` from **)** -.. _class_Nil_Nil: + .. _class_Nil_Nil: - void **Nil** **(** :ref:`PoolVector3Array` from **)** -.. _class_Nil_Nil: + .. _class_Nil_Nil: - void **Nil** **(** :ref:`PoolVector2Array` from **)** -.. _class_Nil_Nil: + .. _class_Nil_Nil: - void **Nil** **(** :ref:`PoolStringArray` from **)** -.. _class_Nil_Nil: + .. _class_Nil_Nil: - void **Nil** **(** :ref:`PoolRealArray` from **)** -.. _class_Nil_Nil: + .. _class_Nil_Nil: - void **Nil** **(** :ref:`PoolIntArray` from **)** -.. _class_Nil_Nil: + .. _class_Nil_Nil: - void **Nil** **(** :ref:`PoolByteArray` from **)** -.. _class_Nil_Nil: + .. _class_Nil_Nil: - void **Nil** **(** :ref:`Array` from **)** -.. _class_Nil_Nil: + .. _class_Nil_Nil: - void **Nil** **(** :ref:`Dictionary` from **)** -.. _class_Nil_Nil: + .. _class_Nil_Nil: - void **Nil** **(** :ref:`Object` from **)** -.. _class_Nil_Nil: + .. _class_Nil_Nil: - void **Nil** **(** :ref:`RID` from **)** -.. _class_Nil_Nil: + .. _class_Nil_Nil: - void **Nil** **(** :ref:`NodePath` from **)** -.. _class_Nil_Nil: + .. _class_Nil_Nil: - void **Nil** **(** :ref:`Color` from **)** -.. _class_Nil_Nil: + .. _class_Nil_Nil: - void **Nil** **(** :ref:`Transform` from **)** -.. _class_Nil_Nil: + .. _class_Nil_Nil: - void **Nil** **(** :ref:`Basis` from **)** -.. _class_Nil_Nil: + .. _class_Nil_Nil: - void **Nil** **(** :ref:`AABB` from **)** -.. _class_Nil_Nil: + .. _class_Nil_Nil: - void **Nil** **(** :ref:`Quat` from **)** -.. _class_Nil_Nil: + .. _class_Nil_Nil: - void **Nil** **(** :ref:`Plane` from **)** -.. _class_Nil_Nil: + .. _class_Nil_Nil: - void **Nil** **(** :ref:`Transform2D` from **)** -.. _class_Nil_Nil: + .. _class_Nil_Nil: - void **Nil** **(** :ref:`Vector3` from **)** -.. _class_Nil_Nil: + .. _class_Nil_Nil: - void **Nil** **(** :ref:`Rect2` from **)** -.. _class_Nil_Nil: + .. _class_Nil_Nil: - void **Nil** **(** :ref:`Vector2` from **)** -.. _class_Nil_Nil: + .. _class_Nil_Nil: - void **Nil** **(** :ref:`String` from **)** -.. _class_Nil_Nil: + .. _class_Nil_Nil: - void **Nil** **(** :ref:`float` from **)** -.. _class_Nil_Nil: + .. _class_Nil_Nil: - void **Nil** **(** :ref:`int` from **)** -.. _class_Nil_Nil: + .. _class_Nil_Nil: - void **Nil** **(** :ref:`bool` from **)** - diff --git a/classes/class_ninepatchrect.rst b/classes/class_ninepatchrect.rst index af1ea93c4..0c477e928 100644 --- a/classes/class_ninepatchrect.rst +++ b/classes/class_ninepatchrect.rst @@ -8,6 +8,7 @@ NinePatchRect ============= **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,28 +16,49 @@ Brief Description Scalable texture-based frame that tiles the texture's centers and sides, but keeps the corners' original size. Perfect for panels and dialog boxes. +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` | ++------------------------------------------------------------+-----------------------------------------------------------------------------+ + Signals ------- -.. _class_NinePatchRect_texture_changed: + .. _class_NinePatchRect_texture_changed: - **texture_changed** **(** **)** Fired when the node's texture changes. - Enumerations ------------ .. _enum_NinePatchRect_AxisStretchMode: -enum **AxisStretchMode** +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``. - **AXIS_STRETCH_MODE_TILE** = **1** --- Doesn't do anything at the time of writing. - **AXIS_STRETCH_MODE_TILE_FIT** = **2** --- Doesn't do anything at the time of writing. - Description ----------- @@ -47,38 +69,109 @@ Property Descriptions .. _class_NinePatchRect_axis_stretch_horizontal: -- :ref:`AxisStretchMode` **axis_stretch_horizontal** - Doesn't do anything at the time of writing. +- :ref:`AxisStretchMode` **axis_stretch_horizontal** + ++----------+--------------------------------+ +| *Setter* | set_h_axis_stretch_mode(value) | ++----------+--------------------------------+ +| *Getter* | get_h_axis_stretch_mode() | ++----------+--------------------------------+ + +Doesn't do anything at the time of writing. .. _class_NinePatchRect_axis_stretch_vertical: -- :ref:`AxisStretchMode` **axis_stretch_vertical** - Doesn't do anything at the time of writing. +- :ref:`AxisStretchMode` **axis_stretch_vertical** + ++----------+--------------------------------+ +| *Setter* | set_v_axis_stretch_mode(value) | ++----------+--------------------------------+ +| *Getter* | get_v_axis_stretch_mode() | ++----------+--------------------------------+ + +Doesn't do anything at the time of writing. .. _class_NinePatchRect_draw_center: -- :ref:`bool` **draw_center** - If ``true``, draw the panel's center. Else, only draw the 9-slice's borders. Default value: ``true`` +- :ref:`bool` **draw_center** + ++----------+--------------------------+ +| *Setter* | set_draw_center(value) | ++----------+--------------------------+ +| *Getter* | is_draw_center_enabled() | ++----------+--------------------------+ + +If ``true``, draw the panel's center. Else, only draw the 9-slice's borders. Default value: ``true`` .. _class_NinePatchRect_patch_margin_bottom: -- :ref:`int` **patch_margin_bottom** - 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. +- :ref:`int` **patch_margin_bottom** + ++----------+-------------------------+ +| *Setter* | set_patch_margin(value) | ++----------+-------------------------+ +| *Getter* | get_patch_margin() | ++----------+-------------------------+ + +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: -- :ref:`int` **patch_margin_left** - The height of the 9-slice's left column. +- :ref:`int` **patch_margin_left** + ++----------+-------------------------+ +| *Setter* | set_patch_margin(value) | ++----------+-------------------------+ +| *Getter* | get_patch_margin() | ++----------+-------------------------+ + +The height of the 9-slice's left column. .. _class_NinePatchRect_patch_margin_right: -- :ref:`int` **patch_margin_right** - The height of the 9-slice's right column. +- :ref:`int` **patch_margin_right** + ++----------+-------------------------+ +| *Setter* | set_patch_margin(value) | ++----------+-------------------------+ +| *Getter* | get_patch_margin() | ++----------+-------------------------+ + +The height of the 9-slice's right column. .. _class_NinePatchRect_patch_margin_top: -- :ref:`int` **patch_margin_top** - The height of the 9-slice's top row. +- :ref:`int` **patch_margin_top** + ++----------+-------------------------+ +| *Setter* | set_patch_margin(value) | ++----------+-------------------------+ +| *Getter* | get_patch_margin() | ++----------+-------------------------+ + +The height of the 9-slice's top row. .. _class_NinePatchRect_region_rect: -- :ref:`Rect2` **region_rect** - 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. +- :ref:`Rect2` **region_rect** + ++----------+------------------------+ +| *Setter* | set_region_rect(value) | ++----------+------------------------+ +| *Getter* | get_region_rect() | ++----------+------------------------+ + +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: -- :ref:`Texture` **texture** - The node's texture resource. +- :ref:`Texture` **texture** ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + +The node's texture resource. diff --git a/classes/class_node.rst b/classes/class_node.rst index ff7699069..1336ed2ae 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -8,7 +8,9 @@ Node ==== **Inherits:** :ref:`Object` + **Inherited By:** :ref:`Viewport`, :ref:`AudioStreamPlayer`, :ref:`EditorFileSystem`, :ref:`SkeletonIK`, :ref:`CanvasLayer`, :ref:`Spatial`, :ref:`AnimationPlayer`, :ref:`EditorPlugin`, :ref:`ResourcePreloader`, :ref:`AnimationTreePlayer`, :ref:`AnimationTree`, :ref:`WorldEnvironment`, :ref:`InstancePlaceholder`, :ref:`HTTPRequest`, :ref:`EditorInterface`, :ref:`EditorResourcePreview`, :ref:`CanvasItem`, :ref:`Timer`, :ref:`Tween` + **Category:** Core Brief Description @@ -16,6 +18,23 @@ Brief Description 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` | ++---------------------------------------------+----------------------------------------------------------+ + Methods ------- @@ -186,43 +205,42 @@ Methods Signals ------- -.. _class_Node_ready: + .. _class_Node_ready: - **ready** **(** **)** Emitted when the node is ready. -.. _class_Node_renamed: + .. _class_Node_renamed: - **renamed** **(** **)** Emitted when the node is renamed. -.. _class_Node_tree_entered: + .. _class_Node_tree_entered: - **tree_entered** **(** **)** Emitted when the node enters the tree. -.. _class_Node_tree_exited: + .. _class_Node_tree_exited: - **tree_exited** **(** **)** Emitted after the node exits the tree and is no longer active. -.. _class_Node_tree_exiting: + .. _class_Node_tree_exiting: - **tree_exiting** **(** **)** Emitted when the node is still active but about to exit the tree. This is the right place for de-initialization (or a "destructor", if you will). - Enumerations ------------ .. _enum_Node_PauseMode: -enum **PauseMode** +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. - **PAUSE_MODE_STOP** = **1** --- Stop processing when the :ref:`SceneTree` is paused. @@ -230,14 +248,13 @@ enum **PauseMode** .. _enum_Node_DuplicateFlags: -enum **DuplicateFlags** +enum **DuplicateFlags**: - **DUPLICATE_SIGNALS** = **1** --- Duplicate the node's signals. - **DUPLICATE_GROUPS** = **2** --- Duplicate the node's groups. - **DUPLICATE_SCRIPTS** = **4** --- Duplicate the node's scripts. - **DUPLICATE_USE_INSTANCING** = **8** --- Duplicate using instancing. - Constants --------- @@ -258,7 +275,6 @@ Constants - **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_PHYSICS_PROCESS** = **26** --- Notification received every frame when the internal physics process flag is set (see :ref:`set_physics_process_internal`). - Description ----------- @@ -288,39 +304,83 @@ Tutorials --------- - :doc:`../getting_started/step_by_step/scenes_and_nodes` - Property Descriptions --------------------- .. _class_Node_custom_multiplayer: -- :ref:`MultiplayerAPI` **custom_multiplayer** - The override to the default :ref:`MultiplayerAPI`. Set to null to use the default SceneTree one. +- :ref:`MultiplayerAPI` **custom_multiplayer** + ++----------+-------------------------------+ +| *Setter* | set_custom_multiplayer(value) | ++----------+-------------------------------+ +| *Getter* | get_custom_multiplayer() | ++----------+-------------------------------+ + +The override to the default :ref:`MultiplayerAPI`. Set to null to use the default SceneTree one. .. _class_Node_filename: -- :ref:`String` **filename** - When a scene is instanced from a file, its topmost node contains the filename from which it was loaded. +- :ref:`String` **filename** + ++----------+---------------------+ +| *Setter* | set_filename(value) | ++----------+---------------------+ +| *Getter* | get_filename() | ++----------+---------------------+ + +When a scene is instanced from a file, its topmost node contains the filename from which it was loaded. .. _class_Node_multiplayer: -- :ref:`MultiplayerAPI` **multiplayer** - The :ref:`MultiplayerAPI` instance associated with this node. Either the :ref:`custom_multiplayer`, or the default SceneTree one (if inside tree). +- :ref:`MultiplayerAPI` **multiplayer** + ++----------+-------------------+ +| *Getter* | get_multiplayer() | ++----------+-------------------+ + +The :ref:`MultiplayerAPI` instance associated with this node. Either the :ref:`custom_multiplayer`, or the default SceneTree one (if inside tree). .. _class_Node_name: -- :ref:`String` **name** - 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 +- :ref:`String` **name** + ++----------+-----------------+ +| *Setter* | set_name(value) | ++----------+-----------------+ +| *Getter* | get_name() | ++----------+-----------------+ + +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: -- :ref:`Node` **owner** - 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. +- :ref:`Node` **owner** + ++----------+------------------+ +| *Setter* | set_owner(value) | ++----------+------------------+ +| *Getter* | get_owner() | ++----------+------------------+ + +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: -- :ref:`PauseMode` **pause_mode** - Pause mode. How the node will behave if the :ref:`SceneTree` is paused. +- :ref:`PauseMode` **pause_mode** ++----------+-----------------------+ +| *Setter* | set_pause_mode(value) | ++----------+-----------------------+ +| *Getter* | get_pause_mode() | ++----------+-----------------------+ + +Pause mode. How the node will behave if the :ref:`SceneTree` is paused. Method Descriptions ------------------- -.. _class_Node__enter_tree: + .. _class_Node__enter_tree: - void **_enter_tree** **(** **)** virtual @@ -328,7 +388,7 @@ Called when the node enters the :ref:`SceneTree` (e.g. upon ins Corresponds to the NOTIFICATION_ENTER_TREE notification in :ref:`Object._notification`. -.. _class_Node__exit_tree: + .. _class_Node__exit_tree: - void **_exit_tree** **(** **)** virtual @@ -336,11 +396,11 @@ Called when the node is about to leave the :ref:`SceneTree` (e. 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__get_configuration_warning: - :ref:`String` **_get_configuration_warning** **(** **)** virtual -.. _class_Node__input: + .. _class_Node__input: - void **_input** **(** :ref:`InputEvent` event **)** virtual @@ -352,7 +412,7 @@ To consume the input event and stop it propagating further to other nodes, :ref: 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__physics_process: - void **_physics_process** **(** :ref:`float` delta **)** virtual @@ -362,7 +422,7 @@ It is only called if physics processing is enabled, which is done automatically Corresponds to the NOTIFICATION_PHYSICS_PROCESS notification in :ref:`Object._notification`. -.. _class_Node__process: + .. _class_Node__process: - void **_process** **(** :ref:`float` delta **)** virtual @@ -372,7 +432,7 @@ It is only called if processing is enabled, which is done automatically if this Corresponds to the NOTIFICATION_PROCESS notification in :ref:`Object._notification`. -.. _class_Node__ready: + .. _class_Node__ready: - void **_ready** **(** **)** virtual @@ -382,7 +442,7 @@ Corresponds to the NOTIFICATION_READY notification in :ref:`Object._notification 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__unhandled_input: - void **_unhandled_input** **(** :ref:`InputEvent` event **)** virtual @@ -394,7 +454,7 @@ To consume the input event and stop it propagating further to other nodes, :ref: 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__unhandled_key_input: - void **_unhandled_key_input** **(** :ref:`InputEventKey` event **)** virtual @@ -406,7 +466,7 @@ To consume the input event and stop it propagating further to other nodes, :ref: 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_add_child: - void **add_child** **(** :ref:`Node` node, :ref:`bool` legible_unique_name=false **)** @@ -414,7 +474,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_add_child_below_node: - void **add_child_below_node** **(** :ref:`Node` node, :ref:`Node` child_node, :ref:`bool` legible_unique_name=false **)** @@ -422,19 +482,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_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`. -.. _class_Node_can_process: + .. _class_Node_can_process: - :ref:`bool` **can_process** **(** **)** const Returns ``true`` if the node can process while the scene tree is paused (see :ref:`set_pause_mode`). Always returns ``true`` if the scene tree is not paused, and ``false`` if the node is not in the tree. FIXME: Why FAIL_COND? -.. _class_Node_duplicate: + .. _class_Node_duplicate: - :ref:`Node` **duplicate** **(** :ref:`int` flags=15 **)** const @@ -442,49 +502,49 @@ Duplicates the node, returning a new node. You can fine-tune the behavior using the ``flags``. See DUPLICATE\_\* constants. -.. _class_Node_find_node: + .. _class_Node_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. -.. _class_Node_get_child: + .. _class_Node_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. -.. _class_Node_get_child_count: + .. _class_Node_get_child_count: - :ref:`int` **get_child_count** **(** **)** const Returns the number of child nodes. -.. _class_Node_get_children: + .. _class_Node_get_children: - :ref:`Array` **get_children** **(** **)** const Returns an array of references to node's children. -.. _class_Node_get_groups: + .. _class_Node_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_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_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`. -.. _class_Node_get_node: + .. _class_Node_get_node: - :ref:`Node` **get_node** **(** :ref:`NodePath` path **)** const @@ -514,165 +574,165 @@ Possible paths are: get_node("../Swamp/Alligator") get_node("/root/MyGame") -.. _class_Node_get_node_and_resource: + .. _class_Node_get_node_and_resource: - :ref:`Array` **get_node_and_resource** **(** :ref:`NodePath` path **)** -.. _class_Node_get_parent: + .. _class_Node_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_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`). -.. _class_Node_get_path_to: + .. _class_Node_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_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`. -.. _class_Node_get_position_in_parent: + .. _class_Node_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_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_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_get_tree: - :ref:`SceneTree` **get_tree** **(** **)** const Returns the :ref:`SceneTree` that contains this node. -.. _class_Node_get_viewport: + .. _class_Node_get_viewport: - :ref:`Viewport` **get_viewport** **(** **)** const Returns the node's :ref:`Viewport`. -.. _class_Node_has_node: + .. _class_Node_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_has_node_and_resource: - :ref:`bool` **has_node_and_resource** **(** :ref:`NodePath` path **)** const -.. _class_Node_is_a_parent_of: + .. _class_Node_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_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_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_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_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_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_is_physics_processing: - :ref:`bool` **is_physics_processing** **(** **)** const Returns ``true`` if physics processing is enabled (see :ref:`set_physics_process`). -.. _class_Node_is_physics_processing_internal: + .. _class_Node_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`). -.. _class_Node_is_processing: + .. _class_Node_is_processing: - :ref:`bool` **is_processing** **(** **)** const Returns ``true`` if processing is enabled (see :ref:`set_process`). -.. _class_Node_is_processing_input: + .. _class_Node_is_processing_input: - :ref:`bool` **is_processing_input** **(** **)** const Returns ``true`` if the node is processing input (see :ref:`set_process_input`). -.. _class_Node_is_processing_internal: + .. _class_Node_is_processing_internal: - :ref:`bool` **is_processing_internal** **(** **)** const Returns ``true`` if internal processing is enabled (see :ref:`set_process_internal`). -.. _class_Node_is_processing_unhandled_input: + .. _class_Node_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`). -.. _class_Node_is_processing_unhandled_key_input: + .. _class_Node_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`). -.. _class_Node_move_child: + .. _class_Node_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_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_print_tree: - void **print_tree** **(** **)** @@ -687,7 +747,7 @@ 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_print_tree_pretty: - void **print_tree_pretty** **(** **)** @@ -702,182 +762,181 @@ Similar to :ref:`print_tree`, this prints the tree to std â”–-SplashScreen â”–â•´Camera2D -.. _class_Node_propagate_call: + .. _class_Node_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_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_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. -.. _class_Node_raise: + .. _class_Node_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_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_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_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_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_request_ready: - void **request_ready** **(** **)** Requests that ``_ready`` be called again. -.. _class_Node_rpc: + .. _class_Node_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``. -.. _class_Node_rpc_config: + .. _class_Node_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``, ``sync``, ``master``, ``slave``). 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_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`. -.. _class_Node_rpc_unreliable: + .. _class_Node_rpc_unreliable: - :ref:`Variant` **rpc_unreliable** **(** :ref:`String` method **)** vararg Sends a :ref:`rpc` using an unreliable protocol. Returns an empty :ref:`Variant`. -.. _class_Node_rpc_unreliable_id: + .. _class_Node_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`. -.. _class_Node_rset: + .. _class_Node_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. -.. _class_Node_rset_config: + .. _class_Node_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``, ``sync``, ``master``, ``slave``). 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_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`). -.. _class_Node_rset_unreliable: + .. _class_Node_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_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`). -.. _class_Node_set_display_folded: + .. _class_Node_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_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 ``slave`` 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_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. -.. _class_Node_set_physics_process_internal: + .. _class_Node_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. -.. _class_Node_set_process: + .. _class_Node_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. -.. _class_Node_set_process_input: + .. _class_Node_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. -.. _class_Node_set_process_internal: + .. _class_Node_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. -.. _class_Node_set_process_priority: + .. _class_Node_set_process_priority: - void **set_process_priority** **(** :ref:`int` priority **)** -.. _class_Node_set_process_unhandled_input: + .. _class_Node_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. -.. _class_Node_set_process_unhandled_key_input: + .. _class_Node_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. -.. _class_Node_set_scene_instance_load_placeholder: + .. _class_Node_set_scene_instance_load_placeholder: - void **set_scene_instance_load_placeholder** **(** :ref:`bool` load_placeholder **)** Sets whether this is an instance load placeholder. See :ref:`InstancePlaceholder`. - diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index 8b00da04b..3b5cc8295 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -8,7 +8,9 @@ Node2D ====== **Inherits:** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`RemoteTransform2D`, :ref:`Joint2D`, :ref:`Skeleton2D`, :ref:`VisibilityNotifier2D`, :ref:`Navigation2D`, :ref:`CollisionPolygon2D`, :ref:`TouchScreenButton`, :ref:`Particles2D`, :ref:`AnimatedSprite`, :ref:`RayCast2D`, :ref:`Light2D`, :ref:`Path2D`, :ref:`Line2D`, :ref:`AudioStreamPlayer2D`, :ref:`CanvasModulate`, :ref:`Sprite`, :ref:`CPUParticles2D`, :ref:`CollisionShape2D`, :ref:`NavigationPolygonInstance`, :ref:`PathFollow2D`, :ref:`ParallaxLayer`, :ref:`Polygon2D`, :ref:`Position2D`, :ref:`LightOccluder2D`, :ref:`CollisionObject2D`, :ref:`BackBufferCopy`, :ref:`MeshInstance2D`, :ref:`YSort`, :ref:`TileMap`, :ref:`Bone2D`, :ref:`Camera2D` + **Category:** Core Brief Description @@ -16,6 +18,35 @@ Brief Description A 2D game object, parent of all 2D related nodes. Has a position, rotation, scale and Z-index. +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` | ++---------------------------------------+----------------------------------------------------------------------+ + Methods ------- @@ -52,126 +83,219 @@ Tutorials --------- - :doc:`../tutorials/2d/custom_drawing_in_2d` - Property Descriptions --------------------- .. _class_Node2D_global_position: -- :ref:`Vector2` **global_position** - Global position. +- :ref:`Vector2` **global_position** + ++----------+----------------------------+ +| *Setter* | set_global_position(value) | ++----------+----------------------------+ +| *Getter* | get_global_position() | ++----------+----------------------------+ + +Global position. .. _class_Node2D_global_rotation: -- :ref:`float` **global_rotation** - Global rotation in radians. +- :ref:`float` **global_rotation** + ++----------+----------------------------+ +| *Setter* | set_global_rotation(value) | ++----------+----------------------------+ +| *Getter* | get_global_rotation() | ++----------+----------------------------+ + +Global rotation in radians. .. _class_Node2D_global_rotation_degrees: -- :ref:`float` **global_rotation_degrees** - Global rotation in degrees. +- :ref:`float` **global_rotation_degrees** + ++----------+------------------------------------+ +| *Setter* | set_global_rotation_degrees(value) | ++----------+------------------------------------+ +| *Getter* | get_global_rotation_degrees() | ++----------+------------------------------------+ + +Global rotation in degrees. .. _class_Node2D_global_scale: -- :ref:`Vector2` **global_scale** - Global scale. +- :ref:`Vector2` **global_scale** + ++----------+-------------------------+ +| *Setter* | set_global_scale(value) | ++----------+-------------------------+ +| *Getter* | get_global_scale() | ++----------+-------------------------+ + +Global scale. .. _class_Node2D_global_transform: -- :ref:`Transform2D` **global_transform** - Global :ref:`Transform2D`. +- :ref:`Transform2D` **global_transform** + ++----------+-----------------------------+ +| *Setter* | set_global_transform(value) | ++----------+-----------------------------+ +| *Getter* | get_global_transform() | ++----------+-----------------------------+ + +Global :ref:`Transform2D`. .. _class_Node2D_position: -- :ref:`Vector2` **position** - Position, relative to the node's parent. +- :ref:`Vector2` **position** + ++----------+---------------------+ +| *Setter* | set_position(value) | ++----------+---------------------+ +| *Getter* | get_position() | ++----------+---------------------+ + +Position, relative to the node's parent. .. _class_Node2D_rotation: -- :ref:`float` **rotation** - Rotation in radians, relative to the node's parent. +- :ref:`float` **rotation** + ++----------+---------------------+ +| *Setter* | set_rotation(value) | ++----------+---------------------+ +| *Getter* | get_rotation() | ++----------+---------------------+ + +Rotation in radians, relative to the node's parent. .. _class_Node2D_rotation_degrees: -- :ref:`float` **rotation_degrees** - Rotation in degrees, relative to the node's parent. +- :ref:`float` **rotation_degrees** + ++----------+-----------------------------+ +| *Setter* | set_rotation_degrees(value) | ++----------+-----------------------------+ +| *Getter* | get_rotation_degrees() | ++----------+-----------------------------+ + +Rotation in degrees, relative to the node's parent. .. _class_Node2D_scale: -- :ref:`Vector2` **scale** - The node's scale. Unscaled value: ``(1, 1)`` +- :ref:`Vector2` **scale** + ++----------+------------------+ +| *Setter* | set_scale(value) | ++----------+------------------+ +| *Getter* | get_scale() | ++----------+------------------+ + +The node's scale. Unscaled value: ``(1, 1)`` .. _class_Node2D_transform: -- :ref:`Transform2D` **transform** - Local :ref:`Transform2D`. +- :ref:`Transform2D` **transform** + ++----------+----------------------+ +| *Setter* | set_transform(value) | ++----------+----------------------+ +| *Getter* | get_transform() | ++----------+----------------------+ + +Local :ref:`Transform2D`. .. _class_Node2D_z_as_relative: -- :ref:`bool` **z_as_relative** - 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. +- :ref:`bool` **z_as_relative** + ++----------+--------------------------+ +| *Setter* | set_z_as_relative(value) | ++----------+--------------------------+ +| *Getter* | is_z_relative() | ++----------+--------------------------+ + +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: -- :ref:`int` **z_index** - Z-index. Controls the order in which the nodes render. A node with a higher Z-index will display in front of others. +- :ref:`int` **z_index** ++----------+--------------------+ +| *Setter* | set_z_index(value) | ++----------+--------------------+ +| *Getter* | get_z_index() | ++----------+--------------------+ + +Z-index. Controls the order in which the nodes render. A node with a higher Z-index will display in front of others. Method Descriptions ------------------- -.. _class_Node2D_apply_scale: + .. _class_Node2D_apply_scale: - void **apply_scale** **(** :ref:`Vector2` ratio **)** Multiplies the current scale by the 'ratio' vector. -.. _class_Node2D_get_angle_to: + .. _class_Node2D_get_angle_to: - :ref:`float` **get_angle_to** **(** :ref:`Vector2` point **)** const Returns the angle between the node and the 'point' in radians. -.. _class_Node2D_get_relative_transform_to_parent: + .. _class_Node2D_get_relative_transform_to_parent: - :ref:`Transform2D` **get_relative_transform_to_parent** **(** :ref:`Node` parent **)** const Returns the :ref:`Transform2D` relative to this node's parent. -.. _class_Node2D_global_translate: + .. _class_Node2D_global_translate: - void **global_translate** **(** :ref:`Vector2` offset **)** Adds the 'offset' vector to the node's global position. -.. _class_Node2D_look_at: + .. _class_Node2D_look_at: - void **look_at** **(** :ref:`Vector2` point **)** Rotates the node so it points towards the 'point'. -.. _class_Node2D_move_local_x: + .. _class_Node2D_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. -.. _class_Node2D_move_local_y: + .. _class_Node2D_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. -.. _class_Node2D_rotate: + .. _class_Node2D_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_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_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_translate: - void **translate** **(** :ref:`Vector2` offset **)** Translates the node by the given ``offset`` in local coordinates. - diff --git a/classes/class_nodepath.rst b/classes/class_nodepath.rst index 1d388825f..9c410b6f4 100644 --- a/classes/class_nodepath.rst +++ b/classes/class_nodepath.rst @@ -49,54 +49,53 @@ A ``NodePath`` is made up of a list of node names, a list of "subnode" (resource Method Descriptions ------------------- -.. _class_NodePath_NodePath: + .. _class_NodePath_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_get_as_property_path: - :ref:`NodePath` **get_as_property_path** **(** **)** -.. _class_NodePath_get_concatenated_subnames: + .. _class_NodePath_get_concatenated_subnames: - :ref:`String` **get_concatenated_subnames** **(** **)** -.. _class_NodePath_get_name: + .. _class_NodePath_get_name: - :ref:`String` **get_name** **(** :ref:`int` idx **)** Get the node name indicated by ``idx`` (0 to :ref:`get_name_count`) -.. _class_NodePath_get_name_count: + .. _class_NodePath_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_get_subname: - :ref:`String` **get_subname** **(** :ref:`int` idx **)** Get the resource name indicated by ``idx`` (0 to :ref:`get_subname_count`) -.. _class_NodePath_get_subname_count: + .. _class_NodePath_get_subname_count: - :ref:`int` **get_subname_count** **(** **)** Get the number of resource names in the path. -.. _class_NodePath_is_absolute: + .. _class_NodePath_is_absolute: - :ref:`bool` **is_absolute** **(** **)** Return true if the node path is absolute (not relative). -.. _class_NodePath_is_empty: + .. _class_NodePath_is_empty: - :ref:`bool` **is_empty** **(** **)** Return true if the node path is empty. - diff --git a/classes/class_object.rst b/classes/class_object.rst index 217332b38..b0e3bae7a 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -8,6 +8,7 @@ Object ====== **Inherited By:** :ref:`Reference`, :ref:`Physics2DServer`, :ref:`MainLoop`, :ref:`PhysicsDirectBodyState`, :ref:`Input`, :ref:`Node`, :ref:`Geometry`, :ref:`ARVRPositionalTracker`, :ref:`TreeItem`, :ref:`JavaScript`, :ref:`ARVRServer`, :ref:`PhysicsDirectSpaceState`, :ref:`ProjectSettings`, :ref:`Engine`, :ref:`Physics2DDirectSpaceState`, :ref:`InputMap`, :ref:`UndoRedo`, :ref:`PhysicsServer`, :ref:`ResourceSaver`, :ref:`Performance`, :ref:`ResourceLoader`, :ref:`JSON`, :ref:`AudioServer`, :ref:`IP`, :ref:`ClassDB`, :ref:`VisualServer`, :ref:`OS`, :ref:`GodotSharp`, :ref:`EditorSelection`, :ref:`Physics2DDirectBodyState`, :ref:`VisualScriptEditor`, :ref:`TranslationServer`, :ref:`EditorFileSystemDirectory` + **Category:** Core Brief Description @@ -107,32 +108,29 @@ Methods Signals ------- -.. _class_Object_script_changed: + .. _class_Object_script_changed: - **script_changed** **(** **)** Emitted whenever the script of the Object is changed. - Enumerations ------------ .. _enum_Object_ConnectFlags: -enum **ConnectFlags** +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. - **CONNECT_PERSIST** = **2** --- Persisting connections are saved when the object is serialized to file. - **CONNECT_ONESHOT** = **4** --- One shot connections disconnect themselves after emission. - **CONNECT_REFERENCE_COUNTED** = **8** - Constants --------- - **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. - Description ----------- @@ -149,103 +147,103 @@ Objects also receive notifications (:ref:`_notification` **_get** **(** :ref:`String` property **)** virtual Returns the given property. Returns ``null`` if the ``property`` does not exist. -.. _class_Object__get_property_list: + .. _class_Object__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__init: - void **_init** **(** **)** virtual The virtual method called upon initialization. -.. _class_Object__notification: + .. _class_Object__notification: - void **_notification** **(** :ref:`int` what **)** virtual Notify the object internally using an ID. -.. _class_Object__set: + .. _class_Object__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_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_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_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_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_can_translate_messages: - :ref:`bool` **can_translate_messages** **(** **)** const Returns ``true`` if the object can translate strings. -.. _class_Object_connect: + .. _class_Object_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. -.. _class_Object_disconnect: + .. _class_Object_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_emit_signal: - :ref:`Variant` **emit_signal** **(** :ref:`String` signal **)** vararg Emits the given ``signal``. -.. _class_Object_free: + .. _class_Object_free: - void **free** **(** **)** Deletes the object from memory. -.. _class_Object_get: + .. _class_Object_get: - :ref:`Variant` **get** **(** :ref:`String` property **)** const Returns a :ref:`Variant` for a ``property``. -.. _class_Object_get_class: + .. _class_Object_get_class: - :ref:`String` **get_class** **(** **)** const Returns the object's class as a :ref:`String`. -.. _class_Object_get_incoming_connections: + .. _class_Object_get_incoming_connections: - :ref:`Array` **get_incoming_connections** **(** **)** const @@ -259,152 +257,151 @@ 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_get_indexed: - :ref:`Variant` **get_indexed** **(** :ref:`NodePath` property **)** const Get indexed object property by String. -Property indices get accessed with colon seperation, for example: ``position:x`` +Property indices get accessed with colon separation, for example: ``position:x`` -.. _class_Object_get_instance_id: + .. _class_Object_get_instance_id: - :ref:`int` **get_instance_id** **(** **)** const Returns the object's unique instance ID. -.. _class_Object_get_meta: + .. _class_Object_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_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_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_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_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_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_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_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_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_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_is_blocking_signals: - :ref:`bool` **is_blocking_signals** **(** **)** const Returns ``true`` if signal emission blocking is enabled. -.. _class_Object_is_class: + .. _class_Object_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_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_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_notification: - void **notification** **(** :ref:`int` what, :ref:`bool` reversed=false **)** Notify the object of something. -.. _class_Object_property_list_changed_notify: + .. _class_Object_property_list_changed_notify: - void **property_list_changed_notify** **(** **)** -.. _class_Object_set: + .. _class_Object_set: - void **set** **(** :ref:`String` property, :ref:`Variant` value **)** Set property into the object. -.. _class_Object_set_block_signals: + .. _class_Object_set_block_signals: - void **set_block_signals** **(** :ref:`bool` enable **)** If set to true, signal emission is blocked. -.. _class_Object_set_indexed: + .. _class_Object_set_indexed: - void **set_indexed** **(** :ref:`NodePath` property, :ref:`Variant` value **)** -.. _class_Object_set_message_translation: + .. _class_Object_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. -.. _class_Object_set_meta: + .. _class_Object_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_set_script: - void **set_script** **(** :ref:`Reference` script **)** Set a script into the object, scripts extend the object functionality. -.. _class_Object_tr: + .. _class_Object_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`. - diff --git a/classes/class_occluderpolygon2d.rst b/classes/class_occluderpolygon2d.rst index 9004e9723..55e9fb64d 100644 --- a/classes/class_occluderpolygon2d.rst +++ b/classes/class_occluderpolygon2d.rst @@ -8,6 +8,7 @@ OccluderPolygon2D ================= **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,18 +16,28 @@ Brief Description Defines a 2D polygon for LightOccluder2D. +Properties +---------- + ++--------------------------------------------------+-----------------------------------------------------+ +| :ref:`bool` | :ref:`closed` | ++--------------------------------------------------+-----------------------------------------------------+ +| :ref:`CullMode` | :ref:`cull_mode` | ++--------------------------------------------------+-----------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`polygon` | ++--------------------------------------------------+-----------------------------------------------------+ + Enumerations ------------ .. _enum_OccluderPolygon2D_CullMode: -enum **CullMode** +enum **CullMode**: - **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_COUNTER_CLOCKWISE** = **2** --- Culling mode for the occlusion. Sets the culling to be in counter clockwise direction. See :ref:`cull_mode`. - Description ----------- @@ -37,14 +48,37 @@ Property Descriptions .. _class_OccluderPolygon2D_closed: -- :ref:`bool` **closed** - 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``. +- :ref:`bool` **closed** + ++----------+-------------------+ +| *Setter* | set_closed(value) | ++----------+-------------------+ +| *Getter* | is_closed() | ++----------+-------------------+ + +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: -- :ref:`CullMode` **cull_mode** - Set the direction of the occlusion culling when not ``CULL_DISABLED``. Default value ``DISABLED``. +- :ref:`CullMode` **cull_mode** + ++----------+----------------------+ +| *Setter* | set_cull_mode(value) | ++----------+----------------------+ +| *Getter* | get_cull_mode() | ++----------+----------------------+ + +Set the direction of the occlusion culling when not ``CULL_DISABLED``. Default value ``DISABLED``. .. _class_OccluderPolygon2D_polygon: -- :ref:`PoolVector2Array` **polygon** - A :ref:`Vector2` array with the index for polygon's vertices positions. +- :ref:`PoolVector2Array` **polygon** ++----------+--------------------+ +| *Setter* | set_polygon(value) | ++----------+--------------------+ +| *Getter* | get_polygon() | ++----------+--------------------+ + +A :ref:`Vector2` array with the index for polygon's vertices positions. diff --git a/classes/class_omnilight.rst b/classes/class_omnilight.rst index 6aae95610..151bb4af6 100644 --- a/classes/class_omnilight.rst +++ b/classes/class_omnilight.rst @@ -8,6 +8,7 @@ OmniLight ========= **Inherits:** :ref:`Light` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,24 +16,36 @@ Brief Description 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` | ++--------------------------------------------------+---------------------------------------------------------------+ + Enumerations ------------ .. _enum_OmniLight_ShadowDetail: -enum **ShadowDetail** +enum **ShadowDetail**: - **SHADOW_DETAIL_VERTICAL** = **0** - **SHADOW_DETAIL_HORIZONTAL** = **1** .. _enum_OmniLight_ShadowMode: -enum **ShadowMode** +enum **ShadowMode**: - **SHADOW_DUAL_PARABOLOID** = **0** - **SHADOW_CUBE** = **1** - Description ----------- @@ -42,24 +55,54 @@ Tutorials --------- - :doc:`../tutorials/3d/lights_and_shadows` - Property Descriptions --------------------- .. _class_OmniLight_omni_attenuation: -- :ref:`float` **omni_attenuation** - The light's attenuation (drop-off) curve. A number of presets are available in the Inspector. +- :ref:`float` **omni_attenuation** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +The light's attenuation (drop-off) curve. A number of presets are available in the Inspector. .. _class_OmniLight_omni_range: -- :ref:`float` **omni_range** - Maximum distance the light affects. +- :ref:`float` **omni_range** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +Maximum distance the light affects. .. _class_OmniLight_omni_shadow_detail: -- :ref:`ShadowDetail` **omni_shadow_detail** - See :ref:`ShadowDetail`. +- :ref:`ShadowDetail` **omni_shadow_detail** + ++----------+--------------------------+ +| *Setter* | set_shadow_detail(value) | ++----------+--------------------------+ +| *Getter* | get_shadow_detail() | ++----------+--------------------------+ + +See :ref:`ShadowDetail`. .. _class_OmniLight_omni_shadow_mode: -- :ref:`ShadowMode` **omni_shadow_mode** - See :ref:`ShadowMode`. +- :ref:`ShadowMode` **omni_shadow_mode** ++----------+------------------------+ +| *Setter* | set_shadow_mode(value) | ++----------+------------------------+ +| *Getter* | get_shadow_mode() | ++----------+------------------------+ + +See :ref:`ShadowMode`. diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index 289f6f43b..c15a6d863 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -8,6 +8,7 @@ OptionButton ============ **Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Button control that provides selectable options when pressed. +Properties +---------- + ++-----------------------+----------------------------------------------+ +| :ref:`int` | :ref:`selected` | ++-----------------------+----------------------------------------------+ + Methods ------- @@ -60,22 +68,52 @@ Methods | 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` | ++---------------------------------+--------------------------------------------------------------------+ + Signals ------- -.. _class_OptionButton_item_focused: + .. _class_OptionButton_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_item_selected: - **item_selected** **(** :ref:`int` ID **)** This signal is emitted when the current item was changed by the user. ID of the item selected is passed as argument (if no IDs were added, ID will be just the item index). - Description ----------- @@ -88,114 +126,116 @@ Property Descriptions - :ref:`int` **selected** ++----------+----------------+ +| *Getter* | get_selected() | ++----------+----------------+ Method Descriptions ------------------- -.. _class_OptionButton_add_icon_item: + .. _class_OptionButton_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_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_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_clear: - void **clear** **(** **)** Clear all the items in the ``OptionButton``. -.. _class_OptionButton_get_item_count: + .. _class_OptionButton_get_item_count: - :ref:`int` **get_item_count** **(** **)** const Return the amount of items in the OptionButton. -.. _class_OptionButton_get_item_icon: + .. _class_OptionButton_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_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_get_item_metadata: - :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const -.. _class_OptionButton_get_item_text: + .. _class_OptionButton_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_get_popup: - :ref:`PopupMenu` **get_popup** **(** **)** const Return the :ref:`PopupMenu` contained in this button. -.. _class_OptionButton_get_selected_id: + .. _class_OptionButton_get_selected_id: - :ref:`int` **get_selected_id** **(** **)** const -.. _class_OptionButton_get_selected_metadata: + .. _class_OptionButton_get_selected_metadata: - :ref:`Variant` **get_selected_metadata** **(** **)** const -.. _class_OptionButton_is_item_disabled: + .. _class_OptionButton_is_item_disabled: - :ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** const -.. _class_OptionButton_remove_item: + .. _class_OptionButton_remove_item: - void **remove_item** **(** :ref:`int` idx **)** -.. _class_OptionButton_select: + .. _class_OptionButton_select: - void **select** **(** :ref:`int` idx **)** Select an item by index and make it the current item. -.. _class_OptionButton_set_item_disabled: + .. _class_OptionButton_set_item_disabled: - void **set_item_disabled** **(** :ref:`int` idx, :ref:`bool` disabled **)** -.. _class_OptionButton_set_item_icon: + .. _class_OptionButton_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_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_set_item_metadata: - void **set_item_metadata** **(** :ref:`int` idx, :ref:`Variant` metadata **)** -.. _class_OptionButton_set_item_text: + .. _class_OptionButton_set_item_text: - void **set_item_text** **(** :ref:`int` idx, :ref:`String` text **)** Set the text of an item at index "idx". - diff --git a/classes/class_orientedpathfollow.rst b/classes/class_orientedpathfollow.rst index 00a46923a..39c2d5d18 100644 --- a/classes/class_orientedpathfollow.rst +++ b/classes/class_orientedpathfollow.rst @@ -8,6 +8,7 @@ OrientedPathFollow ================== **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,23 @@ Brief Description 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` | ++---------------------------+------------------------------------------------------------+ + Description ----------- @@ -27,7 +45,15 @@ Property Descriptions .. _class_OrientedPathFollow_cubic_interp: -- :ref:`bool` **cubic_interp** - If ``true`` the position between two cached points is interpolated cubically, and linearly otherwise. +- :ref:`bool` **cubic_interp** + ++----------+--------------------------------+ +| *Setter* | set_cubic_interpolation(value) | ++----------+--------------------------------+ +| *Getter* | get_cubic_interpolation() | ++----------+--------------------------------+ + +If ``true`` the position between two cached points is interpolated cubically, and linearly otherwise. The points along the :ref:`Curve3D` of the :ref:`Path` are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. @@ -35,22 +61,61 @@ There are two answers to this problem: Either increase the number of cached poin .. _class_OrientedPathFollow_h_offset: -- :ref:`float` **h_offset** - The node's offset along the curve. +- :ref:`float` **h_offset** + ++----------+---------------------+ +| *Setter* | set_h_offset(value) | ++----------+---------------------+ +| *Getter* | get_h_offset() | ++----------+---------------------+ + +The node's offset along the curve. .. _class_OrientedPathFollow_loop: -- :ref:`bool` **loop** - If ``true``, any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths. +- :ref:`bool` **loop** + ++----------+-----------------+ +| *Setter* | set_loop(value) | ++----------+-----------------+ +| *Getter* | has_loop() | ++----------+-----------------+ + +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: -- :ref:`float` **offset** - 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. +- :ref:`float` **offset** + ++----------+-------------------+ +| *Setter* | set_offset(value) | ++----------+-------------------+ +| *Getter* | get_offset() | ++----------+-------------------+ + +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: -- :ref:`float` **unit_offset** - 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. +- :ref:`float` **unit_offset** + ++----------+------------------------+ +| *Setter* | set_unit_offset(value) | ++----------+------------------------+ +| *Getter* | get_unit_offset() | ++----------+------------------------+ + +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: -- :ref:`float` **v_offset** - The node's offset perpendicular to the curve. +- :ref:`float` **v_offset** ++----------+---------------------+ +| *Setter* | set_v_offset(value) | ++----------+---------------------+ +| *Getter* | get_v_offset() | ++----------+---------------------+ + +The node's offset perpendicular to the curve. diff --git a/classes/class_os.rst b/classes/class_os.rst index 7d876c646..f9fb6da43 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -8,6 +8,7 @@ OS == **Inherits:** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,41 @@ Brief Description 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` | ++-------------------------------+----------------------------------------------------------------------------------------------+ + Methods ------- @@ -193,7 +229,7 @@ Enumerations .. _enum_OS_SystemDir: -enum **SystemDir** +enum **SystemDir**: - **SYSTEM_DIR_DESKTOP** = **0** --- Desktop directory path. - **SYSTEM_DIR_DCIM** = **1** --- DCIM (Digital Camera Images) directory path. @@ -206,7 +242,7 @@ enum **SystemDir** .. _enum_OS_ScreenOrientation: -enum **ScreenOrientation** +enum **ScreenOrientation**: - **SCREEN_ORIENTATION_LANDSCAPE** = **0** --- Landscape screen orientation. - **SCREEN_ORIENTATION_PORTRAIT** = **1** --- Portrait screen orientation. @@ -218,7 +254,7 @@ enum **ScreenOrientation** .. _enum_OS_PowerState: -enum **PowerState** +enum **PowerState**: - **POWERSTATE_UNKNOWN** = **0** --- Unknown powerstate. - **POWERSTATE_ON_BATTERY** = **1** --- Unplugged, running on battery. @@ -228,7 +264,7 @@ enum **PowerState** .. _enum_OS_Weekday: -enum **Weekday** +enum **Weekday**: - **DAY_SUNDAY** = **0** --- Sunday. - **DAY_MONDAY** = **1** --- Monday. @@ -240,7 +276,7 @@ enum **Weekday** .. _enum_OS_Month: -enum **Month** +enum **Month**: - **MONTH_JANUARY** = **1** --- January. - **MONTH_FEBRUARY** = **2** --- February. @@ -255,7 +291,6 @@ enum **Month** - **MONTH_NOVEMBER** = **11** --- November. - **MONTH_DECEMBER** = **12** --- December. - Description ----------- @@ -266,109 +301,226 @@ Property Descriptions .. _class_OS_clipboard: -- :ref:`String` **clipboard** - The clipboard from the host OS. Might be unavailable on some platforms. +- :ref:`String` **clipboard** + ++----------+----------------------+ +| *Setter* | set_clipboard(value) | ++----------+----------------------+ +| *Getter* | get_clipboard() | ++----------+----------------------+ + +The clipboard from the host OS. Might be unavailable on some platforms. .. _class_OS_current_screen: -- :ref:`int` **current_screen** - The current screen index (starting from 0). +- :ref:`int` **current_screen** + ++----------+---------------------------+ +| *Setter* | set_current_screen(value) | ++----------+---------------------------+ +| *Getter* | get_current_screen() | ++----------+---------------------------+ + +The current screen index (starting from 0). .. _class_OS_exit_code: -- :ref:`int` **exit_code** - The exit code passed to the OS when the main loop exits. +- :ref:`int` **exit_code** + ++----------+----------------------+ +| *Setter* | set_exit_code(value) | ++----------+----------------------+ +| *Getter* | get_exit_code() | ++----------+----------------------+ + +The exit code passed to the OS when the main loop exits. .. _class_OS_keep_screen_on: -- :ref:`bool` **keep_screen_on** - If ``true`` the engine tries to keep the screen on while the game is running. Useful on mobile. +- :ref:`bool` **keep_screen_on** + ++----------+---------------------------+ +| *Setter* | set_keep_screen_on(value) | ++----------+---------------------------+ +| *Getter* | is_keep_screen_on() | ++----------+---------------------------+ + +If ``true`` the engine tries to keep the screen on while the game is running. Useful on mobile. .. _class_OS_low_processor_usage_mode: -- :ref:`bool` **low_processor_usage_mode** - If ``true`` the engine optimizes for low processor usage by only refreshing the screen if needed. Can improve battery consumption on mobile. +- :ref:`bool` **low_processor_usage_mode** + ++----------+-------------------------------------+ +| *Setter* | set_low_processor_usage_mode(value) | ++----------+-------------------------------------+ +| *Getter* | is_in_low_processor_usage_mode() | ++----------+-------------------------------------+ + +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: -- _OS.ScreenOrientation **screen_orientation** - The current screen orientation. +- _OS.ScreenOrientation **screen_orientation** + ++----------+-------------------------------+ +| *Setter* | set_screen_orientation(value) | ++----------+-------------------------------+ +| *Getter* | get_screen_orientation() | ++----------+-------------------------------+ + +The current screen orientation. .. _class_OS_vsync_enabled: -- :ref:`bool` **vsync_enabled** - If ``true`` vertical synchronization (Vsync) is enabled. +- :ref:`bool` **vsync_enabled** + ++----------+----------------------+ +| *Setter* | set_use_vsync(value) | ++----------+----------------------+ +| *Getter* | is_vsync_enabled() | ++----------+----------------------+ + +If ``true`` vertical synchronization (Vsync) is enabled. .. _class_OS_window_borderless: -- :ref:`bool` **window_borderless** - If ``true`` removes the window frame. +- :ref:`bool` **window_borderless** + ++----------+------------------------------+ +| *Setter* | set_borderless_window(value) | ++----------+------------------------------+ +| *Getter* | get_borderless_window() | ++----------+------------------------------+ + +If ``true`` removes the window frame. .. _class_OS_window_fullscreen: -- :ref:`bool` **window_fullscreen** - If ``true`` the window is fullscreen. +- :ref:`bool` **window_fullscreen** + ++----------+------------------------------+ +| *Setter* | set_window_fullscreen(value) | ++----------+------------------------------+ +| *Getter* | is_window_fullscreen() | ++----------+------------------------------+ + +If ``true`` the window is fullscreen. .. _class_OS_window_maximized: -- :ref:`bool` **window_maximized** - If ``true`` the window is maximized. +- :ref:`bool` **window_maximized** + ++----------+-----------------------------+ +| *Setter* | set_window_maximized(value) | ++----------+-----------------------------+ +| *Getter* | is_window_maximized() | ++----------+-----------------------------+ + +If ``true`` the window is maximized. .. _class_OS_window_minimized: -- :ref:`bool` **window_minimized** - If ``true`` the window is minimized. +- :ref:`bool` **window_minimized** + ++----------+-----------------------------+ +| *Setter* | set_window_minimized(value) | ++----------+-----------------------------+ +| *Getter* | is_window_minimized() | ++----------+-----------------------------+ + +If ``true`` the window is minimized. .. _class_OS_window_per_pixel_transparency_enabled: - :ref:`bool` **window_per_pixel_transparency_enabled** ++----------+--------------------------------------------------+ +| *Setter* | set_window_per_pixel_transparency_enabled(value) | ++----------+--------------------------------------------------+ +| *Getter* | get_window_per_pixel_transparency_enabled() | ++----------+--------------------------------------------------+ + .. _class_OS_window_position: -- :ref:`Vector2` **window_position** - 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. +- :ref:`Vector2` **window_position** + ++----------+----------------------------+ +| *Setter* | set_window_position(value) | ++----------+----------------------------+ +| *Getter* | get_window_position() | ++----------+----------------------------+ + +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: -- :ref:`bool` **window_resizable** - If ``true``, the window is resizable by the user. +- :ref:`bool` **window_resizable** + ++----------+-----------------------------+ +| *Setter* | set_window_resizable(value) | ++----------+-----------------------------+ +| *Getter* | is_window_resizable() | ++----------+-----------------------------+ + +If ``true``, the window is resizable by the user. .. _class_OS_window_size: -- :ref:`Vector2` **window_size** - The size of the window (without counting window manager decorations). +- :ref:`Vector2` **window_size** ++----------+------------------------+ +| *Setter* | set_window_size(value) | ++----------+------------------------+ +| *Getter* | get_window_size() | ++----------+------------------------+ + +The size of the window (without counting window manager decorations). Method Descriptions ------------------- -.. _class_OS_alert: + .. _class_OS_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_can_draw: - :ref:`bool` **can_draw** **(** **)** const Returns ``true`` if the host OS allows drawing. -.. _class_OS_can_use_threads: + .. _class_OS_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_center_window: - void **center_window** **(** **)** Centers the window on the screen if in windowed mode. -.. _class_OS_close_midi_inputs: + .. _class_OS_close_midi_inputs: - void **close_midi_inputs** **(** **)** -.. _class_OS_delay_msec: + .. _class_OS_delay_msec: - void **delay_msec** **(** :ref:`int` msec **)** const Delay execution of the current thread by given milliseconds. -.. _class_OS_delay_usec: + .. _class_OS_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_dump_memory_to_file: - void **dump_memory_to_file** **(** :ref:`String` file **)** @@ -376,7 +528,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_dump_resources_to_file: - void **dump_resources_to_file** **(** :ref:`String` file **)** @@ -386,7 +538,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_execute: - :ref:`int` **execute** **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=[ ] **)** @@ -421,47 +573,47 @@ 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_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_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_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_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_get_connected_midi_inputs: - :ref:`PoolStringArray` **get_connected_midi_inputs** **(** **)** -.. _class_OS_get_date: + .. _class_OS_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_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_get_datetime_from_unix_time: - :ref:`Dictionary` **get_datetime_from_unix_time** **(** :ref:`int` unix_time_val **)** const @@ -469,25 +621,25 @@ 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). -.. _class_OS_get_dynamic_memory_usage: + .. _class_OS_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_get_environment: - :ref:`String` **get_environment** **(** :ref:`String` environment **)** const Returns an environment variable. -.. _class_OS_get_executable_path: + .. _class_OS_get_executable_path: - :ref:`String` **get_executable_path** **(** **)** const Returns the path to the current engine executable. -.. _class_OS_get_latin_keyboard_variant: + .. _class_OS_get_latin_keyboard_variant: - :ref:`String` **get_latin_keyboard_variant** **(** **)** const @@ -495,73 +647,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_get_locale: - :ref:`String` **get_locale** **(** **)** const Returns the host OS locale. -.. _class_OS_get_model_name: + .. _class_OS_get_model_name: - :ref:`String` **get_model_name** **(** **)** const Returns the model name of the current device. -.. _class_OS_get_name: + .. _class_OS_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_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_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_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_get_process_id: - :ref:`int` **get_process_id** **(** **)** const Returns the game process ID -.. _class_OS_get_processor_count: + .. _class_OS_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_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_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_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_get_screen_dpi: - :ref:`int` **get_screen_dpi** **(** :ref:`int` screen=-1 **)** const @@ -581,71 +733,71 @@ xxhdpi - 480 dpi xxxhdpi - 640 dpi -.. _class_OS_get_screen_position: + .. _class_OS_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_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_get_splash_tick_msec: - :ref:`int` **get_splash_tick_msec** **(** **)** const -.. _class_OS_get_static_memory_peak_usage: + .. _class_OS_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_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_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 OS.SystemDir. -.. _class_OS_get_system_time_secs: + .. _class_OS_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_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_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_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_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_get_unique_id: - :ref:`String` **get_unique_id** **(** **)** const @@ -653,13 +805,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_get_unix_time: - :ref:`int` **get_unix_time** **(** **)** const Returns the current unix epoch timestamp. -.. _class_OS_get_unix_time_from_datetime: + .. _class_OS_get_unix_time_from_datetime: - :ref:`int` **get_unix_time_from_datetime** **(** :ref:`Dictionary` datetime **)** const @@ -669,7 +821,7 @@ Get an epoch time value from a dictionary of time values. You can pass the output from :ref:`get_datetime_from_unix_time` directly into this function. Daylight savings time (dst), if present, is ignored. -.. _class_OS_get_user_data_dir: + .. _class_OS_get_user_data_dir: - :ref:`String` **get_user_data_dir** **(** **)** const @@ -683,55 +835,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_get_video_driver_count: - :ref:`int` **get_video_driver_count** **(** **)** const -.. _class_OS_get_video_driver_name: + .. _class_OS_get_video_driver_name: - :ref:`String` **get_video_driver_name** **(** :ref:`int` driver **)** const -.. _class_OS_get_virtual_keyboard_height: + .. _class_OS_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_get_window_safe_area: - :ref:`Rect2` **get_window_safe_area** **(** **)** const -.. _class_OS_has_environment: + .. _class_OS_has_environment: - :ref:`bool` **has_environment** **(** :ref:`String` environment **)** const Returns ``true`` if an environment variable exists. -.. _class_OS_has_feature: + .. _class_OS_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_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_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_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_is_debug_build: - :ref:`bool` **is_debug_build** **(** **)** const @@ -741,37 +893,37 @@ 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_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_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_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_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_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_kill: - :ref:`Error` **kill** **(** :ref:`int` pid **)** @@ -779,105 +931,105 @@ Kill (terminate) the process identified by the given process ID (``pid``), e.g. Note that this method can also be used to kill processes that were not spawned by the game. -.. _class_OS_native_video_is_playing: + .. _class_OS_native_video_is_playing: - :ref:`bool` **native_video_is_playing** **(** **)** Returns ``true`` if native video is playing. -.. _class_OS_native_video_pause: + .. _class_OS_native_video_pause: - void **native_video_pause** **(** **)** Pauses native video playback. -.. _class_OS_native_video_play: + .. _class_OS_native_video_play: - :ref:`Error` **native_video_play** **(** :ref:`String` path, :ref:`float` volume, :ref:`String` audio_track, :ref:`String` subtitle_track **)** Plays native video from the specified path, at the given volume and with audio and subtitle tracks. -.. _class_OS_native_video_stop: + .. _class_OS_native_video_stop: - void **native_video_stop** **(** **)** Stops native video playback. -.. _class_OS_native_video_unpause: + .. _class_OS_native_video_unpause: - void **native_video_unpause** **(** **)** Resumes native video playback. -.. _class_OS_open_midi_inputs: + .. _class_OS_open_midi_inputs: - void **open_midi_inputs** **(** **)** -.. _class_OS_print_all_resources: + .. _class_OS_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_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_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_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_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_set_icon: - void **set_icon** **(** :ref:`Image` icon **)** Sets the game's icon. -.. _class_OS_set_ime_position: + .. _class_OS_set_ime_position: - void **set_ime_position** **(** :ref:`Vector2` position **)** -.. _class_OS_set_thread_name: + .. _class_OS_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_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_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_set_window_title: - void **set_window_title** **(** :ref:`String` title **)** Sets the window title to the specified string. -.. _class_OS_shell_open: + .. _class_OS_shell_open: - :ref:`Error` **shell_open** **(** :ref:`String` uri **)** @@ -887,10 +1039,9 @@ 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_show_virtual_keyboard: - void **show_virtual_keyboard** **(** :ref:`String` existing_text="" **)** Shows the virtual keyboard if the platform has one. The *existing_text* parameter is useful for implementing your own LineEdit, as it tells the virtual keyboard what text has already been typed (the virtual keyboard uses it for auto-correct and predictions). - diff --git a/classes/class_packeddatacontainer.rst b/classes/class_packeddatacontainer.rst index 25eadcbd6..b62f14dd3 100644 --- a/classes/class_packeddatacontainer.rst +++ b/classes/class_packeddatacontainer.rst @@ -8,6 +8,7 @@ PackedDataContainer =================== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description +Properties +---------- + ++-------------------------------------------+-----------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`__data__` | ++-------------------------------------------+-----------------------------------------------------+ + Methods ------- @@ -31,16 +39,14 @@ Property Descriptions - :ref:`PoolByteArray` **__data__** - Method Descriptions ------------------- -.. _class_PackedDataContainer_pack: + .. _class_PackedDataContainer_pack: - :ref:`Error` **pack** **(** :ref:`Variant` value **)** -.. _class_PackedDataContainer_size: + .. _class_PackedDataContainer_size: - :ref:`int` **size** **(** **)** const - diff --git a/classes/class_packeddatacontainerref.rst b/classes/class_packeddatacontainerref.rst index 54b69ee45..dce391db6 100644 --- a/classes/class_packeddatacontainerref.rst +++ b/classes/class_packeddatacontainerref.rst @@ -8,6 +8,7 @@ PackedDataContainerRef ====================== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -25,8 +26,7 @@ Methods Method Descriptions ------------------- -.. _class_PackedDataContainerRef_size: + .. _class_PackedDataContainerRef_size: - :ref:`int` **size** **(** **)** const - diff --git a/classes/class_packedscene.rst b/classes/class_packedscene.rst index 9cdf93f18..8e0497dd9 100644 --- a/classes/class_packedscene.rst +++ b/classes/class_packedscene.rst @@ -8,6 +8,7 @@ PackedScene =========== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description An abstraction of a serialized scene. +Properties +---------- + ++-------------------------------------+---------------------------------------------+ +| :ref:`Dictionary` | :ref:`_bundled` | ++-------------------------------------+---------------------------------------------+ + Methods ------- @@ -33,13 +41,12 @@ Enumerations .. _enum_PackedScene_GenEditState: -enum **GenEditState** +enum **GenEditState**: - **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_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 ----------- @@ -61,36 +68,36 @@ Property Descriptions .. _class_PackedScene__bundled: -- :ref:`Dictionary` **_bundled** - A dictionary representation of the scene contents. +- :ref:`Dictionary` **_bundled** + +A dictionary representation of the scene contents. Available keys include "rnames" and "variants" for resources, "node_count", "nodes", "node_paths" for nodes, "editable_instances" for base scene children overrides, "conn_count" and "conns" for signal connections, and "version" for the format style of the PackedScene. - Method Descriptions ------------------- -.. _class_PackedScene_can_instance: + .. _class_PackedScene_can_instance: - :ref:`bool` **can_instance** **(** **)** const Returns ``true`` if the scene file has nodes. -.. _class_PackedScene_get_state: + .. _class_PackedScene_get_state: - :ref:`SceneState` **get_state** **(** **)** Returns the ``SceneState`` representing the scene file contents. -.. _class_PackedScene_instance: + .. _class_PackedScene_instance: - :ref:`Node` **instance** **(** :ref:`GenEditState` edit_state=0 **)** const Instantiates the scene's node hierarchy. Triggers child scene instantiation(s). Triggers the :ref:`NOTIFICATION_INSTANCED` notification on the root node. -.. _class_PackedScene_pack: + .. _class_PackedScene_pack: - :ref:`Error` **pack** **(** :ref:`Node` path **)** 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 d5adbfcbe..05f06e9c6 100644 --- a/classes/class_packetpeer.rst +++ b/classes/class_packetpeer.rst @@ -8,7 +8,9 @@ PacketPeer ========== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`PacketPeerStream`, :ref:`PacketPeerUDP`, :ref:`WebSocketPeer`, :ref:`PacketPeerGDNative`, :ref:`NetworkedMultiplayerPeer` + **Category:** Core Brief Description @@ -16,6 +18,13 @@ Brief Description Abstraction and base class for packet-based protocols. +Properties +---------- + ++-------------------------+----------------------------------------------------------------------+ +| :ref:`bool` | :ref:`allow_object_decoding` | ++-------------------------+----------------------------------------------------------------------+ + Methods ------- @@ -45,44 +54,48 @@ Property Descriptions - :ref:`bool` **allow_object_decoding** ++----------+----------------------------------+ +| *Setter* | set_allow_object_decoding(value) | ++----------+----------------------------------+ +| *Getter* | is_object_decoding_allowed() | ++----------+----------------------------------+ Method Descriptions ------------------- -.. _class_PacketPeer_get_available_packet_count: + .. _class_PacketPeer_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_get_packet: - :ref:`PoolByteArray` **get_packet** **(** **)** Get a raw packet. -.. _class_PacketPeer_get_packet_error: + .. _class_PacketPeer_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`). -.. _class_PacketPeer_get_var: + .. _class_PacketPeer_get_var: - :ref:`Variant` **get_var** **(** **)** Get a Variant. -.. _class_PacketPeer_put_packet: + .. _class_PacketPeer_put_packet: - :ref:`Error` **put_packet** **(** :ref:`PoolByteArray` buffer **)** Send a raw packet. -.. _class_PacketPeer_put_var: + .. _class_PacketPeer_put_var: - :ref:`Error` **put_var** **(** :ref:`Variant` var **)** Send a Variant as a packet. - diff --git a/classes/class_packetpeergdnative.rst b/classes/class_packetpeergdnative.rst index 7060b3733..f4b570b43 100644 --- a/classes/class_packetpeergdnative.rst +++ b/classes/class_packetpeergdnative.rst @@ -8,6 +8,7 @@ PacketPeerGDNative ================== **Inherits:** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_packetpeerstream.rst b/classes/class_packetpeerstream.rst index 5dd179be1..3bc4a0b00 100644 --- a/classes/class_packetpeerstream.rst +++ b/classes/class_packetpeerstream.rst @@ -8,6 +8,7 @@ PacketPeerStream ================ **Inherits:** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,17 @@ Brief Description 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` | ++-------------------------------------+------------------------------------------------------------------------------+ + Description ----------- @@ -27,12 +39,31 @@ Property Descriptions - :ref:`int` **input_buffer_max_size** ++----------+----------------------------------+ +| *Setter* | set_input_buffer_max_size(value) | ++----------+----------------------------------+ +| *Getter* | get_input_buffer_max_size() | ++----------+----------------------------------+ + .. _class_PacketPeerStream_output_buffer_max_size: - :ref:`int` **output_buffer_max_size** ++----------+-----------------------------------+ +| *Setter* | set_output_buffer_max_size(value) | ++----------+-----------------------------------+ +| *Getter* | get_output_buffer_max_size() | ++----------+-----------------------------------+ + .. _class_PacketPeerStream_stream_peer: -- :ref:`StreamPeer` **stream_peer** - The wrapped :ref:`StreamPeer` object. +- :ref:`StreamPeer` **stream_peer** ++----------+------------------------+ +| *Setter* | set_stream_peer(value) | ++----------+------------------------+ +| *Getter* | get_stream_peer() | ++----------+------------------------+ + +The wrapped :ref:`StreamPeer` object. diff --git a/classes/class_packetpeerudp.rst b/classes/class_packetpeerudp.rst index a736be5b3..517cfc80f 100644 --- a/classes/class_packetpeerudp.rst +++ b/classes/class_packetpeerudp.rst @@ -8,6 +8,7 @@ PacketPeerUDP ============= **Inherits:** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -42,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`). -.. _class_PacketPeerUDP_get_packet_port: + .. _class_PacketPeerUDP_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`). -.. _class_PacketPeerUDP_is_listening: + .. _class_PacketPeerUDP_is_listening: - :ref:`bool` **is_listening** **(** **)** const Return whether this ``PacketPeerUDP`` is listening. -.. _class_PacketPeerUDP_listen: + .. _class_PacketPeerUDP_listen: - :ref:`Error` **listen** **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=65536 **)** @@ -78,16 +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_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_wait: - :ref:`Error` **wait** **(** **)** 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 a715df69e..9a64c5d51 100644 --- a/classes/class_panel.rst +++ b/classes/class_panel.rst @@ -8,6 +8,7 @@ Panel ===== **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,17 @@ Brief Description Provides an opaque background for :ref:`Control` children. +Theme Properties +---------------- + ++---------------------------------+-------------------------------------+ +| :ref:`StyleBox` | :ref:`panel` | ++---------------------------------+-------------------------------------+ +| :ref:`StyleBox` | :ref:`panelf` | ++---------------------------------+-------------------------------------+ +| :ref:`StyleBox` | :ref:`panelnc` | ++---------------------------------+-------------------------------------+ + Description ----------- diff --git a/classes/class_panelcontainer.rst b/classes/class_panelcontainer.rst index 74208c221..cb51a9d4b 100644 --- a/classes/class_panelcontainer.rst +++ b/classes/class_panelcontainer.rst @@ -8,7 +8,9 @@ PanelContainer ============== **Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`ScriptEditor` + **Category:** Core Brief Description @@ -16,6 +18,13 @@ Brief Description Panel container type. +Theme Properties +---------------- + ++---------------------------------+------------------------------------------+ +| :ref:`StyleBox` | :ref:`panel` | ++---------------------------------+------------------------------------------+ + Description ----------- diff --git a/classes/class_panoramasky.rst b/classes/class_panoramasky.rst index fca9577db..753909788 100644 --- a/classes/class_panoramasky.rst +++ b/classes/class_panoramasky.rst @@ -8,6 +8,7 @@ PanoramaSky =========== **Inherits:** :ref:`Sky` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description A type of :ref:`Sky` used to draw a background texture. +Properties +---------- + ++-------------------------------+---------------------------------------------+ +| :ref:`Texture` | :ref:`panorama` | ++-------------------------------+---------------------------------------------+ + Description ----------- @@ -25,6 +33,13 @@ Property Descriptions .. _class_PanoramaSky_panorama: -- :ref:`Texture` **panorama** - :ref:`Texture` to be applied to the PanoramaSky. +- :ref:`Texture` **panorama** ++----------+---------------------+ +| *Setter* | set_panorama(value) | ++----------+---------------------+ +| *Getter* | get_panorama() | ++----------+---------------------+ + +:ref:`Texture` to be applied to the PanoramaSky. diff --git a/classes/class_parallaxbackground.rst b/classes/class_parallaxbackground.rst index a92ec841c..2c5d7da73 100644 --- a/classes/class_parallaxbackground.rst +++ b/classes/class_parallaxbackground.rst @@ -8,6 +8,7 @@ ParallaxBackground ================== **Inherits:** :ref:`CanvasLayer` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,23 @@ Brief Description 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` | ++-------------------------------+--------------------------------------------------------------------------------------+ + Description ----------- @@ -25,26 +43,73 @@ Property Descriptions .. _class_ParallaxBackground_scroll_base_offset: -- :ref:`Vector2` **scroll_base_offset** - Base position offset of all :ref:`ParallaxLayer` children. +- :ref:`Vector2` **scroll_base_offset** + ++----------+-------------------------------+ +| *Setter* | set_scroll_base_offset(value) | ++----------+-------------------------------+ +| *Getter* | get_scroll_base_offset() | ++----------+-------------------------------+ + +Base position offset of all :ref:`ParallaxLayer` children. .. _class_ParallaxBackground_scroll_base_scale: -- :ref:`Vector2` **scroll_base_scale** - Base motion scale of all :ref:`ParallaxLayer` children. +- :ref:`Vector2` **scroll_base_scale** + ++----------+------------------------------+ +| *Setter* | set_scroll_base_scale(value) | ++----------+------------------------------+ +| *Getter* | get_scroll_base_scale() | ++----------+------------------------------+ + +Base motion scale of all :ref:`ParallaxLayer` children. .. _class_ParallaxBackground_scroll_ignore_camera_zoom: -- :ref:`bool` **scroll_ignore_camera_zoom** - If ``true`` elements in :ref:`ParallaxLayer` child aren't affected by the zoom level of the camera. +- :ref:`bool` **scroll_ignore_camera_zoom** + ++----------+-------------------------------+ +| *Setter* | set_ignore_camera_zoom(value) | ++----------+-------------------------------+ +| *Getter* | is_ignore_camera_zoom() | ++----------+-------------------------------+ + +If ``true`` elements in :ref:`ParallaxLayer` child aren't affected by the zoom level of the camera. .. _class_ParallaxBackground_scroll_limit_begin: -- :ref:`Vector2` **scroll_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. +- :ref:`Vector2` **scroll_limit_begin** + ++----------+------------------------+ +| *Setter* | set_limit_begin(value) | ++----------+------------------------+ +| *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. .. _class_ParallaxBackground_scroll_limit_end: -- :ref:`Vector2` **scroll_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. +- :ref:`Vector2` **scroll_limit_end** + ++----------+----------------------+ +| *Setter* | set_limit_end(value) | ++----------+----------------------+ +| *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. .. _class_ParallaxBackground_scroll_offset: -- :ref:`Vector2` **scroll_offset** - The ParallaxBackground's scroll value. Calculated automatically when using a :ref:`Camera2D`, but can be used to manually manage scrolling when no camera is present. +- :ref:`Vector2` **scroll_offset** ++----------+--------------------------+ +| *Setter* | set_scroll_offset(value) | ++----------+--------------------------+ +| *Getter* | get_scroll_offset() | ++----------+--------------------------+ + +The ParallaxBackground's scroll value. Calculated automatically when using a :ref:`Camera2D`, but can be used to manually manage scrolling when no camera is present. diff --git a/classes/class_parallaxlayer.rst b/classes/class_parallaxlayer.rst index 9ebea6812..413544140 100644 --- a/classes/class_parallaxlayer.rst +++ b/classes/class_parallaxlayer.rst @@ -8,6 +8,7 @@ ParallaxLayer ============= **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,17 @@ Brief Description A parallax scrolling layer to be used with :ref:`ParallaxBackground`. +Properties +---------- + ++-------------------------------+---------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`motion_mirroring` | ++-------------------------------+---------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`motion_offset` | ++-------------------------------+---------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`motion_scale` | ++-------------------------------+---------------------------------------------------------------+ + Description ----------- @@ -27,14 +39,37 @@ Property Descriptions .. _class_ParallaxLayer_motion_mirroring: -- :ref:`Vector2` **motion_mirroring** - 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)``. +- :ref:`Vector2` **motion_mirroring** + ++----------+----------------------+ +| *Setter* | set_mirroring(value) | ++----------+----------------------+ +| *Getter* | get_mirroring() | ++----------+----------------------+ + +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: -- :ref:`Vector2` **motion_offset** - The ParallaxLayer's offset relative to the parent ParallaxBackground's :ref:`ParallaxBackground.scroll_offset`. +- :ref:`Vector2` **motion_offset** + ++----------+--------------------------+ +| *Setter* | set_motion_offset(value) | ++----------+--------------------------+ +| *Getter* | get_motion_offset() | ++----------+--------------------------+ + +The ParallaxLayer's offset relative to the parent ParallaxBackground's :ref:`ParallaxBackground.scroll_offset`. .. _class_ParallaxLayer_motion_scale: -- :ref:`Vector2` **motion_scale** - Multiplies the ParallaxLayer's motion. If an axis is set to ``0`` it will not scroll. +- :ref:`Vector2` **motion_scale** ++----------+-------------------------+ +| *Setter* | set_motion_scale(value) | ++----------+-------------------------+ +| *Getter* | get_motion_scale() | ++----------+-------------------------+ + +Multiplies the ParallaxLayer's motion. If an axis is set to ``0`` it will not scroll. diff --git a/classes/class_particles.rst b/classes/class_particles.rst index 5802aac5e..8ad5034f4 100644 --- a/classes/class_particles.rst +++ b/classes/class_particles.rst @@ -8,6 +8,7 @@ Particles ========= **Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,49 @@ Brief Description 3D particle emitter. +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` | ++--------------------------------------------+-----------------------------------------------------------+ + Methods ------- @@ -29,18 +73,16 @@ Enumerations .. _enum_Particles_DrawOrder: -enum **DrawOrder** +enum **DrawOrder**: - **DRAW_ORDER_INDEX** = **0** --- Particles are drawn in the order emitted. - **DRAW_ORDER_LIFETIME** = **1** --- Particles are drawn in order of remaining lifetime. - **DRAW_ORDER_VIEW_DEPTH** = **2** --- Particles are drawn in order of depth. - Constants --------- - **MAX_DRAW_PASSES** = **4** --- Maximum number of draw passes supported. - Description ----------- @@ -53,92 +95,238 @@ Property Descriptions .. _class_Particles_amount: -- :ref:`int` **amount** - Number of particles to emit. +- :ref:`int` **amount** + ++----------+-------------------+ +| *Setter* | set_amount(value) | ++----------+-------------------+ +| *Getter* | get_amount() | ++----------+-------------------+ + +Number of particles to emit. .. _class_Particles_draw_order: -- :ref:`DrawOrder` **draw_order** - Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: ``DRAW_ORDER_INDEX``. +- :ref:`DrawOrder` **draw_order** + ++----------+-----------------------+ +| *Setter* | set_draw_order(value) | ++----------+-----------------------+ +| *Getter* | get_draw_order() | ++----------+-----------------------+ + +Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: ``DRAW_ORDER_INDEX``. .. _class_Particles_draw_pass_1: -- :ref:`Mesh` **draw_pass_1** - :ref:`Mesh` that is drawn for the first draw pass. +- :ref:`Mesh` **draw_pass_1** + ++----------+---------------------------+ +| *Setter* | set_draw_pass_mesh(value) | ++----------+---------------------------+ +| *Getter* | get_draw_pass_mesh() | ++----------+---------------------------+ + +:ref:`Mesh` that is drawn for the first draw pass. .. _class_Particles_draw_pass_2: -- :ref:`Mesh` **draw_pass_2** - :ref:`Mesh` that is drawn for the second draw pass. +- :ref:`Mesh` **draw_pass_2** + ++----------+---------------------------+ +| *Setter* | set_draw_pass_mesh(value) | ++----------+---------------------------+ +| *Getter* | get_draw_pass_mesh() | ++----------+---------------------------+ + +:ref:`Mesh` that is drawn for the second draw pass. .. _class_Particles_draw_pass_3: -- :ref:`Mesh` **draw_pass_3** - :ref:`Mesh` that is drawn for the third draw pass. +- :ref:`Mesh` **draw_pass_3** + ++----------+---------------------------+ +| *Setter* | set_draw_pass_mesh(value) | ++----------+---------------------------+ +| *Getter* | get_draw_pass_mesh() | ++----------+---------------------------+ + +:ref:`Mesh` that is drawn for the third draw pass. .. _class_Particles_draw_pass_4: -- :ref:`Mesh` **draw_pass_4** - :ref:`Mesh` that is drawn for the fourth draw pass. +- :ref:`Mesh` **draw_pass_4** + ++----------+---------------------------+ +| *Setter* | set_draw_pass_mesh(value) | ++----------+---------------------------+ +| *Getter* | get_draw_pass_mesh() | ++----------+---------------------------+ + +:ref:`Mesh` that is drawn for the fourth draw pass. .. _class_Particles_draw_passes: -- :ref:`int` **draw_passes** - The number of draw passes when rendering particles. +- :ref:`int` **draw_passes** + ++----------+------------------------+ +| *Setter* | set_draw_passes(value) | ++----------+------------------------+ +| *Getter* | get_draw_passes() | ++----------+------------------------+ + +The number of draw passes when rendering particles. .. _class_Particles_emitting: -- :ref:`bool` **emitting** - If ``true`` particles are being emitted. Default value: ``true``. +- :ref:`bool` **emitting** + ++----------+---------------------+ +| *Setter* | set_emitting(value) | ++----------+---------------------+ +| *Getter* | is_emitting() | ++----------+---------------------+ + +If ``true`` particles are being emitted. Default value: ``true``. .. _class_Particles_explosiveness: -- :ref:`float` **explosiveness** - Time ratio between each emission. If ``0`` particles are emitted continuously. If ``1`` all particles are emitted simultaneously. Default value: ``0``. +- :ref:`float` **explosiveness** + ++----------+--------------------------------+ +| *Setter* | set_explosiveness_ratio(value) | ++----------+--------------------------------+ +| *Getter* | get_explosiveness_ratio() | ++----------+--------------------------------+ + +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: - :ref:`int` **fixed_fps** ++----------+----------------------+ +| *Setter* | set_fixed_fps(value) | ++----------+----------------------+ +| *Getter* | get_fixed_fps() | ++----------+----------------------+ + .. _class_Particles_fract_delta: - :ref:`bool` **fract_delta** ++----------+-----------------------------+ +| *Setter* | set_fractional_delta(value) | ++----------+-----------------------------+ +| *Getter* | get_fractional_delta() | ++----------+-----------------------------+ + .. _class_Particles_lifetime: -- :ref:`float` **lifetime** - Amount of time each particle will exist. Default value: ``1``. +- :ref:`float` **lifetime** + ++----------+---------------------+ +| *Setter* | set_lifetime(value) | ++----------+---------------------+ +| *Getter* | get_lifetime() | ++----------+---------------------+ + +Amount of time each particle will exist. Default value: ``1``. .. _class_Particles_local_coords: -- :ref:`bool` **local_coords** - If ``true`` particles use the parent node's coordinate space. If ``false`` they use global coordinates. Default value: ``true``. +- :ref:`bool` **local_coords** + ++----------+----------------------------------+ +| *Setter* | set_use_local_coordinates(value) | ++----------+----------------------------------+ +| *Getter* | get_use_local_coordinates() | ++----------+----------------------------------+ + +If ``true`` particles use the parent node's coordinate space. If ``false`` they use global coordinates. Default value: ``true``. .. _class_Particles_one_shot: -- :ref:`bool` **one_shot** - If ``true`` only ``amount`` particles will be emitted. Default value: ``false``. +- :ref:`bool` **one_shot** + ++----------+---------------------+ +| *Setter* | set_one_shot(value) | ++----------+---------------------+ +| *Getter* | get_one_shot() | ++----------+---------------------+ + +If ``true`` only ``amount`` particles will be emitted. Default value: ``false``. .. _class_Particles_preprocess: -- :ref:`float` **preprocess** - Amount of time to preprocess the particles before animation starts. Lets you start the animation some time after particles have started emitting. +- :ref:`float` **preprocess** + ++----------+-----------------------------+ +| *Setter* | set_pre_process_time(value) | ++----------+-----------------------------+ +| *Getter* | get_pre_process_time() | ++----------+-----------------------------+ + +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: -- :ref:`Material` **process_material** - :ref:`Material` for processing particles. Can be a :ref:`ParticlesMaterial` or a :ref:`ShaderMaterial`. +- :ref:`Material` **process_material** + ++----------+-----------------------------+ +| *Setter* | set_process_material(value) | ++----------+-----------------------------+ +| *Getter* | get_process_material() | ++----------+-----------------------------+ + +:ref:`Material` for processing particles. Can be a :ref:`ParticlesMaterial` or a :ref:`ShaderMaterial`. .. _class_Particles_randomness: -- :ref:`float` **randomness** - Emission randomness ratio. Default value: ``0``. +- :ref:`float` **randomness** + ++----------+-----------------------------+ +| *Setter* | set_randomness_ratio(value) | ++----------+-----------------------------+ +| *Getter* | get_randomness_ratio() | ++----------+-----------------------------+ + +Emission randomness ratio. Default value: ``0``. .. _class_Particles_speed_scale: -- :ref:`float` **speed_scale** - Speed scaling ratio. Default value: ``1``. A value of ``0`` can be used to pause the particles. +- :ref:`float` **speed_scale** + ++----------+------------------------+ +| *Setter* | set_speed_scale(value) | ++----------+------------------------+ +| *Getter* | get_speed_scale() | ++----------+------------------------+ + +Speed scaling ratio. Default value: ``1``. A value of ``0`` can be used to pause the particles. .. _class_Particles_visibility_aabb: -- :ref:`AABB` **visibility_aabb** - The :ref:`AABB` that determines the area of the world part of which needs to be visible on screen for the particle system to be active. +- :ref:`AABB` **visibility_aabb** ++----------+----------------------------+ +| *Setter* | set_visibility_aabb(value) | ++----------+----------------------------+ +| *Getter* | get_visibility_aabb() | ++----------+----------------------------+ + +The :ref:`AABB` that determines the area of the world part of which needs to be visible on screen for the particle system to be active. Method Descriptions ------------------- -.. _class_Particles_capture_aabb: + .. _class_Particles_capture_aabb: - :ref:`AABB` **capture_aabb** **(** **)** const -.. _class_Particles_restart: + .. _class_Particles_restart: - void **restart** **(** **)** Restarts the particle emmission, clearing existing particles. - diff --git a/classes/class_particles2d.rst b/classes/class_particles2d.rst index 112e30511..29bf4f7a1 100644 --- a/classes/class_particles2d.rst +++ b/classes/class_particles2d.rst @@ -8,6 +8,7 @@ Particles2D =========== **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,47 @@ Brief Description 2D particle emitter. +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:`int` | :ref:`h_frames` | ++----------------------------------------------+-------------------------------------------------------------+ +| :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:`int` | :ref:`v_frames` | ++----------------------------------------------+-------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`visibility_rect` | ++----------------------------------------------+-------------------------------------------------------------+ + Methods ------- @@ -29,12 +71,11 @@ Enumerations .. _enum_Particles2D_DrawOrder: -enum **DrawOrder** +enum **DrawOrder**: - **DRAW_ORDER_INDEX** = **0** --- Particles are drawn in the order emitted. - **DRAW_ORDER_LIFETIME** = **1** --- Particles are drawn in order of remaining lifetime. - Description ----------- @@ -47,86 +88,222 @@ Property Descriptions .. _class_Particles2D_amount: -- :ref:`int` **amount** - Number of particles emitted in one emission cycle. +- :ref:`int` **amount** + ++----------+-------------------+ +| *Setter* | set_amount(value) | ++----------+-------------------+ +| *Getter* | get_amount() | ++----------+-------------------+ + +Number of particles emitted in one emission cycle. .. _class_Particles2D_draw_order: -- :ref:`DrawOrder` **draw_order** - Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: ``DRAW_ORDER_INDEX``. +- :ref:`DrawOrder` **draw_order** + ++----------+-----------------------+ +| *Setter* | set_draw_order(value) | ++----------+-----------------------+ +| *Getter* | get_draw_order() | ++----------+-----------------------+ + +Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: ``DRAW_ORDER_INDEX``. .. _class_Particles2D_emitting: -- :ref:`bool` **emitting** - If ``true`` particles are being emitted. Default value: ``true``. +- :ref:`bool` **emitting** + ++----------+---------------------+ +| *Setter* | set_emitting(value) | ++----------+---------------------+ +| *Getter* | is_emitting() | ++----------+---------------------+ + +If ``true`` particles are being emitted. Default value: ``true``. .. _class_Particles2D_explosiveness: -- :ref:`float` **explosiveness** - 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``. +- :ref:`float` **explosiveness** + ++----------+--------------------------------+ +| *Setter* | set_explosiveness_ratio(value) | ++----------+--------------------------------+ +| *Getter* | get_explosiveness_ratio() | ++----------+--------------------------------+ + +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: - :ref:`int` **fixed_fps** ++----------+----------------------+ +| *Setter* | set_fixed_fps(value) | ++----------+----------------------+ +| *Getter* | get_fixed_fps() | ++----------+----------------------+ + .. _class_Particles2D_fract_delta: - :ref:`bool` **fract_delta** ++----------+-----------------------------+ +| *Setter* | set_fractional_delta(value) | ++----------+-----------------------------+ +| *Getter* | get_fractional_delta() | ++----------+-----------------------------+ + .. _class_Particles2D_h_frames: -- :ref:`int` **h_frames** - Number of horizontal frames in ``texture``. +- :ref:`int` **h_frames** + ++----------+---------------------+ +| *Setter* | set_h_frames(value) | ++----------+---------------------+ +| *Getter* | get_h_frames() | ++----------+---------------------+ + +Number of horizontal frames in ``texture``. .. _class_Particles2D_lifetime: -- :ref:`float` **lifetime** - Amount of time each particle will exist. Default value: ``1``. +- :ref:`float` **lifetime** + ++----------+---------------------+ +| *Setter* | set_lifetime(value) | ++----------+---------------------+ +| *Getter* | get_lifetime() | ++----------+---------------------+ + +Amount of time each particle will exist. Default value: ``1``. .. _class_Particles2D_local_coords: -- :ref:`bool` **local_coords** - If ``true`` particles use the parent node's coordinate space. If ``false`` they use global coordinates. Default value: ``true``. +- :ref:`bool` **local_coords** + ++----------+----------------------------------+ +| *Setter* | set_use_local_coordinates(value) | ++----------+----------------------------------+ +| *Getter* | get_use_local_coordinates() | ++----------+----------------------------------+ + +If ``true`` particles use the parent node's coordinate space. If ``false`` they use global coordinates. Default value: ``true``. .. _class_Particles2D_normal_map: - :ref:`Texture` **normal_map** ++----------+-----------------------+ +| *Setter* | set_normal_map(value) | ++----------+-----------------------+ +| *Getter* | get_normal_map() | ++----------+-----------------------+ + .. _class_Particles2D_one_shot: -- :ref:`bool` **one_shot** - If ``true`` only one emission cycle occurs. If set ``true`` during a cycle, emission will stop at the cycle's end. Default value: ``false``. +- :ref:`bool` **one_shot** + ++----------+---------------------+ +| *Setter* | set_one_shot(value) | ++----------+---------------------+ +| *Getter* | get_one_shot() | ++----------+---------------------+ + +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: -- :ref:`float` **preprocess** - Particle system starts as if it had already run for this many seconds. +- :ref:`float` **preprocess** + ++----------+-----------------------------+ +| *Setter* | set_pre_process_time(value) | ++----------+-----------------------------+ +| *Getter* | get_pre_process_time() | ++----------+-----------------------------+ + +Particle system starts as if it had already run for this many seconds. .. _class_Particles2D_process_material: -- :ref:`Material` **process_material** - :ref:`Material` for processing particles. Can be a :ref:`ParticlesMaterial` or a :ref:`ShaderMaterial`. +- :ref:`Material` **process_material** + ++----------+-----------------------------+ +| *Setter* | set_process_material(value) | ++----------+-----------------------------+ +| *Getter* | get_process_material() | ++----------+-----------------------------+ + +:ref:`Material` for processing particles. Can be a :ref:`ParticlesMaterial` or a :ref:`ShaderMaterial`. .. _class_Particles2D_randomness: -- :ref:`float` **randomness** - Emission lifetime randomness ratio. Default value: ``0``. +- :ref:`float` **randomness** + ++----------+-----------------------------+ +| *Setter* | set_randomness_ratio(value) | ++----------+-----------------------------+ +| *Getter* | get_randomness_ratio() | ++----------+-----------------------------+ + +Emission lifetime randomness ratio. Default value: ``0``. .. _class_Particles2D_speed_scale: -- :ref:`float` **speed_scale** - Particle system's running speed scaling ratio. Default value: ``1``. A value of ``0`` can be used to pause the particles. +- :ref:`float` **speed_scale** + ++----------+------------------------+ +| *Setter* | set_speed_scale(value) | ++----------+------------------------+ +| *Getter* | get_speed_scale() | ++----------+------------------------+ + +Particle system's running speed scaling ratio. Default value: ``1``. A value of ``0`` can be used to pause the particles. .. _class_Particles2D_texture: -- :ref:`Texture` **texture** - Particle texture. If ``null`` particles will be squares. +- :ref:`Texture` **texture** + ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + +Particle texture. If ``null`` particles will be squares. .. _class_Particles2D_v_frames: -- :ref:`int` **v_frames** - Number of vertical frames in ``texture``. +- :ref:`int` **v_frames** + ++----------+---------------------+ +| *Setter* | set_v_frames(value) | ++----------+---------------------+ +| *Getter* | get_v_frames() | ++----------+---------------------+ + +Number of vertical frames in ``texture``. .. _class_Particles2D_visibility_rect: -- :ref:`Rect2` **visibility_rect** - Editor visibility helper. +- :ref:`Rect2` **visibility_rect** ++----------+----------------------------+ +| *Setter* | set_visibility_rect(value) | ++----------+----------------------------+ +| *Getter* | get_visibility_rect() | ++----------+----------------------------+ + +Editor visibility helper. Method Descriptions ------------------- -.. _class_Particles2D_capture_rect: + .. _class_Particles2D_capture_rect: - :ref:`Rect2` **capture_rect** **(** **)** const -.. _class_Particles2D_restart: + .. _class_Particles2D_restart: - void **restart** **(** **)** - diff --git a/classes/class_particlesmaterial.rst b/classes/class_particlesmaterial.rst index e4e14f2a6..2657e3523 100644 --- a/classes/class_particlesmaterial.rst +++ b/classes/class_particlesmaterial.rst @@ -8,6 +8,7 @@ ParticlesMaterial ================= **Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,12 +16,125 @@ Brief Description Particle properties for :ref:`Particles` and :ref:`Particles2D` nodes. +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:`bool` | :ref:`anim_loop` | ++------------------------------------------------------------+---------------------------------------------------------------------------------+ +| :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_Flags: -enum **Flags** +enum **Flags**: - **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` @@ -28,7 +142,7 @@ enum **Flags** .. _enum_ParticlesMaterial_Parameter: -enum **Parameter** +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_ANGULAR_VELOCITY** = **1** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set angular velocity properties. @@ -46,7 +160,7 @@ enum **Parameter** .. _enum_ParticlesMaterial_EmissionShape: -enum **EmissionShape** +enum **EmissionShape**: - **EMISSION_SHAPE_POINT** = **0** --- All particles will be emitted from a single point. - **EMISSION_SHAPE_SPHERE** = **1** --- Particles will be emitted in the volume of a sphere. @@ -54,7 +168,6 @@ enum **EmissionShape** - **EMISSION_SHAPE_POINTS** = **3** - **EMISSION_SHAPE_DIRECTED_POINTS** = **4** - Description ----------- @@ -67,218 +180,637 @@ Property Descriptions .. _class_ParticlesMaterial_angle: -- :ref:`float` **angle** - Initial rotation applied to each particle. +- :ref:`float` **angle** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +Initial rotation applied to each particle. .. _class_ParticlesMaterial_angle_curve: -- :ref:`Texture` **angle_curve** - Each particle's rotation will be animated along this :ref:`CurveTexture`. +- :ref:`Texture` **angle_curve** + ++----------+--------------------------+ +| *Setter* | set_param_texture(value) | ++----------+--------------------------+ +| *Getter* | get_param_texture() | ++----------+--------------------------+ + +Each particle's rotation will be animated along this :ref:`CurveTexture`. .. _class_ParticlesMaterial_angle_random: -- :ref:`float` **angle_random** - Rotation randomness ratio. Default value: ``0``. +- :ref:`float` **angle_random** + ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + +Rotation randomness ratio. Default value: ``0``. .. _class_ParticlesMaterial_angular_velocity: -- :ref:`float` **angular_velocity** - Initial angular velocity applied to each particle. +- :ref:`float` **angular_velocity** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +Initial angular velocity applied to each particle. .. _class_ParticlesMaterial_angular_velocity_curve: -- :ref:`Texture` **angular_velocity_curve** - Each particle's angular velocity will vary along this :ref:`CurveTexture`. +- :ref:`Texture` **angular_velocity_curve** + ++----------+--------------------------+ +| *Setter* | set_param_texture(value) | ++----------+--------------------------+ +| *Getter* | get_param_texture() | ++----------+--------------------------+ + +Each particle's angular velocity will vary along this :ref:`CurveTexture`. .. _class_ParticlesMaterial_angular_velocity_random: -- :ref:`float` **angular_velocity_random** - Angular velocity randomness ratio. Default value: ``0``. +- :ref:`float` **angular_velocity_random** + ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + +Angular velocity randomness ratio. Default value: ``0``. .. _class_ParticlesMaterial_anim_loop: -- :ref:`bool` **anim_loop** - If ``true`` animation will loop. Default value: ``false``. +- :ref:`bool` **anim_loop** + ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ + +If ``true`` animation will loop. Default value: ``false``. .. _class_ParticlesMaterial_anim_offset: -- :ref:`float` **anim_offset** - Particle animation offset. +- :ref:`float` **anim_offset** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +Particle animation offset. .. _class_ParticlesMaterial_anim_offset_curve: -- :ref:`Texture` **anim_offset_curve** - Each particle's animation offset will vary along this :ref:`CurveTexture`. +- :ref:`Texture` **anim_offset_curve** + ++----------+--------------------------+ +| *Setter* | set_param_texture(value) | ++----------+--------------------------+ +| *Getter* | get_param_texture() | ++----------+--------------------------+ + +Each particle's animation offset will vary along this :ref:`CurveTexture`. .. _class_ParticlesMaterial_anim_offset_random: -- :ref:`float` **anim_offset_random** - Animation offset randomness ratio. Default value: ``0``. +- :ref:`float` **anim_offset_random** + ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + +Animation offset randomness ratio. Default value: ``0``. .. _class_ParticlesMaterial_anim_speed: -- :ref:`float` **anim_speed** - Particle animation speed. +- :ref:`float` **anim_speed** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +Particle animation speed. .. _class_ParticlesMaterial_anim_speed_curve: -- :ref:`Texture` **anim_speed_curve** - Each particle's animation speed will vary along this :ref:`CurveTexture`. +- :ref:`Texture` **anim_speed_curve** + ++----------+--------------------------+ +| *Setter* | set_param_texture(value) | ++----------+--------------------------+ +| *Getter* | get_param_texture() | ++----------+--------------------------+ + +Each particle's animation speed will vary along this :ref:`CurveTexture`. .. _class_ParticlesMaterial_anim_speed_random: -- :ref:`float` **anim_speed_random** - Animation speed randomness ratio. Default value: ``0``. +- :ref:`float` **anim_speed_random** + ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + +Animation speed randomness ratio. Default value: ``0``. .. _class_ParticlesMaterial_color: -- :ref:`Color` **color** - Each particle's initial color. If the Particle2D's ``texture`` is defined, it will be multiplied by this color. +- :ref:`Color` **color** + ++----------+------------------+ +| *Setter* | set_color(value) | ++----------+------------------+ +| *Getter* | get_color() | ++----------+------------------+ + +Each particle's initial color. If the Particle2D's ``texture`` is defined, it will be multiplied by this color. .. _class_ParticlesMaterial_color_ramp: -- :ref:`Texture` **color_ramp** - Each particle's color will vary along this :ref:`GradientTexture`. +- :ref:`Texture` **color_ramp** + ++----------+-----------------------+ +| *Setter* | set_color_ramp(value) | ++----------+-----------------------+ +| *Getter* | get_color_ramp() | ++----------+-----------------------+ + +Each particle's color will vary along this :ref:`GradientTexture`. .. _class_ParticlesMaterial_damping: -- :ref:`float` **damping** - The rate at which particles lose velocity. +- :ref:`float` **damping** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +The rate at which particles lose velocity. .. _class_ParticlesMaterial_damping_curve: -- :ref:`Texture` **damping_curve** - Damping will vary along this :ref:`CurveTexture`. +- :ref:`Texture` **damping_curve** + ++----------+--------------------------+ +| *Setter* | set_param_texture(value) | ++----------+--------------------------+ +| *Getter* | get_param_texture() | ++----------+--------------------------+ + +Damping will vary along this :ref:`CurveTexture`. .. _class_ParticlesMaterial_damping_random: -- :ref:`float` **damping_random** - Damping randomness ratio. Default value: ``0``. +- :ref:`float` **damping_random** + ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + +Damping randomness ratio. Default value: ``0``. .. _class_ParticlesMaterial_emission_box_extents: -- :ref:`Vector3` **emission_box_extents** - The box's extents if ``emission_shape`` is set to ``EMISSION_SHAPE_BOX``. +- :ref:`Vector3` **emission_box_extents** + ++----------+---------------------------------+ +| *Setter* | set_emission_box_extents(value) | ++----------+---------------------------------+ +| *Getter* | get_emission_box_extents() | ++----------+---------------------------------+ + +The box's extents if ``emission_shape`` is set to ``EMISSION_SHAPE_BOX``. .. _class_ParticlesMaterial_emission_color_texture: - :ref:`Texture` **emission_color_texture** ++----------+-----------------------------------+ +| *Setter* | set_emission_color_texture(value) | ++----------+-----------------------------------+ +| *Getter* | get_emission_color_texture() | ++----------+-----------------------------------+ + .. _class_ParticlesMaterial_emission_normal_texture: - :ref:`Texture` **emission_normal_texture** ++----------+------------------------------------+ +| *Setter* | set_emission_normal_texture(value) | ++----------+------------------------------------+ +| *Getter* | get_emission_normal_texture() | ++----------+------------------------------------+ + .. _class_ParticlesMaterial_emission_point_count: -- :ref:`int` **emission_point_count** - The number of emission points if ``emission_shape`` is set to ``EMISSION_SHAPE_POINTS`` or ``EMISSION_SHAPE_DIRECTED_POINTS``. +- :ref:`int` **emission_point_count** + ++----------+---------------------------------+ +| *Setter* | set_emission_point_count(value) | ++----------+---------------------------------+ +| *Getter* | get_emission_point_count() | ++----------+---------------------------------+ + +The number of emission points if ``emission_shape`` is set to ``EMISSION_SHAPE_POINTS`` or ``EMISSION_SHAPE_DIRECTED_POINTS``. .. _class_ParticlesMaterial_emission_point_texture: - :ref:`Texture` **emission_point_texture** ++----------+-----------------------------------+ +| *Setter* | set_emission_point_texture(value) | ++----------+-----------------------------------+ +| *Getter* | get_emission_point_texture() | ++----------+-----------------------------------+ + .. _class_ParticlesMaterial_emission_shape: -- :ref:`EmissionShape` **emission_shape** - Particles will be emitted inside this region. Use ``EMISSION_SHAPE_*`` constants for values. Default value: ``EMISSION_SHAPE_POINT``. +- :ref:`EmissionShape` **emission_shape** + ++----------+---------------------------+ +| *Setter* | set_emission_shape(value) | ++----------+---------------------------+ +| *Getter* | get_emission_shape() | ++----------+---------------------------+ + +Particles will be emitted inside this region. Use ``EMISSION_SHAPE_*`` constants for values. Default value: ``EMISSION_SHAPE_POINT``. .. _class_ParticlesMaterial_emission_sphere_radius: -- :ref:`float` **emission_sphere_radius** - The sphere's radius if ``emission_shape`` is set to ``EMISSION_SHAPE_SPHERE``. +- :ref:`float` **emission_sphere_radius** + ++----------+-----------------------------------+ +| *Setter* | set_emission_sphere_radius(value) | ++----------+-----------------------------------+ +| *Getter* | get_emission_sphere_radius() | ++----------+-----------------------------------+ + +The sphere's radius if ``emission_shape`` is set to ``EMISSION_SHAPE_SPHERE``. .. _class_ParticlesMaterial_flag_align_y: - :ref:`bool` **flag_align_y** ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ + .. _class_ParticlesMaterial_flag_disable_z: -- :ref:`bool` **flag_disable_z** - If ``true`` particles will not move on the z axis. Default value: ``true`` for :ref:`Particles2D`, ``false`` for :ref:`Particles`. +- :ref:`bool` **flag_disable_z** + ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ + +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: - :ref:`bool` **flag_rotate_y** ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ + .. _class_ParticlesMaterial_flatness: - :ref:`float` **flatness** ++----------+---------------------+ +| *Setter* | set_flatness(value) | ++----------+---------------------+ +| *Getter* | get_flatness() | ++----------+---------------------+ + .. _class_ParticlesMaterial_gravity: -- :ref:`Vector3` **gravity** - Gravity applied to every particle. Default value: ``(0, 98, 0)``. +- :ref:`Vector3` **gravity** + ++----------+--------------------+ +| *Setter* | set_gravity(value) | ++----------+--------------------+ +| *Getter* | get_gravity() | ++----------+--------------------+ + +Gravity applied to every particle. Default value: ``(0, 98, 0)``. .. _class_ParticlesMaterial_hue_variation: -- :ref:`float` **hue_variation** - Initial hue variation applied to each particle. +- :ref:`float` **hue_variation** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +Initial hue variation applied to each particle. .. _class_ParticlesMaterial_hue_variation_curve: -- :ref:`Texture` **hue_variation_curve** - Each particle's hue will vary along this :ref:`CurveTexture`. +- :ref:`Texture` **hue_variation_curve** + ++----------+--------------------------+ +| *Setter* | set_param_texture(value) | ++----------+--------------------------+ +| *Getter* | get_param_texture() | ++----------+--------------------------+ + +Each particle's hue will vary along this :ref:`CurveTexture`. .. _class_ParticlesMaterial_hue_variation_random: -- :ref:`float` **hue_variation_random** - Hue variation randomness ratio. Default value: ``0``. +- :ref:`float` **hue_variation_random** + ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + +Hue variation randomness ratio. Default value: ``0``. .. _class_ParticlesMaterial_initial_velocity: -- :ref:`float` **initial_velocity** - Initial velocity for each particle. +- :ref:`float` **initial_velocity** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +Initial velocity for each particle. .. _class_ParticlesMaterial_initial_velocity_random: -- :ref:`float` **initial_velocity_random** - Initial velocity randomness ratio. Default value: ``0``. +- :ref:`float` **initial_velocity_random** + ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + +Initial velocity randomness ratio. Default value: ``0``. .. _class_ParticlesMaterial_linear_accel: -- :ref:`float` **linear_accel** - Linear acceleration applied to each particle. +- :ref:`float` **linear_accel** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +Linear acceleration applied to each particle. .. _class_ParticlesMaterial_linear_accel_curve: -- :ref:`Texture` **linear_accel_curve** - Each particle's linear acceleration will vary along this :ref:`CurveTexture`. +- :ref:`Texture` **linear_accel_curve** + ++----------+--------------------------+ +| *Setter* | set_param_texture(value) | ++----------+--------------------------+ +| *Getter* | get_param_texture() | ++----------+--------------------------+ + +Each particle's linear acceleration will vary along this :ref:`CurveTexture`. .. _class_ParticlesMaterial_linear_accel_random: -- :ref:`float` **linear_accel_random** - Linear acceleration randomness ratio. Default value: ``0``. +- :ref:`float` **linear_accel_random** + ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + +Linear acceleration randomness ratio. Default value: ``0``. .. _class_ParticlesMaterial_orbit_velocity: -- :ref:`float` **orbit_velocity** - Orbital velocity applied to each particle. +- :ref:`float` **orbit_velocity** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +Orbital velocity applied to each particle. .. _class_ParticlesMaterial_orbit_velocity_curve: -- :ref:`Texture` **orbit_velocity_curve** - Each particle's orbital velocity will vary along this :ref:`CurveTexture`. +- :ref:`Texture` **orbit_velocity_curve** + ++----------+--------------------------+ +| *Setter* | set_param_texture(value) | ++----------+--------------------------+ +| *Getter* | get_param_texture() | ++----------+--------------------------+ + +Each particle's orbital velocity will vary along this :ref:`CurveTexture`. .. _class_ParticlesMaterial_orbit_velocity_random: -- :ref:`float` **orbit_velocity_random** - Orbital velocity randomness ratio. Default value: ``0``. +- :ref:`float` **orbit_velocity_random** + ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + +Orbital velocity randomness ratio. Default value: ``0``. .. _class_ParticlesMaterial_radial_accel: -- :ref:`float` **radial_accel** - Radial acceleration applied to each particle. +- :ref:`float` **radial_accel** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +Radial acceleration applied to each particle. .. _class_ParticlesMaterial_radial_accel_curve: -- :ref:`Texture` **radial_accel_curve** - Each particle's radial acceleration will vary along this :ref:`CurveTexture`. +- :ref:`Texture` **radial_accel_curve** + ++----------+--------------------------+ +| *Setter* | set_param_texture(value) | ++----------+--------------------------+ +| *Getter* | get_param_texture() | ++----------+--------------------------+ + +Each particle's radial acceleration will vary along this :ref:`CurveTexture`. .. _class_ParticlesMaterial_radial_accel_random: -- :ref:`float` **radial_accel_random** - Radial acceleration randomness ratio. Default value: ``0``. +- :ref:`float` **radial_accel_random** + ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + +Radial acceleration randomness ratio. Default value: ``0``. .. _class_ParticlesMaterial_scale: -- :ref:`float` **scale** - Initial scale applied to each particle. +- :ref:`float` **scale** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +Initial scale applied to each particle. .. _class_ParticlesMaterial_scale_curve: -- :ref:`Texture` **scale_curve** - Each particle's scale will vary along this :ref:`CurveTexture`. +- :ref:`Texture` **scale_curve** + ++----------+--------------------------+ +| *Setter* | set_param_texture(value) | ++----------+--------------------------+ +| *Getter* | get_param_texture() | ++----------+--------------------------+ + +Each particle's scale will vary along this :ref:`CurveTexture`. .. _class_ParticlesMaterial_scale_random: -- :ref:`float` **scale_random** - Scale randomness ratio. Default value: ``0``. +- :ref:`float` **scale_random** + ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + +Scale randomness ratio. Default value: ``0``. .. _class_ParticlesMaterial_spread: -- :ref:`float` **spread** - Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Default value: ``45``. +- :ref:`float` **spread** + ++----------+-------------------+ +| *Setter* | set_spread(value) | ++----------+-------------------+ +| *Getter* | get_spread() | ++----------+-------------------+ + +Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Default value: ``45``. .. _class_ParticlesMaterial_tangential_accel: -- :ref:`float` **tangential_accel** - Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity. +- :ref:`float` **tangential_accel** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity. .. _class_ParticlesMaterial_tangential_accel_curve: -- :ref:`Texture` **tangential_accel_curve** - Each particle's tangential acceleration will vary along this :ref:`CurveTexture`. +- :ref:`Texture` **tangential_accel_curve** + ++----------+--------------------------+ +| *Setter* | set_param_texture(value) | ++----------+--------------------------+ +| *Getter* | get_param_texture() | ++----------+--------------------------+ + +Each particle's tangential acceleration will vary along this :ref:`CurveTexture`. .. _class_ParticlesMaterial_tangential_accel_random: -- :ref:`float` **tangential_accel_random** - Tangential acceleration randomness ratio. Default value: ``0``. +- :ref:`float` **tangential_accel_random** + ++----------+-----------------------------+ +| *Setter* | set_param_randomness(value) | ++----------+-----------------------------+ +| *Getter* | get_param_randomness() | ++----------+-----------------------------+ + +Tangential acceleration randomness ratio. Default value: ``0``. .. _class_ParticlesMaterial_trail_color_modifier: -- :ref:`GradientTexture` **trail_color_modifier** - Trail particles' color will vary along this :ref:`GradientTexture`. +- :ref:`GradientTexture` **trail_color_modifier** + ++----------+---------------------------------+ +| *Setter* | set_trail_color_modifier(value) | ++----------+---------------------------------+ +| *Getter* | get_trail_color_modifier() | ++----------+---------------------------------+ + +Trail particles' color will vary along this :ref:`GradientTexture`. .. _class_ParticlesMaterial_trail_divisor: -- :ref:`int` **trail_divisor** - Emitter will emit ``amount`` divided by ``trail_divisor`` particles. The remaining particles will be used as trail(s). +- :ref:`int` **trail_divisor** + ++----------+--------------------------+ +| *Setter* | set_trail_divisor(value) | ++----------+--------------------------+ +| *Getter* | get_trail_divisor() | ++----------+--------------------------+ + +Emitter will emit ``amount`` divided by ``trail_divisor`` particles. The remaining particles will be used as trail(s). .. _class_ParticlesMaterial_trail_size_modifier: -- :ref:`CurveTexture` **trail_size_modifier** - Trail particles' size will vary along this :ref:`CurveTexture`. +- :ref:`CurveTexture` **trail_size_modifier** ++----------+--------------------------------+ +| *Setter* | set_trail_size_modifier(value) | ++----------+--------------------------------+ +| *Getter* | get_trail_size_modifier() | ++----------+--------------------------------+ + +Trail particles' size will vary along this :ref:`CurveTexture`. diff --git a/classes/class_path.rst b/classes/class_path.rst index 11aeb922d..c84526064 100644 --- a/classes/class_path.rst +++ b/classes/class_path.rst @@ -8,6 +8,7 @@ Path ==== **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,14 +16,20 @@ Brief Description Container for a :ref:`Curve3D`. +Properties +---------- + ++-------------------------------+--------------------------------+ +| :ref:`Curve3D` | :ref:`curve` | ++-------------------------------+--------------------------------+ + Signals ------- -.. _class_Path_curve_changed: + .. _class_Path_curve_changed: - **curve_changed** **(** **)** - Description ----------- @@ -35,4 +42,9 @@ Property Descriptions - :ref:`Curve3D` **curve** ++----------+------------------+ +| *Setter* | set_curve(value) | ++----------+------------------+ +| *Getter* | get_curve() | ++----------+------------------+ diff --git a/classes/class_path2d.rst b/classes/class_path2d.rst index 15a4ebddb..82c099297 100644 --- a/classes/class_path2d.rst +++ b/classes/class_path2d.rst @@ -8,6 +8,7 @@ Path2D ====== **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Contains a :ref:`Curve2D` path for :ref:`PathFollow2D` nodes to follow. +Properties +---------- + ++-------------------------------+----------------------------------+ +| :ref:`Curve2D` | :ref:`curve` | ++-------------------------------+----------------------------------+ + Description ----------- @@ -25,6 +33,13 @@ Property Descriptions .. _class_Path2D_curve: -- :ref:`Curve2D` **curve** - A :ref:`Curve2D` describing the path. +- :ref:`Curve2D` **curve** ++----------+------------------+ +| *Setter* | set_curve(value) | ++----------+------------------+ +| *Getter* | get_curve() | ++----------+------------------+ + +A :ref:`Curve2D` describing the path. diff --git a/classes/class_pathfollow.rst b/classes/class_pathfollow.rst index 916bd8697..94a0742e3 100644 --- a/classes/class_pathfollow.rst +++ b/classes/class_pathfollow.rst @@ -8,6 +8,7 @@ PathFollow ========== **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,19 +16,37 @@ Brief Description 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` | ++---------------------------------------------------+------------------------------------------------------+ + Enumerations ------------ .. _enum_PathFollow_RotationMode: -enum **RotationMode** +enum **RotationMode**: - **ROTATION_NONE** = **0** --- Forbids the PathFollow to rotate. - **ROTATION_Y** = **1** --- Allows the PathFollow to rotate in the Y axis only. - **ROTATION_XY** = **2** --- Allows the PathFollow to rotate in both the X, and Y axes. - **ROTATION_XYZ** = **3** --- Allows the PathFollow to rotate in any axis. - Description ----------- @@ -40,7 +59,15 @@ Property Descriptions .. _class_PathFollow_cubic_interp: -- :ref:`bool` **cubic_interp** - If ``true`` the position between two cached points is interpolated cubically, and linearly otherwise. +- :ref:`bool` **cubic_interp** + ++----------+--------------------------------+ +| *Setter* | set_cubic_interpolation(value) | ++----------+--------------------------------+ +| *Getter* | get_cubic_interpolation() | ++----------+--------------------------------+ + +If ``true`` the position between two cached points is interpolated cubically, and linearly otherwise. The points along the :ref:`Curve3D` of the :ref:`Path` are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. @@ -48,26 +75,73 @@ There are two answers to this problem: Either increase the number of cached poin .. _class_PathFollow_h_offset: -- :ref:`float` **h_offset** - The node's offset along the curve. +- :ref:`float` **h_offset** + ++----------+---------------------+ +| *Setter* | set_h_offset(value) | ++----------+---------------------+ +| *Getter* | get_h_offset() | ++----------+---------------------+ + +The node's offset along the curve. .. _class_PathFollow_loop: -- :ref:`bool` **loop** - If ``true``, any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths. +- :ref:`bool` **loop** + ++----------+-----------------+ +| *Setter* | set_loop(value) | ++----------+-----------------+ +| *Getter* | has_loop() | ++----------+-----------------+ + +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: -- :ref:`float` **offset** - 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. +- :ref:`float` **offset** + ++----------+-------------------+ +| *Setter* | set_offset(value) | ++----------+-------------------+ +| *Getter* | get_offset() | ++----------+-------------------+ + +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: -- :ref:`RotationMode` **rotation_mode** - Allows or forbids rotation on one or more axes, depending on the constants being used. +- :ref:`RotationMode` **rotation_mode** + ++----------+--------------------------+ +| *Setter* | set_rotation_mode(value) | ++----------+--------------------------+ +| *Getter* | get_rotation_mode() | ++----------+--------------------------+ + +Allows or forbids rotation on one or more axes, depending on the constants being used. .. _class_PathFollow_unit_offset: -- :ref:`float` **unit_offset** - 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. +- :ref:`float` **unit_offset** + ++----------+------------------------+ +| *Setter* | set_unit_offset(value) | ++----------+------------------------+ +| *Getter* | get_unit_offset() | ++----------+------------------------+ + +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: -- :ref:`float` **v_offset** - The node's offset perpendicular to the curve. +- :ref:`float` **v_offset** ++----------+---------------------+ +| *Setter* | set_v_offset(value) | ++----------+---------------------+ +| *Getter* | get_v_offset() | ++----------+---------------------+ + +The node's offset perpendicular to the curve. diff --git a/classes/class_pathfollow2d.rst b/classes/class_pathfollow2d.rst index af38e46fe..8ae704c3b 100644 --- a/classes/class_pathfollow2d.rst +++ b/classes/class_pathfollow2d.rst @@ -8,6 +8,7 @@ PathFollow2D ============ **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,27 @@ Brief Description 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` | ++---------------------------+------------------------------------------------------+ + Description ----------- @@ -27,7 +49,15 @@ Property Descriptions .. _class_PathFollow2D_cubic_interp: -- :ref:`bool` **cubic_interp** - If ``true`` the position between two cached points is interpolated cubically, and linearly otherwise. +- :ref:`bool` **cubic_interp** + ++----------+--------------------------------+ +| *Setter* | set_cubic_interpolation(value) | ++----------+--------------------------------+ +| *Getter* | get_cubic_interpolation() | ++----------+--------------------------------+ + +If ``true`` the position between two cached points is interpolated cubically, and linearly otherwise. The points along the :ref:`Curve2D` of the :ref:`Path2D` are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. @@ -35,30 +65,83 @@ There are two answers to this problem: Either increase the number of cached poin .. _class_PathFollow2D_h_offset: -- :ref:`float` **h_offset** - The node's offset along the curve. +- :ref:`float` **h_offset** + ++----------+---------------------+ +| *Setter* | set_h_offset(value) | ++----------+---------------------+ +| *Getter* | get_h_offset() | ++----------+---------------------+ + +The node's offset along the curve. .. _class_PathFollow2D_lookahead: - :ref:`float` **lookahead** ++----------+----------------------+ +| *Setter* | set_lookahead(value) | ++----------+----------------------+ +| *Getter* | get_lookahead() | ++----------+----------------------+ + .. _class_PathFollow2D_loop: -- :ref:`bool` **loop** - If ``true``, any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths. +- :ref:`bool` **loop** + ++----------+-----------------+ +| *Setter* | set_loop(value) | ++----------+-----------------+ +| *Getter* | has_loop() | ++----------+-----------------+ + +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: -- :ref:`float` **offset** - The distance along the path in pixels. +- :ref:`float` **offset** + ++----------+-------------------+ +| *Setter* | set_offset(value) | ++----------+-------------------+ +| *Getter* | get_offset() | ++----------+-------------------+ + +The distance along the path in pixels. .. _class_PathFollow2D_rotate: -- :ref:`bool` **rotate** - If ``true``, this node rotates to follow the path, making its descendants rotate. +- :ref:`bool` **rotate** + ++----------+-------------------+ +| *Setter* | set_rotate(value) | ++----------+-------------------+ +| *Getter* | is_rotating() | ++----------+-------------------+ + +If ``true``, this node rotates to follow the path, making its descendants rotate. .. _class_PathFollow2D_unit_offset: -- :ref:`float` **unit_offset** - 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. +- :ref:`float` **unit_offset** + ++----------+------------------------+ +| *Setter* | set_unit_offset(value) | ++----------+------------------------+ +| *Getter* | get_unit_offset() | ++----------+------------------------+ + +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: -- :ref:`float` **v_offset** - The node's offset perpendicular to the curve. +- :ref:`float` **v_offset** ++----------+---------------------+ +| *Setter* | set_v_offset(value) | ++----------+---------------------+ +| *Getter* | get_v_offset() | ++----------+---------------------+ + +The node's offset perpendicular to the curve. diff --git a/classes/class_pckpacker.rst b/classes/class_pckpacker.rst index a076fb26e..00c8f8ac9 100644 --- a/classes/class_pckpacker.rst +++ b/classes/class_pckpacker.rst @@ -8,6 +8,7 @@ PCKPacker ========= **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -29,16 +30,15 @@ Methods Method Descriptions ------------------- -.. _class_PCKPacker_add_file: + .. _class_PCKPacker_add_file: - :ref:`Error` **add_file** **(** :ref:`String` pck_path, :ref:`String` source_path **)** -.. _class_PCKPacker_flush: + .. _class_PCKPacker_flush: - :ref:`Error` **flush** **(** :ref:`bool` verbose **)** -.. _class_PCKPacker_pck_start: + .. _class_PCKPacker_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 320e794a6..b51287e20 100644 --- a/classes/class_performance.rst +++ b/classes/class_performance.rst @@ -8,6 +8,7 @@ Performance =========== **Inherits:** :ref:`Object` + **Category:** Core Brief Description @@ -27,7 +28,7 @@ Enumerations .. _enum_Performance_Monitor: -enum **Monitor** +enum **Monitor**: - **TIME_FPS** = **0** --- Frames per second. - **TIME_PROCESS** = **1** --- Time it took to complete one frame. @@ -59,7 +60,6 @@ enum **Monitor** - **AUDIO_OUTPUT_LATENCY** = **27** - **MONITOR_MAX** = **28** - Description ----------- @@ -70,7 +70,7 @@ Many of these monitors are not updated in real-time, so there may be a short del Method Descriptions ------------------- -.. _class_Performance_get_monitor: + .. _class_Performance_get_monitor: - :ref:`float` **get_monitor** **(** :ref:`Monitor` monitor **)** const @@ -80,4 +80,3 @@ Returns the value of one of the available monitors. You should provide one of th print(Performance.get_monitor(Performance.TIME_FPS)) # Prints the FPS to the console - diff --git a/classes/class_phashtranslation.rst b/classes/class_phashtranslation.rst index a4ae078e9..b58fc80cc 100644 --- a/classes/class_phashtranslation.rst +++ b/classes/class_phashtranslation.rst @@ -8,6 +8,7 @@ PHashTranslation ================ **Inherits:** :ref:`Translation` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -30,8 +31,7 @@ Optimized translation. Uses real-time compressed translations, which results in Method Descriptions ------------------- -.. _class_PHashTranslation_generate: + .. _class_PHashTranslation_generate: - void **generate** **(** :ref:`Translation` from **)** - diff --git a/classes/class_physicalbone.rst b/classes/class_physicalbone.rst index 47e2d86e5..d9269b224 100644 --- a/classes/class_physicalbone.rst +++ b/classes/class_physicalbone.rst @@ -8,6 +8,7 @@ PhysicalBone ============ **Inherits:** :ref:`PhysicsBody` **<** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,27 @@ 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` | ++-----------------------------------------------+--------------------------------------------------------+ + Methods ------- @@ -33,7 +55,7 @@ Enumerations .. _enum_PhysicalBone_JointType: -enum **JointType** +enum **JointType**: - **JOINT_TYPE_NONE** = **0** - **JOINT_TYPE_PIN** = **1** @@ -42,7 +64,6 @@ enum **JointType** - **JOINT_TYPE_SLIDER** = **4** - **JOINT_TYPE_6DOF** = **5** - Property Descriptions --------------------- @@ -50,52 +71,98 @@ Property Descriptions - :ref:`Transform` **body_offset** ++----------+------------------------+ +| *Setter* | set_body_offset(value) | ++----------+------------------------+ +| *Getter* | get_body_offset() | ++----------+------------------------+ + .. _class_PhysicalBone_bounce: - :ref:`float` **bounce** ++----------+-------------------+ +| *Setter* | set_bounce(value) | ++----------+-------------------+ +| *Getter* | get_bounce() | ++----------+-------------------+ + .. _class_PhysicalBone_friction: - :ref:`float` **friction** ++----------+---------------------+ +| *Setter* | set_friction(value) | ++----------+---------------------+ +| *Getter* | get_friction() | ++----------+---------------------+ + .. _class_PhysicalBone_gravity_scale: - :ref:`float` **gravity_scale** ++----------+--------------------------+ +| *Setter* | set_gravity_scale(value) | ++----------+--------------------------+ +| *Getter* | get_gravity_scale() | ++----------+--------------------------+ + .. _class_PhysicalBone_joint_offset: - :ref:`Transform` **joint_offset** ++----------+-------------------------+ +| *Setter* | set_joint_offset(value) | ++----------+-------------------------+ +| *Getter* | get_joint_offset() | ++----------+-------------------------+ + .. _class_PhysicalBone_joint_type: - :ref:`JointType` **joint_type** ++----------+-----------------------+ +| *Setter* | set_joint_type(value) | ++----------+-----------------------+ +| *Getter* | get_joint_type() | ++----------+-----------------------+ + .. _class_PhysicalBone_mass: - :ref:`float` **mass** ++----------+-----------------+ +| *Setter* | set_mass(value) | ++----------+-----------------+ +| *Getter* | get_mass() | ++----------+-----------------+ + .. _class_PhysicalBone_weight: - :ref:`float` **weight** ++----------+-------------------+ +| *Setter* | set_weight(value) | ++----------+-------------------+ +| *Getter* | get_weight() | ++----------+-------------------+ Method Descriptions ------------------- -.. _class_PhysicalBone_get_bone_id: + .. _class_PhysicalBone_get_bone_id: - :ref:`int` **get_bone_id** **(** **)** const -.. _class_PhysicalBone_get_simulate_physics: + .. _class_PhysicalBone_get_simulate_physics: - :ref:`bool` **get_simulate_physics** **(** **)** -.. _class_PhysicalBone_is_simulating_physics: + .. _class_PhysicalBone_is_simulating_physics: - :ref:`bool` **is_simulating_physics** **(** **)** -.. _class_PhysicalBone_is_static_body: + .. _class_PhysicalBone_is_static_body: - :ref:`bool` **is_static_body** **(** **)** - diff --git a/classes/class_physics2ddirectbodystate.rst b/classes/class_physics2ddirectbodystate.rst index 0c5aeb879..51ea000a1 100644 --- a/classes/class_physics2ddirectbodystate.rst +++ b/classes/class_physics2ddirectbodystate.rst @@ -8,7 +8,9 @@ Physics2DDirectBodyState ======================== **Inherits:** :ref:`Object` + **Inherited By:** :ref:`Physics2DDirectBodyStateSW` + **Category:** Core Brief Description @@ -16,6 +18,31 @@ Brief Description Direct access object to a physics body in the :ref:`Physics2DServer`. +Properties +---------- + ++---------------------------------------+------------------------------------------------------------------------------+ +| :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 ------- @@ -69,148 +96,214 @@ Property Descriptions .. _class_Physics2DDirectBodyState_angular_velocity: -- :ref:`float` **angular_velocity** - The angular velocity of the body. +- :ref:`float` **angular_velocity** + ++----------+-----------------------------+ +| *Setter* | set_angular_velocity(value) | ++----------+-----------------------------+ +| *Getter* | get_angular_velocity() | ++----------+-----------------------------+ + +The angular velocity of the body. .. _class_Physics2DDirectBodyState_inverse_inertia: -- :ref:`float` **inverse_inertia** - The inverse of the inertia of the body. +- :ref:`float` **inverse_inertia** + ++----------+-----------------------+ +| *Getter* | get_inverse_inertia() | ++----------+-----------------------+ + +The inverse of the inertia of the body. .. _class_Physics2DDirectBodyState_inverse_mass: -- :ref:`float` **inverse_mass** - The inverse of the mass of the body. +- :ref:`float` **inverse_mass** + ++----------+--------------------+ +| *Getter* | get_inverse_mass() | ++----------+--------------------+ + +The inverse of the mass of the body. .. _class_Physics2DDirectBodyState_linear_velocity: -- :ref:`Vector2` **linear_velocity** - The linear velocity of the body. +- :ref:`Vector2` **linear_velocity** + ++----------+----------------------------+ +| *Setter* | set_linear_velocity(value) | ++----------+----------------------------+ +| *Getter* | get_linear_velocity() | ++----------+----------------------------+ + +The linear velocity of the body. .. _class_Physics2DDirectBodyState_sleeping: -- :ref:`bool` **sleeping** - ``true`` if this body is currently sleeping (not active). +- :ref:`bool` **sleeping** + ++----------+------------------------+ +| *Setter* | set_sleep_state(value) | ++----------+------------------------+ +| *Getter* | is_sleeping() | ++----------+------------------------+ + +``true`` if this body is currently sleeping (not active). .. _class_Physics2DDirectBodyState_step: -- :ref:`float` **step** - The timestep (delta) used for the simulation. +- :ref:`float` **step** + ++----------+------------+ +| *Getter* | get_step() | ++----------+------------+ + +The timestep (delta) used for the simulation. .. _class_Physics2DDirectBodyState_total_angular_damp: -- :ref:`float` **total_angular_damp** - The rate at which the body stops rotating, if there are not any other forces moving it. +- :ref:`float` **total_angular_damp** + ++----------+--------------------------+ +| *Getter* | get_total_angular_damp() | ++----------+--------------------------+ + +The rate at which the body stops rotating, if there are not any other forces moving it. .. _class_Physics2DDirectBodyState_total_gravity: -- :ref:`Vector2` **total_gravity** - The total gravity vector being currently applied to this body. +- :ref:`Vector2` **total_gravity** + ++----------+---------------------+ +| *Getter* | get_total_gravity() | ++----------+---------------------+ + +The total gravity vector being currently applied to this body. .. _class_Physics2DDirectBodyState_total_linear_damp: -- :ref:`float` **total_linear_damp** - The rate at which the body stops moving, if there are not any other forces moving it. +- :ref:`float` **total_linear_damp** + ++----------+-------------------------+ +| *Getter* | get_total_linear_damp() | ++----------+-------------------------+ + +The rate at which the body stops moving, if there are not any other forces moving it. .. _class_Physics2DDirectBodyState_transform: -- :ref:`Transform2D` **transform** - The transformation matrix of the body. +- :ref:`Transform2D` **transform** ++----------+----------------------+ +| *Setter* | set_transform(value) | ++----------+----------------------+ +| *Getter* | get_transform() | ++----------+----------------------+ + +The transformation matrix of the body. Method Descriptions ------------------- -.. _class_Physics2DDirectBodyState_add_central_force: + .. _class_Physics2DDirectBodyState_add_central_force: - void **add_central_force** **(** :ref:`Vector2` force **)** -.. _class_Physics2DDirectBodyState_add_force: + .. _class_Physics2DDirectBodyState_add_force: - void **add_force** **(** :ref:`Vector2` offset, :ref:`Vector2` force **)** -.. _class_Physics2DDirectBodyState_add_torque: + .. _class_Physics2DDirectBodyState_add_torque: - void **add_torque** **(** :ref:`float` torque **)** -.. _class_Physics2DDirectBodyState_apply_central_impulse: + .. _class_Physics2DDirectBodyState_apply_central_impulse: - void **apply_central_impulse** **(** :ref:`Vector2` impulse **)** -.. _class_Physics2DDirectBodyState_apply_impulse: + .. _class_Physics2DDirectBodyState_apply_impulse: - void **apply_impulse** **(** :ref:`Vector2` offset, :ref:`Vector2` impulse **)** -.. _class_Physics2DDirectBodyState_apply_torque_impulse: + .. _class_Physics2DDirectBodyState_apply_torque_impulse: - void **apply_torque_impulse** **(** :ref:`float` impulse **)** -.. _class_Physics2DDirectBodyState_get_contact_collider: + .. _class_Physics2DDirectBodyState_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_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_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_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_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_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`. -.. _class_Physics2DDirectBodyState_get_contact_collider_velocity_at_position: + .. _class_Physics2DDirectBodyState_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_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_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_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_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_get_space_state: - :ref:`Physics2DDirectSpaceState` **get_space_state** **(** **)** Return the current state of space, useful for queries. -.. _class_Physics2DDirectBodyState_integrate_forces: + .. _class_Physics2DDirectBodyState_integrate_forces: - void **integrate_forces** **(** **)** Call the built-in force integration code. - diff --git a/classes/class_physics2ddirectbodystatesw.rst b/classes/class_physics2ddirectbodystatesw.rst index f86969943..e9d915ae8 100644 --- a/classes/class_physics2ddirectbodystatesw.rst +++ b/classes/class_physics2ddirectbodystatesw.rst @@ -8,6 +8,7 @@ Physics2DDirectBodyStateSW ========================== **Inherits:** :ref:`Physics2DDirectBodyState` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_physics2ddirectspacestate.rst b/classes/class_physics2ddirectspacestate.rst index 506899449..fea0eb38b 100644 --- a/classes/class_physics2ddirectspacestate.rst +++ b/classes/class_physics2ddirectspacestate.rst @@ -8,6 +8,7 @@ Physics2DDirectSpaceState ========================= **Inherits:** :ref:`Object` + **Category:** Core Brief Description @@ -41,11 +42,10 @@ Tutorials --------- - :doc:`../tutorials/physics/ray-casting` - Method Descriptions ------------------- -.. _class_Physics2DDirectSpaceState_cast_motion: + .. _class_Physics2DDirectSpaceState_cast_motion: - :ref:`Array` **cast_motion** **(** :ref:`Physics2DShapeQueryParameters` shape **)** @@ -53,13 +53,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_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. -.. _class_Physics2DDirectSpaceState_get_rest_info: + .. _class_Physics2DDirectSpaceState_get_rest_info: - :ref:`Dictionary` **get_rest_info** **(** :ref:`Physics2DShapeQueryParameters` shape **)** @@ -81,7 +81,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_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 **)** @@ -99,7 +99,7 @@ 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_ray: + .. _class_Physics2DDirectSpaceState_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 **)** @@ -123,7 +123,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_intersect_shape: - :ref:`Array` **intersect_shape** **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** @@ -141,4 +141,3 @@ Checks the intersections of a shape, given through a :ref:`Physics2DShapeQueryPa The number of intersections can be limited with the second parameter, to reduce the processing time. - diff --git a/classes/class_physics2dserver.rst b/classes/class_physics2dserver.rst index b5cd2774c..e754b89f1 100644 --- a/classes/class_physics2dserver.rst +++ b/classes/class_physics2dserver.rst @@ -8,7 +8,9 @@ Physics2DServer =============== **Inherits:** :ref:`Object` + **Inherited By:** :ref:`Physics2DServerSW` + **Category:** Core Brief Description @@ -222,7 +224,7 @@ Enumerations .. _enum_Physics2DServer_CCDMode: -enum **CCDMode** +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. - **CCD_MODE_CAST_RAY** = **1** --- Enables continuous collision detection by raycasting. It is faster than shapecasting, but less precise. @@ -230,7 +232,7 @@ enum **CCDMode** .. _enum_Physics2DServer_BodyState: -enum **BodyState** +enum **BodyState**: - **BODY_STATE_TRANSFORM** = **0** --- Constant to set/get the current transform matrix of the body. - **BODY_STATE_LINEAR_VELOCITY** = **1** --- Constant to set/get the current linear velocity of the body. @@ -240,7 +242,7 @@ enum **BodyState** .. _enum_Physics2DServer_ProcessInfo: -enum **ProcessInfo** +enum **ProcessInfo**: - **INFO_ACTIVE_OBJECTS** = **0** --- Constant to get the number of objects that are not sleeping. - **INFO_COLLISION_PAIRS** = **1** --- Constant to get the number of possible collisions. @@ -248,7 +250,7 @@ enum **ProcessInfo** .. _enum_Physics2DServer_JointParam: -enum **JointParam** +enum **JointParam**: - **JOINT_PARAM_BIAS** = **0** - **JOINT_PARAM_MAX_BIAS** = **1** @@ -256,7 +258,7 @@ enum **JointParam** .. _enum_Physics2DServer_ShapeType: -enum **ShapeType** +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. - **SHAPE_RAY** = **1** @@ -270,7 +272,7 @@ enum **ShapeType** .. _enum_Physics2DServer_AreaParameter: -enum **AreaParameter** +enum **AreaParameter**: - **AREA_PARAM_GRAVITY** = **0** --- Constant to set/get gravity strength in an area. - **AREA_PARAM_GRAVITY_VECTOR** = **1** --- Constant to set/get gravity vector/center in an area. @@ -283,14 +285,14 @@ enum **AreaParameter** .. _enum_Physics2DServer_AreaBodyStatus: -enum **AreaBodyStatus** +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. - **AREA_BODY_REMOVED** = **1** --- The value of the first parameter and area callback function receives, when an object exits one of its shapes. .. _enum_Physics2DServer_BodyParameter: -enum **BodyParameter** +enum **BodyParameter**: - **BODY_PARAM_BOUNCE** = **0** --- Constant to set/get a body's bounce factor. - **BODY_PARAM_FRICTION** = **1** --- Constant to set/get a body's friction. @@ -303,7 +305,7 @@ enum **BodyParameter** .. _enum_Physics2DServer_BodyMode: -enum **BodyMode** +enum **BodyMode**: - **BODY_MODE_STATIC** = **0** --- Constant for static bodies. - **BODY_MODE_KINEMATIC** = **1** --- Constant for kinematic bodies. @@ -312,7 +314,7 @@ enum **BodyMode** .. _enum_Physics2DServer_DampedStringParam: -enum **DampedStringParam** +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. - **DAMPED_STRING_STIFFNESS** = **1** --- Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length. @@ -320,7 +322,7 @@ enum **DampedStringParam** .. _enum_Physics2DServer_SpaceParameter: -enum **SpaceParameter** +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. - **SPACE_PARAM_CONTACT_MAX_SEPARATION** = **1** --- Constant to set/get the maximum distance a shape can be from another before they are considered separated. @@ -332,7 +334,7 @@ enum **SpaceParameter** .. _enum_Physics2DServer_AreaSpaceOverrideMode: -enum **AreaSpaceOverrideMode** +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. - **AREA_SPACE_OVERRIDE_COMBINE** = **1** --- This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects. @@ -342,13 +344,12 @@ enum **AreaSpaceOverrideMode** .. _enum_Physics2DServer_JointType: -enum **JointType** +enum **JointType**: - **JOINT_PIN** = **0** --- Constant to create pin joints. - **JOINT_GROOVE** = **1** --- Constant to create groove joints. - **JOINT_DAMPED_SPRING** = **2** --- Constant to create damped spring joints. - Description ----------- @@ -357,101 +358,101 @@ Physics 2D Server is the server responsible for all 2D physics. It can create ma Method Descriptions ------------------- -.. _class_Physics2DServer_area_add_shape: + .. _class_Physics2DServer_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_object_instance_id: + .. _class_Physics2DServer_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_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_area_create: - :ref:`RID` **area_create** **(** **)** Creates an :ref:`Area2D`. -.. _class_Physics2DServer_area_get_object_instance_id: + .. _class_Physics2DServer_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_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_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_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_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_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_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_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_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_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_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_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_area_set_monitor_callback: - void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** @@ -467,231 +468,231 @@ 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_area_set_monitorable: - void **area_set_monitorable** **(** :ref:`RID` area, :ref:`bool` monitorable **)** -.. _class_Physics2DServer_area_set_param: + .. _class_Physics2DServer_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_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_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_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_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_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_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_body_add_central_force: - void **body_add_central_force** **(** :ref:`RID` body, :ref:`Vector2` force **)** -.. _class_Physics2DServer_body_add_collision_exception: + .. _class_Physics2DServer_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_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. -.. _class_Physics2DServer_body_add_shape: + .. _class_Physics2DServer_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_body_add_torque: - void **body_add_torque** **(** :ref:`RID` body, :ref:`float` torque **)** -.. _class_Physics2DServer_body_apply_central_impulse: + .. _class_Physics2DServer_body_apply_central_impulse: - void **body_apply_central_impulse** **(** :ref:`RID` body, :ref:`Vector2` impulse **)** -.. _class_Physics2DServer_body_apply_impulse: + .. _class_Physics2DServer_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_body_apply_torque_impulse: - void **body_apply_torque_impulse** **(** :ref:`RID` body, :ref:`float` impulse **)** -.. _class_Physics2DServer_body_attach_object_instance_id: + .. _class_Physics2DServer_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_body_clear_shapes: - void **body_clear_shapes** **(** :ref:`RID` body **)** Removes all shapes from a body. -.. _class_Physics2DServer_body_create: + .. _class_Physics2DServer_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_collision_layer: + .. _class_Physics2DServer_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_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_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_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_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`. -.. _class_Physics2DServer_body_get_mode: + .. _class_Physics2DServer_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_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_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_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_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_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_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_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_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_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`). -.. _class_Physics2DServer_body_remove_collision_exception: + .. _class_Physics2DServer_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_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_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_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_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_body_set_continuous_collision_detection_mode: - void **body_set_continuous_collision_detection_mode** **(** :ref:`RID` body, :ref:`CCDMode` mode **)** @@ -699,234 +700,233 @@ 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_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`). -.. _class_Physics2DServer_body_set_max_contacts_reported: + .. _class_Physics2DServer_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_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_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`). -.. _class_Physics2DServer_body_set_param: + .. _class_Physics2DServer_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_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_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_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_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. -.. _class_Physics2DServer_body_set_shape_transform: + .. _class_Physics2DServer_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_body_set_space: - void **body_set_space** **(** :ref:`RID` body, :ref:`RID` space **)** Assigns a space to the body (see :ref:`space_create`). -.. _class_Physics2DServer_body_set_state: + .. _class_Physics2DServer_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_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_capsule_shape_create: - :ref:`RID` **capsule_shape_create** **(** **)** -.. _class_Physics2DServer_circle_shape_create: + .. _class_Physics2DServer_circle_shape_create: - :ref:`RID` **circle_shape_create** **(** **)** -.. _class_Physics2DServer_concave_polygon_shape_create: + .. _class_Physics2DServer_concave_polygon_shape_create: - :ref:`RID` **concave_polygon_shape_create** **(** **)** -.. _class_Physics2DServer_convex_polygon_shape_create: + .. _class_Physics2DServer_convex_polygon_shape_create: - :ref:`RID` **convex_polygon_shape_create** **(** **)** -.. _class_Physics2DServer_damped_spring_joint_create: + .. _class_Physics2DServer_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_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_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_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_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_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_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_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_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_line_shape_create: - :ref:`RID` **line_shape_create** **(** **)** -.. _class_Physics2DServer_pin_joint_create: + .. _class_Physics2DServer_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_ray_shape_create: - :ref:`RID` **ray_shape_create** **(** **)** -.. _class_Physics2DServer_rectangle_shape_create: + .. _class_Physics2DServer_rectangle_shape_create: - :ref:`RID` **rectangle_shape_create** **(** **)** -.. _class_Physics2DServer_segment_shape_create: + .. _class_Physics2DServer_segment_shape_create: - :ref:`RID` **segment_shape_create** **(** **)** -.. _class_Physics2DServer_set_active: + .. _class_Physics2DServer_set_active: - void **set_active** **(** :ref:`bool` active **)** Activates or deactivates the 2D physics engine. -.. _class_Physics2DServer_shape_get_data: + .. _class_Physics2DServer_shape_get_data: - :ref:`Variant` **shape_get_data** **(** :ref:`RID` shape **)** const Returns the shape data. -.. _class_Physics2DServer_shape_get_type: + .. _class_Physics2DServer_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_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`. -.. _class_Physics2DServer_space_create: + .. _class_Physics2DServer_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`. -.. _class_Physics2DServer_space_get_direct_state: + .. _class_Physics2DServer_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_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_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_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_space_set_param: - void **space_set_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** Sets the value for a space parameter. A list of available parameters is on the SPACE_PARAM\_\* constants. - diff --git a/classes/class_physics2dserversw.rst b/classes/class_physics2dserversw.rst index 0eab65c6a..c5f8b20be 100644 --- a/classes/class_physics2dserversw.rst +++ b/classes/class_physics2dserversw.rst @@ -8,6 +8,7 @@ Physics2DServerSW ================= **Inherits:** :ref:`Physics2DServer` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_physics2dshapequeryparameters.rst b/classes/class_physics2dshapequeryparameters.rst index ef31d9f63..e99aa69eb 100644 --- a/classes/class_physics2dshapequeryparameters.rst +++ b/classes/class_physics2dshapequeryparameters.rst @@ -8,6 +8,7 @@ Physics2DShapeQueryParameters ============================= **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,27 @@ Brief Description 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` | ++---------------------------------------+-------------------------------------------------------------------------------------+ + Methods ------- @@ -34,42 +56,100 @@ Property Descriptions - :ref:`bool` **collide_with_areas** ++----------+---------------------------------+ +| *Setter* | set_collide_with_areas(value) | ++----------+---------------------------------+ +| *Getter* | is_collide_with_areas_enabled() | ++----------+---------------------------------+ + .. _class_Physics2DShapeQueryParameters_collide_with_bodies: - :ref:`bool` **collide_with_bodies** ++----------+----------------------------------+ +| *Setter* | set_collide_with_bodies(value) | ++----------+----------------------------------+ +| *Getter* | is_collide_with_bodies_enabled() | ++----------+----------------------------------+ + .. _class_Physics2DShapeQueryParameters_collision_layer: -- :ref:`int` **collision_layer** - The physics layer the query should be made on. +- :ref:`int` **collision_layer** + ++----------+----------------------------+ +| *Setter* | set_collision_layer(value) | ++----------+----------------------------+ +| *Getter* | get_collision_layer() | ++----------+----------------------------+ + +The physics layer the query should be made on. .. _class_Physics2DShapeQueryParameters_exclude: -- :ref:`Array` **exclude** - The list of objects or object :ref:`RID`\ s, that will be excluded from collisions. +- :ref:`Array` **exclude** + ++----------+--------------------+ +| *Setter* | set_exclude(value) | ++----------+--------------------+ +| *Getter* | get_exclude() | ++----------+--------------------+ + +The list of objects or object :ref:`RID`\ s, that will be excluded from collisions. .. _class_Physics2DShapeQueryParameters_margin: -- :ref:`float` **margin** - The collision margin for the shape. +- :ref:`float` **margin** + ++----------+-------------------+ +| *Setter* | set_margin(value) | ++----------+-------------------+ +| *Getter* | get_margin() | ++----------+-------------------+ + +The collision margin for the shape. .. _class_Physics2DShapeQueryParameters_motion: -- :ref:`Vector2` **motion** - The motion of the shape being queried for. +- :ref:`Vector2` **motion** + ++----------+-------------------+ +| *Setter* | set_motion(value) | ++----------+-------------------+ +| *Getter* | get_motion() | ++----------+-------------------+ + +The motion of the shape being queried for. .. _class_Physics2DShapeQueryParameters_shape_rid: -- :ref:`RID` **shape_rid** - The :ref:`RID` of the queried shape. See :ref:`set_shape` also. +- :ref:`RID` **shape_rid** + ++----------+----------------------+ +| *Setter* | set_shape_rid(value) | ++----------+----------------------+ +| *Getter* | get_shape_rid() | ++----------+----------------------+ + +The :ref:`RID` of the queried shape. See :ref:`set_shape` also. .. _class_Physics2DShapeQueryParameters_transform: -- :ref:`Transform2D` **transform** - the transform matrix of the queried shape. +- :ref:`Transform2D` **transform** ++----------+----------------------+ +| *Setter* | set_transform(value) | ++----------+----------------------+ +| *Getter* | get_transform() | ++----------+----------------------+ + +the transform matrix of the queried shape. Method Descriptions ------------------- -.. _class_Physics2DShapeQueryParameters_set_shape: + .. _class_Physics2DShapeQueryParameters_set_shape: - void **set_shape** **(** :ref:`Resource` shape **)** Set the :ref:`Shape2D` that will be used for collision/intersection queries. - diff --git a/classes/class_physics2dshapequeryresult.rst b/classes/class_physics2dshapequeryresult.rst index 7f24e9177..bb3d91945 100644 --- a/classes/class_physics2dshapequeryresult.rst +++ b/classes/class_physics2dshapequeryresult.rst @@ -8,6 +8,7 @@ Physics2DShapeQueryResult ========================= **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -33,24 +34,23 @@ Methods Method Descriptions ------------------- -.. _class_Physics2DShapeQueryResult_get_result_count: + .. _class_Physics2DShapeQueryResult_get_result_count: - :ref:`int` **get_result_count** **(** **)** const -.. _class_Physics2DShapeQueryResult_get_result_object: + .. _class_Physics2DShapeQueryResult_get_result_object: - :ref:`Object` **get_result_object** **(** :ref:`int` idx **)** const -.. _class_Physics2DShapeQueryResult_get_result_object_id: + .. _class_Physics2DShapeQueryResult_get_result_object_id: - :ref:`int` **get_result_object_id** **(** :ref:`int` idx **)** const -.. _class_Physics2DShapeQueryResult_get_result_object_shape: + .. _class_Physics2DShapeQueryResult_get_result_object_shape: - :ref:`int` **get_result_object_shape** **(** :ref:`int` idx **)** const -.. _class_Physics2DShapeQueryResult_get_result_rid: + .. _class_Physics2DShapeQueryResult_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 53c978622..742c39c1e 100644 --- a/classes/class_physics2dtestmotionresult.rst +++ b/classes/class_physics2dtestmotionresult.rst @@ -8,6 +8,7 @@ Physics2DTestMotionResult ========================= **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,29 @@ 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` | ++-------------------------------+-----------------------------------------------------------------------------+ + Property Descriptions --------------------- @@ -22,36 +46,71 @@ Property Descriptions - :ref:`Object` **collider** ++----------+----------------+ +| *Getter* | get_collider() | ++----------+----------------+ + .. _class_Physics2DTestMotionResult_collider_id: - :ref:`int` **collider_id** ++----------+-------------------+ +| *Getter* | get_collider_id() | ++----------+-------------------+ + .. _class_Physics2DTestMotionResult_collider_rid: - :ref:`RID` **collider_rid** ++----------+--------------------+ +| *Getter* | get_collider_rid() | ++----------+--------------------+ + .. _class_Physics2DTestMotionResult_collider_shape: - :ref:`int` **collider_shape** ++----------+----------------------+ +| *Getter* | get_collider_shape() | ++----------+----------------------+ + .. _class_Physics2DTestMotionResult_collider_velocity: - :ref:`Vector2` **collider_velocity** ++----------+-------------------------+ +| *Getter* | get_collider_velocity() | ++----------+-------------------------+ + .. _class_Physics2DTestMotionResult_collision_normal: - :ref:`Vector2` **collision_normal** ++----------+------------------------+ +| *Getter* | get_collision_normal() | ++----------+------------------------+ + .. _class_Physics2DTestMotionResult_collision_point: - :ref:`Vector2` **collision_point** ++----------+-----------------------+ +| *Getter* | get_collision_point() | ++----------+-----------------------+ + .. _class_Physics2DTestMotionResult_motion: - :ref:`Vector2` **motion** ++----------+--------------+ +| *Getter* | get_motion() | ++----------+--------------+ + .. _class_Physics2DTestMotionResult_motion_remainder: - :ref:`Vector2` **motion_remainder** ++----------+------------------------+ +| *Getter* | get_motion_remainder() | ++----------+------------------------+ diff --git a/classes/class_physicsbody.rst b/classes/class_physicsbody.rst index 7fda010a8..b18cbabd5 100644 --- a/classes/class_physicsbody.rst +++ b/classes/class_physicsbody.rst @@ -8,7 +8,9 @@ PhysicsBody =========== **Inherits:** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`PhysicalBone`, :ref:`StaticBody`, :ref:`KinematicBody`, :ref:`RigidBody` + **Category:** Core Brief Description @@ -16,6 +18,15 @@ Brief Description Base class for all objects affected by physics in 3D space. +Properties +---------- + ++-----------------------+-----------------------------------------------------------+ +| :ref:`int` | :ref:`collision_layer` | ++-----------------------+-----------------------------------------------------------+ +| :ref:`int` | :ref:`collision_mask` | ++-----------------------+-----------------------------------------------------------+ + Methods ------- @@ -42,13 +53,20 @@ Tutorials --------- - :doc:`../tutorials/physics/physics_introduction` - Property Descriptions --------------------- .. _class_PhysicsBody_collision_layer: -- :ref:`int` **collision_layer** - The physics layers this area is in. +- :ref:`int` **collision_layer** + ++----------+----------------------------+ +| *Setter* | set_collision_layer(value) | ++----------+----------------------------+ +| *Getter* | get_collision_layer() | ++----------+----------------------------+ + +The physics layers this area is in. Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the collision_mask property. @@ -56,38 +74,44 @@ A contact is detected if object A is in any of the layers that object B scans, o .. _class_PhysicsBody_collision_mask: -- :ref:`int` **collision_mask** - The physics layers this area can scan for collisions. +- :ref:`int` **collision_mask** ++----------+---------------------------+ +| *Setter* | set_collision_mask(value) | ++----------+---------------------------+ +| *Getter* | get_collision_mask() | ++----------+---------------------------+ + +The physics layers this area can scan for collisions. Method Descriptions ------------------- -.. _class_PhysicsBody_add_collision_exception_with: + .. _class_PhysicsBody_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_layer_bit: + .. _class_PhysicsBody_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const -.. _class_PhysicsBody_get_collision_mask_bit: + .. _class_PhysicsBody_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const -.. _class_PhysicsBody_remove_collision_exception_with: + .. _class_PhysicsBody_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_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** -.. _class_PhysicsBody_set_collision_mask_bit: + .. _class_PhysicsBody_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** - diff --git a/classes/class_physicsbody2d.rst b/classes/class_physicsbody2d.rst index 58ab1d4a5..aa1fe8b96 100644 --- a/classes/class_physicsbody2d.rst +++ b/classes/class_physicsbody2d.rst @@ -8,7 +8,9 @@ PhysicsBody2D ============= **Inherits:** :ref:`CollisionObject2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`RigidBody2D`, :ref:`StaticBody2D`, :ref:`KinematicBody2D` + **Category:** Core Brief Description @@ -16,6 +18,17 @@ Brief Description 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` | ++-----------------------+-------------------------------------------------------------+ + Methods ------- @@ -42,13 +55,20 @@ Tutorials --------- - :doc:`../tutorials/physics/physics_introduction` - Property Descriptions --------------------- .. _class_PhysicsBody2D_collision_layer: -- :ref:`int` **collision_layer** - The physics layers this area is in. +- :ref:`int` **collision_layer** + ++----------+----------------------------+ +| *Setter* | set_collision_layer(value) | ++----------+----------------------------+ +| *Getter* | get_collision_layer() | ++----------+----------------------------+ + +The physics layers this area is in. Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the collision_mask property. @@ -56,50 +76,58 @@ A contact is detected if object A is in any of the layers that object B scans, o .. _class_PhysicsBody2D_collision_mask: -- :ref:`int` **collision_mask** - The physics layers this area can scan for collisions. +- :ref:`int` **collision_mask** + ++----------+---------------------------+ +| *Setter* | set_collision_mask(value) | ++----------+---------------------------+ +| *Getter* | get_collision_mask() | ++----------+---------------------------+ + +The physics layers this area can scan for collisions. .. _class_PhysicsBody2D_layers: -- :ref:`int` **layers** - Both collision_layer and collision_mask. Returns collision_layer when accessed. Updates collision_layers and collision_mask when modified. +- :ref:`int` **layers** +Both collision_layer and collision_mask. Returns collision_layer when accessed. Updates collision_layers and collision_mask when modified. Method Descriptions ------------------- -.. _class_PhysicsBody2D_add_collision_exception_with: + .. _class_PhysicsBody2D_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_layer_bit: + .. _class_PhysicsBody2D_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const Return an individual bit on the collision mask. -.. _class_PhysicsBody2D_get_collision_mask_bit: + .. _class_PhysicsBody2D_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Return an individual bit on the collision mask. -.. _class_PhysicsBody2D_remove_collision_exception_with: + .. _class_PhysicsBody2D_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_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Set/clear individual bits on the layer mask. This makes getting a body in/out of only one layer easier. -.. _class_PhysicsBody2D_set_collision_mask_bit: + .. _class_PhysicsBody2D_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. - diff --git a/classes/class_physicsdirectbodystate.rst b/classes/class_physicsdirectbodystate.rst index ac7d97a55..a7ee229ab 100644 --- a/classes/class_physicsdirectbodystate.rst +++ b/classes/class_physicsdirectbodystate.rst @@ -8,7 +8,9 @@ PhysicsDirectBodyState ====================== **Inherits:** :ref:`Object` + **Inherited By:** :ref:`BulletPhysicsDirectBodyState` + **Category:** Core Brief Description @@ -16,6 +18,35 @@ 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` | ++-----------------------------------+------------------------------------------------------------------------------------+ + Methods ------- @@ -64,57 +95,132 @@ Property Descriptions .. _class_PhysicsDirectBodyState_angular_velocity: -- :ref:`Vector3` **angular_velocity** - The angular velocity of the body. +- :ref:`Vector3` **angular_velocity** + ++----------+-----------------------------+ +| *Setter* | set_angular_velocity(value) | ++----------+-----------------------------+ +| *Getter* | get_angular_velocity() | ++----------+-----------------------------+ + +The angular velocity of the body. .. _class_PhysicsDirectBodyState_center_of_mass: - :ref:`Vector3` **center_of_mass** ++----------+----------------------+ +| *Getter* | get_center_of_mass() | ++----------+----------------------+ + .. _class_PhysicsDirectBodyState_inverse_inertia: -- :ref:`Vector3` **inverse_inertia** - The inverse of the inertia of the body. +- :ref:`Vector3` **inverse_inertia** + ++----------+-----------------------+ +| *Getter* | get_inverse_inertia() | ++----------+-----------------------+ + +The inverse of the inertia of the body. .. _class_PhysicsDirectBodyState_inverse_mass: -- :ref:`float` **inverse_mass** - The inverse of the mass of the body. +- :ref:`float` **inverse_mass** + ++----------+--------------------+ +| *Getter* | get_inverse_mass() | ++----------+--------------------+ + +The inverse of the mass of the body. .. _class_PhysicsDirectBodyState_linear_velocity: -- :ref:`Vector3` **linear_velocity** - The linear velocity of the body. +- :ref:`Vector3` **linear_velocity** + ++----------+----------------------------+ +| *Setter* | set_linear_velocity(value) | ++----------+----------------------------+ +| *Getter* | get_linear_velocity() | ++----------+----------------------------+ + +The linear velocity of the body. .. _class_PhysicsDirectBodyState_principal_inertia_axes: - :ref:`Basis` **principal_inertia_axes** ++----------+------------------------------+ +| *Getter* | get_principal_inertia_axes() | ++----------+------------------------------+ + .. _class_PhysicsDirectBodyState_sleeping: -- :ref:`bool` **sleeping** - ``true`` if this body is currently sleeping (not active). +- :ref:`bool` **sleeping** + ++----------+------------------------+ +| *Setter* | set_sleep_state(value) | ++----------+------------------------+ +| *Getter* | is_sleeping() | ++----------+------------------------+ + +``true`` if this body is currently sleeping (not active). .. _class_PhysicsDirectBodyState_step: -- :ref:`float` **step** - The timestep (delta) used for the simulation. +- :ref:`float` **step** + ++----------+------------+ +| *Getter* | get_step() | ++----------+------------+ + +The timestep (delta) used for the simulation. .. _class_PhysicsDirectBodyState_total_angular_damp: -- :ref:`float` **total_angular_damp** - The rate at which the body stops rotating, if there are not any other forces moving it. +- :ref:`float` **total_angular_damp** + ++----------+--------------------------+ +| *Getter* | get_total_angular_damp() | ++----------+--------------------------+ + +The rate at which the body stops rotating, if there are not any other forces moving it. .. _class_PhysicsDirectBodyState_total_gravity: -- :ref:`Vector3` **total_gravity** - The total gravity vector being currently applied to this body. +- :ref:`Vector3` **total_gravity** + ++----------+---------------------+ +| *Getter* | get_total_gravity() | ++----------+---------------------+ + +The total gravity vector being currently applied to this body. .. _class_PhysicsDirectBodyState_total_linear_damp: -- :ref:`float` **total_linear_damp** - The rate at which the body stops moving, if there are not any other forces moving it. +- :ref:`float` **total_linear_damp** + ++----------+-------------------------+ +| *Getter* | get_total_linear_damp() | ++----------+-------------------------+ + +The rate at which the body stops moving, if there are not any other forces moving it. .. _class_PhysicsDirectBodyState_transform: -- :ref:`Transform` **transform** - The transformation matrix of the body. +- :ref:`Transform` **transform** ++----------+----------------------+ +| *Setter* | set_transform(value) | ++----------+----------------------+ +| *Getter* | get_transform() | ++----------+----------------------+ + +The transformation matrix of the body. Method Descriptions ------------------- -.. _class_PhysicsDirectBodyState_add_central_force: + .. _class_PhysicsDirectBodyState_add_central_force: - void **add_central_force** **(** :ref:`Vector3` force **)** @@ -122,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_add_force: - void **add_force** **(** :ref:`Vector3` force, :ref:`Vector3` position **)** Adds a constant force (i.e. acceleration). -.. _class_PhysicsDirectBodyState_add_torque: + .. _class_PhysicsDirectBodyState_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_apply_central_impulse: - void **apply_central_impulse** **(** :ref:`Vector3` j **)** @@ -142,70 +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_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_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_get_contact_collider: - :ref:`RID` **get_contact_collider** **(** :ref:`int` contact_idx **)** const -.. _class_PhysicsDirectBodyState_get_contact_collider_id: + .. _class_PhysicsDirectBodyState_get_contact_collider_id: - :ref:`int` **get_contact_collider_id** **(** :ref:`int` contact_idx **)** const -.. _class_PhysicsDirectBodyState_get_contact_collider_object: + .. _class_PhysicsDirectBodyState_get_contact_collider_object: - :ref:`Object` **get_contact_collider_object** **(** :ref:`int` contact_idx **)** const -.. _class_PhysicsDirectBodyState_get_contact_collider_position: + .. _class_PhysicsDirectBodyState_get_contact_collider_position: - :ref:`Vector3` **get_contact_collider_position** **(** :ref:`int` contact_idx **)** const -.. _class_PhysicsDirectBodyState_get_contact_collider_shape: + .. _class_PhysicsDirectBodyState_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_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_get_contact_count: - :ref:`int` **get_contact_count** **(** **)** const -.. _class_PhysicsDirectBodyState_get_contact_impulse: + .. _class_PhysicsDirectBodyState_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_get_contact_local_normal: - :ref:`Vector3` **get_contact_local_normal** **(** :ref:`int` contact_idx **)** const -.. _class_PhysicsDirectBodyState_get_contact_local_position: + .. _class_PhysicsDirectBodyState_get_contact_local_position: - :ref:`Vector3` **get_contact_local_position** **(** :ref:`int` contact_idx **)** const -.. _class_PhysicsDirectBodyState_get_contact_local_shape: + .. _class_PhysicsDirectBodyState_get_contact_local_shape: - :ref:`int` **get_contact_local_shape** **(** :ref:`int` contact_idx **)** const -.. _class_PhysicsDirectBodyState_get_space_state: + .. _class_PhysicsDirectBodyState_get_space_state: - :ref:`PhysicsDirectSpaceState` **get_space_state** **(** **)** -.. _class_PhysicsDirectBodyState_integrate_forces: + .. _class_PhysicsDirectBodyState_integrate_forces: - void **integrate_forces** **(** **)** - diff --git a/classes/class_physicsdirectspacestate.rst b/classes/class_physicsdirectspacestate.rst index 977b6ad74..0672a4ab7 100644 --- a/classes/class_physicsdirectspacestate.rst +++ b/classes/class_physicsdirectspacestate.rst @@ -8,6 +8,7 @@ PhysicsDirectSpaceState ======================= **Inherits:** :ref:`Object` + **Category:** Core Brief Description @@ -39,11 +40,10 @@ Tutorials --------- - :doc:`../tutorials/physics/ray-casting` - Method Descriptions ------------------- -.. _class_PhysicsDirectSpaceState_cast_motion: + .. _class_PhysicsDirectSpaceState_cast_motion: - :ref:`Array` **cast_motion** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`Vector3` motion **)** @@ -51,13 +51,13 @@ Checks whether the shape can travel to a point. The method will return an array If the shape can not move, the array will be empty. -.. _class_PhysicsDirectSpaceState_collide_shape: + .. _class_PhysicsDirectSpaceState_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. -.. _class_PhysicsDirectSpaceState_get_rest_info: + .. _class_PhysicsDirectSpaceState_get_rest_info: - :ref:`Dictionary` **get_rest_info** **(** :ref:`PhysicsShapeQueryParameters` shape **)** @@ -77,7 +77,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_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 **)** @@ -99,7 +99,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_intersect_shape: - :ref:`Array` **intersect_shape** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** @@ -115,4 +115,3 @@ Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryPara The number of intersections can be limited with the second parameter, to reduce the processing time. - diff --git a/classes/class_physicsmaterial.rst b/classes/class_physicsmaterial.rst index b79823c16..977150482 100644 --- a/classes/class_physicsmaterial.rst +++ b/classes/class_physicsmaterial.rst @@ -8,6 +8,7 @@ PhysicsMaterial =============== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,19 @@ Brief Description A material for physics properties. +Properties +---------- + ++---------------------------+---------------------------------------------------+ +| :ref:`bool` | :ref:`absorbent` | ++---------------------------+---------------------------------------------------+ +| :ref:`float` | :ref:`bounce` | ++---------------------------+---------------------------------------------------+ +| :ref:`float` | :ref:`friction` | ++---------------------------+---------------------------------------------------+ +| :ref:`bool` | :ref:`rough` | ++---------------------------+---------------------------------------------------+ + Description ----------- @@ -27,16 +41,43 @@ Property Descriptions - :ref:`bool` **absorbent** ++----------+----------------------+ +| *Setter* | set_absorbent(value) | ++----------+----------------------+ +| *Getter* | is_absorbent() | ++----------+----------------------+ + .. _class_PhysicsMaterial_bounce: -- :ref:`float` **bounce** - The body's bounciness. Default value: ``0``. +- :ref:`float` **bounce** + ++----------+-------------------+ +| *Setter* | set_bounce(value) | ++----------+-------------------+ +| *Getter* | get_bounce() | ++----------+-------------------+ + +The body's bounciness. Default value: ``0``. .. _class_PhysicsMaterial_friction: -- :ref:`float` **friction** - The body's friction. Values range from ``0`` (frictionless) to ``1`` (maximum friction). Default value: ``1``. +- :ref:`float` **friction** + ++----------+---------------------+ +| *Setter* | set_friction(value) | ++----------+---------------------+ +| *Getter* | get_friction() | ++----------+---------------------+ + +The body's friction. Values range from ``0`` (frictionless) to ``1`` (maximum friction). Default value: ``1``. .. _class_PhysicsMaterial_rough: - :ref:`bool` **rough** ++----------+------------------+ +| *Setter* | set_rough(value) | ++----------+------------------+ +| *Getter* | is_rough() | ++----------+------------------+ diff --git a/classes/class_physicsserver.rst b/classes/class_physicsserver.rst index 0ce7a576b..9d4fa12ea 100644 --- a/classes/class_physicsserver.rst +++ b/classes/class_physicsserver.rst @@ -8,7 +8,9 @@ PhysicsServer ============= **Inherits:** :ref:`Object` + **Inherited By:** :ref:`BulletPhysicsServer` + **Category:** Core Brief Description @@ -248,7 +250,7 @@ Enumerations .. _enum_PhysicsServer_BodyState: -enum **BodyState** +enum **BodyState**: - **BODY_STATE_TRANSFORM** = **0** --- Constant to set/get the current transform matrix of the body. - **BODY_STATE_LINEAR_VELOCITY** = **1** --- Constant to set/get the current linear velocity of the body. @@ -258,7 +260,7 @@ enum **BodyState** .. _enum_PhysicsServer_G6DOFJointAxisParam: -enum **G6DOFJointAxisParam** +enum **G6DOFJointAxisParam**: - **G6DOF_JOINT_LINEAR_LOWER_LIMIT** = **0** --- The minimum difference between the pivot points' axes. - **G6DOF_JOINT_LINEAR_UPPER_LIMIT** = **1** --- The maximum difference between the pivot points' axes. @@ -279,7 +281,7 @@ enum **G6DOFJointAxisParam** .. _enum_PhysicsServer_ProcessInfo: -enum **ProcessInfo** +enum **ProcessInfo**: - **INFO_ACTIVE_OBJECTS** = **0** --- Constant to get the number of objects that are not sleeping. - **INFO_COLLISION_PAIRS** = **1** --- Constant to get the number of possible collisions. @@ -287,7 +289,7 @@ enum **ProcessInfo** .. _enum_PhysicsServer_ShapeType: -enum **ShapeType** +enum **ShapeType**: - **SHAPE_PLANE** = **0** --- The :ref:`Shape` is a :ref:`PlaneShape`. - **SHAPE_RAY** = **1** --- The :ref:`Shape` is a :ref:`RayShape`. @@ -302,14 +304,14 @@ enum **ShapeType** .. _enum_PhysicsServer_HingeJointFlag: -enum **HingeJointFlag** +enum **HingeJointFlag**: - **HINGE_JOINT_FLAG_USE_LIMIT** = **0** --- If ``true`` the Hinge has a maximum and a minimum rotation. - **HINGE_JOINT_FLAG_ENABLE_MOTOR** = **1** --- If ``true`` a motor turns the Hinge .. _enum_PhysicsServer_AreaParameter: -enum **AreaParameter** +enum **AreaParameter**: - **AREA_PARAM_GRAVITY** = **0** --- Constant to set/get gravity strength in an area. - **AREA_PARAM_GRAVITY_VECTOR** = **1** --- Constant to set/get gravity vector/center in an area. @@ -322,7 +324,7 @@ enum **AreaParameter** .. _enum_PhysicsServer_PinJointParam: -enum **PinJointParam** +enum **PinJointParam**: - **PIN_JOINT_BIAS** = **0** --- The strength with which the pinned objects try to stay in positional relation to each other. @@ -334,7 +336,7 @@ The higher, the stronger. .. _enum_PhysicsServer_BodyParameter: -enum **BodyParameter** +enum **BodyParameter**: - **BODY_PARAM_BOUNCE** = **0** --- Constant to set/get a body's bounce factor. - **BODY_PARAM_FRICTION** = **1** --- Constant to set/get a body's friction. @@ -346,7 +348,7 @@ enum **BodyParameter** .. _enum_PhysicsServer_BodyMode: -enum **BodyMode** +enum **BodyMode**: - **BODY_MODE_STATIC** = **0** --- Constant for static bodies. - **BODY_MODE_KINEMATIC** = **1** --- Constant for kinematic bodies. @@ -356,7 +358,7 @@ enum **BodyMode** .. _enum_PhysicsServer_SpaceParameter: -enum **SpaceParameter** +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. - **SPACE_PARAM_CONTACT_MAX_SEPARATION** = **1** --- Constant to set/get the maximum distance a shape can be from another before they are considered separated. @@ -369,14 +371,14 @@ enum **SpaceParameter** .. _enum_PhysicsServer_AreaBodyStatus: -enum **AreaBodyStatus** +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. - **AREA_BODY_REMOVED** = **1** --- The value of the first parameter and area callback function receives, when an object exits one of its shapes. .. _enum_PhysicsServer_BodyAxis: -enum **BodyAxis** +enum **BodyAxis**: - **BODY_AXIS_LINEAR_X** = **1** - **BODY_AXIS_LINEAR_Y** = **2** @@ -387,7 +389,7 @@ enum **BodyAxis** .. _enum_PhysicsServer_JointType: -enum **JointType** +enum **JointType**: - **JOINT_PIN** = **0** --- The :ref:`Joint` is a :ref:`PinJoint`. - **JOINT_HINGE** = **1** --- The :ref:`Joint` is a :ref:`HingeJoint`. @@ -397,7 +399,7 @@ enum **JointType** .. _enum_PhysicsServer_AreaSpaceOverrideMode: -enum **AreaSpaceOverrideMode** +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. - **AREA_SPACE_OVERRIDE_COMBINE** = **1** --- This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects. @@ -407,7 +409,7 @@ enum **AreaSpaceOverrideMode** .. _enum_PhysicsServer_G6DOFJointAxisFlag: -enum **G6DOFJointAxisFlag** +enum **G6DOFJointAxisFlag**: - **G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT** = **0** --- If ``set`` there is linear motion possible within the given limits. - **G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT** = **1** --- If ``set`` there is rotational motion possible. @@ -416,7 +418,7 @@ enum **G6DOFJointAxisFlag** .. _enum_PhysicsServer_SliderJointParam: -enum **SliderJointParam** +enum **SliderJointParam**: - **SLIDER_JOINT_LINEAR_LIMIT_UPPER** = **0** --- The maximum difference between the pivot points on their x-axis before damping happens. - **SLIDER_JOINT_LINEAR_LIMIT_LOWER** = **1** --- The minimum difference between the pivot points on their x-axis before damping happens. @@ -444,7 +446,7 @@ enum **SliderJointParam** .. _enum_PhysicsServer_ConeTwistJointParam: -enum **ConeTwistJointParam** +enum **ConeTwistJointParam**: - **CONE_TWIST_JOINT_SWING_SPAN** = **0** --- Swing is rotation from side to side, around the axis perpendicular to the twist axis. @@ -464,7 +466,7 @@ The higher, the faster. .. _enum_PhysicsServer_HingeJointParam: -enum **HingeJointParam** +enum **HingeJointParam**: - **HINGE_JOINT_BIAS** = **0** --- The speed with which the two bodies get pulled together when they move in different directions. - **HINGE_JOINT_LIMIT_UPPER** = **1** --- The maximum rotation across the Hinge. @@ -475,7 +477,6 @@ enum **HingeJointParam** - **HINGE_JOINT_MOTOR_TARGET_VELOCITY** = **6** --- Target speed for the motor. - **HINGE_JOINT_MOTOR_MAX_IMPULSE** = **7** --- Maximum acceleration for the motor. - Description ----------- @@ -484,107 +485,107 @@ Everything related to physics in 3D. Method Descriptions ------------------- -.. _class_PhysicsServer_area_add_shape: + .. _class_PhysicsServer_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_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_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_area_create: - :ref:`RID` **area_create** **(** **)** Creates an :ref:`Area`. -.. _class_PhysicsServer_area_get_object_instance_id: + .. _class_PhysicsServer_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_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_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_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_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_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_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_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_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_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_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_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_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_area_set_monitor_callback: - void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** @@ -600,117 +601,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_area_set_monitorable: - void **area_set_monitorable** **(** :ref:`RID` area, :ref:`bool` monitorable **)** -.. _class_PhysicsServer_area_set_param: + .. _class_PhysicsServer_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_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_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_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_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_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_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_body_add_central_force: - void **body_add_central_force** **(** :ref:`RID` body, :ref:`Vector3` force **)** -.. _class_PhysicsServer_body_add_collision_exception: + .. _class_PhysicsServer_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_body_add_force: - void **body_add_force** **(** :ref:`RID` body, :ref:`Vector3` force, :ref:`Vector3` position **)** -.. _class_PhysicsServer_body_add_shape: + .. _class_PhysicsServer_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_body_add_torque: - void **body_add_torque** **(** :ref:`RID` body, :ref:`Vector3` torque **)** -.. _class_PhysicsServer_body_apply_central_impulse: + .. _class_PhysicsServer_body_apply_central_impulse: - void **body_apply_central_impulse** **(** :ref:`RID` body, :ref:`Vector3` impulse **)** -.. _class_PhysicsServer_body_apply_impulse: + .. _class_PhysicsServer_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_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_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_body_clear_shapes: - void **body_clear_shapes** **(** :ref:`RID` body **)** Removes all shapes from a body. -.. _class_PhysicsServer_body_create: + .. _class_PhysicsServer_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_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_body_get_collision_mask: - :ref:`int` **body_get_collision_mask** **(** :ref:`RID` body **)** const @@ -718,93 +719,93 @@ Returns the physics layer or layers a body can collide with. - -.. _class_PhysicsServer_body_get_direct_state: + .. _class_PhysicsServer_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_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_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`. -.. _class_PhysicsServer_body_get_mode: + .. _class_PhysicsServer_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_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_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_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_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_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_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_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_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_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_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`). -.. _class_PhysicsServer_body_is_ray_pickable: + .. _class_PhysicsServer_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_body_remove_collision_exception: - void **body_remove_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** @@ -812,35 +813,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_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_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_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_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_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_body_set_enable_continuous_collision_detection: - void **body_set_enable_continuous_collision_detection** **(** :ref:`RID` body, :ref:`bool` enable **)** @@ -848,302 +849,301 @@ 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_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`). -.. _class_PhysicsServer_body_set_kinematic_safe_margin: + .. _class_PhysicsServer_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_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_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_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`). -.. _class_PhysicsServer_body_set_param: + .. _class_PhysicsServer_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_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_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_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_body_set_space: - void **body_set_space** **(** :ref:`RID` body, :ref:`RID` space **)** Assigns a space to the body (see :ref:`create_space`). -.. _class_PhysicsServer_body_set_state: + .. _class_PhysicsServer_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_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_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_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_generic_6dof_joint_get_flag: - :ref:`bool` **generic_6dof_joint_get_flag** **(** :ref:`RID` joint, :ref:`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_generic_6dof_joint_get_param: - :ref:`float` **generic_6dof_joint_get_param** **(** :ref:`RID` joint, :ref:`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_generic_6dof_joint_set_flag: - void **generic_6dof_joint_set_flag** **(** :ref:`RID` joint, :ref:`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_generic_6dof_joint_set_param: - void **generic_6dof_joint_set_param** **(** :ref:`RID` joint, :ref:`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_get_process_info: - :ref:`int` **get_process_info** **(** :ref:`ProcessInfo` process_info **)** Returns an Info defined by the ProcessInfo input given. -.. _class_PhysicsServer_hinge_joint_get_flag: + .. _class_PhysicsServer_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_set_active: - void **set_active** **(** :ref:`bool` active **)** Activates or deactivates the 3D physics engine. -.. _class_PhysicsServer_shape_create: + .. _class_PhysicsServer_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`. -.. _class_PhysicsServer_shape_get_data: + .. _class_PhysicsServer_shape_get_data: - :ref:`Variant` **shape_get_data** **(** :ref:`RID` shape **)** const Returns the shape data. -.. _class_PhysicsServer_shape_get_type: + .. _class_PhysicsServer_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_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`. -.. _class_PhysicsServer_slider_joint_get_param: + .. _class_PhysicsServer_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_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_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`. -.. _class_PhysicsServer_space_get_direct_state: + .. _class_PhysicsServer_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_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_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_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_space_set_param: - void **space_set_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** Sets the value for a space parameter. A list of available parameters is on the SPACE_PARAM\_\* constants. - diff --git a/classes/class_physicsshapequeryparameters.rst b/classes/class_physicsshapequeryparameters.rst index 157ec40ac..838787858 100644 --- a/classes/class_physicsshapequeryparameters.rst +++ b/classes/class_physicsshapequeryparameters.rst @@ -8,6 +8,7 @@ PhysicsShapeQueryParameters =========================== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,25 @@ 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` | ++-----------------------------------+-----------------------------------------------------------------------------------+ + Methods ------- @@ -29,36 +49,76 @@ Property Descriptions - :ref:`bool` **collide_with_areas** ++----------+---------------------------------+ +| *Setter* | set_collide_with_areas(value) | ++----------+---------------------------------+ +| *Getter* | is_collide_with_areas_enabled() | ++----------+---------------------------------+ + .. _class_PhysicsShapeQueryParameters_collide_with_bodies: - :ref:`bool` **collide_with_bodies** ++----------+----------------------------------+ +| *Setter* | set_collide_with_bodies(value) | ++----------+----------------------------------+ +| *Getter* | is_collide_with_bodies_enabled() | ++----------+----------------------------------+ + .. _class_PhysicsShapeQueryParameters_collision_mask: - :ref:`int` **collision_mask** ++----------+---------------------------+ +| *Setter* | set_collision_mask(value) | ++----------+---------------------------+ +| *Getter* | get_collision_mask() | ++----------+---------------------------+ + .. _class_PhysicsShapeQueryParameters_exclude: - :ref:`Array` **exclude** ++----------+--------------------+ +| *Setter* | set_exclude(value) | ++----------+--------------------+ +| *Getter* | get_exclude() | ++----------+--------------------+ + .. _class_PhysicsShapeQueryParameters_margin: - :ref:`float` **margin** ++----------+-------------------+ +| *Setter* | set_margin(value) | ++----------+-------------------+ +| *Getter* | get_margin() | ++----------+-------------------+ + .. _class_PhysicsShapeQueryParameters_shape_rid: - :ref:`RID` **shape_rid** ++----------+----------------------+ +| *Setter* | set_shape_rid(value) | ++----------+----------------------+ +| *Getter* | get_shape_rid() | ++----------+----------------------+ + .. _class_PhysicsShapeQueryParameters_transform: - :ref:`Transform` **transform** ++----------+----------------------+ +| *Setter* | set_transform(value) | ++----------+----------------------+ +| *Getter* | get_transform() | ++----------+----------------------+ Method Descriptions ------------------- -.. _class_PhysicsShapeQueryParameters_set_shape: + .. _class_PhysicsShapeQueryParameters_set_shape: - void **set_shape** **(** :ref:`Resource` shape **)** - diff --git a/classes/class_physicsshapequeryresult.rst b/classes/class_physicsshapequeryresult.rst index 5f483d3e3..9388afc6b 100644 --- a/classes/class_physicsshapequeryresult.rst +++ b/classes/class_physicsshapequeryresult.rst @@ -8,6 +8,7 @@ PhysicsShapeQueryResult ======================= **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -33,24 +34,23 @@ Methods Method Descriptions ------------------- -.. _class_PhysicsShapeQueryResult_get_result_count: + .. _class_PhysicsShapeQueryResult_get_result_count: - :ref:`int` **get_result_count** **(** **)** const -.. _class_PhysicsShapeQueryResult_get_result_object: + .. _class_PhysicsShapeQueryResult_get_result_object: - :ref:`Object` **get_result_object** **(** :ref:`int` idx **)** const -.. _class_PhysicsShapeQueryResult_get_result_object_id: + .. _class_PhysicsShapeQueryResult_get_result_object_id: - :ref:`int` **get_result_object_id** **(** :ref:`int` idx **)** const -.. _class_PhysicsShapeQueryResult_get_result_object_shape: + .. _class_PhysicsShapeQueryResult_get_result_object_shape: - :ref:`int` **get_result_object_shape** **(** :ref:`int` idx **)** const -.. _class_PhysicsShapeQueryResult_get_result_rid: + .. _class_PhysicsShapeQueryResult_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 8fd64ab07..a8221d8de 100644 --- a/classes/class_pinjoint.rst +++ b/classes/class_pinjoint.rst @@ -8,6 +8,7 @@ PinJoint ======== **Inherits:** :ref:`Joint` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,12 +16,23 @@ Brief Description Pin Joint for 3D Shapes. +Properties +---------- + ++---------------------------+------------------------------------------------------------------+ +| :ref:`float` | :ref:`params/bias` | ++---------------------------+------------------------------------------------------------------+ +| :ref:`float` | :ref:`params/damping` | ++---------------------------+------------------------------------------------------------------+ +| :ref:`float` | :ref:`params/impulse_clamp` | ++---------------------------+------------------------------------------------------------------+ + Enumerations ------------ .. _enum_PinJoint_Param: -enum **Param** +enum **Param**: - **PARAM_BIAS** = **0** --- The force with which the pinned objects stay in positional relation to each other. @@ -30,7 +42,6 @@ The higher, the stronger. The higher, the stronger. - **PARAM_IMPULSE_CLAMP** = **2** --- If above 0, this value is the maximum value for an impulse that this Joint produces. - Description ----------- @@ -41,18 +52,41 @@ Property Descriptions .. _class_PinJoint_params/bias: -- :ref:`float` **params/bias** - The force with which the pinned objects stay in positional relation to each other. +- :ref:`float` **params/bias** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +The force with which the pinned objects stay in positional relation to each other. The higher, the stronger. .. _class_PinJoint_params/damping: -- :ref:`float` **params/damping** - The force with which the pinned objects stay in velocity relation to each other. +- :ref:`float` **params/damping** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +The force with which the pinned objects stay in velocity relation to each other. The higher, the stronger. .. _class_PinJoint_params/impulse_clamp: -- :ref:`float` **params/impulse_clamp** - If above 0, this value is the maximum value for an impulse that this Joint produces. +- :ref:`float` **params/impulse_clamp** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +If above 0, this value is the maximum value for an impulse that this Joint produces. diff --git a/classes/class_pinjoint2d.rst b/classes/class_pinjoint2d.rst index c9437fc5c..3c0e3d03b 100644 --- a/classes/class_pinjoint2d.rst +++ b/classes/class_pinjoint2d.rst @@ -8,6 +8,7 @@ PinJoint2D ========== **Inherits:** :ref:`Joint2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Pin Joint for 2D Shapes. +Properties +---------- + ++---------------------------+--------------------------------------------+ +| :ref:`float` | :ref:`softness` | ++---------------------------+--------------------------------------------+ + Description ----------- @@ -25,6 +33,13 @@ Property Descriptions .. _class_PinJoint2D_softness: -- :ref:`float` **softness** - The higher this value, the more the bond to the pinned partner can flex. +- :ref:`float` **softness** ++----------+---------------------+ +| *Setter* | set_softness(value) | ++----------+---------------------+ +| *Getter* | get_softness() | ++----------+---------------------+ + +The higher this value, the more the bond to the pinned partner can flex. diff --git a/classes/class_plane.rst b/classes/class_plane.rst index 0349033f3..2a47aa211 100644 --- a/classes/class_plane.rst +++ b/classes/class_plane.rst @@ -14,6 +14,21 @@ Brief Description 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` | ++-------------------------------+-----------------------------------+ + Methods ------- @@ -51,7 +66,6 @@ Constants - **PLANE_YZ** = **Plane( 1, 0, 0, 0 )** - **PLANE_XZ** = **Plane( 0, 1, 0, 0 )** - **PLANE_XY** = **Plane( 0, 0, 1, 0 )** - Description ----------- @@ -61,7 +75,6 @@ Tutorials --------- - :doc:`../tutorials/math/index` - Property Descriptions --------------------- @@ -85,86 +98,84 @@ Property Descriptions - :ref:`float` **z** - Method Descriptions ------------------- -.. _class_Plane_Plane: + .. _class_Plane_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: + .. _class_Plane_Plane: - :ref:`Plane` **Plane** **(** :ref:`Vector3` v1, :ref:`Vector3` v2, :ref:`Vector3` v3 **)** Creates a plane from three points. -.. _class_Plane_Plane: + .. _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_center: - :ref:`Vector3` **center** **(** **)** Returns the center of the plane. -.. _class_Plane_distance_to: + .. _class_Plane_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_get_any_point: - :ref:`Vector3` **get_any_point** **(** **)** Returns a point on the plane. -.. _class_Plane_has_point: + .. _class_Plane_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_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_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_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_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_normalized: - :ref:`Plane` **normalized** **(** **)** Returns a copy of the plane, normalized. -.. _class_Plane_project: + .. _class_Plane_project: - :ref:`Vector3` **project** **(** :ref:`Vector3` point **)** Returns the orthogonal projection of point "p" into a point in the plane. - diff --git a/classes/class_planemesh.rst b/classes/class_planemesh.rst index 09ba1bbc7..0ce72c6f9 100644 --- a/classes/class_planemesh.rst +++ b/classes/class_planemesh.rst @@ -8,6 +8,7 @@ PlaneMesh ========= **Inherits:** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,17 @@ Brief Description Class representing a planar :ref:`PrimitiveMesh`. +Properties +---------- + ++-------------------------------+---------------------------------------------------------+ +| :ref:`Vector2` | :ref:`size` | ++-------------------------------+---------------------------------------------------------+ +| :ref:`int` | :ref:`subdivide_depth` | ++-------------------------------+---------------------------------------------------------+ +| :ref:`int` | :ref:`subdivide_width` | ++-------------------------------+---------------------------------------------------------+ + Description ----------- @@ -25,14 +37,37 @@ Property Descriptions .. _class_PlaneMesh_size: -- :ref:`Vector2` **size** - Size of the generated plane. Defaults to (2.0, 2.0). +- :ref:`Vector2` **size** + ++----------+-----------------+ +| *Setter* | set_size(value) | ++----------+-----------------+ +| *Getter* | get_size() | ++----------+-----------------+ + +Size of the generated plane. Defaults to (2.0, 2.0). .. _class_PlaneMesh_subdivide_depth: -- :ref:`int` **subdivide_depth** - Number of subdivision along the z-axis. Defaults to 0. +- :ref:`int` **subdivide_depth** + ++----------+----------------------------+ +| *Setter* | set_subdivide_depth(value) | ++----------+----------------------------+ +| *Getter* | get_subdivide_depth() | ++----------+----------------------------+ + +Number of subdivision along the z-axis. Defaults to 0. .. _class_PlaneMesh_subdivide_width: -- :ref:`int` **subdivide_width** - Number of subdivision along the x-axis. Defaults to 0. +- :ref:`int` **subdivide_width** ++----------+----------------------------+ +| *Setter* | set_subdivide_width(value) | ++----------+----------------------------+ +| *Getter* | get_subdivide_width() | ++----------+----------------------------+ + +Number of subdivision along the x-axis. Defaults to 0. diff --git a/classes/class_planeshape.rst b/classes/class_planeshape.rst index 381618476..2e58bd26b 100644 --- a/classes/class_planeshape.rst +++ b/classes/class_planeshape.rst @@ -8,6 +8,7 @@ PlaneShape ========== **Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description +Properties +---------- + ++---------------------------+--------------------------------------+ +| :ref:`Plane` | :ref:`plane` | ++---------------------------+--------------------------------------+ + Property Descriptions --------------------- @@ -22,4 +30,9 @@ Property Descriptions - :ref:`Plane` **plane** ++----------+------------------+ +| *Setter* | set_plane(value) | ++----------+------------------+ +| *Getter* | get_plane() | ++----------+------------------+ diff --git a/classes/class_pluginscript.rst b/classes/class_pluginscript.rst index 65cf8ae9c..d659cf117 100644 --- a/classes/class_pluginscript.rst +++ b/classes/class_pluginscript.rst @@ -8,6 +8,7 @@ PluginScript ============ **Inherits:** :ref:`Script` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_polygon2d.rst b/classes/class_polygon2d.rst index fb688f741..fd3f2cdac 100644 --- a/classes/class_polygon2d.rst +++ b/classes/class_polygon2d.rst @@ -8,6 +8,7 @@ Polygon2D ========= **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,43 @@ Brief Description 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` | ++-------------------------------------------------+---------------------------------------------------------------------------+ + Methods ------- @@ -46,7 +84,15 @@ Property Descriptions .. _class_Polygon2D_antialiased: -- :ref:`bool` **antialiased** - If ``true`` polygon edges will be anti-aliased. Default value: ``false``. +- :ref:`bool` **antialiased** + ++----------+------------------------+ +| *Setter* | set_antialiased(value) | ++----------+------------------------+ +| *Getter* | get_antialiased() | ++----------+------------------------+ + +If ``true`` polygon edges will be anti-aliased. Default value: ``false``. .. _class_Polygon2D_bones: @@ -54,94 +100,200 @@ Property Descriptions .. _class_Polygon2D_color: -- :ref:`Color` **color** - 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``. +- :ref:`Color` **color** + ++----------+------------------+ +| *Setter* | set_color(value) | ++----------+------------------+ +| *Getter* | get_color() | ++----------+------------------+ + +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: -- :ref:`float` **invert_border** - 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``. +- :ref:`float` **invert_border** + ++----------+--------------------------+ +| *Setter* | set_invert_border(value) | ++----------+--------------------------+ +| *Getter* | get_invert_border() | ++----------+--------------------------+ + +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: -- :ref:`bool` **invert_enable** - If ``true`` polygon will be inverted, containing the area outside the defined points and extending to the ``invert_border``. Default value: ``false``. +- :ref:`bool` **invert_enable** + ++----------+-------------------+ +| *Setter* | set_invert(value) | ++----------+-------------------+ +| *Getter* | get_invert() | ++----------+-------------------+ + +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: -- :ref:`Vector2` **offset** - The offset applied to each vertex. +- :ref:`Vector2` **offset** + ++----------+-------------------+ +| *Setter* | set_offset(value) | ++----------+-------------------+ +| *Getter* | get_offset() | ++----------+-------------------+ + +The offset applied to each vertex. .. _class_Polygon2D_polygon: -- :ref:`PoolVector2Array` **polygon** - The polygon's list of vertices. The final point will be connected to the first. +- :ref:`PoolVector2Array` **polygon** + ++----------+--------------------+ +| *Setter* | set_polygon(value) | ++----------+--------------------+ +| *Getter* | get_polygon() | ++----------+--------------------+ + +The polygon's list of vertices. The final point will be connected to the first. .. _class_Polygon2D_skeleton: - :ref:`NodePath` **skeleton** ++----------+---------------------+ +| *Setter* | set_skeleton(value) | ++----------+---------------------+ +| *Getter* | get_skeleton() | ++----------+---------------------+ + .. _class_Polygon2D_splits: - :ref:`PoolIntArray` **splits** ++----------+-------------------+ +| *Setter* | set_splits(value) | ++----------+-------------------+ +| *Getter* | get_splits() | ++----------+-------------------+ + .. _class_Polygon2D_texture: -- :ref:`Texture` **texture** - The polygon's fill texture. Use ``uv`` to set texture coordinates. +- :ref:`Texture` **texture** + ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + +The polygon's fill texture. Use ``uv`` to set texture coordinates. .. _class_Polygon2D_texture_offset: -- :ref:`Vector2` **texture_offset** - 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``. +- :ref:`Vector2` **texture_offset** + ++----------+---------------------------+ +| *Setter* | set_texture_offset(value) | ++----------+---------------------------+ +| *Getter* | get_texture_offset() | ++----------+---------------------------+ + +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: -- :ref:`float` **texture_rotation** - The texture's rotation in radians. +- :ref:`float` **texture_rotation** + ++----------+-------------------------------------+ +| *Setter* | set_texture_rotation_degrees(value) | ++----------+-------------------------------------+ +| *Getter* | get_texture_rotation_degrees() | ++----------+-------------------------------------+ + +The texture's rotation in radians. .. _class_Polygon2D_texture_rotation_degrees: -- :ref:`float` **texture_rotation_degrees** - The texture's rotation in degrees. +- :ref:`float` **texture_rotation_degrees** + ++----------+-------------------------------------+ +| *Setter* | set_texture_rotation_degrees(value) | ++----------+-------------------------------------+ +| *Getter* | get_texture_rotation_degrees() | ++----------+-------------------------------------+ + +The texture's rotation in degrees. .. _class_Polygon2D_texture_scale: -- :ref:`Vector2` **texture_scale** - Amount to multiply the ``uv`` coordinates when using a ``texture``. Larger values make the texture smaller, and vice versa. +- :ref:`Vector2` **texture_scale** + ++----------+--------------------------+ +| *Setter* | set_texture_scale(value) | ++----------+--------------------------+ +| *Getter* | get_texture_scale() | ++----------+--------------------------+ + +Amount to multiply the ``uv`` coordinates when using a ``texture``. Larger values make the texture smaller, and vice versa. .. _class_Polygon2D_uv: -- :ref:`PoolVector2Array` **uv** - 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)``. +- :ref:`PoolVector2Array` **uv** + ++----------+---------------+ +| *Setter* | set_uv(value) | ++----------+---------------+ +| *Getter* | get_uv() | ++----------+---------------+ + +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: -- :ref:`PoolColorArray` **vertex_colors** - Color for each vertex. Colors are interpolated between vertices, resulting in smooth gradients. There should be one per polygon vertex. If there are fewer, undefined vertices will use ``color``. +- :ref:`PoolColorArray` **vertex_colors** ++----------+--------------------------+ +| *Setter* | set_vertex_colors(value) | ++----------+--------------------------+ +| *Getter* | get_vertex_colors() | ++----------+--------------------------+ + +Color for each vertex. Colors are interpolated between vertices, resulting in smooth gradients. There should be one per polygon vertex. If there are fewer, undefined vertices will use ``color``. Method Descriptions ------------------- -.. _class_Polygon2D_add_bone: + .. _class_Polygon2D_add_bone: - void **add_bone** **(** :ref:`NodePath` path, :ref:`PoolRealArray` weights **)** -.. _class_Polygon2D_clear_bones: + .. _class_Polygon2D_clear_bones: - void **clear_bones** **(** **)** -.. _class_Polygon2D_erase_bone: + .. _class_Polygon2D_erase_bone: - void **erase_bone** **(** :ref:`int` index **)** -.. _class_Polygon2D_get_bone_count: + .. _class_Polygon2D_get_bone_count: - :ref:`int` **get_bone_count** **(** **)** const -.. _class_Polygon2D_get_bone_path: + .. _class_Polygon2D_get_bone_path: - :ref:`NodePath` **get_bone_path** **(** :ref:`int` index **)** const -.. _class_Polygon2D_get_bone_weights: + .. _class_Polygon2D_get_bone_weights: - :ref:`PoolRealArray` **get_bone_weights** **(** :ref:`int` index **)** const -.. _class_Polygon2D_set_bone_path: + .. _class_Polygon2D_set_bone_path: - void **set_bone_path** **(** :ref:`int` index, :ref:`NodePath` path **)** -.. _class_Polygon2D_set_bone_weights: + .. _class_Polygon2D_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 9233cf3fc..432f56712 100644 --- a/classes/class_polygonpathfinder.rst +++ b/classes/class_polygonpathfinder.rst @@ -8,6 +8,7 @@ PolygonPathFinder ================= **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -39,36 +40,35 @@ Methods Method Descriptions ------------------- -.. _class_PolygonPathFinder_find_path: + .. _class_PolygonPathFinder_find_path: - :ref:`PoolVector2Array` **find_path** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** -.. _class_PolygonPathFinder_get_bounds: + .. _class_PolygonPathFinder_get_bounds: - :ref:`Rect2` **get_bounds** **(** **)** const -.. _class_PolygonPathFinder_get_closest_point: + .. _class_PolygonPathFinder_get_closest_point: - :ref:`Vector2` **get_closest_point** **(** :ref:`Vector2` point **)** const -.. _class_PolygonPathFinder_get_intersections: + .. _class_PolygonPathFinder_get_intersections: - :ref:`PoolVector2Array` **get_intersections** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** const -.. _class_PolygonPathFinder_get_point_penalty: + .. _class_PolygonPathFinder_get_point_penalty: - :ref:`float` **get_point_penalty** **(** :ref:`int` idx **)** const -.. _class_PolygonPathFinder_is_point_inside: + .. _class_PolygonPathFinder_is_point_inside: - :ref:`bool` **is_point_inside** **(** :ref:`Vector2` point **)** const -.. _class_PolygonPathFinder_set_point_penalty: + .. _class_PolygonPathFinder_set_point_penalty: - void **set_point_penalty** **(** :ref:`int` idx, :ref:`float` penalty **)** -.. _class_PolygonPathFinder_setup: + .. _class_PolygonPathFinder_setup: - void **setup** **(** :ref:`PoolVector2Array` points, :ref:`PoolIntArray` connections **)** - diff --git a/classes/class_poolbytearray.rst b/classes/class_poolbytearray.rst index 73b51a151..c11cf99f3 100644 --- a/classes/class_poolbytearray.rst +++ b/classes/class_poolbytearray.rst @@ -57,94 +57,93 @@ Raw byte array. Contains bytes. Optimized for memory usage, can't fragment the m Method Descriptions ------------------- -.. _class_PoolByteArray_PoolByteArray: + .. _class_PoolByteArray_PoolByteArray: - :ref:`PoolByteArray` **PoolByteArray** **(** :ref:`Array` from **)** Create from a generic array. -.. _class_PoolByteArray_append: + .. _class_PoolByteArray_append: - void **append** **(** :ref:`int` byte **)** Append an element at the end of the array (alias of :ref:`push_back`). -.. _class_PoolByteArray_append_array: + .. _class_PoolByteArray_append_array: - void **append_array** **(** :ref:`PoolByteArray` array **)** Append a ``PoolByteArray`` at the end of this array. -.. _class_PoolByteArray_compress: + .. _class_PoolByteArray_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:`File`'s COMPRESS\_\* constants. -.. _class_PoolByteArray_decompress: + .. _class_PoolByteArray_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:`File`'s COMPRESS\_\* constants. -.. _class_PoolByteArray_get_string_from_ascii: + .. _class_PoolByteArray_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:`PoolByteArray.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:`PoolByteArray.get_string_from_utf8`. -.. _class_PoolByteArray_get_string_from_utf8: + .. _class_PoolByteArray_get_string_from_utf8: - :ref:`String` **get_string_from_utf8** **(** **)** Returns a copy of the array's contents as :ref:`String`. Slower than :ref:`PoolByteArray.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_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 (pos==size()). -.. _class_PoolByteArray_invert: + .. _class_PoolByteArray_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. -.. _class_PoolByteArray_push_back: + .. _class_PoolByteArray_push_back: - void **push_back** **(** :ref:`int` byte **)** Append an element at the end of the array. -.. _class_PoolByteArray_remove: + .. _class_PoolByteArray_remove: - void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. -.. _class_PoolByteArray_resize: + .. _class_PoolByteArray_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_set: - void **set** **(** :ref:`int` idx, :ref:`int` byte **)** Change the byte at the given index. -.. _class_PoolByteArray_size: + .. _class_PoolByteArray_size: - :ref:`int` **size** **(** **)** Return the size of the array. -.. _class_PoolByteArray_subarray: + .. _class_PoolByteArray_subarray: - :ref:`PoolByteArray` **subarray** **(** :ref:`int` from, :ref:`int` to **)** Returns the slice of the ``PoolByteArray`` between indices (inclusive) as a new ``PoolByteArray``. Any negative index is considered to be from the end of the array. - diff --git a/classes/class_poolcolorarray.rst b/classes/class_poolcolorarray.rst index 0bc442589..6e1cfe128 100644 --- a/classes/class_poolcolorarray.rst +++ b/classes/class_poolcolorarray.rst @@ -47,64 +47,63 @@ Array of Color, Contains colors. Optimized for memory usage, can't fragment the Method Descriptions ------------------- -.. _class_PoolColorArray_PoolColorArray: + .. _class_PoolColorArray_PoolColorArray: - :ref:`PoolColorArray` **PoolColorArray** **(** :ref:`Array` from **)** Create from a generic array. -.. _class_PoolColorArray_append: + .. _class_PoolColorArray_append: - void **append** **(** :ref:`Color` color **)** Append an element at the end of the array (alias of :ref:`push_back`). -.. _class_PoolColorArray_append_array: + .. _class_PoolColorArray_append_array: - void **append_array** **(** :ref:`PoolColorArray` array **)** Append a ``PoolColorArray`` at the end of this array. -.. _class_PoolColorArray_insert: + .. _class_PoolColorArray_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 (pos==size()). -.. _class_PoolColorArray_invert: + .. _class_PoolColorArray_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. -.. _class_PoolColorArray_push_back: + .. _class_PoolColorArray_push_back: - void **push_back** **(** :ref:`Color` color **)** Append a value to the array. -.. _class_PoolColorArray_remove: + .. _class_PoolColorArray_remove: - void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. -.. _class_PoolColorArray_resize: + .. _class_PoolColorArray_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_set: - void **set** **(** :ref:`int` idx, :ref:`Color` color **)** Change the :ref:`Color` at the given index. -.. _class_PoolColorArray_size: + .. _class_PoolColorArray_size: - :ref:`int` **size** **(** **)** Return the size of the array. - diff --git a/classes/class_poolintarray.rst b/classes/class_poolintarray.rst index 94ca55a23..58ece41e8 100644 --- a/classes/class_poolintarray.rst +++ b/classes/class_poolintarray.rst @@ -47,64 +47,63 @@ Integer Array. Contains integers. Optimized for memory usage, can't fragment the Method Descriptions ------------------- -.. _class_PoolIntArray_PoolIntArray: + .. _class_PoolIntArray_PoolIntArray: - :ref:`PoolIntArray` **PoolIntArray** **(** :ref:`Array` from **)** Create from a generic array. -.. _class_PoolIntArray_append: + .. _class_PoolIntArray_append: - void **append** **(** :ref:`int` integer **)** Append an element at the end of the array (alias of :ref:`push_back`). -.. _class_PoolIntArray_append_array: + .. _class_PoolIntArray_append_array: - void **append_array** **(** :ref:`PoolIntArray` array **)** Append an ``PoolIntArray`` at the end of this array. -.. _class_PoolIntArray_insert: + .. _class_PoolIntArray_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 (pos==size()). -.. _class_PoolIntArray_invert: + .. _class_PoolIntArray_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. -.. _class_PoolIntArray_push_back: + .. _class_PoolIntArray_push_back: - void **push_back** **(** :ref:`int` integer **)** Append a value to the array. -.. _class_PoolIntArray_remove: + .. _class_PoolIntArray_remove: - void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. -.. _class_PoolIntArray_resize: + .. _class_PoolIntArray_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_set: - void **set** **(** :ref:`int` idx, :ref:`int` integer **)** Change the int at the given index. -.. _class_PoolIntArray_size: + .. _class_PoolIntArray_size: - :ref:`int` **size** **(** **)** Return the array size. - diff --git a/classes/class_poolrealarray.rst b/classes/class_poolrealarray.rst index b5afe314b..b6cebccc6 100644 --- a/classes/class_poolrealarray.rst +++ b/classes/class_poolrealarray.rst @@ -47,64 +47,63 @@ Real Array. Array of floating point values. Can only contain floats. Optimized f Method Descriptions ------------------- -.. _class_PoolRealArray_PoolRealArray: + .. _class_PoolRealArray_PoolRealArray: - :ref:`PoolRealArray` **PoolRealArray** **(** :ref:`Array` from **)** Create from a generic array. -.. _class_PoolRealArray_append: + .. _class_PoolRealArray_append: - void **append** **(** :ref:`float` value **)** Append an element at the end of the array (alias of :ref:`push_back`). -.. _class_PoolRealArray_append_array: + .. _class_PoolRealArray_append_array: - void **append_array** **(** :ref:`PoolRealArray` array **)** Append an RealArray at the end of this array. -.. _class_PoolRealArray_insert: + .. _class_PoolRealArray_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 (pos==size()). -.. _class_PoolRealArray_invert: + .. _class_PoolRealArray_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. -.. _class_PoolRealArray_push_back: + .. _class_PoolRealArray_push_back: - void **push_back** **(** :ref:`float` value **)** Append an element at the end of the array. -.. _class_PoolRealArray_remove: + .. _class_PoolRealArray_remove: - void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. -.. _class_PoolRealArray_resize: + .. _class_PoolRealArray_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_set: - void **set** **(** :ref:`int` idx, :ref:`float` value **)** Change the float at the given index. -.. _class_PoolRealArray_size: + .. _class_PoolRealArray_size: - :ref:`int` **size** **(** **)** Return the size of the array. - diff --git a/classes/class_poolstringarray.rst b/classes/class_poolstringarray.rst index 129b9eb98..84bae2500 100644 --- a/classes/class_poolstringarray.rst +++ b/classes/class_poolstringarray.rst @@ -49,70 +49,69 @@ String Array. Array of strings. Can only contain strings. Optimized for memory u Method Descriptions ------------------- -.. _class_PoolStringArray_PoolStringArray: + .. _class_PoolStringArray_PoolStringArray: - :ref:`PoolStringArray` **PoolStringArray** **(** :ref:`Array` from **)** Create from a generic array. -.. _class_PoolStringArray_append: + .. _class_PoolStringArray_append: - void **append** **(** :ref:`String` string **)** Append an element at the end of the array (alias of :ref:`push_back`). -.. _class_PoolStringArray_append_array: + .. _class_PoolStringArray_append_array: - void **append_array** **(** :ref:`PoolStringArray` array **)** Append an StringArray at the end of this array. -.. _class_PoolStringArray_insert: + .. _class_PoolStringArray_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 (pos==size()). -.. _class_PoolStringArray_invert: + .. _class_PoolStringArray_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. -.. _class_PoolStringArray_join: + .. _class_PoolStringArray_join: - :ref:`String` **join** **(** :ref:`String` delimiter **)** Returns a :ref:`String` with each element of the array joined with the delimiter. -.. _class_PoolStringArray_push_back: + .. _class_PoolStringArray_push_back: - void **push_back** **(** :ref:`String` string **)** Append a string element at end of the array. -.. _class_PoolStringArray_remove: + .. _class_PoolStringArray_remove: - void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. -.. _class_PoolStringArray_resize: + .. _class_PoolStringArray_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_set: - void **set** **(** :ref:`int` idx, :ref:`String` string **)** Change the :ref:`String` at the given index. -.. _class_PoolStringArray_size: + .. _class_PoolStringArray_size: - :ref:`int` **size** **(** **)** Return the size of the array. - diff --git a/classes/class_poolvector2array.rst b/classes/class_poolvector2array.rst index 21741c52b..de9166971 100644 --- a/classes/class_poolvector2array.rst +++ b/classes/class_poolvector2array.rst @@ -47,64 +47,63 @@ An Array specifically designed to hold Vector2. Note that this type is passed by Method Descriptions ------------------- -.. _class_PoolVector2Array_PoolVector2Array: + .. _class_PoolVector2Array_PoolVector2Array: - :ref:`PoolVector2Array` **PoolVector2Array** **(** :ref:`Array` from **)** Construct a new ``PoolVector2Array``. Optionally, you can pass in an Array that will be converted. -.. _class_PoolVector2Array_append: + .. _class_PoolVector2Array_append: - void **append** **(** :ref:`Vector2` vector2 **)** Append an element at the end of the array (alias of :ref:`push_back`). -.. _class_PoolVector2Array_append_array: + .. _class_PoolVector2Array_append_array: - void **append_array** **(** :ref:`PoolVector2Array` array **)** Append an ``PoolVector2Array`` at the end of this array. -.. _class_PoolVector2Array_insert: + .. _class_PoolVector2Array_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 (pos==size()). -.. _class_PoolVector2Array_invert: + .. _class_PoolVector2Array_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. -.. _class_PoolVector2Array_push_back: + .. _class_PoolVector2Array_push_back: - void **push_back** **(** :ref:`Vector2` vector2 **)** Insert a :ref:`Vector2` at the end. -.. _class_PoolVector2Array_remove: + .. _class_PoolVector2Array_remove: - void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. -.. _class_PoolVector2Array_resize: + .. _class_PoolVector2Array_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_set: - void **set** **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** Change the :ref:`Vector2` at the given index. -.. _class_PoolVector2Array_size: + .. _class_PoolVector2Array_size: - :ref:`int` **size** **(** **)** Return the size of the array. - diff --git a/classes/class_poolvector3array.rst b/classes/class_poolvector3array.rst index 46211c15e..0f2743caf 100644 --- a/classes/class_poolvector3array.rst +++ b/classes/class_poolvector3array.rst @@ -47,64 +47,63 @@ An Array specifically designed to hold Vector3. Note that this type is passed by Method Descriptions ------------------- -.. _class_PoolVector3Array_PoolVector3Array: + .. _class_PoolVector3Array_PoolVector3Array: - :ref:`PoolVector3Array` **PoolVector3Array** **(** :ref:`Array` from **)** Construct a new PoolVector3Array. Optionally, you can pass in an Array that will be converted. -.. _class_PoolVector3Array_append: + .. _class_PoolVector3Array_append: - void **append** **(** :ref:`Vector3` vector3 **)** Append an element at the end of the array (alias of :ref:`push_back`). -.. _class_PoolVector3Array_append_array: + .. _class_PoolVector3Array_append_array: - void **append_array** **(** :ref:`PoolVector3Array` array **)** Append an ``PoolVector3Array`` at the end of this array. -.. _class_PoolVector3Array_insert: + .. _class_PoolVector3Array_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 (pos==size()). -.. _class_PoolVector3Array_invert: + .. _class_PoolVector3Array_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. -.. _class_PoolVector3Array_push_back: + .. _class_PoolVector3Array_push_back: - void **push_back** **(** :ref:`Vector3` vector3 **)** Insert a :ref:`Vector3` at the end. -.. _class_PoolVector3Array_remove: + .. _class_PoolVector3Array_remove: - void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. -.. _class_PoolVector3Array_resize: + .. _class_PoolVector3Array_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_set: - void **set** **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** Change the :ref:`Vector3` at the given index. -.. _class_PoolVector3Array_size: + .. _class_PoolVector3Array_size: - :ref:`int` **size** **(** **)** Return the size of the array. - diff --git a/classes/class_popup.rst b/classes/class_popup.rst index b9aafce0c..66ae0f493 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -8,7 +8,9 @@ Popup ===== **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`PopupPanel`, :ref:`PopupDialog`, :ref:`PopupMenu`, :ref:`WindowDialog` + **Category:** Core Brief Description @@ -16,6 +18,13 @@ Brief Description Base container control for popups and dialogs. +Properties +---------- + ++-------------------------+-----------------------------------------------------+ +| :ref:`bool` | :ref:`popup_exclusive` | ++-------------------------+-----------------------------------------------------+ + Methods ------- @@ -32,25 +41,23 @@ Methods Signals ------- -.. _class_Popup_about_to_show: + .. _class_Popup_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_popup_hide: - **popup_hide** **(** **)** This signal is emitted when a popup is hidden. - Constants --------- - **NOTIFICATION_POST_POPUP** = **80** --- Notification sent right after the popup is shown. - **NOTIFICATION_POPUP_HIDE** = **81** --- Notification sent right after the popup is hidden. - Description ----------- @@ -61,34 +68,40 @@ Property Descriptions .. _class_Popup_popup_exclusive: -- :ref:`bool` **popup_exclusive** - If ``true`` the popup will not be hidden when a click event occurs outside of it, or when it receives the ``ui_cancel`` action event. +- :ref:`bool` **popup_exclusive** ++----------+----------------------+ +| *Setter* | set_exclusive(value) | ++----------+----------------------+ +| *Getter* | is_exclusive() | ++----------+----------------------+ + +If ``true`` the popup will not be hidden when a click event occurs outside of it, or when it receives the ``ui_cancel`` action event. Method Descriptions ------------------- -.. _class_Popup_popup: + .. _class_Popup_popup: - void **popup** **(** :ref:`Rect2` bounds=Rect2( 0, 0, 0, 0 ) **)** Popup (show the control in modal form). -.. _class_Popup_popup_centered: + .. _class_Popup_popup_centered: - void **popup_centered** **(** :ref:`Vector2` size=Vector2( 0, 0 ) **)** Popup (show the control in modal form) in the center of the screen, at the current size, or at a size determined by "size". -.. _class_Popup_popup_centered_minsize: + .. _class_Popup_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, ensuring the size is never smaller than ``minsize``. -.. _class_Popup_popup_centered_ratio: + .. _class_Popup_popup_centered_ratio: - void **popup_centered_ratio** **(** :ref:`float` ratio=0.75 **)** Popup (show the control in modal form) in the center of the screen, scaled at a ratio of size of the screen. - diff --git a/classes/class_popupdialog.rst b/classes/class_popupdialog.rst index b416118f5..03a33c338 100644 --- a/classes/class_popupdialog.rst +++ b/classes/class_popupdialog.rst @@ -8,6 +8,7 @@ PopupDialog =========== **Inherits:** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index 5ac6638ab..f153a0afb 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -8,6 +8,7 @@ PopupMenu ========= **Inherits:** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,19 @@ Brief Description 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` | ++---------------------------+-------------------------------------------------------------------------------------------+ + Methods ------- @@ -118,28 +132,68 @@ Methods | 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` | ++---------------------------------+-------------------------------------------------------------------------+ + Signals ------- -.. _class_PopupMenu_id_focused: + .. _class_PopupMenu_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_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_index_pressed: - **index_pressed** **(** :ref:`int` index **)** This event is emitted when an item of some index is pressed or its accelerator is activated. - Description ----------- @@ -152,33 +206,58 @@ Property Descriptions - :ref:`bool` **hide_on_checkable_item_selection** ++----------+---------------------------------------------+ +| *Setter* | set_hide_on_checkable_item_selection(value) | ++----------+---------------------------------------------+ +| *Getter* | is_hide_on_checkable_item_selection() | ++----------+---------------------------------------------+ + .. _class_PopupMenu_hide_on_item_selection: - :ref:`bool` **hide_on_item_selection** ++----------+-----------------------------------+ +| *Setter* | set_hide_on_item_selection(value) | ++----------+-----------------------------------+ +| *Getter* | is_hide_on_item_selection() | ++----------+-----------------------------------+ + .. _class_PopupMenu_hide_on_state_item_selection: - :ref:`bool` **hide_on_state_item_selection** ++----------+-----------------------------------------+ +| *Setter* | set_hide_on_state_item_selection(value) | ++----------+-----------------------------------------+ +| *Getter* | is_hide_on_state_item_selection() | ++----------+-----------------------------------------+ + .. _class_PopupMenu_submenu_popup_delay: -- :ref:`float` **submenu_popup_delay** - Sets the delay time for the submenu item to popup on mouse hovering. If the popup menu is added as a child of another (acting as a submenu), it will inherit the delay time of the parent menu item. Default value: ``0.3`` seconds. +- :ref:`float` **submenu_popup_delay** ++----------+--------------------------------+ +| *Setter* | set_submenu_popup_delay(value) | ++----------+--------------------------------+ +| *Getter* | get_submenu_popup_delay() | ++----------+--------------------------------+ + +Sets the delay time for the submenu item to popup on mouse hovering. If the popup menu is added as a child of another (acting as a submenu), it will inherit the delay time of the parent menu item. Default value: ``0.3`` seconds. Method Descriptions ------------------- -.. _class_PopupMenu_add_check_item: + .. _class_PopupMenu_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_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_add_icon_check_item: - void **add_icon_check_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** @@ -186,175 +265,175 @@ 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_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_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_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_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_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. -.. _class_PopupMenu_add_radio_check_shortcut: + .. _class_PopupMenu_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_add_separator: - void **add_separator** **(** :ref:`String` label="" **)** Add a separator between items. Separators also occupy an index. -.. _class_PopupMenu_add_shortcut: + .. _class_PopupMenu_add_shortcut: - void **add_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** -.. _class_PopupMenu_add_submenu_item: + .. _class_PopupMenu_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_clear: - void **clear** **(** **)** Clear the popup menu, in effect removing all items. -.. _class_PopupMenu_get_item_accelerator: + .. _class_PopupMenu_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_get_item_count: - :ref:`int` **get_item_count** **(** **)** const Return the amount of items. -.. _class_PopupMenu_get_item_icon: + .. _class_PopupMenu_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_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_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_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. -.. _class_PopupMenu_get_item_shortcut: + .. _class_PopupMenu_get_item_shortcut: - :ref:`ShortCut` **get_item_shortcut** **(** :ref:`int` idx **)** const -.. _class_PopupMenu_get_item_submenu: + .. _class_PopupMenu_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_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_get_item_tooltip: - :ref:`String` **get_item_tooltip** **(** :ref:`int` idx **)** const -.. _class_PopupMenu_is_hide_on_window_lose_focus: + .. _class_PopupMenu_is_hide_on_window_lose_focus: - :ref:`bool` **is_hide_on_window_lose_focus** **(** **)** const -.. _class_PopupMenu_is_item_checkable: + .. _class_PopupMenu_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_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_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_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_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_is_item_shortcut_disabled: - :ref:`bool` **is_item_shortcut_disabled** **(** :ref:`int` idx **)** const -.. _class_PopupMenu_remove_item: + .. _class_PopupMenu_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_set_hide_on_window_lose_focus: - void **set_hide_on_window_lose_focus** **(** :ref:`bool` enable **)** -.. _class_PopupMenu_set_item_accelerator: + .. _class_PopupMenu_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_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_set_item_as_radio_checkable: - void **set_item_as_radio_checkable** **(** :ref:`int` idx, :ref:`bool` enable **)** @@ -362,74 +441,73 @@ The same as :ref:`set_item_as_checkable` 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_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_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_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_set_item_icon: - void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture` icon **)** -.. _class_PopupMenu_set_item_id: + .. _class_PopupMenu_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_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. -.. _class_PopupMenu_set_item_multistate: + .. _class_PopupMenu_set_item_multistate: - void **set_item_multistate** **(** :ref:`int` idx, :ref:`int` state **)** -.. _class_PopupMenu_set_item_shortcut: + .. _class_PopupMenu_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_set_item_shortcut_disabled: - void **set_item_shortcut_disabled** **(** :ref:`int` idx, :ref:`bool` disabled **)** -.. _class_PopupMenu_set_item_submenu: + .. _class_PopupMenu_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_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_set_item_tooltip: - void **set_item_tooltip** **(** :ref:`int` idx, :ref:`String` tooltip **)** -.. _class_PopupMenu_toggle_item_checked: + .. _class_PopupMenu_toggle_item_checked: - void **toggle_item_checked** **(** :ref:`int` idx **)** -.. _class_PopupMenu_toggle_item_multistate: + .. _class_PopupMenu_toggle_item_multistate: - void **toggle_item_multistate** **(** :ref:`int` idx **)** - diff --git a/classes/class_popuppanel.rst b/classes/class_popuppanel.rst index 7e1b2c261..36624fb84 100644 --- a/classes/class_popuppanel.rst +++ b/classes/class_popuppanel.rst @@ -8,6 +8,7 @@ PopupPanel ========== **Inherits:** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Class for displaying popups with a panel background. +Theme Properties +---------------- + ++---------------------------------+--------------------------------------+ +| :ref:`StyleBox` | :ref:`panel` | ++---------------------------------+--------------------------------------+ + Description ----------- diff --git a/classes/class_position2d.rst b/classes/class_position2d.rst index b31151aa6..8444897cd 100644 --- a/classes/class_position2d.rst +++ b/classes/class_position2d.rst @@ -8,6 +8,7 @@ Position2D ========== **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_position3d.rst b/classes/class_position3d.rst index 2379b8923..23e6e41f5 100644 --- a/classes/class_position3d.rst +++ b/classes/class_position3d.rst @@ -8,6 +8,7 @@ Position3D ========== **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_primitivemesh.rst b/classes/class_primitivemesh.rst index 10a71d126..c15b21d5a 100644 --- a/classes/class_primitivemesh.rst +++ b/classes/class_primitivemesh.rst @@ -8,7 +8,9 @@ PrimitiveMesh ============= **Inherits:** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`PlaneMesh`, :ref:`CubeMesh`, :ref:`SphereMesh`, :ref:`CylinderMesh`, :ref:`CapsuleMesh`, :ref:`QuadMesh`, :ref:`PrismMesh` + **Category:** Core Brief Description @@ -16,6 +18,17 @@ Brief Description Base class for all primitive meshes. Handles applying a :ref:`Material` to a primitive mesh. +Properties +---------- + ++---------------------------------+-----------------------------------------------------+ +| :ref:`AABB` | :ref:`custom_aabb` | ++---------------------------------+-----------------------------------------------------+ +| :ref:`bool` | :ref:`flip_faces` | ++---------------------------------+-----------------------------------------------------+ +| :ref:`Material` | :ref:`material` | ++---------------------------------+-----------------------------------------------------+ + Methods ------- @@ -35,20 +48,38 @@ Property Descriptions - :ref:`AABB` **custom_aabb** ++----------+------------------------+ +| *Setter* | set_custom_aabb(value) | ++----------+------------------------+ +| *Getter* | get_custom_aabb() | ++----------+------------------------+ + .. _class_PrimitiveMesh_flip_faces: - :ref:`bool` **flip_faces** ++----------+-----------------------+ +| *Setter* | set_flip_faces(value) | ++----------+-----------------------+ +| *Getter* | get_flip_faces() | ++----------+-----------------------+ + .. _class_PrimitiveMesh_material: -- :ref:`Material` **material** - The current :ref:`Material` of the primitive mesh. +- :ref:`Material` **material** ++----------+---------------------+ +| *Setter* | set_material(value) | ++----------+---------------------+ +| *Getter* | get_material() | ++----------+---------------------+ + +The current :ref:`Material` of the primitive mesh. Method Descriptions ------------------- -.. _class_PrimitiveMesh_get_mesh_arrays: + .. _class_PrimitiveMesh_get_mesh_arrays: - :ref:`Array` **get_mesh_arrays** **(** **)** const - diff --git a/classes/class_prismmesh.rst b/classes/class_prismmesh.rst index 709e25a79..83c128358 100644 --- a/classes/class_prismmesh.rst +++ b/classes/class_prismmesh.rst @@ -8,6 +8,7 @@ PrismMesh ========= **Inherits:** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,21 @@ Brief Description 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` | ++-------------------------------+-----------------------------------------------------------+ + Description ----------- @@ -25,22 +41,61 @@ Property Descriptions .. _class_PrismMesh_left_to_right: -- :ref:`float` **left_to_right** - 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). +- :ref:`float` **left_to_right** + ++----------+--------------------------+ +| *Setter* | set_left_to_right(value) | ++----------+--------------------------+ +| *Getter* | get_left_to_right() | ++----------+--------------------------+ + +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: -- :ref:`Vector3` **size** - Size of the prism. Defaults to (2.0, 2.0, 2.0). +- :ref:`Vector3` **size** + ++----------+-----------------+ +| *Setter* | set_size(value) | ++----------+-----------------+ +| *Getter* | get_size() | ++----------+-----------------+ + +Size of the prism. Defaults to (2.0, 2.0, 2.0). .. _class_PrismMesh_subdivide_depth: -- :ref:`int` **subdivide_depth** - Number of added edge loops along the z-axis. Defaults to 0. +- :ref:`int` **subdivide_depth** + ++----------+----------------------------+ +| *Setter* | set_subdivide_depth(value) | ++----------+----------------------------+ +| *Getter* | get_subdivide_depth() | ++----------+----------------------------+ + +Number of added edge loops along the z-axis. Defaults to 0. .. _class_PrismMesh_subdivide_height: -- :ref:`int` **subdivide_height** - Number of added edge loops along the y-axis. Defaults to 0. +- :ref:`int` **subdivide_height** + ++----------+-----------------------------+ +| *Setter* | set_subdivide_height(value) | ++----------+-----------------------------+ +| *Getter* | get_subdivide_height() | ++----------+-----------------------------+ + +Number of added edge loops along the y-axis. Defaults to 0. .. _class_PrismMesh_subdivide_width: -- :ref:`int` **subdivide_width** - Number of added edge loops along the x-axis. Defaults to 0. +- :ref:`int` **subdivide_width** ++----------+----------------------------+ +| *Setter* | set_subdivide_width(value) | ++----------+----------------------------+ +| *Getter* | get_subdivide_width() | ++----------+----------------------------+ + +Number of added edge loops along the x-axis. Defaults to 0. diff --git a/classes/class_proceduralsky.rst b/classes/class_proceduralsky.rst index 0d8f4d4b1..4ecc25bb4 100644 --- a/classes/class_proceduralsky.rst +++ b/classes/class_proceduralsky.rst @@ -8,6 +8,7 @@ ProceduralSky ============= **Inherits:** :ref:`Sky` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,12 +16,49 @@ Brief Description Type of :ref:`Sky` that is generated procedurally based on user input parameters. +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` | ++----------------------------------------------------+-----------------------------------------------------------------------+ + Enumerations ------------ .. _enum_ProceduralSky_TextureSize: -enum **TextureSize** +enum **TextureSize**: - **TEXTURE_SIZE_256** = **0** - **TEXTURE_SIZE_512** = **1** @@ -29,79 +67,205 @@ enum **TextureSize** - **TEXTURE_SIZE_4096** = **4** - **TEXTURE_SIZE_MAX** = **5** - Description ----------- ProceduralSky provides a way to create an effective background quickly by defining procedural parameters for the sun, the sky and the ground. The sky and ground are very similar, they are defined by a color at the horizon, another color, and finally an easing curve to interpolate between these two colors. Similarly the sun is described by a position in the sky, a color, and an easing curve. However, the sun also defines a minimum and maximum angle, these two values define at what distance the easing curve begins and ends from the sun, and thus end up defining the size of the sun in the sky. -The ProceduralSky is updated on the CPU after the parameters change and stored in a texture and then displayed as a background in the scene. This makes it relatively unsuitable for realtime updates during gameplay. But with a small texture size it is still feasible to update relatively frequently becuase it is updated on a background thread when multi-threading is available. +The ProceduralSky is updated on the CPU after the parameters change and stored in a texture and then displayed as a background in the scene. This makes it relatively unsuitable for realtime updates during gameplay. But with a small texture size it is still feasible to update relatively frequently because it is updated on a background thread when multi-threading is available. Property Descriptions --------------------- .. _class_ProceduralSky_ground_bottom_color: -- :ref:`Color` **ground_bottom_color** - Color of the ground at the bottom. +- :ref:`Color` **ground_bottom_color** + ++----------+--------------------------------+ +| *Setter* | set_ground_bottom_color(value) | ++----------+--------------------------------+ +| *Getter* | get_ground_bottom_color() | ++----------+--------------------------------+ + +Color of the ground at the bottom. .. _class_ProceduralSky_ground_curve: -- :ref:`float` **ground_curve** - How quickly the :ref:`ground_horizon_color` fades into the :ref:`ground_bottom_color`. +- :ref:`float` **ground_curve** + ++----------+-------------------------+ +| *Setter* | set_ground_curve(value) | ++----------+-------------------------+ +| *Getter* | get_ground_curve() | ++----------+-------------------------+ + +How quickly the :ref:`ground_horizon_color` fades into the :ref:`ground_bottom_color`. .. _class_ProceduralSky_ground_energy: -- :ref:`float` **ground_energy** - Amount of energy contribution from the ground. +- :ref:`float` **ground_energy** + ++----------+--------------------------+ +| *Setter* | set_ground_energy(value) | ++----------+--------------------------+ +| *Getter* | get_ground_energy() | ++----------+--------------------------+ + +Amount of energy contribution from the ground. .. _class_ProceduralSky_ground_horizon_color: -- :ref:`Color` **ground_horizon_color** - Color of the ground at the horizon. +- :ref:`Color` **ground_horizon_color** + ++----------+---------------------------------+ +| *Setter* | set_ground_horizon_color(value) | ++----------+---------------------------------+ +| *Getter* | get_ground_horizon_color() | ++----------+---------------------------------+ + +Color of the ground at the horizon. .. _class_ProceduralSky_sky_curve: -- :ref:`float` **sky_curve** - How quickly the :ref:`sky_horizon_color` fades into the :ref:`sky_top_color`. +- :ref:`float` **sky_curve** + ++----------+----------------------+ +| *Setter* | set_sky_curve(value) | ++----------+----------------------+ +| *Getter* | get_sky_curve() | ++----------+----------------------+ + +How quickly the :ref:`sky_horizon_color` fades into the :ref:`sky_top_color`. .. _class_ProceduralSky_sky_energy: -- :ref:`float` **sky_energy** - Amount of energy contribution from the sky. +- :ref:`float` **sky_energy** + ++----------+-----------------------+ +| *Setter* | set_sky_energy(value) | ++----------+-----------------------+ +| *Getter* | get_sky_energy() | ++----------+-----------------------+ + +Amount of energy contribution from the sky. .. _class_ProceduralSky_sky_horizon_color: -- :ref:`Color` **sky_horizon_color** - Color of the sky at the horizon. +- :ref:`Color` **sky_horizon_color** + ++----------+------------------------------+ +| *Setter* | set_sky_horizon_color(value) | ++----------+------------------------------+ +| *Getter* | get_sky_horizon_color() | ++----------+------------------------------+ + +Color of the sky at the horizon. .. _class_ProceduralSky_sky_top_color: -- :ref:`Color` **sky_top_color** - Color of the sky at the top. +- :ref:`Color` **sky_top_color** + ++----------+--------------------------+ +| *Setter* | set_sky_top_color(value) | ++----------+--------------------------+ +| *Getter* | get_sky_top_color() | ++----------+--------------------------+ + +Color of the sky at the top. .. _class_ProceduralSky_sun_angle_max: -- :ref:`float` **sun_angle_max** - Distance from center of sun where it fades out completely. +- :ref:`float` **sun_angle_max** + ++----------+--------------------------+ +| *Setter* | set_sun_angle_max(value) | ++----------+--------------------------+ +| *Getter* | get_sun_angle_max() | ++----------+--------------------------+ + +Distance from center of sun where it fades out completely. .. _class_ProceduralSky_sun_angle_min: -- :ref:`float` **sun_angle_min** - Distance from sun where it goes from solid to starting to fade. +- :ref:`float` **sun_angle_min** + ++----------+--------------------------+ +| *Setter* | set_sun_angle_min(value) | ++----------+--------------------------+ +| *Getter* | get_sun_angle_min() | ++----------+--------------------------+ + +Distance from sun where it goes from solid to starting to fade. .. _class_ProceduralSky_sun_color: -- :ref:`Color` **sun_color** - Color of the sun. +- :ref:`Color` **sun_color** + ++----------+----------------------+ +| *Setter* | set_sun_color(value) | ++----------+----------------------+ +| *Getter* | get_sun_color() | ++----------+----------------------+ + +Color of the sun. .. _class_ProceduralSky_sun_curve: -- :ref:`float` **sun_curve** - How quickly the sun fades away between :ref:`sun_angle_min` and :ref:`sun_angle_max` +- :ref:`float` **sun_curve** + ++----------+----------------------+ +| *Setter* | set_sun_curve(value) | ++----------+----------------------+ +| *Getter* | get_sun_curve() | ++----------+----------------------+ + +How quickly the sun fades away between :ref:`sun_angle_min` and :ref:`sun_angle_max` .. _class_ProceduralSky_sun_energy: -- :ref:`float` **sun_energy** - Amount of energy contribution from the sun. +- :ref:`float` **sun_energy** + ++----------+-----------------------+ +| *Setter* | set_sun_energy(value) | ++----------+-----------------------+ +| *Getter* | get_sun_energy() | ++----------+-----------------------+ + +Amount of energy contribution from the sun. .. _class_ProceduralSky_sun_latitude: -- :ref:`float` **sun_latitude** - The suns height using polar coordinates. +- :ref:`float` **sun_latitude** + ++----------+-------------------------+ +| *Setter* | set_sun_latitude(value) | ++----------+-------------------------+ +| *Getter* | get_sun_latitude() | ++----------+-------------------------+ + +The suns height using polar coordinates. .. _class_ProceduralSky_sun_longitude: -- :ref:`float` **sun_longitude** - The direction of the sun using polar coordinates. +- :ref:`float` **sun_longitude** + ++----------+--------------------------+ +| *Setter* | set_sun_longitude(value) | ++----------+--------------------------+ +| *Getter* | get_sun_longitude() | ++----------+--------------------------+ + +The direction of the sun using polar coordinates. .. _class_ProceduralSky_texture_size: -- :ref:`TextureSize` **texture_size** - Size of :ref:`Texture` that the ProceduralSky will generate. +- :ref:`TextureSize` **texture_size** ++----------+-------------------------+ +| *Setter* | set_texture_size(value) | ++----------+-------------------------+ +| *Getter* | get_texture_size() | ++----------+-------------------------+ + +Size of :ref:`Texture` that the ProceduralSky will generate. diff --git a/classes/class_progressbar.rst b/classes/class_progressbar.rst index f5f98afd6..4992fa021 100644 --- a/classes/class_progressbar.rst +++ b/classes/class_progressbar.rst @@ -8,6 +8,7 @@ ProgressBar =========== **Inherits:** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,28 @@ Brief Description General purpose progress bar. +Properties +---------- + ++-------------------------+-----------------------------------------------------------+ +| :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` | ++---------------------------------+---------------------------------------------------------------+ + Description ----------- @@ -25,6 +48,13 @@ Property Descriptions .. _class_ProgressBar_percent_visible: -- :ref:`bool` **percent_visible** - If ``true`` the fill percentage is displayed on the bar. Default value: ``true``. +- :ref:`bool` **percent_visible** ++----------+----------------------------+ +| *Setter* | set_percent_visible(value) | ++----------+----------------------------+ +| *Getter* | is_percent_visible() | ++----------+----------------------------+ + +If ``true`` the fill percentage is displayed on the bar. Default value: ``true``. diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index d5a869be7..959a07d5f 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -8,6 +8,7 @@ ProjectSettings =============== **Inherits:** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,505 @@ Brief Description Contains global variables accessible from everywhere. +Properties +---------- + ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`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:`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/warnings/constant_used_as_function` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`int` | :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:`mono/debugger_agent/port` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`mono/debugger_agent/wait_for_debugger` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mono/debugger_agent/wait_timeout` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`mono/export/include_scripts_content` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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/remote_fs/max_pages` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/remote_fs/page_read_ahead` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/remote_fs/page_size` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`network/ssl/certificates` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :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:`int` | :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_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 ------- @@ -60,61 +560,89 @@ Property Descriptions .. _class_ProjectSettings_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). +- :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: -- :ref:`String` **application/boot_splash/image** - Path to an image used for boot splash. +- :ref:`String` **application/boot_splash/image** + +Path to an image used for boot splash. .. _class_ProjectSettings_application/config/custom_user_dir_name: -- :ref:`String` **application/config/custom_user_dir_name** - This directory is used for storing persistent data (user:// filesystem). If a custom name is set, then system paths will be used to store this on Desktop (AppData on Windows, user ~/.config on Unixes, etc), else the Godot config folder is used. This name needs to be unique, and it's recommended to set it to something before publishing. +- :ref:`String` **application/config/custom_user_dir_name** + +This directory is used for storing persistent data (user:// filesystem). If a custom name is set, then system paths will be used to store this on Desktop (AppData on Windows, user ~/.config on Unixes, etc), else the Godot config folder is used. This name needs to be unique, and it's recommended to set it to something before publishing. the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_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. +- :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: -- :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. +- :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/use_custom_user_dir: -- :ref:`bool` **application/config/use_custom_user_dir** - Allow the project to save to it's own custom user dir (in AppData on windows or ~/.config on unixes). This setting only works for desktop exporters. A name must be set in the "custom_user_dir_name" setting for this to take effect. +- :ref:`bool` **application/config/use_custom_user_dir** + +Allow the project to save to it's own custom user dir (in AppData on windows or ~/.config on unixes). This setting only works for desktop exporters. A name must be set in the "custom_user_dir_name" setting for this to take effect. .. _class_ProjectSettings_application/run/disable_stderr: -- :ref:`bool` **application/run/disable_stderr** - Disable printing to stderr on exported build. +- :ref:`bool` **application/run/disable_stderr** + +Disable printing to stderr on exported build. .. _class_ProjectSettings_application/run/disable_stdout: -- :ref:`bool` **application/run/disable_stdout** - Disable printing to stdout on exported build. +- :ref:`bool` **application/run/disable_stdout** + +Disable printing to stdout on exported build. .. _class_ProjectSettings_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. +- :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: -- :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. +- :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: -- :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. +- :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: -- :ref:`String` **application/run/main_scene** - Path to the main scene file that will be loaded when the project runs. +- :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: -- :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. +- :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: -- :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. +- :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: @@ -122,7 +650,9 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_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. +- :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: @@ -130,23 +660,33 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_audio/video_delay_compensation_ms: -- :ref:`int` **audio/video_delay_compensation_ms** - Setting to harcode audio delay when playing video. Best to leave this untouched unless you know what you are doing. +- :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: -- :ref:`int` **compression/formats/gzip/compression_level** - Default compression level for gzip. Affects compressed scenes and resources. +- :ref:`int` **compression/formats/gzip/compression_level** + +Default compression level for gzip. Affects compressed scenes and resources. .. _class_ProjectSettings_compression/formats/zlib/compression_level: -- :ref:`int` **compression/formats/zlib/compression_level** - Default compression level for zlib. Affects compressed scenes and resources. +- :ref:`int` **compression/formats/zlib/compression_level** + +Default compression level for zlib. Affects compressed scenes and resources. .. _class_ProjectSettings_compression/formats/zstd/compression_level: -- :ref:`int` **compression/formats/zstd/compression_level** - Default compression level for zstd. Affects compressed scenes and resources. +- :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: -- :ref:`bool` **compression/formats/zstd/long_distance_matching** - Enable long distance matching in zstd. +- :ref:`bool` **compression/formats/zstd/long_distance_matching** + +Enable long distance matching in zstd. .. _class_ProjectSettings_compression/formats/zstd/window_log_size: @@ -266,47 +806,69 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_debug/settings/gdscript/max_call_stack: -- :ref:`int` **debug/settings/gdscript/max_call_stack** - Maximum call stack allowed for debugging GDScript. +- :ref:`int` **debug/settings/gdscript/max_call_stack** + +Maximum call stack allowed for debugging GDScript. .. _class_ProjectSettings_debug/settings/profiler/max_functions: -- :ref:`int` **debug/settings/profiler/max_functions** - Maximum amount of functions per frame allowed when profiling. +- :ref:`int` **debug/settings/profiler/max_functions** + +Maximum amount of functions per frame allowed when profiling. .. _class_ProjectSettings_debug/settings/stdout/print_fps: -- :ref:`bool` **debug/settings/stdout/print_fps** - Print frames per second to stdout. Not very useful in general. +- :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: -- :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. +- :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: -- :ref:`int` **debug/settings/visual_script/max_call_stack** - Maximum call stack in visual scripting, to avoid infinite recursion. +- :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: -- :ref:`String` **display/mouse_cursor/custom_image** - Custom image for the mouse cursor. +- :ref:`String` **display/mouse_cursor/custom_image** + +Custom image for the mouse cursor. .. _class_ProjectSettings_display/mouse_cursor/custom_image_hotspot: -- :ref:`Vector2` **display/mouse_cursor/custom_image_hotspot** - Hotspot for the custom mouse cursor image. +- :ref:`Vector2` **display/mouse_cursor/custom_image_hotspot** + +Hotspot for the custom mouse cursor image. .. _class_ProjectSettings_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. +- :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: -- :ref:`bool` **display/window/dpi/allow_hidpi** - Allow HiDPI display on Windows and OSX. On Desktop Linux, this can't be enabled or disabled. +- :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: -- :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. +- :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: -- :ref:`String` **display/window/handheld/orientation** - Default orientation for cell phone or tablet. +- :ref:`String` **display/window/handheld/orientation** + +Default orientation for cell phone or tablet. .. _class_ProjectSettings_display/window/per_pixel_transparency: @@ -318,43 +880,63 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_display/window/size/always_on_top: -- :ref:`bool` **display/window/size/always_on_top** - Force the window to be 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: -- :ref:`bool` **display/window/size/borderless** - Force the window to be borderless. +- :ref:`bool` **display/window/size/borderless** + +Force the window to be borderless. .. _class_ProjectSettings_display/window/size/fullscreen: -- :ref:`bool` **display/window/size/fullscreen** - Set the window to full screen when it starts. +- :ref:`bool` **display/window/size/fullscreen** + +Set the window to full screen when it starts. .. _class_ProjectSettings_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. +- :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: -- :ref:`bool` **display/window/size/resizable** - Allow the window to be resizable by default. +- :ref:`bool` **display/window/size/resizable** + +Allow the window to be resizable by default. .. _class_ProjectSettings_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. +- :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: -- :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. +- :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: -- :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. +- :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: -- :ref:`bool` **display/window/vsync/use_vsync** - Use VSync. Don't be stupid, don't turn this off. +- :ref:`bool` **display/window/vsync/use_vsync** + +Use VSync. Don't be stupid, don't turn this off. .. _class_ProjectSettings_editor/active: -- :ref:`bool` **editor/active** - Internal editor setting, don't touch. +- :ref:`bool` **editor/active** + +Internal editor setting, don't touch. .. _class_ProjectSettings_gui/common/default_scroll_deadzone: @@ -362,27 +944,39 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_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. +- :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: -- :ref:`String` **gui/theme/custom** - Use a custom theme resource, set a path to it here. +- :ref:`String` **gui/theme/custom** + +Use a custom theme resource, set a path to it here. .. _class_ProjectSettings_gui/theme/custom_font: -- :ref:`String` **gui/theme/custom_font** - USe a custom default font resource, set a path to it here. +- :ref:`String` **gui/theme/custom_font** + +USe a custom default font resource, set a path to it here. .. _class_ProjectSettings_gui/theme/use_hidpi: -- :ref:`bool` **gui/theme/use_hidpi** - Make sure the theme used works with hidpi. +- :ref:`bool` **gui/theme/use_hidpi** + +Make sure the theme used works with hidpi. .. _class_ProjectSettings_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. +- :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: -- :ref:`int` **gui/timers/text_edit_idle_detect_sec** - Timer for detecting idle in the editor. +- :ref:`int` **gui/timers/text_edit_idle_detect_sec** + +Timer for detecting idle in the editor. .. _class_ProjectSettings_input/ui_accept: @@ -774,23 +1368,33 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_logging/file_logging/enable_file_logging: -- :ref:`bool` **logging/file_logging/enable_file_logging** - Log all output to a file. +- :ref:`bool` **logging/file_logging/enable_file_logging** + +Log all output to a file. .. _class_ProjectSettings_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. +- :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: -- :ref:`int` **logging/file_logging/max_log_files** - Amount of log files (used for rotation)/ +- :ref:`int` **logging/file_logging/max_log_files** + +Amount of log files (used for rotation)/ .. _class_ProjectSettings_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. +- :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: -- :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. +- :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_mono/debugger_agent/port: @@ -810,43 +1414,63 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_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. +- :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: -- :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. +- :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: -- :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. +- :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: -- :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. +- :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/remote_fs/max_pages: -- :ref:`int` **network/remote_fs/max_pages** - Maximum amount of pages used for remote filesystem (used by debugging). +- :ref:`int` **network/remote_fs/max_pages** + +Maximum amount of pages used for remote filesystem (used by debugging). .. _class_ProjectSettings_network/remote_fs/page_read_ahead: -- :ref:`int` **network/remote_fs/page_read_ahead** - Amount of read ahead used by remote filesystem. Improves latency. +- :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: -- :ref:`int` **network/remote_fs/page_size** - Page size used by remote filesystem. +- :ref:`int` **network/remote_fs/page_size** + +Page size used by remote filesystem. .. _class_ProjectSettings_network/ssl/certificates: -- :ref:`String` **network/ssl/certificates** - If your game or application uses HTTPS, a certificates file is needed. It must be set here. +- :ref:`String` **network/ssl/certificates** + +If your game or application uses HTTPS, a certificates file is needed. It must be set here. .. _class_ProjectSettings_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. +- :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: -- :ref:`int` **node/name_num_separator** - What to use to separate node name from number. This is mostly an editor setting. +- :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: @@ -854,7 +1478,9 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_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. +- :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: @@ -866,55 +1492,81 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_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. +- :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: -- :ref:`float` **physics/common/physics_jitter_fix** - Fix to improve physics jitter, specially on monitors where refresh rate is different than physics FPS. +- :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: -- :ref:`Color` **rendering/environment/default_clear_color** - Default background clear color. +- :ref:`Color` **rendering/environment/default_clear_color** + +Default background clear color. .. _class_ProjectSettings_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. +- :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: -- :ref:`int` **rendering/limits/buffers/canvas_polygon_buffer_size_kb** - Max buffer size for drawing polygons. Any polygon bigger than this will not work. +- :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: -- :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. +- :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: -- :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. +- :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: -- :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. +- :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: -- :ref:`int` **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. +- :ref:`int` **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: -- :ref:`bool` **rendering/quality/2d/use_pixel_snap** - Force snapping of polygons to pixels in 2D rendering. May help in some pixel art styles. +- :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: -- :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. +- :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: -- :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. +- :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: -- :ref:`int` **rendering/quality/directional_shadow/size** - Size in pixels of the directional shadow. +- :ref:`int` **rendering/quality/directional_shadow/size** + +Size in pixels of the directional shadow. .. _class_ProjectSettings_rendering/quality/directional_shadow/size.mobile: @@ -922,7 +1574,9 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_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. +- :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: @@ -930,15 +1584,21 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_rendering/quality/filters/anisotropic_filter_level: -- :ref:`int` **rendering/quality/filters/anisotropic_filter_level** - Maximum Anisotropic filter level used for textures when anisotropy enabled. +- :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: -- :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. +- :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: -- :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). +- :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: @@ -946,7 +1606,9 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_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). +- :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: @@ -954,7 +1616,9 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_rendering/quality/reflections/texture_array_reflections: -- :ref:`bool` **rendering/quality/reflections/texture_array_reflections** - For reflection probes and panorama backgrounds (sky), use a texure array instead of mipmaps. This reduces jitter noise on reflections, but costs more performance and memory. +- :ref:`bool` **rendering/quality/reflections/texture_array_reflections** + +For reflection probes and panorama backgrounds (sky), use a texure 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: @@ -962,7 +1626,9 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_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 inmensely. Can work to optimize on very low end mobile. +- :ref:`bool` **rendering/quality/shading/force_vertex_shading** + +Force vertex shading for all rendering. This can increase performance a lot, but also reduces quality inmensely. Can work to optimize on very low end mobile. .. _class_ProjectSettings_rendering/quality/shading/force_vertex_shading.mobile: @@ -970,23 +1636,33 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_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. +- :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: -- :ref:`int` **rendering/quality/shadow_atlas/quadrant_1_subdiv** - Subdivision quadrant size for shadow mapping. See shadow mapping documentation. +- :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: -- :ref:`int` **rendering/quality/shadow_atlas/quadrant_2_subdiv** - Subdivision quadrant size for shadow mapping. See shadow mapping documentation. +- :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: -- :ref:`int` **rendering/quality/shadow_atlas/quadrant_3_subdiv** - Subdivision quadrant size for shadow mapping. See shadow mapping documentation. +- :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: -- :ref:`int` **rendering/quality/shadow_atlas/size** - Size for shadow atlas (used for point and omni lights). See documentation. +- :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: @@ -994,7 +1670,9 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_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. +- :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: @@ -1002,11 +1680,15 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_rendering/quality/subsurface_scattering/follow_surface: -- :ref:`bool` **rendering/quality/subsurface_scattering/follow_surface** - Improves quality of subsurface scattering, but cost significantly increases. +- :ref:`bool` **rendering/quality/subsurface_scattering/follow_surface** + +Improves quality of subsurface scattering, but cost significantly increases. .. _class_ProjectSettings_rendering/quality/subsurface_scattering/quality: -- :ref:`int` **rendering/quality/subsurface_scattering/quality** - Quality setting for subsurface scaterring (samples taken). +- :ref:`int` **rendering/quality/subsurface_scattering/quality** + +Quality setting for subsurface scaterring (samples taken). .. _class_ProjectSettings_rendering/quality/subsurface_scattering/scale: @@ -1014,15 +1696,21 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_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. +- :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: -- :ref:`bool` **rendering/quality/voxel_cone_tracing/high_quality** - Use high quality voxel cone tracing (looks better, but requires a higher end GPU). +- :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: -- :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. +- :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: @@ -1030,29 +1718,36 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_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. +- :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: -- :ref:`bool` **rendering/vram_compression/import_etc2** - If the project uses this compression (usually high end mobile), texture importer will import these. +- :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: -- :ref:`bool` **rendering/vram_compression/import_pvrtc** - If the project uses this compression (usually iOS), texture importer will import these. +- :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: -- :ref:`bool` **rendering/vram_compression/import_s3tc** - If the project uses this compression (usually Desktop and Consoles), texture importer will import these. +- :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: - :ref:`Script` **script** - Method Descriptions ------------------- -.. _class_ProjectSettings_add_property_info: + .. _class_ProjectSettings_add_property_info: - void **add_property_info** **(** :ref:`Dictionary` hint **)** @@ -1073,72 +1768,71 @@ Example: ProjectSettings.add_property_info(property_info) -.. _class_ProjectSettings_clear: + .. _class_ProjectSettings_clear: - void **clear** **(** :ref:`String` name **)** Clear the whole configuration (not recommended, may break things). -.. _class_ProjectSettings_get_order: + .. _class_ProjectSettings_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_get_setting: - :ref:`Variant` **get_setting** **(** :ref:`String` name **)** const -.. _class_ProjectSettings_globalize_path: + .. _class_ProjectSettings_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_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_load_resource_pack: - :ref:`bool` **load_resource_pack** **(** :ref:`String` pack **)** -.. _class_ProjectSettings_localize_path: + .. _class_ProjectSettings_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_property_can_revert: - :ref:`bool` **property_can_revert** **(** :ref:`String` name **)** -.. _class_ProjectSettings_property_get_revert: + .. _class_ProjectSettings_property_get_revert: - :ref:`Variant` **property_get_revert** **(** :ref:`String` name **)** -.. _class_ProjectSettings_save: + .. _class_ProjectSettings_save: - :ref:`Error` **save** **(** **)** -.. _class_ProjectSettings_save_custom: + .. _class_ProjectSettings_save_custom: - :ref:`Error` **save_custom** **(** :ref:`String` file **)** -.. _class_ProjectSettings_set_initial_value: + .. _class_ProjectSettings_set_initial_value: - void **set_initial_value** **(** :ref:`String` name, :ref:`Variant` value **)** -.. _class_ProjectSettings_set_order: + .. _class_ProjectSettings_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_set_setting: - void **set_setting** **(** :ref:`String` name, :ref:`Variant` value **)** - diff --git a/classes/class_proximitygroup.rst b/classes/class_proximitygroup.rst index a947032b1..72b5632fc 100644 --- a/classes/class_proximitygroup.rst +++ b/classes/class_proximitygroup.rst @@ -8,6 +8,7 @@ ProximityGroup ============== **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,17 @@ Brief Description General purpose proximity-detection node. +Properties +---------- + ++-------------------------------------------------------+----------------------------------------------------------+ +| :ref:`DispatchMode` | :ref:`dispatch_mode` | ++-------------------------------------------------------+----------------------------------------------------------+ +| :ref:`Vector3` | :ref:`grid_radius` | ++-------------------------------------------------------+----------------------------------------------------------+ +| :ref:`String` | :ref:`group_name` | ++-------------------------------------------------------+----------------------------------------------------------+ + Methods ------- @@ -25,22 +37,20 @@ Methods Signals ------- -.. _class_ProximityGroup_broadcast: + .. _class_ProximityGroup_broadcast: - **broadcast** **(** :ref:`String` group_name, :ref:`Array` parameters **)** - Enumerations ------------ .. _enum_ProximityGroup_DispatchMode: -enum **DispatchMode** +enum **DispatchMode**: - **MODE_PROXY** = **0** - **MODE_SIGNAL** = **1** - Description ----------- @@ -53,20 +63,36 @@ Property Descriptions - :ref:`DispatchMode` **dispatch_mode** ++----------+--------------------------+ +| *Setter* | set_dispatch_mode(value) | ++----------+--------------------------+ +| *Getter* | get_dispatch_mode() | ++----------+--------------------------+ + .. _class_ProximityGroup_grid_radius: - :ref:`Vector3` **grid_radius** ++----------+------------------------+ +| *Setter* | set_grid_radius(value) | ++----------+------------------------+ +| *Getter* | get_grid_radius() | ++----------+------------------------+ + .. _class_ProximityGroup_group_name: - :ref:`String` **group_name** ++----------+-----------------------+ +| *Setter* | set_group_name(value) | ++----------+-----------------------+ +| *Getter* | get_group_name() | ++----------+-----------------------+ Method Descriptions ------------------- -.. _class_ProximityGroup_broadcast: + .. _class_ProximityGroup_broadcast: - void **broadcast** **(** :ref:`String` name, :ref:`Variant` parameters **)** - diff --git a/classes/class_proxytexture.rst b/classes/class_proxytexture.rst index 2a74ee4de..10f49a561 100644 --- a/classes/class_proxytexture.rst +++ b/classes/class_proxytexture.rst @@ -8,6 +8,7 @@ ProxyTexture ============ **Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description +Properties +---------- + ++-------------------------------+--------------------------------------+ +| :ref:`Texture` | :ref:`base` | ++-------------------------------+--------------------------------------+ + Property Descriptions --------------------- @@ -22,4 +30,9 @@ Property Descriptions - :ref:`Texture` **base** ++----------+-----------------+ +| *Setter* | set_base(value) | ++----------+-----------------+ +| *Getter* | get_base() | ++----------+-----------------+ diff --git a/classes/class_quadmesh.rst b/classes/class_quadmesh.rst index d0754f8ac..ce542e644 100644 --- a/classes/class_quadmesh.rst +++ b/classes/class_quadmesh.rst @@ -8,6 +8,7 @@ QuadMesh ======== **Inherits:** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Class representing a square mesh. +Properties +---------- + ++-------------------------------+----------------------------------+ +| :ref:`Vector2` | :ref:`size` | ++-------------------------------+----------------------------------+ + Description ----------- @@ -27,4 +35,9 @@ Property Descriptions - :ref:`Vector2` **size** ++----------+-----------------+ +| *Setter* | set_size(value) | ++----------+-----------------+ +| *Getter* | get_size() | ++----------+-----------------+ diff --git a/classes/class_quat.rst b/classes/class_quat.rst index 7ee0166fe..2b7592ce5 100644 --- a/classes/class_quat.rst +++ b/classes/class_quat.rst @@ -14,6 +14,19 @@ Brief Description Quaternion. +Properties +---------- + ++---------------------------+------------------------+ +| :ref:`float` | :ref:`w` | ++---------------------------+------------------------+ +| :ref:`float` | :ref:`x` | ++---------------------------+------------------------+ +| :ref:`float` | :ref:`y` | ++---------------------------+------------------------+ +| :ref:`float` | :ref:`z` | ++---------------------------+------------------------+ + Methods ------- @@ -57,7 +70,6 @@ Constants --------- - **IDENTITY** = **Quat( 0, 0, 0, 1 )** - Description ----------- @@ -72,130 +84,135 @@ Tutorials - `#interpolating-with-quaternions <../tutorials/3d/using_transforms.html#interpolating-with-quaternions>`_ in :doc:`../tutorials/3d/using_transforms` - :doc:`../tutorials/math/rotations` - Property Descriptions --------------------- .. _class_Quat_w: -- :ref:`float` **w** - W component of the quaternion. Default value: ``1`` +- :ref:`float` **w** + +W component of the quaternion. Default value: ``1`` .. _class_Quat_x: -- :ref:`float` **x** - X component of the quaternion. Default value: ``0`` +- :ref:`float` **x** + +X component of the quaternion. Default value: ``0`` .. _class_Quat_y: -- :ref:`float` **y** - Y component of the quaternion. Default value: ``0`` +- :ref:`float` **y** + +Y component of the quaternion. Default value: ``0`` .. _class_Quat_z: -- :ref:`float` **z** - Z component of the quaternion. Default value: ``0`` +- :ref:`float` **z** +Z component of the quaternion. Default value: ``0`` Method Descriptions ------------------- -.. _class_Quat_Quat: + .. _class_Quat_Quat: - :ref:`Quat` **Quat** **(** :ref:`Basis` from **)** Returns the rotation matrix corresponding to the given quaternion. -.. _class_Quat_Quat: + .. _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: + .. _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: + .. _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_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_dot: - :ref:`float` **dot** **(** :ref:`Quat` b **)** Returns the dot product of two quaternions. -.. _class_Quat_get_euler: + .. _class_Quat_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_inverse: - :ref:`Quat` **inverse** **(** **)** Returns the inverse of the quaternion. -.. _class_Quat_is_normalized: + .. _class_Quat_is_normalized: - :ref:`bool` **is_normalized** **(** **)** Returns whether the quaternion is normalized or not. -.. _class_Quat_length: + .. _class_Quat_length: - :ref:`float` **length** **(** **)** Returns the length of the quaternion. -.. _class_Quat_length_squared: + .. _class_Quat_length_squared: - :ref:`float` **length_squared** **(** **)** Returns the length of the quaternion, squared. -.. _class_Quat_normalized: + .. _class_Quat_normalized: - :ref:`Quat` **normalized** **(** **)** Returns a copy of the quaternion, normalized to unit length. -.. _class_Quat_set_axis_angle: + .. _class_Quat_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_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_slerp: - :ref:`Quat` **slerp** **(** :ref:`Quat` b, :ref:`float` t **)** Performs a spherical-linear interpolation with another quaternion. -.. _class_Quat_slerpni: + .. _class_Quat_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_xform: - :ref:`Vector3` **xform** **(** :ref:`Vector3` v **)** Transforms the vector ``v`` by this quaternion. - diff --git a/classes/class_range.rst b/classes/class_range.rst index 927158e6e..875de2a6f 100644 --- a/classes/class_range.rst +++ b/classes/class_range.rst @@ -8,7 +8,9 @@ Range ===== **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`SpinBox`, :ref:`ScrollBar`, :ref:`ProgressBar`, :ref:`TextureProgress`, :ref:`Slider` + **Category:** Core Brief Description @@ -16,6 +18,31 @@ Brief Description 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` | ++---------------------------+-------------------------------------------------+ + Methods ------- @@ -28,19 +55,18 @@ Methods Signals ------- -.. _class_Range_changed: + .. _class_Range_changed: - **changed** **(** **)** Emitted when :ref:`min_value`, :ref:`max_value`, :ref:`page`, or :ref:`step` change. -.. _class_Range_value_changed: + .. _class_Range_value_changed: - **value_changed** **(** :ref:`float` value **)** Emitted when :ref:`value` changes. - Description ----------- @@ -51,58 +77,136 @@ Property Descriptions .. _class_Range_allow_greater: -- :ref:`bool` **allow_greater** - If ``true`` :ref:`value` may be greater than :ref:`max_value`. Default value: ``false``. +- :ref:`bool` **allow_greater** + ++----------+--------------------------+ +| *Setter* | set_allow_greater(value) | ++----------+--------------------------+ +| *Getter* | is_greater_allowed() | ++----------+--------------------------+ + +If ``true`` :ref:`value` may be greater than :ref:`max_value`. Default value: ``false``. .. _class_Range_allow_lesser: -- :ref:`bool` **allow_lesser** - If ``true`` :ref:`value` may be less than :ref:`min_value`. Default value: ``false``. +- :ref:`bool` **allow_lesser** + ++----------+-------------------------+ +| *Setter* | set_allow_lesser(value) | ++----------+-------------------------+ +| *Getter* | is_lesser_allowed() | ++----------+-------------------------+ + +If ``true`` :ref:`value` may be less than :ref:`min_value`. Default value: ``false``. .. _class_Range_exp_edit: -- :ref:`bool` **exp_edit** - If ``true`` and ``min_value`` is greater than 0, ``value`` will be represented exponentially rather than linearly. +- :ref:`bool` **exp_edit** + ++----------+----------------------+ +| *Setter* | set_exp_ratio(value) | ++----------+----------------------+ +| *Getter* | is_ratio_exp() | ++----------+----------------------+ + +If ``true`` and ``min_value`` is greater than 0, ``value`` will be represented exponentially rather than linearly. .. _class_Range_max_value: -- :ref:`float` **max_value** - Maximum value. Range is clamped if ``value`` is greater than ``max_value``. Default value: ``100``. +- :ref:`float` **max_value** + ++----------+----------------+ +| *Setter* | set_max(value) | ++----------+----------------+ +| *Getter* | get_max() | ++----------+----------------+ + +Maximum value. Range is clamped if ``value`` is greater than ``max_value``. Default value: ``100``. .. _class_Range_min_value: -- :ref:`float` **min_value** - Minimum value. Range is clamped if ``value`` is less than ``min_value``. Default value: ``0``. +- :ref:`float` **min_value** + ++----------+----------------+ +| *Setter* | set_min(value) | ++----------+----------------+ +| *Getter* | get_min() | ++----------+----------------+ + +Minimum value. Range is clamped if ``value`` is less than ``min_value``. Default value: ``0``. .. _class_Range_page: -- :ref:`float` **page** - 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``. +- :ref:`float` **page** + ++----------+-----------------+ +| *Setter* | set_page(value) | ++----------+-----------------+ +| *Getter* | get_page() | ++----------+-----------------+ + +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: -- :ref:`float` **ratio** - The value mapped between 0 and 1. +- :ref:`float` **ratio** + ++----------+---------------------+ +| *Setter* | set_as_ratio(value) | ++----------+---------------------+ +| *Getter* | get_as_ratio() | ++----------+---------------------+ + +The value mapped between 0 and 1. .. _class_Range_rounded: -- :ref:`bool` **rounded** - If ``true`` ``value`` will always be rounded to the nearest integer. Default value: ``false``. +- :ref:`bool` **rounded** + ++----------+-------------------------------+ +| *Setter* | set_use_rounded_values(value) | ++----------+-------------------------------+ +| *Getter* | is_using_rounded_values() | ++----------+-------------------------------+ + +If ``true`` ``value`` will always be rounded to the nearest integer. Default value: ``false``. .. _class_Range_step: -- :ref:`float` **step** - 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. +- :ref:`float` **step** + ++----------+-----------------+ +| *Setter* | set_step(value) | ++----------+-----------------+ +| *Getter* | get_step() | ++----------+-----------------+ + +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: -- :ref:`float` **value** - Range's current value. +- :ref:`float` **value** ++----------+------------------+ +| *Setter* | set_value(value) | ++----------+------------------+ +| *Getter* | get_value() | ++----------+------------------+ + +Range's current value. Method Descriptions ------------------- -.. _class_Range_share: + .. _class_Range_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_unshare: - void **unshare** **(** **)** Stop range from sharing its member variables with any other. - diff --git a/classes/class_raycast.rst b/classes/class_raycast.rst index aa122ba56..e1134e657 100644 --- a/classes/class_raycast.rst +++ b/classes/class_raycast.rst @@ -8,6 +8,7 @@ RayCast ======= **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,23 @@ Brief Description 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` | ++-------------------------------+---------------------------------------------------------------+ + Methods ------- @@ -64,51 +82,98 @@ Property Descriptions .. _class_RayCast_cast_to: -- :ref:`Vector3` **cast_to** - The ray's destination point, relative to the RayCast's ``position``. +- :ref:`Vector3` **cast_to** + ++----------+--------------------+ +| *Setter* | set_cast_to(value) | ++----------+--------------------+ +| *Getter* | get_cast_to() | ++----------+--------------------+ + +The ray's destination point, relative to the RayCast's ``position``. .. _class_RayCast_collide_with_areas: -- :ref:`bool` **collide_with_areas** - If ``true``, collision with :ref:`Area`\ s will be reported. Default value: ``false``. +- :ref:`bool` **collide_with_areas** + ++----------+---------------------------------+ +| *Setter* | set_collide_with_areas(value) | ++----------+---------------------------------+ +| *Getter* | is_collide_with_areas_enabled() | ++----------+---------------------------------+ + +If ``true``, collision with :ref:`Area`\ s will be reported. Default value: ``false``. .. _class_RayCast_collide_with_bodies: -- :ref:`bool` **collide_with_bodies** - If ``true``, collision with :ref:`PhysicsBody`\ s will be reported. Default value: ``true``. +- :ref:`bool` **collide_with_bodies** + ++----------+----------------------------------+ +| *Setter* | set_collide_with_bodies(value) | ++----------+----------------------------------+ +| *Getter* | is_collide_with_bodies_enabled() | ++----------+----------------------------------+ + +If ``true``, collision with :ref:`PhysicsBody`\ s will be reported. Default value: ``true``. .. _class_RayCast_collision_mask: -- :ref:`int` **collision_mask** - The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. +- :ref:`int` **collision_mask** + ++----------+---------------------------+ +| *Setter* | set_collision_mask(value) | ++----------+---------------------------+ +| *Getter* | get_collision_mask() | ++----------+---------------------------+ + +The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. .. _class_RayCast_enabled: -- :ref:`bool` **enabled** - If ``true`` collisions will be reported. Default value: ``false``. +- :ref:`bool` **enabled** + ++----------+--------------------+ +| *Setter* | set_enabled(value) | ++----------+--------------------+ +| *Getter* | is_enabled() | ++----------+--------------------+ + +If ``true`` collisions will be reported. Default value: ``false``. .. _class_RayCast_exclude_parent: -- :ref:`bool` **exclude_parent** - If ``true`` collisions will be ignored for this RayCast's immediate parent. Default value: ``true``. +- :ref:`bool` **exclude_parent** ++----------+--------------------------------+ +| *Setter* | set_exclude_parent_body(value) | ++----------+--------------------------------+ +| *Getter* | get_exclude_parent_body() | ++----------+--------------------------------+ + +If ``true`` collisions will be ignored for this RayCast's immediate parent. Default value: ``true``. Method Descriptions ------------------- -.. _class_RayCast_add_exception: + .. _class_RayCast_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_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_clear_exceptions: - void **clear_exceptions** **(** **)** Removes all collision exceptions for this ray. -.. _class_RayCast_force_raycast_update: + .. _class_RayCast_force_raycast_update: - void **force_raycast_update** **(** **)** @@ -116,58 +181,57 @@ 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_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``). -.. _class_RayCast_get_collider_shape: + .. _class_RayCast_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``). -.. _class_RayCast_get_collision_mask_bit: + .. _class_RayCast_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_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_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_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_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_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_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Sets the bit index passed to the ``value`` passed. Note that bit indexes range from 0-19. - diff --git a/classes/class_raycast2d.rst b/classes/class_raycast2d.rst index a6b4a8664..b88b60d71 100644 --- a/classes/class_raycast2d.rst +++ b/classes/class_raycast2d.rst @@ -8,6 +8,7 @@ RayCast2D ========= **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,23 @@ Brief Description 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` | ++-------------------------------+-----------------------------------------------------------------+ + Methods ------- @@ -64,108 +82,154 @@ Property Descriptions .. _class_RayCast2D_cast_to: -- :ref:`Vector2` **cast_to** - The ray's destination point, relative to the RayCast's ``position``. +- :ref:`Vector2` **cast_to** + ++----------+--------------------+ +| *Setter* | set_cast_to(value) | ++----------+--------------------+ +| *Getter* | get_cast_to() | ++----------+--------------------+ + +The ray's destination point, relative to the RayCast's ``position``. .. _class_RayCast2D_collide_with_areas: -- :ref:`bool` **collide_with_areas** - If ``true``, collision with :ref:`Area2D`\ s will be reported. Default value: ``false``. +- :ref:`bool` **collide_with_areas** + ++----------+---------------------------------+ +| *Setter* | set_collide_with_areas(value) | ++----------+---------------------------------+ +| *Getter* | is_collide_with_areas_enabled() | ++----------+---------------------------------+ + +If ``true``, collision with :ref:`Area2D`\ s will be reported. Default value: ``false``. .. _class_RayCast2D_collide_with_bodies: -- :ref:`bool` **collide_with_bodies** - If ``true``, collision with :ref:`PhysicsBody2D`\ s will be reported. Default value: ``true``. +- :ref:`bool` **collide_with_bodies** + ++----------+----------------------------------+ +| *Setter* | set_collide_with_bodies(value) | ++----------+----------------------------------+ +| *Getter* | is_collide_with_bodies_enabled() | ++----------+----------------------------------+ + +If ``true``, collision with :ref:`PhysicsBody2D`\ s will be reported. Default value: ``true``. .. _class_RayCast2D_collision_mask: -- :ref:`int` **collision_mask** - The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. +- :ref:`int` **collision_mask** + ++----------+---------------------------+ +| *Setter* | set_collision_mask(value) | ++----------+---------------------------+ +| *Getter* | get_collision_mask() | ++----------+---------------------------+ + +The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. .. _class_RayCast2D_enabled: -- :ref:`bool` **enabled** - If ``true``, collisions will be reported. Default value: ``false``. +- :ref:`bool` **enabled** + ++----------+--------------------+ +| *Setter* | set_enabled(value) | ++----------+--------------------+ +| *Getter* | is_enabled() | ++----------+--------------------+ + +If ``true``, collisions will be reported. Default value: ``false``. .. _class_RayCast2D_exclude_parent: -- :ref:`bool` **exclude_parent** - If ``true``, the parent node will be excluded from collision detection. Default value: ``true``. +- :ref:`bool` **exclude_parent** ++----------+--------------------------------+ +| *Setter* | set_exclude_parent_body(value) | ++----------+--------------------------------+ +| *Getter* | get_exclude_parent_body() | ++----------+--------------------------------+ + +If ``true``, the parent node will be excluded from collision detection. Default value: ``true``. Method Descriptions ------------------- -.. _class_RayCast2D_add_exception: + .. _class_RayCast2D_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_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_clear_exceptions: - void **clear_exceptions** **(** **)** Removes all collision exceptions for this ray. -.. _class_RayCast2D_force_raycast_update: + .. _class_RayCast2D_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_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``). -.. _class_RayCast2D_get_collider_shape: + .. _class_RayCast2D_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``). -.. _class_RayCast2D_get_collision_mask_bit: + .. _class_RayCast2D_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_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_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_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_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_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_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. - diff --git a/classes/class_rayshape.rst b/classes/class_rayshape.rst index 40e378446..54011425f 100644 --- a/classes/class_rayshape.rst +++ b/classes/class_rayshape.rst @@ -8,6 +8,7 @@ RayShape ======== **Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description Ray shape for 3D collisions. +Properties +---------- + ++---------------------------+------------------------------------------------------+ +| :ref:`float` | :ref:`length` | ++---------------------------+------------------------------------------------------+ +| :ref:`bool` | :ref:`slips_on_slope` | ++---------------------------+------------------------------------------------------+ + Description ----------- @@ -25,10 +35,25 @@ Property Descriptions .. _class_RayShape_length: -- :ref:`float` **length** - The ray's length. +- :ref:`float` **length** + ++----------+-------------------+ +| *Setter* | set_length(value) | ++----------+-------------------+ +| *Getter* | get_length() | ++----------+-------------------+ + +The ray's length. .. _class_RayShape_slips_on_slope: -- :ref:`bool` **slips_on_slope** - If ``true`` allow the shape to return the correct normal. Default value: ``false``. +- :ref:`bool` **slips_on_slope** ++----------+---------------------------+ +| *Setter* | set_slips_on_slope(value) | ++----------+---------------------------+ +| *Getter* | get_slips_on_slope() | ++----------+---------------------------+ + +If ``true`` allow the shape to return the correct normal. Default value: ``false``. diff --git a/classes/class_rayshape2d.rst b/classes/class_rayshape2d.rst index aec30cc8d..02299975f 100644 --- a/classes/class_rayshape2d.rst +++ b/classes/class_rayshape2d.rst @@ -8,6 +8,7 @@ RayShape2D ========== **Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description Ray shape for 2D collisions. +Properties +---------- + ++---------------------------+--------------------------------------------------------+ +| :ref:`float` | :ref:`length` | ++---------------------------+--------------------------------------------------------+ +| :ref:`bool` | :ref:`slips_on_slope` | ++---------------------------+--------------------------------------------------------+ + Description ----------- @@ -25,10 +35,25 @@ Property Descriptions .. _class_RayShape2D_length: -- :ref:`float` **length** - The ray's length. +- :ref:`float` **length** + ++----------+-------------------+ +| *Setter* | set_length(value) | ++----------+-------------------+ +| *Getter* | get_length() | ++----------+-------------------+ + +The ray's length. .. _class_RayShape2D_slips_on_slope: -- :ref:`bool` **slips_on_slope** - If ``true`` allow the shape to return the correct normal. Default value: ``false``. +- :ref:`bool` **slips_on_slope** ++----------+---------------------------+ +| *Setter* | set_slips_on_slope(value) | ++----------+---------------------------+ +| *Getter* | get_slips_on_slope() | ++----------+---------------------------+ + +If ``true`` allow the shape to return the correct normal. Default value: ``false``. diff --git a/classes/class_rect2.rst b/classes/class_rect2.rst index 89dbaf500..f1c0a8b1a 100644 --- a/classes/class_rect2.rst +++ b/classes/class_rect2.rst @@ -14,6 +14,17 @@ Brief Description 2D Axis-aligned bounding box. +Properties +---------- + ++-------------------------------+---------------------------------------+ +| :ref:`Vector2` | :ref:`end` | ++-------------------------------+---------------------------------------+ +| :ref:`Vector2` | :ref:`position` | ++-------------------------------+---------------------------------------+ +| :ref:`Vector2` | :ref:`size` | ++-------------------------------+---------------------------------------+ + Methods ------- @@ -56,108 +67,111 @@ Tutorials --------- - :doc:`../tutorials/math/index` - Property Descriptions --------------------- .. _class_Rect2_end: -- :ref:`Vector2` **end** - Ending corner. +- :ref:`Vector2` **end** + +Ending corner. .. _class_Rect2_position: -- :ref:`Vector2` **position** - Position (starting corner). +- :ref:`Vector2` **position** + +Position (starting corner). .. _class_Rect2_size: -- :ref:`Vector2` **size** - Size from position to end. +- :ref:`Vector2` **size** +Size from position to end. Method Descriptions ------------------- -.. _class_Rect2_Rect2: + .. _class_Rect2_Rect2: - :ref:`Rect2` **Rect2** **(** :ref:`Vector2` position, :ref:`Vector2` size **)** Constructs a ``Rect2`` by position and size. -.. _class_Rect2_Rect2: + .. _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_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_clip: - :ref:`Rect2` **clip** **(** :ref:`Rect2` b **)** Returns the intersection of this ``Rect2`` and b. -.. _class_Rect2_encloses: + .. _class_Rect2_encloses: - :ref:`bool` **encloses** **(** :ref:`Rect2` b **)** Returns ``true`` if this ``Rect2`` completely encloses another one. -.. _class_Rect2_expand: + .. _class_Rect2_expand: - :ref:`Rect2` **expand** **(** :ref:`Vector2` to **)** Returns this ``Rect2`` expanded to include a given point. -.. _class_Rect2_get_area: + .. _class_Rect2_get_area: - :ref:`float` **get_area** **(** **)** Returns the area of the ``Rect2``. -.. _class_Rect2_grow: + .. _class_Rect2_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_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_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 Margin direction. -.. _class_Rect2_has_no_area: + .. _class_Rect2_has_no_area: - :ref:`bool` **has_no_area** **(** **)** Returns ``true`` if the ``Rect2`` is flat or empty. -.. _class_Rect2_has_point: + .. _class_Rect2_has_point: - :ref:`bool` **has_point** **(** :ref:`Vector2` point **)** Returns ``true`` if the ``Rect2`` contains a point. -.. _class_Rect2_intersects: + .. _class_Rect2_intersects: - :ref:`bool` **intersects** **(** :ref:`Rect2` b **)** Returns ``true`` if the ``Rect2`` overlaps with another. -.. _class_Rect2_merge: + .. _class_Rect2_merge: - :ref:`Rect2` **merge** **(** :ref:`Rect2` b **)** Returns a larger Rect2 that contains this Rect2 and ``with``. - diff --git a/classes/class_rectangleshape2d.rst b/classes/class_rectangleshape2d.rst index f76da904d..29cc58154 100644 --- a/classes/class_rectangleshape2d.rst +++ b/classes/class_rectangleshape2d.rst @@ -8,6 +8,7 @@ RectangleShape2D ================ **Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Rectangle shape for 2D collisions. +Properties +---------- + ++-------------------------------+------------------------------------------------+ +| :ref:`Vector2` | :ref:`extents` | ++-------------------------------+------------------------------------------------+ + Description ----------- @@ -25,6 +33,13 @@ Property Descriptions .. _class_RectangleShape2D_extents: -- :ref:`Vector2` **extents** - The rectangle's half extents. The width and height of this shape is twice the half extents. +- :ref:`Vector2` **extents** ++----------+--------------------+ +| *Setter* | set_extents(value) | ++----------+--------------------+ +| *Getter* | get_extents() | ++----------+--------------------+ + +The rectangle's half extents. The width and height of this shape is twice the half extents. diff --git a/classes/class_reference.rst b/classes/class_reference.rst index b2e25060f..41d10f1c1 100644 --- a/classes/class_reference.rst +++ b/classes/class_reference.rst @@ -8,7 +8,9 @@ Reference ========= **Inherits:** :ref:`Object` + **Inherited By:** :ref:`RegExMatch`, :ref:`RegEx`, :ref:`EncodedObjectAsID`, :ref:`SpatialGizmo`, :ref:`TriangleMesh`, :ref:`AnimationTrackEditPlugin`, :ref:`EditorScenePostImport`, :ref:`Expression`, :ref:`PhysicsShapeQueryResult`, :ref:`EditorSceneImporter`, :ref:`Physics2DTestMotionResult`, :ref:`FuncRef`, :ref:`File`, :ref:`TCP_Server`, :ref:`Physics2DShapeQueryResult`, :ref:`ConfigFile`, :ref:`StreamPeer`, :ref:`GDScriptNativeClass`, :ref:`HTTPClient`, :ref:`AudioStreamPlayback`, :ref:`VisualScriptFunctionState`, :ref:`EditorInspectorPlugin`, :ref:`Resource`, :ref:`KinematicCollision`, :ref:`SurfaceTool`, :ref:`JSONParseResult`, :ref:`SpatialVelocityTracker`, :ref:`EditorResourcePreviewGenerator`, :ref:`Physics2DShapeQueryParameters`, :ref:`EditorExportPlugin`, :ref:`ARVRInterface`, :ref:`UPNP`, :ref:`EditorScript`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`PacketPeer`, :ref:`Semaphore`, :ref:`XMLParser`, :ref:`EditorImportPlugin`, :ref:`Directory`, :ref:`WeakRef`, :ref:`GDScriptFunctionState`, :ref:`Marshalls`, :ref:`SceneState`, :ref:`PCKPacker`, :ref:`MeshDataTool`, :ref:`AStar`, :ref:`ResourceImporter`, :ref:`EditorResourceConversionPlugin`, :ref:`SceneTreeTimer`, :ref:`UPNPDevice`, :ref:`Thread`, :ref:`ResourceInteractiveLoader`, :ref:`PackedDataContainerRef`, :ref:`KinematicCollision2D`, :ref:`GDNative`, :ref:`PhysicsShapeQueryParameters` + **Category:** Core Brief Description @@ -35,20 +37,19 @@ Base class for anything that keeps a reference count. Resource and many other he Method Descriptions ------------------- -.. _class_Reference_init_ref: + .. _class_Reference_init_ref: - :ref:`bool` **init_ref** **(** **)** -.. _class_Reference_reference: + .. _class_Reference_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_unreference: - :ref:`bool` **unreference** **(** **)** Decrease the internal reference counter. Use this only if you really know what you are doing. - diff --git a/classes/class_referencerect.rst b/classes/class_referencerect.rst index c9cf0be29..6bf6d9137 100644 --- a/classes/class_referencerect.rst +++ b/classes/class_referencerect.rst @@ -8,6 +8,7 @@ ReferenceRect ============= **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Reference frame for GUI. +Properties +---------- + ++---------------------------+-------------------------------------------------------+ +| :ref:`Color` | :ref:`border_color` | ++---------------------------+-------------------------------------------------------+ + Description ----------- @@ -27,4 +35,9 @@ Property Descriptions - :ref:`Color` **border_color** ++----------+-------------------------+ +| *Setter* | set_border_color(value) | ++----------+-------------------------+ +| *Getter* | get_border_color() | ++----------+-------------------------+ diff --git a/classes/class_reflectionprobe.rst b/classes/class_reflectionprobe.rst index 1117418e1..e11d6a640 100644 --- a/classes/class_reflectionprobe.rst +++ b/classes/class_reflectionprobe.rst @@ -8,6 +8,7 @@ ReflectionProbe =============== **Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,22 +16,49 @@ 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` | ++----------------------------------------------------+---------------------------------------------------------------------------------+ + Enumerations ------------ .. _enum_ReflectionProbe_UpdateMode: -enum **UpdateMode** +enum **UpdateMode**: - **UPDATE_ONCE** = **0** - **UPDATE_ALWAYS** = **1** - Tutorials --------- - :doc:`../tutorials/3d/reflection_probes` - Property Descriptions --------------------- @@ -38,48 +66,119 @@ Property Descriptions - :ref:`bool` **box_projection** ++----------+----------------------------------+ +| *Setter* | set_enable_box_projection(value) | ++----------+----------------------------------+ +| *Getter* | is_box_projection_enabled() | ++----------+----------------------------------+ + .. _class_ReflectionProbe_cull_mask: - :ref:`int` **cull_mask** ++----------+----------------------+ +| *Setter* | set_cull_mask(value) | ++----------+----------------------+ +| *Getter* | get_cull_mask() | ++----------+----------------------+ + .. _class_ReflectionProbe_enable_shadows: - :ref:`bool` **enable_shadows** ++----------+---------------------------+ +| *Setter* | set_enable_shadows(value) | ++----------+---------------------------+ +| *Getter* | are_shadows_enabled() | ++----------+---------------------------+ + .. _class_ReflectionProbe_extents: - :ref:`Vector3` **extents** ++----------+--------------------+ +| *Setter* | set_extents(value) | ++----------+--------------------+ +| *Getter* | get_extents() | ++----------+--------------------+ + .. _class_ReflectionProbe_intensity: - :ref:`float` **intensity** ++----------+----------------------+ +| *Setter* | set_intensity(value) | ++----------+----------------------+ +| *Getter* | get_intensity() | ++----------+----------------------+ + .. _class_ReflectionProbe_interior_ambient_color: - :ref:`Color` **interior_ambient_color** ++----------+-----------------------------+ +| *Setter* | set_interior_ambient(value) | ++----------+-----------------------------+ +| *Getter* | get_interior_ambient() | ++----------+-----------------------------+ + .. _class_ReflectionProbe_interior_ambient_contrib: - :ref:`float` **interior_ambient_contrib** ++----------+------------------------------------------------+ +| *Setter* | set_interior_ambient_probe_contribution(value) | ++----------+------------------------------------------------+ +| *Getter* | get_interior_ambient_probe_contribution() | ++----------+------------------------------------------------+ + .. _class_ReflectionProbe_interior_ambient_energy: - :ref:`float` **interior_ambient_energy** ++----------+------------------------------------+ +| *Setter* | set_interior_ambient_energy(value) | ++----------+------------------------------------+ +| *Getter* | get_interior_ambient_energy() | ++----------+------------------------------------+ + .. _class_ReflectionProbe_interior_enable: - :ref:`bool` **interior_enable** ++----------+------------------------+ +| *Setter* | set_as_interior(value) | ++----------+------------------------+ +| *Getter* | is_set_as_interior() | ++----------+------------------------+ + .. _class_ReflectionProbe_max_distance: - :ref:`float` **max_distance** ++----------+-------------------------+ +| *Setter* | set_max_distance(value) | ++----------+-------------------------+ +| *Getter* | get_max_distance() | ++----------+-------------------------+ + .. _class_ReflectionProbe_origin_offset: - :ref:`Vector3` **origin_offset** ++----------+--------------------------+ +| *Setter* | set_origin_offset(value) | ++----------+--------------------------+ +| *Getter* | get_origin_offset() | ++----------+--------------------------+ + .. _class_ReflectionProbe_update_mode: - :ref:`UpdateMode` **update_mode** ++----------+------------------------+ +| *Setter* | set_update_mode(value) | ++----------+------------------------+ +| *Getter* | get_update_mode() | ++----------+------------------------+ diff --git a/classes/class_regex.rst b/classes/class_regex.rst index 5638caa49..35f06d1a1 100644 --- a/classes/class_regex.rst +++ b/classes/class_regex.rst @@ -8,6 +8,7 @@ RegEx ===== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -86,58 +87,57 @@ 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_get_group_count: - :ref:`int` **get_group_count** **(** **)** const Returns the number of capturing groups in compiled pattern. -.. _class_RegEx_get_names: + .. _class_RegEx_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_get_pattern: - :ref:`String` **get_pattern** **(** **)** const Returns the original search pattern that was compiled. -.. _class_RegEx_is_valid: + .. _class_RegEx_is_valid: - :ref:`bool` **is_valid** **(** **)** const Returns whether this object has a valid search pattern assigned. -.. _class_RegEx_search: + .. _class_RegEx_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_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_sub: - :ref:`String` **sub** **(** :ref:`String` subject, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` offset=0, :ref:`int` end=-1 **)** const Searches the text for the compiled pattern and replaces it with the specified string. Escapes and backreferences such as ``\1`` and ``\g`` expanded and resolved. By default only the first instance is replaced but it can be changed for all instances (global replacement). The region to search within can be specified without modifying where the start and end anchor would be. - diff --git a/classes/class_regexmatch.rst b/classes/class_regexmatch.rst index 45e1f4e67..91190d1b5 100644 --- a/classes/class_regexmatch.rst +++ b/classes/class_regexmatch.rst @@ -8,6 +8,7 @@ RegExMatch ========== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,17 @@ Brief Description Contains the results of a regex search. +Properties +---------- + ++-------------------------------------+------------------------------------------+ +| :ref:`Dictionary` | :ref:`names` | ++-------------------------------------+------------------------------------------+ +| :ref:`Array` | :ref:`strings` | ++-------------------------------------+------------------------------------------+ +| :ref:`String` | :ref:`subject` | ++-------------------------------------+------------------------------------------+ + Methods ------- @@ -38,21 +50,38 @@ Property Descriptions .. _class_RegExMatch_names: -- :ref:`Dictionary` **names** - 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. +- :ref:`Dictionary` **names** + ++----------+-------------+ +| *Getter* | get_names() | ++----------+-------------+ + +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: -- :ref:`Array` **strings** - An :ref:`Array` of the match and its capturing groups. +- :ref:`Array` **strings** + ++----------+---------------+ +| *Getter* | get_strings() | ++----------+---------------+ + +An :ref:`Array` of the match and its capturing groups. .. _class_RegExMatch_subject: -- :ref:`String` **subject** - The source string used with the search pattern to find this matching result. +- :ref:`String` **subject** ++----------+---------------+ +| *Getter* | get_subject() | ++----------+---------------+ + +The source string used with the search pattern to find this matching result. Method Descriptions ------------------- -.. _class_RegExMatch_get_end: + .. _class_RegExMatch_get_end: - :ref:`int` **get_end** **(** :ref:`Variant` name=0 **)** const @@ -60,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_get_group_count: - :ref:`int` **get_group_count** **(** **)** const Returns the number of capturing groups. -.. _class_RegExMatch_get_start: + .. _class_RegExMatch_get_start: - :ref:`int` **get_start** **(** :ref:`Variant` name=0 **)** const @@ -74,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_get_string: - :ref:`String` **get_string** **(** :ref:`Variant` name=0 **)** const @@ -82,4 +111,3 @@ Returns the substring of the match from the source string. Capturing groups can Returns an empty string if the group did not match or doesn't exist. - diff --git a/classes/class_remotetransform.rst b/classes/class_remotetransform.rst index 40d82ec88..1759f57b6 100644 --- a/classes/class_remotetransform.rst +++ b/classes/class_remotetransform.rst @@ -8,6 +8,7 @@ RemoteTransform =============== **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,21 @@ Brief Description RemoteTransform pushes its own :ref:`Transform` to another :ref:`Spatial` derived Node in the scene. +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` | ++---------------------------------+-----------------------------------------------------------------------------+ + Description ----------- @@ -27,22 +43,61 @@ Property Descriptions .. _class_RemoteTransform_remote_path: -- :ref:`NodePath` **remote_path** - The :ref:`NodePath` to the remote node, relative to the RemoteTransform's position in the scene. +- :ref:`NodePath` **remote_path** + ++----------+------------------------+ +| *Setter* | set_remote_node(value) | ++----------+------------------------+ +| *Getter* | get_remote_node() | ++----------+------------------------+ + +The :ref:`NodePath` to the remote node, relative to the RemoteTransform's position in the scene. .. _class_RemoteTransform_update_position: -- :ref:`bool` **update_position** - If ``true`` the remote node's position is updated. Default value: ``true``. +- :ref:`bool` **update_position** + ++----------+----------------------------+ +| *Setter* | set_update_position(value) | ++----------+----------------------------+ +| *Getter* | get_update_position() | ++----------+----------------------------+ + +If ``true`` the remote node's position is updated. Default value: ``true``. .. _class_RemoteTransform_update_rotation: -- :ref:`bool` **update_rotation** - If ``true`` the remote node's rotation is updated. Default value: ``true``. +- :ref:`bool` **update_rotation** + ++----------+----------------------------+ +| *Setter* | set_update_rotation(value) | ++----------+----------------------------+ +| *Getter* | get_update_rotation() | ++----------+----------------------------+ + +If ``true`` the remote node's rotation is updated. Default value: ``true``. .. _class_RemoteTransform_update_scale: -- :ref:`bool` **update_scale** - If ``true`` the remote node's scale is updated. Default value: ``true``. +- :ref:`bool` **update_scale** + ++----------+-------------------------+ +| *Setter* | set_update_scale(value) | ++----------+-------------------------+ +| *Getter* | get_update_scale() | ++----------+-------------------------+ + +If ``true`` the remote node's scale is updated. Default value: ``true``. .. _class_RemoteTransform_use_global_coordinates: -- :ref:`bool` **use_global_coordinates** - If ``true`` global coordinates are used. If ``false`` local coordinates are used. Default value: ``true``. +- :ref:`bool` **use_global_coordinates** ++----------+-----------------------------------+ +| *Setter* | set_use_global_coordinates(value) | ++----------+-----------------------------------+ +| *Getter* | get_use_global_coordinates() | ++----------+-----------------------------------+ + +If ``true`` global coordinates are used. If ``false`` local coordinates are used. Default value: ``true``. diff --git a/classes/class_remotetransform2d.rst b/classes/class_remotetransform2d.rst index f76dde7b1..d1678a79e 100644 --- a/classes/class_remotetransform2d.rst +++ b/classes/class_remotetransform2d.rst @@ -8,6 +8,7 @@ RemoteTransform2D ================= **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,21 @@ Brief Description RemoteTransform2D pushes its own :ref:`Transform2D` to another :ref:`CanvasItem` derived Node in the scene. +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` | ++---------------------------------+-------------------------------------------------------------------------------+ + Description ----------- @@ -27,22 +43,61 @@ Property Descriptions .. _class_RemoteTransform2D_remote_path: -- :ref:`NodePath` **remote_path** - The :ref:`NodePath` to the remote node, relative to the RemoteTransform2D's position in the scene. +- :ref:`NodePath` **remote_path** + ++----------+------------------------+ +| *Setter* | set_remote_node(value) | ++----------+------------------------+ +| *Getter* | get_remote_node() | ++----------+------------------------+ + +The :ref:`NodePath` to the remote node, relative to the RemoteTransform2D's position in the scene. .. _class_RemoteTransform2D_update_position: -- :ref:`bool` **update_position** - If ``true`` the remote node's position is updated. Default value: ``true``. +- :ref:`bool` **update_position** + ++----------+----------------------------+ +| *Setter* | set_update_position(value) | ++----------+----------------------------+ +| *Getter* | get_update_position() | ++----------+----------------------------+ + +If ``true`` the remote node's position is updated. Default value: ``true``. .. _class_RemoteTransform2D_update_rotation: -- :ref:`bool` **update_rotation** - If ``true`` the remote node's rotation is updated. Default value: ``true``. +- :ref:`bool` **update_rotation** + ++----------+----------------------------+ +| *Setter* | set_update_rotation(value) | ++----------+----------------------------+ +| *Getter* | get_update_rotation() | ++----------+----------------------------+ + +If ``true`` the remote node's rotation is updated. Default value: ``true``. .. _class_RemoteTransform2D_update_scale: -- :ref:`bool` **update_scale** - If ``true`` the remote node's scale is updated. Default value: ``true``. +- :ref:`bool` **update_scale** + ++----------+-------------------------+ +| *Setter* | set_update_scale(value) | ++----------+-------------------------+ +| *Getter* | get_update_scale() | ++----------+-------------------------+ + +If ``true`` the remote node's scale is updated. Default value: ``true``. .. _class_RemoteTransform2D_use_global_coordinates: -- :ref:`bool` **use_global_coordinates** - If ``true`` global coordinates are used. If ``false`` local coordinates are used. Default value: ``true``. +- :ref:`bool` **use_global_coordinates** ++----------+-----------------------------------+ +| *Setter* | set_use_global_coordinates(value) | ++----------+-----------------------------------+ +| *Getter* | get_use_global_coordinates() | ++----------+-----------------------------------+ + +If ``true`` global coordinates are used. If ``false`` local coordinates are used. Default value: ``true``. diff --git a/classes/class_resource.rst b/classes/class_resource.rst index ae345a00f..fb6ec7517 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -8,7 +8,9 @@ Resource ======== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`AnimationNodeStateMachinePlayback`, :ref:`AudioStream`, :ref:`Sky`, :ref:`Theme`, :ref:`TextureLayered`, :ref:`CubeMap`, :ref:`DynamicFontData`, :ref:`InputEvent`, :ref:`VisualShaderNode`, :ref:`Curve2D`, :ref:`Image`, :ref:`Shape`, :ref:`Shape2D`, :ref:`Curve`, :ref:`Mesh`, :ref:`StyleBox`, :ref:`Environment`, :ref:`GDNativeLibrary`, :ref:`Material`, :ref:`PhysicsMaterial`, :ref:`VideoStream`, :ref:`PackedScene`, :ref:`Texture`, :ref:`TextFile`, :ref:`ButtonGroup`, :ref:`TileSet`, :ref:`ShortCut`, :ref:`BitMap`, :ref:`Animation`, :ref:`BakedLightmapData`, :ref:`PolygonPathFinder`, :ref:`Translation`, :ref:`Shader`, :ref:`Script`, :ref:`AudioBusLayout`, :ref:`AnimationNode`, :ref:`World`, :ref:`AudioEffect`, :ref:`VisualScriptNode`, :ref:`AnimationNodeStateMachineTransition`, :ref:`World2D`, :ref:`GIProbeData`, :ref:`Font`, :ref:`SpriteFrames`, :ref:`MeshLibrary`, :ref:`Curve3D`, :ref:`NavigationPolygon`, :ref:`EditorSettings`, :ref:`Gradient`, :ref:`OccluderPolygon2D`, :ref:`MultiMesh`, :ref:`PackedDataContainer`, :ref:`NavigationMesh` + **Category:** Core Brief Description @@ -16,6 +18,17 @@ Brief Description Base class for all resources. +Properties +---------- + ++-----------------------------+------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`resource_local_to_scene` | ++-----------------------------+------------------------------------------------------------------------+ +| :ref:`String` | :ref:`resource_name` | ++-----------------------------+------------------------------------------------------------------------+ +| :ref:`String` | :ref:`resource_path` | ++-----------------------------+------------------------------------------------------------------------+ + Methods ------- @@ -36,11 +49,10 @@ Methods Signals ------- -.. _class_Resource_changed: + .. _class_Resource_changed: - **changed** **(** **)** - Description ----------- @@ -53,44 +65,60 @@ Property Descriptions - :ref:`bool` **resource_local_to_scene** ++----------+---------------------------+ +| *Setter* | set_local_to_scene(value) | ++----------+---------------------------+ +| *Getter* | is_local_to_scene() | ++----------+---------------------------+ + .. _class_Resource_resource_name: - :ref:`String` **resource_name** ++----------+-----------------+ +| *Setter* | set_name(value) | ++----------+-----------------+ +| *Getter* | get_name() | ++----------+-----------------+ + .. _class_Resource_resource_path: - :ref:`String` **resource_path** ++----------+-----------------+ +| *Setter* | set_path(value) | ++----------+-----------------+ +| *Getter* | get_path() | ++----------+-----------------+ Method Descriptions ------------------- -.. _class_Resource__setup_local_to_scene: + .. _class_Resource__setup_local_to_scene: - void **_setup_local_to_scene** **(** **)** virtual -.. _class_Resource_duplicate: + .. _class_Resource_duplicate: - :ref:`Resource` **duplicate** **(** :ref:`bool` subresources=false **)** const -.. _class_Resource_get_local_scene: + .. _class_Resource_get_local_scene: - :ref:`Node` **get_local_scene** **(** **)** const -.. _class_Resource_get_rid: + .. _class_Resource_get_rid: - :ref:`RID` **get_rid** **(** **)** const Return the RID of the resource (or an empty RID). Many resources (such as :ref:`Texture`, :ref:`Mesh`, etc) are high level abstractions of resources stored in a server, so this function will return the original RID. -.. _class_Resource_setup_local_to_scene: + .. _class_Resource_setup_local_to_scene: - void **setup_local_to_scene** **(** **)** -.. _class_Resource_take_over_path: + .. _class_Resource_take_over_path: - void **take_over_path** **(** :ref:`String` path **)** Set the path of the resource. Differs from set_path(), if another ``Resource`` exists with "path" it over-takes it, instead of failing. - diff --git a/classes/class_resourceimporter.rst b/classes/class_resourceimporter.rst index 319279f5e..b00d8b7d6 100644 --- a/classes/class_resourceimporter.rst +++ b/classes/class_resourceimporter.rst @@ -8,7 +8,9 @@ ResourceImporter ================ **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`ResourceImporterOGGVorbis` + **Category:** Core Brief Description diff --git a/classes/class_resourceimporteroggvorbis.rst b/classes/class_resourceimporteroggvorbis.rst index 8a295d032..51015b364 100644 --- a/classes/class_resourceimporteroggvorbis.rst +++ b/classes/class_resourceimporteroggvorbis.rst @@ -8,6 +8,7 @@ ResourceImporterOGGVorbis ========================= **Inherits:** :ref:`ResourceImporter` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_resourceinteractiveloader.rst b/classes/class_resourceinteractiveloader.rst index 9acc2f3f4..ed937bc7a 100644 --- a/classes/class_resourceinteractiveloader.rst +++ b/classes/class_resourceinteractiveloader.rst @@ -8,6 +8,7 @@ ResourceInteractiveLoader ========================= **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -38,32 +39,31 @@ Interactive Resource Loader. This object is returned by ResourceLoader when perf Method Descriptions ------------------- -.. _class_ResourceInteractiveLoader_get_resource: + .. _class_ResourceInteractiveLoader_get_resource: - :ref:`Resource` **get_resource** **(** **)** Return the loaded resource (only if loaded). Otherwise, returns null. -.. _class_ResourceInteractiveLoader_get_stage: + .. _class_ResourceInteractiveLoader_get_stage: - :ref:`int` **get_stage** **(** **)** const Return the load stage. The total amount of stages can be queried with :ref:`get_stage_count` -.. _class_ResourceInteractiveLoader_get_stage_count: + .. _class_ResourceInteractiveLoader_get_stage_count: - :ref:`int` **get_stage_count** **(** **)** const Return the total amount of stages (calls to :ref:`poll`) needed to completely load this resource. -.. _class_ResourceInteractiveLoader_poll: + .. _class_ResourceInteractiveLoader_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`. -.. _class_ResourceInteractiveLoader_wait: + .. _class_ResourceInteractiveLoader_wait: - :ref:`Error` **wait** **(** **)** - diff --git a/classes/class_resourceloader.rst b/classes/class_resourceloader.rst index 0b5df65e8..74538c9aa 100644 --- a/classes/class_resourceloader.rst +++ b/classes/class_resourceloader.rst @@ -8,6 +8,7 @@ ResourceLoader ============== **Inherits:** :ref:`Object` + **Category:** Core Brief Description @@ -44,42 +45,41 @@ Resource Loader. This is a static object accessible as ``ResourceLoader``. GDScr Method Descriptions ------------------- -.. _class_ResourceLoader_exists: + .. _class_ResourceLoader_exists: - :ref:`bool` **exists** **(** :ref:`String` path, :ref:`String` type_hint="" **)** -.. _class_ResourceLoader_get_dependencies: + .. _class_ResourceLoader_get_dependencies: - :ref:`PoolStringArray` **get_dependencies** **(** :ref:`String` path **)** -.. _class_ResourceLoader_get_recognized_extensions_for_type: + .. _class_ResourceLoader_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_has: - :ref:`bool` **has** **(** :ref:`String` path **)** -.. _class_ResourceLoader_has_cached: + .. _class_ResourceLoader_has_cached: - :ref:`bool` **has_cached** **(** :ref:`String` path **)** -.. _class_ResourceLoader_load: + .. _class_ResourceLoader_load: - :ref:`Resource` **load** **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` p_no_cache=false **)** -.. _class_ResourceLoader_load_interactive: + .. _class_ResourceLoader_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_set_abort_on_missing_resources: - void **set_abort_on_missing_resources** **(** :ref:`bool` abort **)** Change the behavior on missing sub-resources. Default is to abort load. - diff --git a/classes/class_resourcepreloader.rst b/classes/class_resourcepreloader.rst index 10764b79a..8d13a5430 100644 --- a/classes/class_resourcepreloader.rst +++ b/classes/class_resourcepreloader.rst @@ -8,6 +8,7 @@ ResourcePreloader ================= **Inherits:** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -40,38 +41,37 @@ Resource Preloader Node. This node is used to preload sub-resources inside a sce Method Descriptions ------------------- -.. _class_ResourcePreloader_add_resource: + .. _class_ResourcePreloader_add_resource: - void **add_resource** **(** :ref:`String` name, :ref:`Resource` resource **)** -.. _class_ResourcePreloader_get_resource: + .. _class_ResourcePreloader_get_resource: - :ref:`Resource` **get_resource** **(** :ref:`String` name **)** const Return the resource given a text-id. -.. _class_ResourcePreloader_get_resource_list: + .. _class_ResourcePreloader_get_resource_list: - :ref:`PoolStringArray` **get_resource_list** **(** **)** const Return the list of resources inside the preloader. -.. _class_ResourcePreloader_has_resource: + .. _class_ResourcePreloader_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_remove_resource: - void **remove_resource** **(** :ref:`String` name **)** Remove a resource from the preloader by text id. -.. _class_ResourcePreloader_rename_resource: + .. _class_ResourcePreloader_rename_resource: - void **rename_resource** **(** :ref:`String` name, :ref:`String` newname **)** Rename a resource inside the preloader, from a text-id to a new text-id. - diff --git a/classes/class_resourcesaver.rst b/classes/class_resourcesaver.rst index 59ebf643f..34111a74f 100644 --- a/classes/class_resourcesaver.rst +++ b/classes/class_resourcesaver.rst @@ -8,6 +8,7 @@ ResourceSaver ============= **Inherits:** :ref:`Object` + **Category:** Core Brief Description @@ -29,7 +30,7 @@ Enumerations .. _enum_ResourceSaver_SaverFlags: -enum **SaverFlags** +enum **SaverFlags**: - **FLAG_RELATIVE_PATHS** = **1** - **FLAG_BUNDLE_RESOURCES** = **2** @@ -38,7 +39,6 @@ enum **SaverFlags** - **FLAG_SAVE_BIG_ENDIAN** = **16** - **FLAG_COMPRESS** = **32** - Description ----------- @@ -47,16 +47,15 @@ Resource saving interface, used for saving resources to disk. Method Descriptions ------------------- -.. _class_ResourceSaver_get_recognized_extensions: + .. _class_ResourceSaver_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_save: - :ref:`Error` **save** **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags=0 **)** Saves a resource to disk. - diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index 5b8a81626..d29fe692b 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -8,6 +8,7 @@ RichTextLabel ============= **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,33 @@ Brief Description 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` | ++-----------------------------+---------------------------------------------------------------------------------------+ + Methods ------- @@ -68,34 +96,72 @@ Methods | 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` | ++---------------------------------+---------------------------------------------------------------------+ + Signals ------- -.. _class_RichTextLabel_meta_clicked: + .. _class_RichTextLabel_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. -.. _class_RichTextLabel_meta_hover_ended: + .. _class_RichTextLabel_meta_hover_ended: - **meta_hover_ended** **(** :ref:`Nil` meta **)** Triggers when the mouse exits a meta tag. -.. _class_RichTextLabel_meta_hover_started: + .. _class_RichTextLabel_meta_hover_started: - **meta_hover_started** **(** :ref:`Nil` meta **)** Triggers when the mouse enters a meta tag. - Enumerations ------------ .. _enum_RichTextLabel_ListType: -enum **ListType** +enum **ListType**: - **LIST_NUMBERS** = **0** - **LIST_LETTERS** = **1** @@ -103,7 +169,7 @@ enum **ListType** .. _enum_RichTextLabel_Align: -enum **Align** +enum **Align**: - **ALIGN_LEFT** = **0** - **ALIGN_CENTER** = **1** @@ -112,7 +178,7 @@ enum **Align** .. _enum_RichTextLabel_ItemType: -enum **ItemType** +enum **ItemType**: - **ITEM_FRAME** = **0** - **ITEM_TEXT** = **1** @@ -127,7 +193,6 @@ enum **ItemType** - **ITEM_TABLE** = **10** - **ITEM_META** = **11** - Description ----------- @@ -139,199 +204,285 @@ Tutorials --------- - :doc:`../tutorials/gui/bbcode_in_richtextlabel` - Property Descriptions --------------------- .. _class_RichTextLabel_bbcode_enabled: -- :ref:`bool` **bbcode_enabled** - If ``true`` the label uses BBCode formatting. Default value: ``false``. +- :ref:`bool` **bbcode_enabled** + ++----------+-----------------------+ +| *Setter* | set_use_bbcode(value) | ++----------+-----------------------+ +| *Getter* | is_using_bbcode() | ++----------+-----------------------+ + +If ``true`` the label uses BBCode formatting. Default value: ``false``. .. _class_RichTextLabel_bbcode_text: -- :ref:`String` **bbcode_text** - The label's text in BBCode format. Is not representative of manual modifications to the internal tag stack. Erases changes made by other methods when edited. +- :ref:`String` **bbcode_text** + ++----------+-------------------+ +| *Setter* | set_bbcode(value) | ++----------+-------------------+ +| *Getter* | get_bbcode() | ++----------+-------------------+ + +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: -- :ref:`bool` **meta_underlined** - If ``true``, the label underlines meta tags such as url{text}. Default value: ``true``. +- :ref:`bool` **meta_underlined** + ++----------+---------------------------+ +| *Setter* | set_meta_underline(value) | ++----------+---------------------------+ +| *Getter* | is_meta_underlined() | ++----------+---------------------------+ + +If ``true``, the label underlines meta tags such as url{text}. Default value: ``true``. .. _class_RichTextLabel_override_selected_font_color: -- :ref:`bool` **override_selected_font_color** - If ``true`` the label uses the custom font color. Default value: ``false``. +- :ref:`bool` **override_selected_font_color** + ++----------+-----------------------------------------+ +| *Setter* | set_override_selected_font_color(value) | ++----------+-----------------------------------------+ +| *Getter* | is_overriding_selected_font_color() | ++----------+-----------------------------------------+ + +If ``true`` the label uses the custom font color. Default value: ``false``. .. _class_RichTextLabel_percent_visible: -- :ref:`float` **percent_visible** - The text's visibility, as a :ref:`float` between 0.0 and 1.0. +- :ref:`float` **percent_visible** + ++----------+----------------------------+ +| *Setter* | set_percent_visible(value) | ++----------+----------------------------+ +| *Getter* | get_percent_visible() | ++----------+----------------------------+ + +The text's visibility, as a :ref:`float` between 0.0 and 1.0. .. _class_RichTextLabel_scroll_active: -- :ref:`bool` **scroll_active** - If ``true``, the scrollbar is visible. Does not block scrolling completely. See :ref:`scroll_to_line`. Default value: ``true``. +- :ref:`bool` **scroll_active** + ++----------+--------------------------+ +| *Setter* | set_scroll_active(value) | ++----------+--------------------------+ +| *Getter* | is_scroll_active() | ++----------+--------------------------+ + +If ``true``, the scrollbar is visible. Does not block scrolling completely. See :ref:`scroll_to_line`. Default value: ``true``. .. _class_RichTextLabel_scroll_following: -- :ref:`bool` **scroll_following** - If ``true``, the window scrolls down to display new content automatically. Default value: ``false``. +- :ref:`bool` **scroll_following** + ++----------+--------------------------+ +| *Setter* | set_scroll_follow(value) | ++----------+--------------------------+ +| *Getter* | is_scroll_following() | ++----------+--------------------------+ + +If ``true``, the window scrolls down to display new content automatically. Default value: ``false``. .. _class_RichTextLabel_selection_enabled: -- :ref:`bool` **selection_enabled** - If ``true``, the label allows text selection. +- :ref:`bool` **selection_enabled** + ++----------+------------------------------+ +| *Setter* | set_selection_enabled(value) | ++----------+------------------------------+ +| *Getter* | is_selection_enabled() | ++----------+------------------------------+ + +If ``true``, the label allows text selection. .. _class_RichTextLabel_tab_size: -- :ref:`int` **tab_size** - The number of spaces associated with a single tab length. Does not affect "\\t" in text tags, only indent tags. +- :ref:`int` **tab_size** + ++----------+---------------------+ +| *Setter* | set_tab_size(value) | ++----------+---------------------+ +| *Getter* | get_tab_size() | ++----------+---------------------+ + +The number of spaces associated with a single tab length. Does not affect "\\t" in text tags, only indent tags. .. _class_RichTextLabel_text: -- :ref:`String` **text** - The raw text of the label. +- :ref:`String` **text** + ++----------+-----------------+ +| *Setter* | set_text(value) | ++----------+-----------------+ +| *Getter* | get_text() | ++----------+-----------------+ + +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`. .. _class_RichTextLabel_visible_characters: -- :ref:`int` **visible_characters** - The restricted number of characters to display in the label. +- :ref:`int` **visible_characters** ++----------+-------------------------------+ +| *Setter* | set_visible_characters(value) | ++----------+-------------------------------+ +| *Getter* | get_visible_characters() | ++----------+-------------------------------+ + +The restricted number of characters to display in the label. Method Descriptions ------------------- -.. _class_RichTextLabel_add_image: + .. _class_RichTextLabel_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_add_text: - void **add_text** **(** :ref:`String` text **)** Adds raw non-bbcode-parsed text to the tag stack. -.. _class_RichTextLabel_append_bbcode: + .. _class_RichTextLabel_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_clear: - void **clear** **(** **)** Clears the tag stack and sets :ref:`bbcode_text` to an empty string. -.. _class_RichTextLabel_get_content_height: + .. _class_RichTextLabel_get_content_height: - :ref:`int` **get_content_height** **(** **)** Returns the height of the content. -.. _class_RichTextLabel_get_line_count: + .. _class_RichTextLabel_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_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_get_v_scroll: - :ref:`VScrollBar` **get_v_scroll** **(** **)** Returns the vertical scrollbar. -.. _class_RichTextLabel_get_visible_line_count: + .. _class_RichTextLabel_get_visible_line_count: - :ref:`int` **get_visible_line_count** **(** **)** const Returns the number of visible lines. -.. _class_RichTextLabel_newline: + .. _class_RichTextLabel_newline: - void **newline** **(** **)** Adds a newline tag to the tag stack. -.. _class_RichTextLabel_parse_bbcode: + .. _class_RichTextLabel_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. -.. _class_RichTextLabel_pop: + .. _class_RichTextLabel_pop: - void **pop** **(** **)** Terminates the current tag. Use after ``push_*`` methods to close bbcodes manually. Does not need to follow ``add_*`` methods. -.. _class_RichTextLabel_push_align: + .. _class_RichTextLabel_push_align: - void **push_align** **(** :ref:`Align` align **)** Adds a ``[right]`` tag to the tag stack. -.. _class_RichTextLabel_push_cell: + .. _class_RichTextLabel_push_cell: - void **push_cell** **(** **)** Adds a ``[cell]`` tag to the tag stack. Must be inside a table tag. See :ref:`push_table` for details. -.. _class_RichTextLabel_push_color: + .. _class_RichTextLabel_push_color: - void **push_color** **(** :ref:`Color` color **)** Adds a ``[color]`` tag to the tag stack. -.. _class_RichTextLabel_push_font: + .. _class_RichTextLabel_push_font: - void **push_font** **(** :ref:`Font` font **)** Adds a ``[font]`` tag to the tag stack. Overrides default fonts for its duration. -.. _class_RichTextLabel_push_indent: + .. _class_RichTextLabel_push_indent: - void **push_indent** **(** :ref:`int` level **)** Adds an ``[indent]`` tag to the tag stack. Multiplies "level" by current tab_size to determine new margin length. -.. _class_RichTextLabel_push_list: + .. _class_RichTextLabel_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_push_meta: - void **push_meta** **(** :ref:`Variant` data **)** Adds a meta tag to the tag stack. Similar to the bbcode ``[url=something]{text}[/url]``, but supports non-:ref:`String` metadata types. -.. _class_RichTextLabel_push_table: + .. _class_RichTextLabel_push_table: - void **push_table** **(** :ref:`int` columns **)** Adds a ``[table=columns]`` tag to the tag stack. -.. _class_RichTextLabel_push_underline: + .. _class_RichTextLabel_push_underline: - void **push_underline** **(** **)** Adds a ``[u]`` tag to the tag stack. -.. _class_RichTextLabel_remove_line: + .. _class_RichTextLabel_remove_line: - :ref:`bool` **remove_line** **(** :ref:`int` line **)** Removes a line of content from the label. Returns ``true`` if the line exists. -.. _class_RichTextLabel_scroll_to_line: + .. _class_RichTextLabel_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_set_table_column_expand: - void **set_table_column_expand** **(** :ref:`int` column, :ref:`bool` expand, :ref:`int` ratio **)** @@ -341,4 +492,3 @@ For example, 2 columns with ratios 3 and 4 plus 70 pixels in available width wou Columns with a ``false`` expand will not contribute to the total ratio. - diff --git a/classes/class_rid.rst b/classes/class_rid.rst index c4bd3eb58..fc67a61e0 100644 --- a/classes/class_rid.rst +++ b/classes/class_rid.rst @@ -31,16 +31,15 @@ The RID type is used to access the unique integer ID of a resource. They are op Method Descriptions ------------------- -.. _class_RID_RID: + .. _class_RID_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_get_id: - :ref:`int` **get_id** **(** **)** Returns the ID of the referenced resource. - diff --git a/classes/class_rigidbody.rst b/classes/class_rigidbody.rst index b50ce3b77..fb06e5da5 100644 --- a/classes/class_rigidbody.rst +++ b/classes/class_rigidbody.rst @@ -8,7 +8,9 @@ RigidBody ========= **Inherits:** :ref:`PhysicsBody` **<** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`VehicleBody` + **Category:** Core Brief Description @@ -16,6 +18,57 @@ Brief Description 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` | ++-----------------------------------------------+-----------------------------------------------------------------------------+ + Methods ------- @@ -42,19 +95,19 @@ Methods Signals ------- -.. _class_RigidBody_body_entered: + .. _class_RigidBody_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_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_body_shape_entered: - **body_shape_entered** **(** :ref:`int` body_id, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` local_shape **)** @@ -62,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_body_shape_exited: - **body_shape_exited** **(** :ref:`int` body_id, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` local_shape **)** @@ -70,26 +123,24 @@ 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_sleeping_state_changed: - **sleeping_state_changed** **(** **)** Emitted when the body changes its sleeping state. Either by sleeping or waking up. - Enumerations ------------ .. _enum_RigidBody_Mode: -enum **Mode** +enum **Mode**: - **MODE_RIGID** = **0** --- Rigid body. This is the "natural" state of a rigid body. It is affected by forces, and can move, rotate, and be affected by user code. - **MODE_STATIC** = **1** --- Static mode. The body behaves like a :ref:`StaticBody`, and can only move by user code. - **MODE_CHARACTER** = **2** --- Character body. This behaves like a rigid body, but can not rotate. - **MODE_KINEMATIC** = **3** --- Kinematic body. The body behaves like a :ref:`KinematicBody`, and can only move by user code. - Description ----------- @@ -105,115 +156,283 @@ Tutorials --------- - :doc:`../tutorials/physics/physics_introduction` - Property Descriptions --------------------- .. _class_RigidBody_angular_damp: -- :ref:`float` **angular_damp** - Damps RigidBody's rotational forces. +- :ref:`float` **angular_damp** + ++----------+-------------------------+ +| *Setter* | set_angular_damp(value) | ++----------+-------------------------+ +| *Getter* | get_angular_damp() | ++----------+-------------------------+ + +Damps RigidBody's rotational forces. .. _class_RigidBody_angular_velocity: -- :ref:`Vector3` **angular_velocity** - RigidBody's rotational velocity. +- :ref:`Vector3` **angular_velocity** + ++----------+-----------------------------+ +| *Setter* | set_angular_velocity(value) | ++----------+-----------------------------+ +| *Getter* | get_angular_velocity() | ++----------+-----------------------------+ + +RigidBody's rotational velocity. .. _class_RigidBody_axis_lock_angular_x: - :ref:`bool` **axis_lock_angular_x** ++----------+----------------------+ +| *Setter* | set_axis_lock(value) | ++----------+----------------------+ +| *Getter* | get_axis_lock() | ++----------+----------------------+ + .. _class_RigidBody_axis_lock_angular_y: - :ref:`bool` **axis_lock_angular_y** ++----------+----------------------+ +| *Setter* | set_axis_lock(value) | ++----------+----------------------+ +| *Getter* | get_axis_lock() | ++----------+----------------------+ + .. _class_RigidBody_axis_lock_angular_z: - :ref:`bool` **axis_lock_angular_z** ++----------+----------------------+ +| *Setter* | set_axis_lock(value) | ++----------+----------------------+ +| *Getter* | get_axis_lock() | ++----------+----------------------+ + .. _class_RigidBody_axis_lock_linear_x: - :ref:`bool` **axis_lock_linear_x** ++----------+----------------------+ +| *Setter* | set_axis_lock(value) | ++----------+----------------------+ +| *Getter* | get_axis_lock() | ++----------+----------------------+ + .. _class_RigidBody_axis_lock_linear_y: - :ref:`bool` **axis_lock_linear_y** ++----------+----------------------+ +| *Setter* | set_axis_lock(value) | ++----------+----------------------+ +| *Getter* | get_axis_lock() | ++----------+----------------------+ + .. _class_RigidBody_axis_lock_linear_z: - :ref:`bool` **axis_lock_linear_z** ++----------+----------------------+ +| *Setter* | set_axis_lock(value) | ++----------+----------------------+ +| *Getter* | get_axis_lock() | ++----------+----------------------+ + .. _class_RigidBody_bounce: -- :ref:`float` **bounce** - RigidBody's bounciness. +- :ref:`float` **bounce** + ++----------+-------------------+ +| *Setter* | set_bounce(value) | ++----------+-------------------+ +| *Getter* | get_bounce() | ++----------+-------------------+ + +RigidBody's bounciness. .. _class_RigidBody_can_sleep: -- :ref:`bool` **can_sleep** - 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. +- :ref:`bool` **can_sleep** + ++----------+----------------------+ +| *Setter* | set_can_sleep(value) | ++----------+----------------------+ +| *Getter* | is_able_to_sleep() | ++----------+----------------------+ + +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: -- :ref:`bool` **contact_monitor** - If true, the RigidBody will emit signals when it collides with another RigidBody. +- :ref:`bool` **contact_monitor** + ++----------+------------------------------+ +| *Setter* | set_contact_monitor(value) | ++----------+------------------------------+ +| *Getter* | is_contact_monitor_enabled() | ++----------+------------------------------+ + +If true, the RigidBody will emit signals when it collides with another RigidBody. .. _class_RigidBody_contacts_reported: -- :ref:`int` **contacts_reported** - 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. +- :ref:`int` **contacts_reported** + ++----------+----------------------------------+ +| *Setter* | set_max_contacts_reported(value) | ++----------+----------------------------------+ +| *Getter* | get_max_contacts_reported() | ++----------+----------------------------------+ + +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: -- :ref:`bool` **continuous_cd** - If ``true`` continuous collision detection is used. +- :ref:`bool` **continuous_cd** + ++----------+-----------------------------------------------+ +| *Setter* | set_use_continuous_collision_detection(value) | ++----------+-----------------------------------------------+ +| *Getter* | is_using_continuous_collision_detection() | ++----------+-----------------------------------------------+ + +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: -- :ref:`bool` **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. +- :ref:`bool` **custom_integrator** + ++----------+----------------------------------+ +| *Setter* | set_use_custom_integrator(value) | ++----------+----------------------------------+ +| *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. .. _class_RigidBody_friction: -- :ref:`float` **friction** - The body friction, from 0 (frictionless) to 1 (max friction). +- :ref:`float` **friction** + ++----------+---------------------+ +| *Setter* | set_friction(value) | ++----------+---------------------+ +| *Getter* | get_friction() | ++----------+---------------------+ + +The body friction, from 0 (frictionless) to 1 (max friction). .. _class_RigidBody_gravity_scale: -- :ref:`float` **gravity_scale** - 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. +- :ref:`float` **gravity_scale** + ++----------+--------------------------+ +| *Setter* | set_gravity_scale(value) | ++----------+--------------------------+ +| *Getter* | get_gravity_scale() | ++----------+--------------------------+ + +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: -- :ref:`float` **linear_damp** - RigidBody'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. +- :ref:`float` **linear_damp** + ++----------+------------------------+ +| *Setter* | set_linear_damp(value) | ++----------+------------------------+ +| *Getter* | get_linear_damp() | ++----------+------------------------+ + +RigidBody'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: -- :ref:`Vector3` **linear_velocity** - RigidBody'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. +- :ref:`Vector3` **linear_velocity** + ++----------+----------------------------+ +| *Setter* | set_linear_velocity(value) | ++----------+----------------------------+ +| *Getter* | get_linear_velocity() | ++----------+----------------------------+ + +RigidBody'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: -- :ref:`float` **mass** - RigidBody's mass. +- :ref:`float` **mass** + ++----------+-----------------+ +| *Setter* | set_mass(value) | ++----------+-----------------+ +| *Getter* | get_mass() | ++----------+-----------------+ + +RigidBody's mass. .. _class_RigidBody_mode: -- :ref:`Mode` **mode** - The body mode from the MODE\_\* enum. Modes include: MODE_STATIC, MODE_KINEMATIC, MODE_RIGID, and MODE_CHARACTER. +- :ref:`Mode` **mode** + ++----------+-----------------+ +| *Setter* | set_mode(value) | ++----------+-----------------+ +| *Getter* | get_mode() | ++----------+-----------------+ + +The body mode from the MODE\_\* enum. Modes include: MODE_STATIC, MODE_KINEMATIC, MODE_RIGID, and MODE_CHARACTER. .. _class_RigidBody_physics_material_override: - :ref:`PhysicsMaterial` **physics_material_override** ++----------+--------------------------------------+ +| *Setter* | set_physics_material_override(value) | ++----------+--------------------------------------+ +| *Getter* | get_physics_material_override() | ++----------+--------------------------------------+ + .. _class_RigidBody_sleeping: -- :ref:`bool` **sleeping** - If ``true`` RigidBody is sleeping and will not calculate forces until woken up by a collision or the ``apply_impulse`` method. +- :ref:`bool` **sleeping** + ++----------+---------------------+ +| *Setter* | set_sleeping(value) | ++----------+---------------------+ +| *Getter* | is_sleeping() | ++----------+---------------------+ + +If ``true`` RigidBody is sleeping and will not calculate forces until woken up by a collision or the ``apply_impulse`` method. .. _class_RigidBody_weight: -- :ref:`float` **weight** - RigidBody's weight based on its mass and the global 3D gravity. Global values are set in "Project > Project Settings > Physics > 3d". +- :ref:`float` **weight** ++----------+-------------------+ +| *Setter* | set_weight(value) | ++----------+-------------------+ +| *Getter* | get_weight() | ++----------+-------------------+ + +RigidBody's weight based on its mass and the global 3D gravity. Global values are set in "Project > Project Settings > Physics > 3d". Method Descriptions ------------------- -.. _class_RigidBody__integrate_forces: + .. _class_RigidBody__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 :ref:`set_use_custom_integrator` allows you to disable the default behavior and do fully custom force integration for a body. -.. _class_RigidBody_add_central_force: + .. _class_RigidBody_add_central_force: - void **add_central_force** **(** :ref:`Vector3` force **)** @@ -221,19 +440,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_add_force: - void **add_force** **(** :ref:`Vector3` force, :ref:`Vector3` position **)** Adds a constant force (i.e. acceleration). -.. _class_RigidBody_add_torque: + .. _class_RigidBody_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_apply_central_impulse: - void **apply_central_impulse** **(** :ref:`Vector3` impulse **)** @@ -241,28 +460,27 @@ Applies a single directional impulse without affecting rotation. This is equivalent to ``apply_impulse(Vector3(0,0,0), impulse)``. -.. _class_RigidBody_apply_impulse: + .. _class_RigidBody_apply_impulse: - void **apply_impulse** **(** :ref:`Vector3` position, :ref:`Vector3` impulse **)** 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_RigidBody_apply_torque_impulse: + .. _class_RigidBody_apply_torque_impulse: - void **apply_torque_impulse** **(** :ref:`Vector3` impulse **)** 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_RigidBody_get_colliding_bodies: + .. _class_RigidBody_get_colliding_bodies: - :ref:`Array` **get_colliding_bodies** **(** **)** const Return a list of the bodies colliding with this one. By default, number of max contacts reported is at 0 , see :ref:`set_max_contacts_reported` to increase it. 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_set_axis_velocity: - void **set_axis_velocity** **(** :ref:`Vector3` axis_velocity **)** Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. - diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index 49fd63643..f34cdf699 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -8,6 +8,7 @@ RigidBody2D =========== **Inherits:** :ref:`PhysicsBody2D` **<** :ref:`CollisionObject2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,51 @@ Brief Description 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` | ++-----------------------------------------------+-------------------------------------------------------------------------------+ + Methods ------- @@ -43,43 +89,42 @@ Methods Signals ------- -.. _class_RigidBody2D_body_entered: + .. _class_RigidBody2D_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``. -.. _class_RigidBody2D_body_exited: + .. _class_RigidBody2D_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``. -.. _class_RigidBody2D_body_shape_entered: + .. _class_RigidBody2D_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``. -.. _class_RigidBody2D_body_shape_exited: + .. _class_RigidBody2D_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``. -.. _class_RigidBody2D_sleeping_state_changed: + .. _class_RigidBody2D_sleeping_state_changed: - **sleeping_state_changed** **(** **)** Emitted when :ref:`sleeping` changes. - Enumerations ------------ .. _enum_RigidBody2D_CCDMode: -enum **CCDMode** +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. - **CCD_MODE_CAST_RAY** = **1** --- Continuous collision detection enabled using raycasting. This is faster than shapecasting but less precise. @@ -87,14 +132,13 @@ enum **CCDMode** .. _enum_RigidBody2D_Mode: -enum **Mode** +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. - **MODE_STATIC** = **1** --- Static mode. The body behaves like a :ref:`StaticBody2D` and does not move. - **MODE_CHARACTER** = **2** --- Character mode. Similar to ``MODE_RIGID``, but the body can not rotate. - **MODE_KINEMATIC** = **3** --- Kinematic mode. The body behaves like a :ref:`KinematicBody2D`, and must be moved by code. - Description ----------- @@ -111,140 +155,296 @@ Property Descriptions .. _class_RigidBody2D_angular_damp: -- :ref:`float` **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``. +- :ref:`float` **angular_damp** + ++----------+-------------------------+ +| *Setter* | set_angular_damp(value) | ++----------+-------------------------+ +| *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``. .. _class_RigidBody2D_angular_velocity: -- :ref:`float` **angular_velocity** - The body's rotational velocity. +- :ref:`float` **angular_velocity** + ++----------+-----------------------------+ +| *Setter* | set_angular_velocity(value) | ++----------+-----------------------------+ +| *Getter* | get_angular_velocity() | ++----------+-----------------------------+ + +The body's rotational velocity. .. _class_RigidBody2D_applied_force: -- :ref:`Vector2` **applied_force** - The body's total applied force. +- :ref:`Vector2` **applied_force** + ++----------+--------------------------+ +| *Setter* | set_applied_force(value) | ++----------+--------------------------+ +| *Getter* | get_applied_force() | ++----------+--------------------------+ + +The body's total applied force. .. _class_RigidBody2D_applied_torque: -- :ref:`float` **applied_torque** - The body's total applied torque. +- :ref:`float` **applied_torque** + ++----------+---------------------------+ +| *Setter* | set_applied_torque(value) | ++----------+---------------------------+ +| *Getter* | get_applied_torque() | ++----------+---------------------------+ + +The body's total applied torque. .. _class_RigidBody2D_bounce: -- :ref:`float` **bounce** - The body's bounciness. Default value: ``0``. +- :ref:`float` **bounce** + ++----------+-------------------+ +| *Setter* | set_bounce(value) | ++----------+-------------------+ +| *Getter* | get_bounce() | ++----------+-------------------+ + +The body's bounciness. Default value: ``0``. .. _class_RigidBody2D_can_sleep: -- :ref:`bool` **can_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``. +- :ref:`bool` **can_sleep** + ++----------+----------------------+ +| *Setter* | set_can_sleep(value) | ++----------+----------------------+ +| *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``. .. _class_RigidBody2D_contact_monitor: -- :ref:`bool` **contact_monitor** - If ``true`` the body will emit signals when it collides with another RigidBody2D. See also :ref:`contacts_reported`. Default value: ``false``. +- :ref:`bool` **contact_monitor** + ++----------+------------------------------+ +| *Setter* | set_contact_monitor(value) | ++----------+------------------------------+ +| *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``. .. _class_RigidBody2D_contacts_reported: -- :ref:`int` **contacts_reported** - The maximum number of contacts to report. Default value: ``0``. +- :ref:`int` **contacts_reported** + ++----------+----------------------------------+ +| *Setter* | set_max_contacts_reported(value) | ++----------+----------------------------------+ +| *Getter* | get_max_contacts_reported() | ++----------+----------------------------------+ + +The maximum number of contacts to report. Default value: ``0``. .. _class_RigidBody2D_continuous_cd: -- :ref:`CCDMode` **continuous_cd** - Continuous collision detection mode. Default value: ``CCD_MODE_DISABLED``. +- :ref:`CCDMode` **continuous_cd** + ++----------+------------------------------------------------+ +| *Setter* | set_continuous_collision_detection_mode(value) | ++----------+------------------------------------------------+ +| *Getter* | get_continuous_collision_detection_mode() | ++----------+------------------------------------------------+ + +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: -- :ref:`bool` **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. +- :ref:`bool` **custom_integrator** + ++----------+----------------------------------+ +| *Setter* | set_use_custom_integrator(value) | ++----------+----------------------------------+ +| *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. .. _class_RigidBody2D_friction: -- :ref:`float` **friction** - The body's friction. Values range from ``0`` (frictionless) to ``1`` (maximum friction). Default value: ``1``. +- :ref:`float` **friction** + ++----------+---------------------+ +| *Setter* | set_friction(value) | ++----------+---------------------+ +| *Getter* | get_friction() | ++----------+---------------------+ + +The body's friction. Values range from ``0`` (frictionless) to ``1`` (maximum friction). Default value: ``1``. .. _class_RigidBody2D_gravity_scale: -- :ref:`float` **gravity_scale** - 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``. +- :ref:`float` **gravity_scale** + ++----------+--------------------------+ +| *Setter* | set_gravity_scale(value) | ++----------+--------------------------+ +| *Getter* | get_gravity_scale() | ++----------+--------------------------+ + +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: -- :ref:`float` **inertia** - 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. +- :ref:`float` **inertia** + ++----------+--------------------+ +| *Setter* | set_inertia(value) | ++----------+--------------------+ +| *Getter* | get_inertia() | ++----------+--------------------+ + +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: -- :ref:`float` **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``. +- :ref:`float` **linear_damp** + ++----------+------------------------+ +| *Setter* | set_linear_damp(value) | ++----------+------------------------+ +| *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``. .. _class_RigidBody2D_linear_velocity: -- :ref:`Vector2` **linear_velocity** - The body's linear velocity. +- :ref:`Vector2` **linear_velocity** + ++----------+----------------------------+ +| *Setter* | set_linear_velocity(value) | ++----------+----------------------------+ +| *Getter* | get_linear_velocity() | ++----------+----------------------------+ + +The body's linear velocity. .. _class_RigidBody2D_mass: -- :ref:`float` **mass** - The body's mass. Default value: ``1``. +- :ref:`float` **mass** + ++----------+-----------------+ +| *Setter* | set_mass(value) | ++----------+-----------------+ +| *Getter* | get_mass() | ++----------+-----------------+ + +The body's mass. Default value: ``1``. .. _class_RigidBody2D_mode: -- :ref:`Mode` **mode** - The body's mode. See ``MODE_*`` constants. Default value: ``MODE_RIGID``. +- :ref:`Mode` **mode** + ++----------+-----------------+ +| *Setter* | set_mode(value) | ++----------+-----------------+ +| *Getter* | get_mode() | ++----------+-----------------+ + +The body's mode. See ``MODE_*`` constants. Default value: ``MODE_RIGID``. .. _class_RigidBody2D_physics_material_override: - :ref:`PhysicsMaterial` **physics_material_override** ++----------+--------------------------------------+ +| *Setter* | set_physics_material_override(value) | ++----------+--------------------------------------+ +| *Getter* | get_physics_material_override() | ++----------+--------------------------------------+ + .. _class_RigidBody2D_sleeping: -- :ref:`bool` **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`. +- :ref:`bool` **sleeping** + ++----------+---------------------+ +| *Setter* | set_sleeping(value) | ++----------+---------------------+ +| *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`. .. _class_RigidBody2D_weight: -- :ref:`float` **weight** - The body's weight based on its mass and the "Default Gravity" value in "Project > Project Settings > Physics > 2d". +- :ref:`float` **weight** ++----------+-------------------+ +| *Setter* | set_weight(value) | ++----------+-------------------+ +| *Getter* | get_weight() | ++----------+-------------------+ + +The body's weight based on its mass and the "Default Gravity" value in "Project > Project Settings > Physics > 2d". Method Descriptions ------------------- -.. _class_RigidBody2D__integrate_forces: + .. _class_RigidBody2D__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 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_add_central_force: - void **add_central_force** **(** :ref:`Vector2` force **)** -.. _class_RigidBody2D_add_force: + .. _class_RigidBody2D_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_add_torque: - void **add_torque** **(** :ref:`float` torque **)** -.. _class_RigidBody2D_apply_central_impulse: + .. _class_RigidBody2D_apply_central_impulse: - void **apply_central_impulse** **(** :ref:`Vector2` impulse **)** -.. _class_RigidBody2D_apply_impulse: + .. _class_RigidBody2D_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_apply_torque_impulse: - void **apply_torque_impulse** **(** :ref:`float` torque **)** -.. _class_RigidBody2D_get_colliding_bodies: + .. _class_RigidBody2D_get_colliding_bodies: - :ref:`Array` **get_colliding_bodies** **(** **)** const Returns a list of the bodies colliding with this one. Use :ref:`contacts_reported` to set the maximum number reported. You must also set :ref:`contact_monitor` to ``true``. 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_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_test_motion: - :ref:`bool` **test_motion** **(** :ref:`Vector2` motion, :ref:`bool` infinite_inertia=true, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** Returns ``true`` if a collision would result from moving in the given vector. ``margin`` increases the size of the shapes involved in the collision detection, and ``result`` is an object of type :ref:`Physics2DTestMotionResult`, which contains additional information about the collision (should there be one). - diff --git a/classes/class_rootmotionview.rst b/classes/class_rootmotionview.rst index 24f6bdd43..8fdd24202 100644 --- a/classes/class_rootmotionview.rst +++ b/classes/class_rootmotionview.rst @@ -8,6 +8,7 @@ RootMotionView ============== **Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,21 @@ 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` | ++---------------------------------+------------------------------------------------------------+ + Property Descriptions --------------------- @@ -22,20 +38,49 @@ Property Descriptions - :ref:`NodePath` **animation_path** ++----------+---------------------------+ +| *Setter* | set_animation_path(value) | ++----------+---------------------------+ +| *Getter* | get_animation_path() | ++----------+---------------------------+ + .. _class_RootMotionView_cell_size: - :ref:`float` **cell_size** ++----------+----------------------+ +| *Setter* | set_cell_size(value) | ++----------+----------------------+ +| *Getter* | get_cell_size() | ++----------+----------------------+ + .. _class_RootMotionView_color: - :ref:`Color` **color** ++----------+------------------+ +| *Setter* | set_color(value) | ++----------+------------------+ +| *Getter* | get_color() | ++----------+------------------+ + .. _class_RootMotionView_radius: - :ref:`float` **radius** ++----------+-------------------+ +| *Setter* | set_radius(value) | ++----------+-------------------+ +| *Getter* | get_radius() | ++----------+-------------------+ + .. _class_RootMotionView_zero_y: - :ref:`bool` **zero_y** ++----------+-------------------+ +| *Setter* | set_zero_y(value) | ++----------+-------------------+ +| *Getter* | get_zero_y() | ++----------+-------------------+ diff --git a/classes/class_scenestate.rst b/classes/class_scenestate.rst index e65c4c39b..7fbca0a19 100644 --- a/classes/class_scenestate.rst +++ b/classes/class_scenestate.rst @@ -8,6 +8,7 @@ SceneState ========== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -65,13 +66,12 @@ Enumerations .. _enum_SceneState_GenEditState: -enum **GenEditState** +enum **GenEditState**: - **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_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 ----------- @@ -80,122 +80,121 @@ Maintains a list of resources, nodes, exported and overridden properties, and bu Method Descriptions ------------------- -.. _class_SceneState_get_connection_binds: + .. _class_SceneState_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_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_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_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_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_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_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_get_node_count: - :ref:`int` **get_node_count** **(** **)** const Returns the number of nodes in the scene. -.. _class_SceneState_get_node_groups: + .. _class_SceneState_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_get_node_index: - :ref:`int` **get_node_index** **(** :ref:`int` idx **)** const -.. _class_SceneState_get_node_instance: + .. _class_SceneState_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_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_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_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_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_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_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_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_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_is_node_instance_placeholder: - :ref:`bool` **is_node_instance_placeholder** **(** :ref:`int` idx **)** const Returns ``true`` if the node at ``idx`` is an :ref:`InstancePlaceholder`. - diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index 893957a3e..da0f15d8f 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -8,6 +8,7 @@ SceneTree ========= **Inherits:** :ref:`MainLoop` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,33 @@ Brief Description 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` | ++-----------------------------------------------------------------+---------------------------------------------------------------------------------------+ + Methods ------- @@ -75,91 +103,90 @@ Methods Signals ------- -.. _class_SceneTree_connected_to_server: + .. _class_SceneTree_connected_to_server: - **connected_to_server** **(** **)** Emitted whenever this SceneTree's :ref:`network_peer` successfully connected to a server. Only emitted on clients. -.. _class_SceneTree_connection_failed: + .. _class_SceneTree_connection_failed: - **connection_failed** **(** **)** 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_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_idle_frame: - **idle_frame** **(** **)** Emitted immediately before :ref:`Node._process` is called on every node in the SceneTree. -.. _class_SceneTree_network_peer_connected: + .. _class_SceneTree_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). -.. _class_SceneTree_network_peer_disconnected: + .. _class_SceneTree_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. -.. _class_SceneTree_node_added: + .. _class_SceneTree_node_added: - **node_added** **(** :ref:`Node` node **)** Emitted whenever a node is added to the SceneTree. -.. _class_SceneTree_node_configuration_warning_changed: + .. _class_SceneTree_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_node_removed: - **node_removed** **(** :ref:`Node` node **)** Emitted whenever a node is removed from the SceneTree. -.. _class_SceneTree_physics_frame: + .. _class_SceneTree_physics_frame: - **physics_frame** **(** **)** Emitted immediately before :ref:`Node._physics_process` is called on every node in the SceneTree. -.. _class_SceneTree_screen_resized: + .. _class_SceneTree_screen_resized: - **screen_resized** **(** **)** Emitted whenever the screen resolution (fullscreen) or window size (windowed) changes. -.. _class_SceneTree_server_disconnected: + .. _class_SceneTree_server_disconnected: - **server_disconnected** **(** **)** Emitted whenever this SceneTree's :ref:`network_peer` disconnected from server. Only emitted on clients. -.. _class_SceneTree_tree_changed: + .. _class_SceneTree_tree_changed: - **tree_changed** **(** **)** Emitted whenever the SceneTree hierarchy changed (children being moved or renamed, etc.). - Enumerations ------------ .. _enum_SceneTree_GroupCallFlags: -enum **GroupCallFlags** +enum **GroupCallFlags**: - **GROUP_CALL_DEFAULT** = **0** --- Call a group with no flags (default). - **GROUP_CALL_REVERSE** = **1** --- Call a group in reverse scene order. @@ -168,7 +195,7 @@ enum **GroupCallFlags** .. _enum_SceneTree_StretchMode: -enum **StretchMode** +enum **StretchMode**: - **STRETCH_MODE_DISABLED** = **0** --- No stretching. - **STRETCH_MODE_2D** = **1** --- Render stretching in higher resolution (interpolated). @@ -176,7 +203,7 @@ enum **StretchMode** .. _enum_SceneTree_StretchAspect: -enum **StretchAspect** +enum **StretchAspect**: - **STRETCH_ASPECT_IGNORE** = **0** --- Fill the window with the content stretched to cover excessive space. Content may appear elongated. - **STRETCH_ASPECT_KEEP** = **1** --- Retain the same aspect ratio by padding with black bars in either axes. No expansion of content. @@ -184,7 +211,6 @@ enum **StretchAspect** - **STRETCH_ASPECT_KEEP_HEIGHT** = **3** --- Expand horizontally. Top/bottom black bars may appear if the window is too tall. - **STRETCH_ASPECT_EXPAND** = **4** --- Expand in both directions, retaining the same aspect ratio. No black bars. - Description ----------- @@ -195,212 +221,291 @@ Tutorials - :doc:`../getting_started/step_by_step/scene_tree` - :doc:`../tutorials/viewports/multiple_resolutions` - Property Descriptions --------------------- .. _class_SceneTree_current_scene: -- :ref:`Node` **current_scene** - The current scene. +- :ref:`Node` **current_scene** + ++----------+--------------------------+ +| *Setter* | set_current_scene(value) | ++----------+--------------------------+ +| *Getter* | get_current_scene() | ++----------+--------------------------+ + +The current scene. .. _class_SceneTree_debug_collisions_hint: - :ref:`bool` **debug_collisions_hint** ++----------+----------------------------------+ +| *Setter* | set_debug_collisions_hint(value) | ++----------+----------------------------------+ +| *Getter* | is_debugging_collisions_hint() | ++----------+----------------------------------+ + .. _class_SceneTree_debug_navigation_hint: - :ref:`bool` **debug_navigation_hint** ++----------+----------------------------------+ +| *Setter* | set_debug_navigation_hint(value) | ++----------+----------------------------------+ +| *Getter* | is_debugging_navigation_hint() | ++----------+----------------------------------+ + .. _class_SceneTree_edited_scene_root: -- :ref:`Node` **edited_scene_root** - The root of the edited scene. +- :ref:`Node` **edited_scene_root** + ++----------+------------------------------+ +| *Setter* | set_edited_scene_root(value) | ++----------+------------------------------+ +| *Getter* | get_edited_scene_root() | ++----------+------------------------------+ + +The root of the edited scene. .. _class_SceneTree_multiplayer: -- :ref:`MultiplayerAPI` **multiplayer** - The default :ref:`MultiplayerAPI` instance for this SceneTree. +- :ref:`MultiplayerAPI` **multiplayer** + ++----------+------------------------+ +| *Setter* | set_multiplayer(value) | ++----------+------------------------+ +| *Getter* | get_multiplayer() | ++----------+------------------------+ + +The default :ref:`MultiplayerAPI` instance for this SceneTree. .. _class_SceneTree_multiplayer_poll: -- :ref:`bool` **multiplayer_poll** - If ``true`` (default) enable the automatic polling of the :ref:`MultiplayerAPI` for this SceneTree during :ref:`idle_frame`. +- :ref:`bool` **multiplayer_poll** -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` protecion when accessing the :ref:`MultiplayerAPI` from threads. ++----------+-------------------------------------+ +| *Setter* | set_multiplayer_poll_enabled(value) | ++----------+-------------------------------------+ +| *Getter* | is_multiplayer_poll_enabled() | ++----------+-------------------------------------+ + +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. .. _class_SceneTree_network_peer: -- :ref:`NetworkedMultiplayerPeer` **network_peer** - 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 slave. 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. +- :ref:`NetworkedMultiplayerPeer` **network_peer** + ++----------+-------------------------+ +| *Setter* | set_network_peer(value) | ++----------+-------------------------+ +| *Getter* | get_network_peer() | ++----------+-------------------------+ + +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 slave. 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: -- :ref:`bool` **paused** - If ``true`` the SceneTree is paused. +- :ref:`bool` **paused** + ++----------+------------------+ +| *Setter* | set_pause(value) | ++----------+------------------+ +| *Getter* | is_paused() | ++----------+------------------+ + +If ``true`` the SceneTree is paused. .. _class_SceneTree_refuse_new_network_connections: -- :ref:`bool` **refuse_new_network_connections** - If ``true`` the SceneTree's :ref:`network_peer` refuses new incoming connections. +- :ref:`bool` **refuse_new_network_connections** + ++----------+-------------------------------------------+ +| *Setter* | set_refuse_new_network_connections(value) | ++----------+-------------------------------------------+ +| *Getter* | is_refusing_new_network_connections() | ++----------+-------------------------------------------+ + +If ``true`` the SceneTree's :ref:`network_peer` refuses new incoming connections. .. _class_SceneTree_root: -- :ref:`Viewport` **root** - The SceneTree's :ref:`Viewport`. +- :ref:`Viewport` **root** + ++----------+------------+ +| *Getter* | get_root() | ++----------+------------+ + +The SceneTree's :ref:`Viewport`. .. _class_SceneTree_use_font_oversampling: -- :ref:`bool` **use_font_oversampling** - If ``true`` font oversampling is used. +- :ref:`bool` **use_font_oversampling** ++----------+----------------------------------+ +| *Setter* | set_use_font_oversampling(value) | ++----------+----------------------------------+ +| *Getter* | is_using_font_oversampling() | ++----------+----------------------------------+ + +If ``true`` font oversampling is used. Method Descriptions ------------------- -.. _class_SceneTree_call_group: + .. _class_SceneTree_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_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`. -.. _class_SceneTree_change_scene: + .. _class_SceneTree_change_scene: - :ref:`Error` **change_scene** **(** :ref:`String` path **)** Changes to the scene at the given ``path``. -.. _class_SceneTree_change_scene_to: + .. _class_SceneTree_change_scene_to: - :ref:`Error` **change_scene_to** **(** :ref:`PackedScene` packed_scene **)** Changes to the given :ref:`PackedScene`. -.. _class_SceneTree_create_timer: + .. _class_SceneTree_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. -.. _class_SceneTree_get_frame: + .. _class_SceneTree_get_frame: - :ref:`int` **get_frame** **(** **)** const -.. _class_SceneTree_get_network_connected_peers: + .. _class_SceneTree_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`. -.. _class_SceneTree_get_network_unique_id: + .. _class_SceneTree_get_network_unique_id: - :ref:`int` **get_network_unique_id** **(** **)** const Returns the unique peer ID of this SceneTree's :ref:`network_peer`. -.. _class_SceneTree_get_node_count: + .. _class_SceneTree_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_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_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_has_group: - :ref:`bool` **has_group** **(** :ref:`String` name **)** const Returns ``true`` if the given group exists. -.. _class_SceneTree_has_network_peer: + .. _class_SceneTree_has_network_peer: - :ref:`bool` **has_network_peer** **(** **)** const Returns ``true`` if there is a :ref:`network_peer` set. -.. _class_SceneTree_is_input_handled: + .. _class_SceneTree_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`. -.. _class_SceneTree_is_network_server: + .. _class_SceneTree_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). -.. _class_SceneTree_notify_group: + .. _class_SceneTree_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_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`. -.. _class_SceneTree_queue_delete: + .. _class_SceneTree_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. -.. _class_SceneTree_quit: + .. _class_SceneTree_quit: - void **quit** **(** **)** Quits the application. -.. _class_SceneTree_reload_current_scene: + .. _class_SceneTree_reload_current_scene: - :ref:`Error` **reload_current_scene** **(** **)** Reloads the currently active scene. -.. _class_SceneTree_set_auto_accept_quit: + .. _class_SceneTree_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_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_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`. -.. _class_SceneTree_set_input_as_handled: + .. _class_SceneTree_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_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_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``. - diff --git a/classes/class_scenetreetimer.rst b/classes/class_scenetreetimer.rst index 39cf7b76e..94f74478b 100644 --- a/classes/class_scenetreetimer.rst +++ b/classes/class_scenetreetimer.rst @@ -8,6 +8,7 @@ SceneTreeTimer ============== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,14 +16,20 @@ Brief Description +Properties +---------- + ++---------------------------+--------------------------------------------------+ +| :ref:`float` | :ref:`time_left` | ++---------------------------+--------------------------------------------------+ + Signals ------- -.. _class_SceneTreeTimer_timeout: + .. _class_SceneTreeTimer_timeout: - **timeout** **(** **)** - Property Descriptions --------------------- @@ -30,4 +37,9 @@ Property Descriptions - :ref:`float` **time_left** ++----------+----------------------+ +| *Setter* | set_time_left(value) | ++----------+----------------------+ +| *Getter* | get_time_left() | ++----------+----------------------+ diff --git a/classes/class_script.rst b/classes/class_script.rst index d68733084..116a6e02a 100644 --- a/classes/class_script.rst +++ b/classes/class_script.rst @@ -8,7 +8,9 @@ Script ====== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`VisualScript`, :ref:`GDScript`, :ref:`CSharpScript`, :ref:`NativeScript`, :ref:`PluginScript` + **Category:** Core Brief Description @@ -16,6 +18,13 @@ Brief Description A class stored as a resource. +Properties +---------- + ++-----------------------------+----------------------------------------------+ +| :ref:`String` | :ref:`source_code` | ++-----------------------------+----------------------------------------------+ + Methods ------- @@ -48,64 +57,69 @@ Tutorials --------- - :doc:`../getting_started/step_by_step/scripting` - Property Descriptions --------------------- .. _class_Script_source_code: -- :ref:`String` **source_code** - The script source code or an empty string if source code is not available. When set, does not reload the class implementation automatically. +- :ref:`String` **source_code** ++----------+------------------------+ +| *Setter* | set_source_code(value) | ++----------+------------------------+ +| *Getter* | get_source_code() | ++----------+------------------------+ + +The script source code or an empty string if source code is not available. When set, does not reload the class implementation automatically. Method Descriptions ------------------- -.. _class_Script_can_instance: + .. _class_Script_can_instance: - :ref:`bool` **can_instance** **(** **)** const Returns ``true`` if the script can be instanced. -.. _class_Script_get_base_script: + .. _class_Script_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_get_instance_base_type: - :ref:`String` **get_instance_base_type** **(** **)** const Returns the script's base type. -.. _class_Script_has_script_signal: + .. _class_Script_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_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_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_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_reload: - :ref:`Error` **reload** **(** :ref:`bool` keep_state=false **)** Reloads the script's class implementation. Returns an error code. - diff --git a/classes/class_scriptcreatedialog.rst b/classes/class_scriptcreatedialog.rst index a56da0428..eb8b2211a 100644 --- a/classes/class_scriptcreatedialog.rst +++ b/classes/class_scriptcreatedialog.rst @@ -8,6 +8,7 @@ ScriptCreateDialog ================== **Inherits:** :ref:`ConfirmationDialog` **<** :ref:`AcceptDialog` **<** :ref:`WindowDialog` **<** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -25,13 +26,12 @@ Methods Signals ------- -.. _class_ScriptCreateDialog_script_created: + .. _class_ScriptCreateDialog_script_created: - **script_created** **(** :ref:`Script` script **)** Emitted when the user clicks the OK button. - Description ----------- @@ -47,10 +47,9 @@ The ScriptCreateDialog creates script files according to a given template for a Method Descriptions ------------------- -.. _class_ScriptCreateDialog_config: + .. _class_ScriptCreateDialog_config: - void **config** **(** :ref:`String` inherits, :ref:`String` path **)** Prefills required fields to configure the ScriptCreateDialog for use. - diff --git a/classes/class_scripteditor.rst b/classes/class_scripteditor.rst index 8b0dce145..1caab4540 100644 --- a/classes/class_scripteditor.rst +++ b/classes/class_scripteditor.rst @@ -8,6 +8,7 @@ ScriptEditor ============ **Inherits:** :ref:`PanelContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -35,48 +36,46 @@ Methods Signals ------- -.. _class_ScriptEditor_editor_script_changed: + .. _class_ScriptEditor_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_script_close: - **script_close** **(** :ref:`Script` script **)** Emitted when editor is about to close the active script. Argument is a :ref:`Script` that is going to be closed. - Method Descriptions ------------------- -.. _class_ScriptEditor_can_drop_data_fw: + .. _class_ScriptEditor_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_drop_data_fw: - void **drop_data_fw** **(** :ref:`Vector2` point, :ref:`Variant` data, :ref:`Control` from **)** -.. _class_ScriptEditor_get_current_script: + .. _class_ScriptEditor_get_current_script: - :ref:`Script` **get_current_script** **(** **)** Returns a :ref:`Script` that is currently active in editor. -.. _class_ScriptEditor_get_drag_data_fw: + .. _class_ScriptEditor_get_drag_data_fw: - :ref:`Variant` **get_drag_data_fw** **(** :ref:`Vector2` point, :ref:`Control` from **)** -.. _class_ScriptEditor_get_open_scripts: + .. _class_ScriptEditor_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_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 899659a08..4f00afdb3 100644 --- a/classes/class_scrollbar.rst +++ b/classes/class_scrollbar.rst @@ -8,7 +8,9 @@ ScrollBar ========= **Inherits:** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`HScrollBar`, :ref:`VScrollBar` + **Category:** Core Brief Description @@ -16,16 +18,22 @@ Brief Description Base class for scroll bars. +Properties +---------- + ++---------------------------+-------------------------------------------------+ +| :ref:`float` | :ref:`custom_step` | ++---------------------------+-------------------------------------------------+ + Signals ------- -.. _class_ScrollBar_scrolling: + .. _class_ScrollBar_scrolling: - **scrolling** **(** **)** Emitted whenever the scrollbar is being scrolled. - Description ----------- @@ -38,4 +46,9 @@ Property Descriptions - :ref:`float` **custom_step** ++----------+------------------------+ +| *Setter* | set_custom_step(value) | ++----------+------------------------+ +| *Getter* | get_custom_step() | ++----------+------------------------+ diff --git a/classes/class_scrollcontainer.rst b/classes/class_scrollcontainer.rst index a2f74cdea..55b05b654 100644 --- a/classes/class_scrollcontainer.rst +++ b/classes/class_scrollcontainer.rst @@ -8,7 +8,9 @@ ScrollContainer =============== **Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`EditorInspector` + **Category:** Core Brief Description @@ -16,6 +18,21 @@ Brief Description 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` | ++-------------------------+-----------------------------------------------------------------------------------+ + Methods ------- @@ -25,22 +42,28 @@ Methods | :ref:`VScrollBar` | :ref:`get_v_scrollbar` **(** **)** | +--------------------------------------+---------------------------------------------------------------------------+ +Theme Properties +---------------- + ++---------------------------------+-------------------------------------+ +| :ref:`StyleBox` | :ref:`bg` | ++---------------------------------+-------------------------------------+ + Signals ------- -.. _class_ScrollContainer_scroll_ended: + .. _class_ScrollContainer_scroll_ended: - **scroll_ended** **(** **)** Emitted whenever scrolling stops. -.. _class_ScrollContainer_scroll_started: + .. _class_ScrollContainer_scroll_started: - **scroll_started** **(** **)** Emitted whenever scrolling is started. - Description ----------- @@ -53,32 +76,68 @@ Property Descriptions - :ref:`int` **scroll_deadzone** ++----------+---------------------+ +| *Setter* | set_deadzone(value) | ++----------+---------------------+ +| *Getter* | get_deadzone() | ++----------+---------------------+ + .. _class_ScrollContainer_scroll_horizontal: -- :ref:`int` **scroll_horizontal** - The current horizontal scroll value. +- :ref:`int` **scroll_horizontal** + ++----------+---------------------+ +| *Setter* | set_h_scroll(value) | ++----------+---------------------+ +| *Getter* | get_h_scroll() | ++----------+---------------------+ + +The current horizontal scroll value. .. _class_ScrollContainer_scroll_horizontal_enabled: -- :ref:`bool` **scroll_horizontal_enabled** - If ``true``, enables horizontal scrolling. +- :ref:`bool` **scroll_horizontal_enabled** + ++----------+----------------------------+ +| *Setter* | set_enable_h_scroll(value) | ++----------+----------------------------+ +| *Getter* | is_h_scroll_enabled() | ++----------+----------------------------+ + +If ``true``, enables horizontal scrolling. .. _class_ScrollContainer_scroll_vertical: -- :ref:`int` **scroll_vertical** - The current vertical scroll value. +- :ref:`int` **scroll_vertical** + ++----------+---------------------+ +| *Setter* | set_v_scroll(value) | ++----------+---------------------+ +| *Getter* | get_v_scroll() | ++----------+---------------------+ + +The current vertical scroll value. .. _class_ScrollContainer_scroll_vertical_enabled: -- :ref:`bool` **scroll_vertical_enabled** - If ``true``, enables vertical scrolling. +- :ref:`bool` **scroll_vertical_enabled** ++----------+----------------------------+ +| *Setter* | set_enable_v_scroll(value) | ++----------+----------------------------+ +| *Getter* | is_v_scroll_enabled() | ++----------+----------------------------+ + +If ``true``, enables vertical scrolling. Method Descriptions ------------------- -.. _class_ScrollContainer_get_h_scrollbar: + .. _class_ScrollContainer_get_h_scrollbar: - :ref:`HScrollBar` **get_h_scrollbar** **(** **)** -.. _class_ScrollContainer_get_v_scrollbar: + .. _class_ScrollContainer_get_v_scrollbar: - :ref:`VScrollBar` **get_v_scrollbar** **(** **)** - diff --git a/classes/class_segmentshape2d.rst b/classes/class_segmentshape2d.rst index 70a14eb0e..d9489b3d3 100644 --- a/classes/class_segmentshape2d.rst +++ b/classes/class_segmentshape2d.rst @@ -8,6 +8,7 @@ SegmentShape2D ============== **Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description Segment shape for 2D collisions. +Properties +---------- + ++-------------------------------+----------------------------------+ +| :ref:`Vector2` | :ref:`a` | ++-------------------------------+----------------------------------+ +| :ref:`Vector2` | :ref:`b` | ++-------------------------------+----------------------------------+ + Description ----------- @@ -25,10 +35,25 @@ Property Descriptions .. _class_SegmentShape2D_a: -- :ref:`Vector2` **a** - The segment's first point position. +- :ref:`Vector2` **a** + ++----------+--------------+ +| *Setter* | set_a(value) | ++----------+--------------+ +| *Getter* | get_a() | ++----------+--------------+ + +The segment's first point position. .. _class_SegmentShape2D_b: -- :ref:`Vector2` **b** - The segment's second point position. +- :ref:`Vector2` **b** ++----------+--------------+ +| *Setter* | set_b(value) | ++----------+--------------+ +| *Getter* | get_b() | ++----------+--------------+ + +The segment's second point position. diff --git a/classes/class_semaphore.rst b/classes/class_semaphore.rst index 5cebdf1b0..6a812711d 100644 --- a/classes/class_semaphore.rst +++ b/classes/class_semaphore.rst @@ -8,6 +8,7 @@ Semaphore ========= **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -32,16 +33,15 @@ 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_wait: - :ref:`Error` **wait** **(** **)** Tries to wait for the ``Semaphore``, if its value is zero, blocks until non-zero. Returns OK on success, ERR_BUSY otherwise. - diff --git a/classes/class_separator.rst b/classes/class_separator.rst index ef791dc64..594fd3481 100644 --- a/classes/class_separator.rst +++ b/classes/class_separator.rst @@ -8,7 +8,9 @@ Separator ========= **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`HSeparator`, :ref:`VSeparator` + **Category:** Core Brief Description diff --git a/classes/class_shader.rst b/classes/class_shader.rst index 0e3ddf630..63ef6687c 100644 --- a/classes/class_shader.rst +++ b/classes/class_shader.rst @@ -8,7 +8,9 @@ Shader ====== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`VisualShader` + **Category:** Core Brief Description @@ -16,6 +18,13 @@ Brief Description A custom shader program. +Properties +---------- + ++-----------------------------+--------------------------------+ +| :ref:`String` | :ref:`code` | ++-----------------------------+--------------------------------+ + Methods ------- @@ -34,13 +43,12 @@ Enumerations .. _enum_Shader_Mode: -enum **Mode** +enum **Mode**: - **MODE_SPATIAL** = **0** - **MODE_CANVAS_ITEM** = **1** - **MODE_PARTICLES** = **2** - Description ----------- @@ -50,7 +58,6 @@ Tutorials --------- - :doc:`../tutorials/shading/index` - Property Descriptions --------------------- @@ -58,26 +65,30 @@ Property Descriptions - :ref:`String` **code** ++----------+-----------------+ +| *Setter* | set_code(value) | ++----------+-----------------+ +| *Getter* | get_code() | ++----------+-----------------+ Method Descriptions ------------------- -.. _class_Shader_get_default_texture_param: + .. _class_Shader_get_default_texture_param: - :ref:`Texture` **get_default_texture_param** **(** :ref:`String` param **)** const -.. _class_Shader_get_mode: + .. _class_Shader_get_mode: - :ref:`Mode` **get_mode** **(** **)** const -Returns the shader mode for the shader, eiter ``MODE_CANVAS_ITEM``, ``MODE_SPATIAL`` or ``MODE_PARTICLES`` +Returns the shader mode for the shader, either ``MODE_CANVAS_ITEM``, ``MODE_SPATIAL`` or ``MODE_PARTICLES`` -.. _class_Shader_has_param: + .. _class_Shader_has_param: - :ref:`bool` **has_param** **(** :ref:`String` name **)** const -.. _class_Shader_set_default_texture_param: + .. _class_Shader_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 95cde8d91..ca6c4caf5 100644 --- a/classes/class_shadermaterial.rst +++ b/classes/class_shadermaterial.rst @@ -8,6 +8,7 @@ ShaderMaterial ============== **Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description A material that uses a custom :ref:`Shader` program. +Properties +---------- + ++-----------------------------+--------------------------------------------+ +| :ref:`Shader` | :ref:`shader` | ++-----------------------------+--------------------------------------------+ + Methods ------- @@ -34,22 +42,28 @@ Property Descriptions .. _class_ShaderMaterial_shader: -- :ref:`Shader` **shader** - The :ref:`Shader` program used to render this material. +- :ref:`Shader` **shader** ++----------+-------------------+ +| *Setter* | set_shader(value) | ++----------+-------------------+ +| *Getter* | get_shader() | ++----------+-------------------+ + +The :ref:`Shader` program used to render this material. Method Descriptions ------------------- -.. _class_ShaderMaterial_get_shader_param: + .. _class_ShaderMaterial_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_set_shader_param: + .. _class_ShaderMaterial_set_shader_param: - void **set_shader_param** **(** :ref:`String` param, :ref:`Variant` value **)** Changes the value set for this material of a uniform in the shader. - diff --git a/classes/class_shape.rst b/classes/class_shape.rst index 63d8d11b2..6e4b266a5 100644 --- a/classes/class_shape.rst +++ b/classes/class_shape.rst @@ -8,7 +8,9 @@ Shape ===== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`CylinderShape`, :ref:`RayShape`, :ref:`SphereShape`, :ref:`CapsuleShape`, :ref:`BoxShape`, :ref:`ConvexPolygonShape`, :ref:`PlaneShape`, :ref:`ConcavePolygonShape` + **Category:** Core Brief Description @@ -16,6 +18,13 @@ Brief Description Base class for all 3D shape resources. +Properties +---------- + ++---------------------------+-----------------------------------+ +| :ref:`float` | :ref:`margin` | ++---------------------------+-----------------------------------+ + Description ----------- @@ -25,7 +34,6 @@ Tutorials --------- - :doc:`../tutorials/physics/physics_introduction` - Property Descriptions --------------------- @@ -33,4 +41,9 @@ Property Descriptions - :ref:`float` **margin** ++----------+-------------------+ +| *Setter* | set_margin(value) | ++----------+-------------------+ +| *Getter* | get_margin() | ++----------+-------------------+ diff --git a/classes/class_shape2d.rst b/classes/class_shape2d.rst index f46d3023c..3188f7169 100644 --- a/classes/class_shape2d.rst +++ b/classes/class_shape2d.rst @@ -8,7 +8,9 @@ Shape2D ======= **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`RayShape2D`, :ref:`LineShape2D`, :ref:`CircleShape2D`, :ref:`ConcavePolygonShape2D`, :ref:`ConvexPolygonShape2D`, :ref:`CapsuleShape2D`, :ref:`RectangleShape2D`, :ref:`SegmentShape2D` + **Category:** Core Brief Description @@ -16,6 +18,13 @@ Brief Description Base class for all 2D Shapes. +Properties +---------- + ++---------------------------+-------------------------------------------------------------+ +| :ref:`float` | :ref:`custom_solver_bias` | ++---------------------------+-------------------------------------------------------------+ + Methods ------- @@ -38,7 +47,6 @@ Tutorials --------- - :doc:`../tutorials/physics/physics_introduction` - Property Descriptions --------------------- @@ -46,11 +54,16 @@ Property Descriptions - :ref:`float` **custom_solver_bias** ++----------+-------------------------------+ +| *Setter* | set_custom_solver_bias(value) | ++----------+-------------------------------+ +| *Getter* | get_custom_solver_bias() | ++----------+-------------------------------+ Method Descriptions ------------------- -.. _class_Shape2D_collide: + .. _class_Shape2D_collide: - :ref:`bool` **collide** **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** @@ -58,7 +71,7 @@ Return whether 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_collide_and_get_contacts: - :ref:`Variant` **collide_and_get_contacts** **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** @@ -66,7 +79,7 @@ Return a list of the points where this shape touches another. If there are no co 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_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 **)** @@ -74,7 +87,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_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 **)** @@ -82,4 +95,3 @@ Return a list of the points where this shape would touch another, if a given mov This method needs the transformation matrix for this shape (``local_xform``), the movement to test on this shape (``local_motion``), the shape to check collisions with (``with_shape``), the transformation matrix of that shape (``shape_xform``), and the movement to test onto the other object (``shape_motion``). - diff --git a/classes/class_shortcut.rst b/classes/class_shortcut.rst index 046e3e9f2..433b20f42 100644 --- a/classes/class_shortcut.rst +++ b/classes/class_shortcut.rst @@ -8,6 +8,7 @@ ShortCut ======== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description A shortcut for binding input. +Properties +---------- + ++-------------------------------------+------------------------------------------+ +| :ref:`InputEvent` | :ref:`shortcut` | ++-------------------------------------+------------------------------------------+ + Methods ------- @@ -38,30 +46,36 @@ Property Descriptions .. _class_ShortCut_shortcut: -- :ref:`InputEvent` **shortcut** - The Shortcut's :ref:`InputEvent`. +- :ref:`InputEvent` **shortcut** + ++----------+---------------------+ +| *Setter* | set_shortcut(value) | ++----------+---------------------+ +| *Getter* | get_shortcut() | ++----------+---------------------+ + +The Shortcut's :ref:`InputEvent`. Generally the :ref:`InputEvent` is a keyboard key, though it can be any :ref:`InputEvent`. - Method Descriptions ------------------- -.. _class_ShortCut_get_as_text: + .. _class_ShortCut_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_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_is_valid: - :ref:`bool` **is_valid** **(** **)** const If ``true`` this Shortcut is valid. - diff --git a/classes/class_skeleton.rst b/classes/class_skeleton.rst index ffc264de9..ae8079401 100644 --- a/classes/class_skeleton.rst +++ b/classes/class_skeleton.rst @@ -8,6 +8,7 @@ Skeleton ======== **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -78,7 +79,6 @@ Constants --------- - **NOTIFICATION_UPDATE_SKELETON** = **50** - Description ----------- @@ -91,146 +91,145 @@ Note that "global pose" below refers to the overall transform of the bone with r Method Descriptions ------------------- -.. _class_Skeleton_add_bone: + .. _class_Skeleton_add_bone: - void **add_bone** **(** :ref:`String` name **)** Add a bone, with name "name". :ref:`get_bone_count` will become the bone index. -.. _class_Skeleton_bind_child_node_to_bone: + .. _class_Skeleton_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_clear_bones: - void **clear_bones** **(** **)** Clear all the bones in this skeleton. -.. _class_Skeleton_find_bone: + .. _class_Skeleton_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_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_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_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_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_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_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_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_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_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_is_bone_rest_disabled: - :ref:`bool` **is_bone_rest_disabled** **(** :ref:`int` bone_idx **)** const -.. _class_Skeleton_physical_bones_add_collision_exception: + .. _class_Skeleton_physical_bones_add_collision_exception: - void **physical_bones_add_collision_exception** **(** :ref:`RID` exception **)** -.. _class_Skeleton_physical_bones_remove_collision_exception: + .. _class_Skeleton_physical_bones_remove_collision_exception: - void **physical_bones_remove_collision_exception** **(** :ref:`RID` exception **)** -.. _class_Skeleton_physical_bones_start_simulation: + .. _class_Skeleton_physical_bones_start_simulation: - void **physical_bones_start_simulation** **(** :ref:`Array` bones=[ ] **)** -.. _class_Skeleton_physical_bones_stop_simulation: + .. _class_Skeleton_physical_bones_stop_simulation: - void **physical_bones_stop_simulation** **(** **)** -.. _class_Skeleton_set_bone_custom_pose: + .. _class_Skeleton_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_set_bone_disable_rest: - void **set_bone_disable_rest** **(** :ref:`int` bone_idx, :ref:`bool` disable **)** -.. _class_Skeleton_set_bone_global_pose: + .. _class_Skeleton_set_bone_global_pose: - void **set_bone_global_pose** **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** -.. _class_Skeleton_set_bone_ignore_animation: + .. _class_Skeleton_set_bone_ignore_animation: - void **set_bone_ignore_animation** **(** :ref:`int` bone, :ref:`bool` ignore **)** -.. _class_Skeleton_set_bone_parent: + .. _class_Skeleton_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_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_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_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_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 f31193764..f8a872287 100644 --- a/classes/class_skeleton2d.rst +++ b/classes/class_skeleton2d.rst @@ -8,6 +8,7 @@ Skeleton2D ========== **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -29,16 +30,15 @@ Methods Method Descriptions ------------------- -.. _class_Skeleton2D_get_bone: + .. _class_Skeleton2D_get_bone: - :ref:`Bone2D` **get_bone** **(** :ref:`int` idx **)** -.. _class_Skeleton2D_get_bone_count: + .. _class_Skeleton2D_get_bone_count: - :ref:`int` **get_bone_count** **(** **)** const -.. _class_Skeleton2D_get_skeleton: + .. _class_Skeleton2D_get_skeleton: - :ref:`RID` **get_skeleton** **(** **)** const - diff --git a/classes/class_skeletonik.rst b/classes/class_skeletonik.rst index 0bc1d49b2..3d01069d4 100644 --- a/classes/class_skeletonik.rst +++ b/classes/class_skeletonik.rst @@ -8,6 +8,7 @@ SkeletonIK ========== **Inherits:** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,29 @@ Brief Description +Properties +---------- + ++-----------------------------------+--------------------------------------------------------+ +| :ref:`float` | :ref:`interpolation` | ++-----------------------------------+--------------------------------------------------------+ +| :ref:`Vector3` | :ref:`magnet` | ++-----------------------------------+--------------------------------------------------------+ +| :ref:`int` | :ref:`max_iterations` | ++-----------------------------------+--------------------------------------------------------+ +| :ref:`float` | :ref:`min_distance` | ++-----------------------------------+--------------------------------------------------------+ +| :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 ------- @@ -35,56 +59,108 @@ Property Descriptions - :ref:`float` **interpolation** ++----------+--------------------------+ +| *Setter* | set_interpolation(value) | ++----------+--------------------------+ +| *Getter* | get_interpolation() | ++----------+--------------------------+ + .. _class_SkeletonIK_magnet: - :ref:`Vector3` **magnet** ++----------+----------------------------+ +| *Setter* | set_magnet_position(value) | ++----------+----------------------------+ +| *Getter* | get_magnet_position() | ++----------+----------------------------+ + .. _class_SkeletonIK_max_iterations: - :ref:`int` **max_iterations** ++----------+---------------------------+ +| *Setter* | set_max_iterations(value) | ++----------+---------------------------+ +| *Getter* | get_max_iterations() | ++----------+---------------------------+ + .. _class_SkeletonIK_min_distance: - :ref:`float` **min_distance** ++----------+-------------------------+ +| *Setter* | set_min_distance(value) | ++----------+-------------------------+ +| *Getter* | get_min_distance() | ++----------+-------------------------+ + .. _class_SkeletonIK_root_bone: - :ref:`String` **root_bone** ++----------+----------------------+ +| *Setter* | set_root_bone(value) | ++----------+----------------------+ +| *Getter* | get_root_bone() | ++----------+----------------------+ + .. _class_SkeletonIK_target: - :ref:`Transform` **target** ++----------+-----------------------------+ +| *Setter* | set_target_transform(value) | ++----------+-----------------------------+ +| *Getter* | get_target_transform() | ++----------+-----------------------------+ + .. _class_SkeletonIK_target_node: - :ref:`NodePath` **target_node** ++----------+------------------------+ +| *Setter* | set_target_node(value) | ++----------+------------------------+ +| *Getter* | get_target_node() | ++----------+------------------------+ + .. _class_SkeletonIK_tip_bone: - :ref:`String` **tip_bone** ++----------+---------------------+ +| *Setter* | set_tip_bone(value) | ++----------+---------------------+ +| *Getter* | get_tip_bone() | ++----------+---------------------+ + .. _class_SkeletonIK_use_magnet: - :ref:`bool` **use_magnet** ++----------+-----------------------+ +| *Setter* | set_use_magnet(value) | ++----------+-----------------------+ +| *Getter* | is_using_magnet() | ++----------+-----------------------+ Method Descriptions ------------------- -.. _class_SkeletonIK_get_parent_skeleton: + .. _class_SkeletonIK_get_parent_skeleton: - :ref:`Skeleton` **get_parent_skeleton** **(** **)** const -.. _class_SkeletonIK_is_running: + .. _class_SkeletonIK_is_running: - :ref:`bool` **is_running** **(** **)** -.. _class_SkeletonIK_start: + .. _class_SkeletonIK_start: - void **start** **(** :ref:`bool` one_time=false **)** -.. _class_SkeletonIK_stop: + .. _class_SkeletonIK_stop: - void **stop** **(** **)** - diff --git a/classes/class_sky.rst b/classes/class_sky.rst index 32d93ebcd..7872d96ce 100644 --- a/classes/class_sky.rst +++ b/classes/class_sky.rst @@ -8,7 +8,9 @@ Sky === **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`PanoramaSky`, :ref:`ProceduralSky` + **Category:** Core Brief Description @@ -16,12 +18,19 @@ Brief Description The base class for :ref:`PanoramaSky` and :ref:`ProceduralSky`. +Properties +---------- + ++--------------------------------------------+-----------------------------------------------+ +| :ref:`RadianceSize` | :ref:`radiance_size` | ++--------------------------------------------+-----------------------------------------------+ + Enumerations ------------ .. _enum_Sky_RadianceSize: -enum **RadianceSize** +enum **RadianceSize**: - **RADIANCE_SIZE_32** = **0** --- Radiance texture size is 32x32 pixels. - **RADIANCE_SIZE_64** = **1** --- Radiance texture size is 64x64 pixels. @@ -32,7 +41,6 @@ enum **RadianceSize** - **RADIANCE_SIZE_2048** = **6** --- Radiance texture size is 2048x2048 pixels. - **RADIANCE_SIZE_MAX** = **7** --- Radiance texture size is the largest size it can be. - Description ----------- @@ -43,10 +51,17 @@ Property Descriptions .. _class_Sky_radiance_size: -- :ref:`RadianceSize` **radiance_size** - The Sky's radiance map size. +- :ref:`RadianceSize` **radiance_size** + ++----------+--------------------------+ +| *Setter* | set_radiance_size(value) | ++----------+--------------------------+ +| *Getter* | get_radiance_size() | ++----------+--------------------------+ + +The Sky's radiance map size. The higher the radiance map size, the more detailed the lighting from the Sky will be. See RADIANCE_SIZE\_\* constants for values. Default size is RADIANCE_SIZE_512. - diff --git a/classes/class_slider.rst b/classes/class_slider.rst index b7b644461..c55154a97 100644 --- a/classes/class_slider.rst +++ b/classes/class_slider.rst @@ -8,7 +8,9 @@ Slider ====== **Inherits:** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`HSlider`, :ref:`VSlider` + **Category:** Core Brief Description @@ -16,6 +18,21 @@ Brief Description 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` | ++------------------------------------------+--------------------------------------------------------+ + Description ----------- @@ -28,20 +45,49 @@ Property Descriptions - :ref:`bool` **editable** ++----------+---------------------+ +| *Setter* | set_editable(value) | ++----------+---------------------+ +| *Getter* | is_editable() | ++----------+---------------------+ + .. _class_Slider_focus_mode: - :ref:`FocusMode` **focus_mode** ++----------+-----------------------+ +| *Setter* | set_focus_mode(value) | ++----------+-----------------------+ +| *Getter* | get_focus_mode() | ++----------+-----------------------+ + .. _class_Slider_scrollable: - :ref:`bool` **scrollable** ++----------+-----------------------+ +| *Setter* | set_scrollable(value) | ++----------+-----------------------+ +| *Getter* | is_scrollable() | ++----------+-----------------------+ + .. _class_Slider_tick_count: - :ref:`int` **tick_count** ++----------+------------------+ +| *Setter* | set_ticks(value) | ++----------+------------------+ +| *Getter* | get_ticks() | ++----------+------------------+ + .. _class_Slider_ticks_on_borders: - :ref:`bool` **ticks_on_borders** ++----------+-----------------------------+ +| *Setter* | set_ticks_on_borders(value) | ++----------+-----------------------------+ +| *Getter* | get_ticks_on_borders() | ++----------+-----------------------------+ diff --git a/classes/class_sliderjoint.rst b/classes/class_sliderjoint.rst index 85050baeb..be110a9df 100644 --- a/classes/class_sliderjoint.rst +++ b/classes/class_sliderjoint.rst @@ -8,6 +8,7 @@ SliderJoint =========== **Inherits:** :ref:`Joint` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,12 +16,61 @@ Brief Description 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` | ++---------------------------+-----------------------------------------------------------------------------------+ + Enumerations ------------ .. _enum_SliderJoint_Param: -enum **Param** +enum **Param**: - **PARAM_LINEAR_LIMIT_UPPER** = **0** --- The maximum difference between the pivot points on their x-axis before damping happens. - **PARAM_LINEAR_LIMIT_LOWER** = **1** --- The minimum difference between the pivot points on their x-axis before damping happens. @@ -46,7 +96,6 @@ enum **Param** - **PARAM_ANGULAR_ORTHOGONAL_DAMPING** = **21** --- The amount of damping of the rotation across axes orthogonal to the slider. - **PARAM_MAX** = **22** --- End flag of PARAM\_\* constants, used internally. - Description ----------- @@ -57,96 +106,259 @@ Property Descriptions .. _class_SliderJoint_angular_limit/damping: -- :ref:`float` **angular_limit/damping** - The amount of damping of the rotation when the limit is surpassed. +- :ref:`float` **angular_limit/damping** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +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: -- :ref:`float` **angular_limit/lower_angle** - The lower limit of rotation in the slider. +- :ref:`float` **angular_limit/lower_angle** + +The lower limit of rotation in the slider. .. _class_SliderJoint_angular_limit/restitution: -- :ref:`float` **angular_limit/restitution** - The amount of restitution of the rotation when the limit is surpassed. +- :ref:`float` **angular_limit/restitution** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +The amount of restitution of the rotation when the limit is surpassed. Does not affect damping. .. _class_SliderJoint_angular_limit/softness: -- :ref:`float` **angular_limit/softness** - A factor applied to the all rotation once the limit is surpassed. +- :ref:`float` **angular_limit/softness** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +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: -- :ref:`float` **angular_limit/upper_angle** - The upper limit of rotation in the slider. +- :ref:`float` **angular_limit/upper_angle** + +The upper limit of rotation in the slider. .. _class_SliderJoint_angular_motion/damping: -- :ref:`float` **angular_motion/damping** - The amount of damping of the rotation in the limits. +- :ref:`float` **angular_motion/damping** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +The amount of damping of the rotation in the limits. .. _class_SliderJoint_angular_motion/restitution: -- :ref:`float` **angular_motion/restitution** - The amount of restitution of the rotation in the limits. +- :ref:`float` **angular_motion/restitution** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +The amount of restitution of the rotation in the limits. .. _class_SliderJoint_angular_motion/softness: -- :ref:`float` **angular_motion/softness** - A factor applied to the all rotation in the limits. +- :ref:`float` **angular_motion/softness** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +A factor applied to the all rotation in the limits. .. _class_SliderJoint_angular_ortho/damping: -- :ref:`float` **angular_ortho/damping** - The amount of damping of the rotation across axes orthogonal to the slider. +- :ref:`float` **angular_ortho/damping** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +The amount of damping of the rotation across axes orthogonal to the slider. .. _class_SliderJoint_angular_ortho/restitution: -- :ref:`float` **angular_ortho/restitution** - The amount of restitution of the rotation across axes orthogonal to the slider. +- :ref:`float` **angular_ortho/restitution** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +The amount of restitution of the rotation across axes orthogonal to the slider. .. _class_SliderJoint_angular_ortho/softness: -- :ref:`float` **angular_ortho/softness** - A factor applied to the all rotation across axes orthogonal to the slider. +- :ref:`float` **angular_ortho/softness** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +A factor applied to the all rotation across axes orthogonal to the slider. .. _class_SliderJoint_linear_limit/damping: -- :ref:`float` **linear_limit/damping** - The amount of damping that happens once the limit defined by :ref:`linear_limit/lower_distance` and :ref:`linear_limit/upper_distance` is surpassed. +- :ref:`float` **linear_limit/damping** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *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. .. _class_SliderJoint_linear_limit/lower_distance: -- :ref:`float` **linear_limit/lower_distance** - The minimum difference between the pivot points on their x-axis before damping happens. +- :ref:`float` **linear_limit/lower_distance** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +The minimum difference between the pivot points on their x-axis before damping happens. .. _class_SliderJoint_linear_limit/restitution: -- :ref:`float` **linear_limit/restitution** - The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost. +- :ref:`float` **linear_limit/restitution** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost. .. _class_SliderJoint_linear_limit/softness: -- :ref:`float` **linear_limit/softness** - A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement. +- :ref:`float` **linear_limit/softness** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +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: -- :ref:`float` **linear_limit/upper_distance** - The maximum difference between the pivot points on their x-axis before damping happens. +- :ref:`float` **linear_limit/upper_distance** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +The maximum difference between the pivot points on their x-axis before damping happens. .. _class_SliderJoint_linear_motion/damping: -- :ref:`float` **linear_motion/damping** - The amount of damping inside the slider limits. +- :ref:`float` **linear_motion/damping** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +The amount of damping inside the slider limits. .. _class_SliderJoint_linear_motion/restitution: -- :ref:`float` **linear_motion/restitution** - The amount of restitution inside the slider limits. +- :ref:`float` **linear_motion/restitution** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +The amount of restitution inside the slider limits. .. _class_SliderJoint_linear_motion/softness: -- :ref:`float` **linear_motion/softness** - 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. +- :ref:`float` **linear_motion/softness** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +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: -- :ref:`float` **linear_ortho/damping** - The amount of damping when movement is across axes orthogonal to the slider. +- :ref:`float` **linear_ortho/damping** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +The amount of damping when movement is across axes orthogonal to the slider. .. _class_SliderJoint_linear_ortho/restitution: -- :ref:`float` **linear_ortho/restitution** - The amount of restitution when movement is across axes orthogonal to the slider. +- :ref:`float` **linear_ortho/restitution** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +The amount of restitution when movement is across axes orthogonal to the slider. .. _class_SliderJoint_linear_ortho/softness: -- :ref:`float` **linear_ortho/softness** - A factor applied to the movement across axes orthogonal to the slider. +- :ref:`float` **linear_ortho/softness** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +A factor applied to the movement across axes orthogonal to the slider. diff --git a/classes/class_softbody.rst b/classes/class_softbody.rst index 85304efda..1f07827c0 100644 --- a/classes/class_softbody.rst +++ b/classes/class_softbody.rst @@ -8,6 +8,7 @@ SoftBody ======== **Inherits:** :ref:`MeshInstance` **<** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,35 @@ Brief Description +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` | ++---------------------------------+----------------------------------------------------------------------------+ + Methods ------- @@ -43,84 +73,154 @@ Property Descriptions - :ref:`float` **areaAngular_stiffness** ++----------+----------------------------------+ +| *Setter* | set_areaAngular_stiffness(value) | ++----------+----------------------------------+ +| *Getter* | get_areaAngular_stiffness() | ++----------+----------------------------------+ + .. _class_SoftBody_collision_layer: - :ref:`int` **collision_layer** ++----------+----------------------------+ +| *Setter* | set_collision_layer(value) | ++----------+----------------------------+ +| *Getter* | get_collision_layer() | ++----------+----------------------------+ + .. _class_SoftBody_collision_mask: - :ref:`int` **collision_mask** ++----------+---------------------------+ +| *Setter* | set_collision_mask(value) | ++----------+---------------------------+ +| *Getter* | get_collision_mask() | ++----------+---------------------------+ + .. _class_SoftBody_damping_coefficient: - :ref:`float` **damping_coefficient** ++----------+--------------------------------+ +| *Setter* | set_damping_coefficient(value) | ++----------+--------------------------------+ +| *Getter* | get_damping_coefficient() | ++----------+--------------------------------+ + .. _class_SoftBody_drag_coefficient: - :ref:`float` **drag_coefficient** ++----------+-----------------------------+ +| *Setter* | set_drag_coefficient(value) | ++----------+-----------------------------+ +| *Getter* | get_drag_coefficient() | ++----------+-----------------------------+ + .. _class_SoftBody_linear_stiffness: - :ref:`float` **linear_stiffness** ++----------+-----------------------------+ +| *Setter* | set_linear_stiffness(value) | ++----------+-----------------------------+ +| *Getter* | get_linear_stiffness() | ++----------+-----------------------------+ + .. _class_SoftBody_parent_collision_ignore: - :ref:`NodePath` **parent_collision_ignore** ++----------+------------------------------------+ +| *Setter* | set_parent_collision_ignore(value) | ++----------+------------------------------------+ +| *Getter* | get_parent_collision_ignore() | ++----------+------------------------------------+ + .. _class_SoftBody_pose_matching_coefficient: - :ref:`float` **pose_matching_coefficient** ++----------+--------------------------------------+ +| *Setter* | set_pose_matching_coefficient(value) | ++----------+--------------------------------------+ +| *Getter* | get_pose_matching_coefficient() | ++----------+--------------------------------------+ + .. _class_SoftBody_pressure_coefficient: - :ref:`float` **pressure_coefficient** ++----------+---------------------------------+ +| *Setter* | set_pressure_coefficient(value) | ++----------+---------------------------------+ +| *Getter* | get_pressure_coefficient() | ++----------+---------------------------------+ + .. _class_SoftBody_simulation_precision: - :ref:`int` **simulation_precision** ++----------+---------------------------------+ +| *Setter* | set_simulation_precision(value) | ++----------+---------------------------------+ +| *Getter* | get_simulation_precision() | ++----------+---------------------------------+ + .. _class_SoftBody_total_mass: - :ref:`float` **total_mass** ++----------+-----------------------+ +| *Setter* | set_total_mass(value) | ++----------+-----------------------+ +| *Getter* | get_total_mass() | ++----------+-----------------------+ + .. _class_SoftBody_volume_stiffness: - :ref:`float` **volume_stiffness** ++----------+-----------------------------+ +| *Setter* | set_volume_stiffness(value) | ++----------+-----------------------------+ +| *Getter* | get_volume_stiffness() | ++----------+-----------------------------+ Method Descriptions ------------------- -.. _class_SoftBody_add_collision_exception_with: + .. _class_SoftBody_add_collision_exception_with: - void **add_collision_exception_with** **(** :ref:`Node` body **)** -.. _class_SoftBody_get_collision_layer_bit: + .. _class_SoftBody_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const -.. _class_SoftBody_get_collision_mask_bit: + .. _class_SoftBody_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const -.. _class_SoftBody_is_ray_pickable: + .. _class_SoftBody_is_ray_pickable: - :ref:`bool` **is_ray_pickable** **(** **)** const -.. _class_SoftBody_remove_collision_exception_with: + .. _class_SoftBody_remove_collision_exception_with: - void **remove_collision_exception_with** **(** :ref:`Node` body **)** -.. _class_SoftBody_set_collision_layer_bit: + .. _class_SoftBody_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** -.. _class_SoftBody_set_collision_mask_bit: + .. _class_SoftBody_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** -.. _class_SoftBody_set_ray_pickable: + .. _class_SoftBody_set_ray_pickable: - void **set_ray_pickable** **(** :ref:`bool` ray_pickable **)** - diff --git a/classes/class_spatial.rst b/classes/class_spatial.rst index 68fd1f812..32fdd1cfe 100644 --- a/classes/class_spatial.rst +++ b/classes/class_spatial.rst @@ -8,7 +8,9 @@ Spatial ======= **Inherits:** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`Joint`, :ref:`RayCast`, :ref:`Camera`, :ref:`BoneAttachment`, :ref:`CollisionShape`, :ref:`AudioStreamPlayer3D`, :ref:`Path`, :ref:`ARVRController`, :ref:`VisualInstance`, :ref:`VehicleWheel`, :ref:`Position3D`, :ref:`ProximityGroup`, :ref:`SpringArm`, :ref:`ARVRAnchor`, :ref:`RemoteTransform`, :ref:`CollisionObject`, :ref:`OrientedPathFollow`, :ref:`PathFollow`, :ref:`NavigationMeshInstance`, :ref:`Listener`, :ref:`VisibilityNotifier`, :ref:`Navigation`, :ref:`CollisionPolygon`, :ref:`GridMap`, :ref:`Skeleton`, :ref:`ARVROrigin` + **Category:** Core Brief Description @@ -16,6 +18,27 @@ Brief Description 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` | ++-----------------------------------------+---------------------------------------------------------+ + Methods ------- @@ -90,13 +113,12 @@ Methods Signals ------- -.. _class_Spatial_visibility_changed: + .. _class_Spatial_visibility_changed: - **visibility_changed** **(** **)** Emitted when node visibility changes. - Constants --------- @@ -106,7 +128,6 @@ In order for NOTIFICATION_TRANSFORM_CHANGED to work user first needs to ask for - **NOTIFICATION_ENTER_WORLD** = **41** --- Spatial nodes receives this notification when they are registered to new :ref:`World` resource. - **NOTIFICATION_EXIT_WORLD** = **42** --- Spatial nodes receives this notification when they are unregistered from current :ref:`World` resource. - **NOTIFICATION_VISIBILITY_CHANGED** = **43** --- Spatial nodes receives this notification when their visibility changes. - Description ----------- @@ -118,115 +139,177 @@ Tutorials --------- - :doc:`../tutorials/3d/introduction_to_3d` - Property Descriptions --------------------- .. _class_Spatial_gizmo: -- :ref:`SpatialGizmo` **gizmo** - The SpatialGizmo for this node. Used for example in :ref:`EditorSpatialGizmo` as custom visualization and editing handles in Editor. +- :ref:`SpatialGizmo` **gizmo** + ++----------+------------------+ +| *Setter* | set_gizmo(value) | ++----------+------------------+ +| *Getter* | get_gizmo() | ++----------+------------------+ + +The SpatialGizmo for this node. Used for example in :ref:`EditorSpatialGizmo` as custom visualization and editing handles in Editor. .. _class_Spatial_global_transform: -- :ref:`Transform` **global_transform** - World space (global) :ref:`Transform` of this node. +- :ref:`Transform` **global_transform** + ++----------+-----------------------------+ +| *Setter* | set_global_transform(value) | ++----------+-----------------------------+ +| *Getter* | get_global_transform() | ++----------+-----------------------------+ + +World space (global) :ref:`Transform` of this node. .. _class_Spatial_rotation: -- :ref:`Vector3` **rotation** - Rotation part of the local transformation in radians, specified in terms of YXZ-Euler angles in the format (X-angle, Y-angle, Z-angle). +- :ref:`Vector3` **rotation** + ++----------+---------------------+ +| *Setter* | set_rotation(value) | ++----------+---------------------+ +| *Getter* | get_rotation() | ++----------+---------------------+ + +Rotation part of the local transformation in radians, specified in terms of YXZ-Euler angles in the format (X-angle, Y-angle, Z-angle). 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: -- :ref:`Vector3` **rotation_degrees** - Rotation part of the local transformation in degrees, specified in terms of YXZ-Euler angles in the format (X-angle, Y-angle, Z-angle). +- :ref:`Vector3` **rotation_degrees** + ++----------+-----------------------------+ +| *Setter* | set_rotation_degrees(value) | ++----------+-----------------------------+ +| *Getter* | get_rotation_degrees() | ++----------+-----------------------------+ + +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: -- :ref:`Vector3` **scale** - Scale part of the local transformation. +- :ref:`Vector3` **scale** + ++----------+------------------+ +| *Setter* | set_scale(value) | ++----------+------------------+ +| *Getter* | get_scale() | ++----------+------------------+ + +Scale part of the local transformation. .. _class_Spatial_transform: -- :ref:`Transform` **transform** - Local space :ref:`Transform` of this node, with respect to the parent node. +- :ref:`Transform` **transform** + ++----------+----------------------+ +| *Setter* | set_transform(value) | ++----------+----------------------+ +| *Getter* | get_transform() | ++----------+----------------------+ + +Local space :ref:`Transform` of this node, with respect to the parent node. .. _class_Spatial_translation: -- :ref:`Vector3` **translation** - Local translation of this node. +- :ref:`Vector3` **translation** + ++----------+------------------------+ +| *Setter* | set_translation(value) | ++----------+------------------------+ +| *Getter* | get_translation() | ++----------+------------------------+ + +Local translation of this node. .. _class_Spatial_visible: -- :ref:`bool` **visible** - If ``true`` this node is drawn. Default value: ``true``. +- :ref:`bool` **visible** ++----------+--------------------+ +| *Setter* | set_visible(value) | ++----------+--------------------+ +| *Getter* | is_visible() | ++----------+--------------------+ + +If ``true`` this node is drawn. Default value: ``true``. Method Descriptions ------------------- -.. _class_Spatial_force_update_transform: + .. _class_Spatial_force_update_transform: - void **force_update_transform** **(** **)** -.. _class_Spatial_get_parent_spatial: + .. _class_Spatial_get_parent_spatial: - :ref:`Spatial` **get_parent_spatial** **(** **)** const Returns the parent ``Spatial``, or an empty :ref:`Object` if no parent exists or parent is not of type ``Spatial``. -.. _class_Spatial_get_world: + .. _class_Spatial_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_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_global_scale: - void **global_scale** **(** :ref:`Vector3` scale **)** -.. _class_Spatial_global_translate: + .. _class_Spatial_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_hide: - void **hide** **(** **)** Disables rendering of this node. Change Spatial Visible property to false. -.. _class_Spatial_is_local_transform_notification_enabled: + .. _class_Spatial_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_is_scale_disabled: - :ref:`bool` **is_scale_disabled** **(** **)** const -.. _class_Spatial_is_set_as_toplevel: + .. _class_Spatial_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_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_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_look_at: - void **look_at** **(** :ref:`Vector3` target, :ref:`Vector3` up **)** @@ -236,120 +319,119 @@ 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_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. -.. _class_Spatial_orthonormalize: + .. _class_Spatial_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 Transform3D. -.. _class_Spatial_rotate: + .. _class_Spatial_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_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_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_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_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_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_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_set_disable_scale: - void **set_disable_scale** **(** :ref:`bool` disable **)** -.. _class_Spatial_set_identity: + .. _class_Spatial_set_identity: - void **set_identity** **(** **)** Reset all transformations for this node. Set its Transform3D to identity matrix. -.. _class_Spatial_set_ignore_transform_notification: + .. _class_Spatial_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_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_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_show: - void **show** **(** **)** Enables rendering of this node. Change Spatial Visible property to "True". -.. _class_Spatial_to_global: + .. _class_Spatial_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_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_translate: - void **translate** **(** :ref:`Vector3` offset **)** Changes the node's position by given offset :ref:`Vector3`. -.. _class_Spatial_translate_object_local: + .. _class_Spatial_translate_object_local: - void **translate_object_local** **(** :ref:`Vector3` offset **)** -.. _class_Spatial_update_gizmo: + .. _class_Spatial_update_gizmo: - void **update_gizmo** **(** **)** Updates the :ref:`SpatialGizmo` of this node. - diff --git a/classes/class_spatialgizmo.rst b/classes/class_spatialgizmo.rst index eb56cc279..2ba58ebfb 100644 --- a/classes/class_spatialgizmo.rst +++ b/classes/class_spatialgizmo.rst @@ -8,7 +8,9 @@ SpatialGizmo ============ **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`EditorSpatialGizmo` + **Category:** Core Brief Description diff --git a/classes/class_spatialmaterial.rst b/classes/class_spatialmaterial.rst index 366c4595c..856adcdcc 100644 --- a/classes/class_spatialmaterial.rst +++ b/classes/class_spatialmaterial.rst @@ -8,6 +8,7 @@ SpatialMaterial =============== **Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,19 +16,220 @@ Brief Description +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:`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:`int` | :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_DetailUV: -enum **DetailUV** +enum **DetailUV**: - **DETAIL_UV_1** = **0** - **DETAIL_UV_2** = **1** .. _enum_SpatialMaterial_TextureParam: -enum **TextureParam** +enum **TextureParam**: - **TEXTURE_ALBEDO** = **0** - **TEXTURE_METALLIC** = **1** @@ -49,7 +251,7 @@ enum **TextureParam** .. _enum_SpatialMaterial_DistanceFadeMode: -enum **DistanceFadeMode** +enum **DistanceFadeMode**: - **DISTANCE_FADE_DISABLED** = **0** - **DISTANCE_FADE_PIXEL_ALPHA** = **1** @@ -58,7 +260,7 @@ enum **DistanceFadeMode** .. _enum_SpatialMaterial_DepthDrawMode: -enum **DepthDrawMode** +enum **DepthDrawMode**: - **DEPTH_DRAW_OPAQUE_ONLY** = **0** - **DEPTH_DRAW_ALWAYS** = **1** @@ -67,7 +269,7 @@ enum **DepthDrawMode** .. _enum_SpatialMaterial_DiffuseMode: -enum **DiffuseMode** +enum **DiffuseMode**: - **DIFFUSE_BURLEY** = **0** - **DIFFUSE_LAMBERT** = **1** @@ -77,7 +279,7 @@ enum **DiffuseMode** .. _enum_SpatialMaterial_CullMode: -enum **CullMode** +enum **CullMode**: - **CULL_BACK** = **0** - **CULL_FRONT** = **1** @@ -85,7 +287,7 @@ enum **CullMode** .. _enum_SpatialMaterial_Feature: -enum **Feature** +enum **Feature**: - **FEATURE_TRANSPARENT** = **0** - **FEATURE_EMISSION** = **1** @@ -103,7 +305,7 @@ enum **Feature** .. _enum_SpatialMaterial_Flags: -enum **Flags** +enum **Flags**: - **FLAG_UNSHADED** = **0** - **FLAG_USE_VERTEX_LIGHTING** = **1** @@ -127,7 +329,7 @@ enum **Flags** .. _enum_SpatialMaterial_BlendMode: -enum **BlendMode** +enum **BlendMode**: - **BLEND_MODE_MIX** = **0** - **BLEND_MODE_ADD** = **1** @@ -136,7 +338,7 @@ enum **BlendMode** .. _enum_SpatialMaterial_SpecularMode: -enum **SpecularMode** +enum **SpecularMode**: - **SPECULAR_SCHLICK_GGX** = **0** - **SPECULAR_BLINN** = **1** @@ -146,7 +348,7 @@ enum **SpecularMode** .. _enum_SpatialMaterial_TextureChannel: -enum **TextureChannel** +enum **TextureChannel**: - **TEXTURE_CHANNEL_RED** = **0** - **TEXTURE_CHANNEL_GREEN** = **1** @@ -156,7 +358,7 @@ enum **TextureChannel** .. _enum_SpatialMaterial_BillboardMode: -enum **BillboardMode** +enum **BillboardMode**: - **BILLBOARD_DISABLED** = **0** - **BILLBOARD_ENABLED** = **1** @@ -165,17 +367,15 @@ enum **BillboardMode** .. _enum_SpatialMaterial_EmissionOperator: -enum **EmissionOperator** +enum **EmissionOperator**: - **EMISSION_OP_ADD** = **0** - **EMISSION_OP_MULTIPLY** = **1** - Tutorials --------- - :doc:`../tutorials/3d/spatial_material` - Property Descriptions --------------------- @@ -183,392 +383,979 @@ Property Descriptions - :ref:`Color` **albedo_color** ++----------+-------------------+ +| *Setter* | set_albedo(value) | ++----------+-------------------+ +| *Getter* | get_albedo() | ++----------+-------------------+ + .. _class_SpatialMaterial_albedo_texture: - :ref:`Texture` **albedo_texture** ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + .. _class_SpatialMaterial_anisotropy: - :ref:`float` **anisotropy** ++----------+-----------------------+ +| *Setter* | set_anisotropy(value) | ++----------+-----------------------+ +| *Getter* | get_anisotropy() | ++----------+-----------------------+ + .. _class_SpatialMaterial_anisotropy_enabled: - :ref:`bool` **anisotropy_enabled** ++----------+--------------------+ +| *Setter* | set_feature(value) | ++----------+--------------------+ +| *Getter* | get_feature() | ++----------+--------------------+ + .. _class_SpatialMaterial_anisotropy_flowmap: - :ref:`Texture` **anisotropy_flowmap** ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + .. _class_SpatialMaterial_ao_enabled: - :ref:`bool` **ao_enabled** ++----------+--------------------+ +| *Setter* | set_feature(value) | ++----------+--------------------+ +| *Getter* | get_feature() | ++----------+--------------------+ + .. _class_SpatialMaterial_ao_light_affect: - :ref:`float` **ao_light_affect** ++----------+----------------------------+ +| *Setter* | set_ao_light_affect(value) | ++----------+----------------------------+ +| *Getter* | get_ao_light_affect() | ++----------+----------------------------+ + .. _class_SpatialMaterial_ao_on_uv2: - :ref:`bool` **ao_on_uv2** ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ + .. _class_SpatialMaterial_ao_texture: - :ref:`Texture` **ao_texture** ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + .. _class_SpatialMaterial_ao_texture_channel: - :ref:`TextureChannel` **ao_texture_channel** ++----------+-------------------------------+ +| *Setter* | set_ao_texture_channel(value) | ++----------+-------------------------------+ +| *Getter* | get_ao_texture_channel() | ++----------+-------------------------------+ + .. _class_SpatialMaterial_clearcoat: - :ref:`float` **clearcoat** ++----------+----------------------+ +| *Setter* | set_clearcoat(value) | ++----------+----------------------+ +| *Getter* | get_clearcoat() | ++----------+----------------------+ + .. _class_SpatialMaterial_clearcoat_enabled: - :ref:`bool` **clearcoat_enabled** ++----------+--------------------+ +| *Setter* | set_feature(value) | ++----------+--------------------+ +| *Getter* | get_feature() | ++----------+--------------------+ + .. _class_SpatialMaterial_clearcoat_gloss: - :ref:`float` **clearcoat_gloss** ++----------+----------------------------+ +| *Setter* | set_clearcoat_gloss(value) | ++----------+----------------------------+ +| *Getter* | get_clearcoat_gloss() | ++----------+----------------------------+ + .. _class_SpatialMaterial_clearcoat_texture: - :ref:`Texture` **clearcoat_texture** ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + .. _class_SpatialMaterial_depth_deep_parallax: - :ref:`bool` **depth_deep_parallax** ++----------+----------------------------------+ +| *Setter* | set_depth_deep_parallax(value) | ++----------+----------------------------------+ +| *Getter* | is_depth_deep_parallax_enabled() | ++----------+----------------------------------+ + .. _class_SpatialMaterial_depth_enabled: - :ref:`bool` **depth_enabled** ++----------+--------------------+ +| *Setter* | set_feature(value) | ++----------+--------------------+ +| *Getter* | get_feature() | ++----------+--------------------+ + .. _class_SpatialMaterial_depth_max_layers: - :ref:`int` **depth_max_layers** ++----------+-------------------------------------------+ +| *Setter* | set_depth_deep_parallax_max_layers(value) | ++----------+-------------------------------------------+ +| *Getter* | get_depth_deep_parallax_max_layers() | ++----------+-------------------------------------------+ + .. _class_SpatialMaterial_depth_min_layers: - :ref:`int` **depth_min_layers** ++----------+-------------------------------------------+ +| *Setter* | set_depth_deep_parallax_min_layers(value) | ++----------+-------------------------------------------+ +| *Getter* | get_depth_deep_parallax_min_layers() | ++----------+-------------------------------------------+ + .. _class_SpatialMaterial_depth_scale: - :ref:`float` **depth_scale** ++----------+------------------------+ +| *Setter* | set_depth_scale(value) | ++----------+------------------------+ +| *Getter* | get_depth_scale() | ++----------+------------------------+ + .. _class_SpatialMaterial_depth_texture: - :ref:`Texture` **depth_texture** ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + .. _class_SpatialMaterial_detail_albedo: - :ref:`Texture` **detail_albedo** ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + .. _class_SpatialMaterial_detail_blend_mode: - :ref:`BlendMode` **detail_blend_mode** ++----------+------------------------------+ +| *Setter* | set_detail_blend_mode(value) | ++----------+------------------------------+ +| *Getter* | get_detail_blend_mode() | ++----------+------------------------------+ + .. _class_SpatialMaterial_detail_enabled: - :ref:`bool` **detail_enabled** ++----------+--------------------+ +| *Setter* | set_feature(value) | ++----------+--------------------+ +| *Getter* | get_feature() | ++----------+--------------------+ + .. _class_SpatialMaterial_detail_mask: - :ref:`Texture` **detail_mask** ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + .. _class_SpatialMaterial_detail_normal: - :ref:`Texture` **detail_normal** ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + .. _class_SpatialMaterial_detail_uv_layer: - :ref:`DetailUV` **detail_uv_layer** ++----------+----------------------+ +| *Setter* | set_detail_uv(value) | ++----------+----------------------+ +| *Getter* | get_detail_uv() | ++----------+----------------------+ + .. _class_SpatialMaterial_distance_fade_max_distance: - :ref:`float` **distance_fade_max_distance** ++----------+---------------------------------------+ +| *Setter* | set_distance_fade_max_distance(value) | ++----------+---------------------------------------+ +| *Getter* | get_distance_fade_max_distance() | ++----------+---------------------------------------+ + .. _class_SpatialMaterial_distance_fade_min_distance: - :ref:`float` **distance_fade_min_distance** ++----------+---------------------------------------+ +| *Setter* | set_distance_fade_min_distance(value) | ++----------+---------------------------------------+ +| *Getter* | get_distance_fade_min_distance() | ++----------+---------------------------------------+ + .. _class_SpatialMaterial_distance_fade_mode: - :ref:`DistanceFadeMode` **distance_fade_mode** ++----------+--------------------------+ +| *Setter* | set_distance_fade(value) | ++----------+--------------------------+ +| *Getter* | get_distance_fade() | ++----------+--------------------------+ + .. _class_SpatialMaterial_emission: - :ref:`Color` **emission** ++----------+---------------------+ +| *Setter* | set_emission(value) | ++----------+---------------------+ +| *Getter* | get_emission() | ++----------+---------------------+ + .. _class_SpatialMaterial_emission_enabled: - :ref:`bool` **emission_enabled** ++----------+--------------------+ +| *Setter* | set_feature(value) | ++----------+--------------------+ +| *Getter* | get_feature() | ++----------+--------------------+ + .. _class_SpatialMaterial_emission_energy: - :ref:`float` **emission_energy** ++----------+----------------------------+ +| *Setter* | set_emission_energy(value) | ++----------+----------------------------+ +| *Getter* | get_emission_energy() | ++----------+----------------------------+ + .. _class_SpatialMaterial_emission_on_uv2: - :ref:`bool` **emission_on_uv2** ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ + .. _class_SpatialMaterial_emission_operator: - :ref:`EmissionOperator` **emission_operator** ++----------+------------------------------+ +| *Setter* | set_emission_operator(value) | ++----------+------------------------------+ +| *Getter* | get_emission_operator() | ++----------+------------------------------+ + .. _class_SpatialMaterial_emission_texture: - :ref:`Texture` **emission_texture** ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + .. _class_SpatialMaterial_flags_albedo_tex_force_srgb: - :ref:`bool` **flags_albedo_tex_force_srgb** ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ + .. _class_SpatialMaterial_flags_disable_ambient_light: - :ref:`bool` **flags_disable_ambient_light** ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ + .. _class_SpatialMaterial_flags_do_not_receive_shadows: - :ref:`bool` **flags_do_not_receive_shadows** ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ + .. _class_SpatialMaterial_flags_ensure_correct_normals: - :ref:`bool` **flags_ensure_correct_normals** ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ + .. _class_SpatialMaterial_flags_fixed_size: - :ref:`bool` **flags_fixed_size** ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ + .. _class_SpatialMaterial_flags_no_depth_test: - :ref:`bool` **flags_no_depth_test** ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ + .. _class_SpatialMaterial_flags_transparent: - :ref:`bool` **flags_transparent** ++----------+--------------------+ +| *Setter* | set_feature(value) | ++----------+--------------------+ +| *Getter* | get_feature() | ++----------+--------------------+ + .. _class_SpatialMaterial_flags_unshaded: - :ref:`bool` **flags_unshaded** ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ + .. _class_SpatialMaterial_flags_use_point_size: - :ref:`bool` **flags_use_point_size** ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ + .. _class_SpatialMaterial_flags_vertex_lighting: - :ref:`bool` **flags_vertex_lighting** ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ + .. _class_SpatialMaterial_flags_world_triplanar: - :ref:`bool` **flags_world_triplanar** ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ + .. _class_SpatialMaterial_metallic: - :ref:`float` **metallic** ++----------+---------------------+ +| *Setter* | set_metallic(value) | ++----------+---------------------+ +| *Getter* | get_metallic() | ++----------+---------------------+ + .. _class_SpatialMaterial_metallic_specular: - :ref:`float` **metallic_specular** ++----------+---------------------+ +| *Setter* | set_specular(value) | ++----------+---------------------+ +| *Getter* | get_specular() | ++----------+---------------------+ + .. _class_SpatialMaterial_metallic_texture: - :ref:`Texture` **metallic_texture** ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + .. _class_SpatialMaterial_metallic_texture_channel: - :ref:`TextureChannel` **metallic_texture_channel** ++----------+-------------------------------------+ +| *Setter* | set_metallic_texture_channel(value) | ++----------+-------------------------------------+ +| *Getter* | get_metallic_texture_channel() | ++----------+-------------------------------------+ + .. _class_SpatialMaterial_normal_enabled: - :ref:`bool` **normal_enabled** ++----------+--------------------+ +| *Setter* | set_feature(value) | ++----------+--------------------+ +| *Getter* | get_feature() | ++----------+--------------------+ + .. _class_SpatialMaterial_normal_scale: - :ref:`float` **normal_scale** ++----------+-------------------------+ +| *Setter* | set_normal_scale(value) | ++----------+-------------------------+ +| *Getter* | get_normal_scale() | ++----------+-------------------------+ + .. _class_SpatialMaterial_normal_texture: - :ref:`Texture` **normal_texture** ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + .. _class_SpatialMaterial_params_alpha_scissor_threshold: - :ref:`float` **params_alpha_scissor_threshold** ++----------+------------------------------------+ +| *Setter* | set_alpha_scissor_threshold(value) | ++----------+------------------------------------+ +| *Getter* | get_alpha_scissor_threshold() | ++----------+------------------------------------+ + .. _class_SpatialMaterial_params_billboard_keep_scale: - :ref:`bool` **params_billboard_keep_scale** ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ + .. _class_SpatialMaterial_params_billboard_mode: - :ref:`BillboardMode` **params_billboard_mode** ++----------+---------------------------+ +| *Setter* | set_billboard_mode(value) | ++----------+---------------------------+ +| *Getter* | get_billboard_mode() | ++----------+---------------------------+ + .. _class_SpatialMaterial_params_blend_mode: - :ref:`BlendMode` **params_blend_mode** ++----------+-----------------------+ +| *Setter* | set_blend_mode(value) | ++----------+-----------------------+ +| *Getter* | get_blend_mode() | ++----------+-----------------------+ + .. _class_SpatialMaterial_params_cull_mode: - :ref:`CullMode` **params_cull_mode** ++----------+----------------------+ +| *Setter* | set_cull_mode(value) | ++----------+----------------------+ +| *Getter* | get_cull_mode() | ++----------+----------------------+ + .. _class_SpatialMaterial_params_depth_draw_mode: - :ref:`DepthDrawMode` **params_depth_draw_mode** ++----------+----------------------------+ +| *Setter* | set_depth_draw_mode(value) | ++----------+----------------------------+ +| *Getter* | get_depth_draw_mode() | ++----------+----------------------------+ + .. _class_SpatialMaterial_params_diffuse_mode: - :ref:`DiffuseMode` **params_diffuse_mode** ++----------+-------------------------+ +| *Setter* | set_diffuse_mode(value) | ++----------+-------------------------+ +| *Getter* | get_diffuse_mode() | ++----------+-------------------------+ + .. _class_SpatialMaterial_params_grow: - :ref:`bool` **params_grow** ++----------+-------------------------+ +| *Setter* | set_grow_enabled(value) | ++----------+-------------------------+ +| *Getter* | is_grow_enabled() | ++----------+-------------------------+ + .. _class_SpatialMaterial_params_grow_amount: - :ref:`float` **params_grow_amount** ++----------+-----------------+ +| *Setter* | set_grow(value) | ++----------+-----------------+ +| *Getter* | get_grow() | ++----------+-----------------+ + .. _class_SpatialMaterial_params_line_width: - :ref:`float` **params_line_width** ++----------+-----------------------+ +| *Setter* | set_line_width(value) | ++----------+-----------------------+ +| *Getter* | get_line_width() | ++----------+-----------------------+ + .. _class_SpatialMaterial_params_point_size: - :ref:`float` **params_point_size** ++----------+-----------------------+ +| *Setter* | set_point_size(value) | ++----------+-----------------------+ +| *Getter* | get_point_size() | ++----------+-----------------------+ + .. _class_SpatialMaterial_params_specular_mode: - :ref:`SpecularMode` **params_specular_mode** ++----------+--------------------------+ +| *Setter* | set_specular_mode(value) | ++----------+--------------------------+ +| *Getter* | get_specular_mode() | ++----------+--------------------------+ + .. _class_SpatialMaterial_params_use_alpha_scissor: - :ref:`bool` **params_use_alpha_scissor** ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ + .. _class_SpatialMaterial_particles_anim_h_frames: - :ref:`int` **particles_anim_h_frames** ++----------+------------------------------------+ +| *Setter* | set_particles_anim_h_frames(value) | ++----------+------------------------------------+ +| *Getter* | get_particles_anim_h_frames() | ++----------+------------------------------------+ + .. _class_SpatialMaterial_particles_anim_loop: - :ref:`int` **particles_anim_loop** ++----------+--------------------------------+ +| *Setter* | set_particles_anim_loop(value) | ++----------+--------------------------------+ +| *Getter* | get_particles_anim_loop() | ++----------+--------------------------------+ + .. _class_SpatialMaterial_particles_anim_v_frames: - :ref:`int` **particles_anim_v_frames** ++----------+------------------------------------+ +| *Setter* | set_particles_anim_v_frames(value) | ++----------+------------------------------------+ +| *Getter* | get_particles_anim_v_frames() | ++----------+------------------------------------+ + .. _class_SpatialMaterial_proximity_fade_distance: - :ref:`float` **proximity_fade_distance** ++----------+------------------------------------+ +| *Setter* | set_proximity_fade_distance(value) | ++----------+------------------------------------+ +| *Getter* | get_proximity_fade_distance() | ++----------+------------------------------------+ + .. _class_SpatialMaterial_proximity_fade_enable: - :ref:`bool` **proximity_fade_enable** ++----------+-----------------------------+ +| *Setter* | set_proximity_fade(value) | ++----------+-----------------------------+ +| *Getter* | is_proximity_fade_enabled() | ++----------+-----------------------------+ + .. _class_SpatialMaterial_refraction_enabled: - :ref:`bool` **refraction_enabled** ++----------+--------------------+ +| *Setter* | set_feature(value) | ++----------+--------------------+ +| *Getter* | get_feature() | ++----------+--------------------+ + .. _class_SpatialMaterial_refraction_scale: - :ref:`float` **refraction_scale** ++----------+-----------------------+ +| *Setter* | set_refraction(value) | ++----------+-----------------------+ +| *Getter* | get_refraction() | ++----------+-----------------------+ + .. _class_SpatialMaterial_refraction_texture: - :ref:`Texture` **refraction_texture** ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + .. _class_SpatialMaterial_refraction_texture_channel: - :ref:`TextureChannel` **refraction_texture_channel** ++----------+---------------------------------------+ +| *Setter* | set_refraction_texture_channel(value) | ++----------+---------------------------------------+ +| *Getter* | get_refraction_texture_channel() | ++----------+---------------------------------------+ + .. _class_SpatialMaterial_rim: - :ref:`float` **rim** ++----------+----------------+ +| *Setter* | set_rim(value) | ++----------+----------------+ +| *Getter* | get_rim() | ++----------+----------------+ + .. _class_SpatialMaterial_rim_enabled: - :ref:`bool` **rim_enabled** ++----------+--------------------+ +| *Setter* | set_feature(value) | ++----------+--------------------+ +| *Getter* | get_feature() | ++----------+--------------------+ + .. _class_SpatialMaterial_rim_texture: - :ref:`Texture` **rim_texture** ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + .. _class_SpatialMaterial_rim_tint: - :ref:`float` **rim_tint** ++----------+---------------------+ +| *Setter* | set_rim_tint(value) | ++----------+---------------------+ +| *Getter* | get_rim_tint() | ++----------+---------------------+ + .. _class_SpatialMaterial_roughness: - :ref:`float` **roughness** ++----------+----------------------+ +| *Setter* | set_roughness(value) | ++----------+----------------------+ +| *Getter* | get_roughness() | ++----------+----------------------+ + .. _class_SpatialMaterial_roughness_texture: - :ref:`Texture` **roughness_texture** ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + .. _class_SpatialMaterial_roughness_texture_channel: - :ref:`TextureChannel` **roughness_texture_channel** ++----------+--------------------------------------+ +| *Setter* | set_roughness_texture_channel(value) | ++----------+--------------------------------------+ +| *Getter* | get_roughness_texture_channel() | ++----------+--------------------------------------+ + .. _class_SpatialMaterial_subsurf_scatter_enabled: - :ref:`bool` **subsurf_scatter_enabled** ++----------+--------------------+ +| *Setter* | set_feature(value) | ++----------+--------------------+ +| *Getter* | get_feature() | ++----------+--------------------+ + .. _class_SpatialMaterial_subsurf_scatter_strength: - :ref:`float` **subsurf_scatter_strength** ++----------+-------------------------------------------+ +| *Setter* | set_subsurface_scattering_strength(value) | ++----------+-------------------------------------------+ +| *Getter* | get_subsurface_scattering_strength() | ++----------+-------------------------------------------+ + .. _class_SpatialMaterial_subsurf_scatter_texture: - :ref:`Texture` **subsurf_scatter_texture** ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + .. _class_SpatialMaterial_transmission: - :ref:`Color` **transmission** ++----------+-------------------------+ +| *Setter* | set_transmission(value) | ++----------+-------------------------+ +| *Getter* | get_transmission() | ++----------+-------------------------+ + .. _class_SpatialMaterial_transmission_enabled: - :ref:`bool` **transmission_enabled** ++----------+--------------------+ +| *Setter* | set_feature(value) | ++----------+--------------------+ +| *Getter* | get_feature() | ++----------+--------------------+ + .. _class_SpatialMaterial_transmission_texture: - :ref:`Texture` **transmission_texture** ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + .. _class_SpatialMaterial_uv1_offset: - :ref:`Vector3` **uv1_offset** ++----------+-----------------------+ +| *Setter* | set_uv1_offset(value) | ++----------+-----------------------+ +| *Getter* | get_uv1_offset() | ++----------+-----------------------+ + .. _class_SpatialMaterial_uv1_scale: - :ref:`Vector3` **uv1_scale** ++----------+----------------------+ +| *Setter* | set_uv1_scale(value) | ++----------+----------------------+ +| *Getter* | get_uv1_scale() | ++----------+----------------------+ + .. _class_SpatialMaterial_uv1_triplanar: - :ref:`bool` **uv1_triplanar** ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ + .. _class_SpatialMaterial_uv1_triplanar_sharpness: - :ref:`float` **uv1_triplanar_sharpness** ++----------+------------------------------------------+ +| *Setter* | set_uv1_triplanar_blend_sharpness(value) | ++----------+------------------------------------------+ +| *Getter* | get_uv1_triplanar_blend_sharpness() | ++----------+------------------------------------------+ + .. _class_SpatialMaterial_uv2_offset: - :ref:`Vector3` **uv2_offset** ++----------+-----------------------+ +| *Setter* | set_uv2_offset(value) | ++----------+-----------------------+ +| *Getter* | get_uv2_offset() | ++----------+-----------------------+ + .. _class_SpatialMaterial_uv2_scale: - :ref:`Vector3` **uv2_scale** ++----------+----------------------+ +| *Setter* | set_uv2_scale(value) | ++----------+----------------------+ +| *Getter* | get_uv2_scale() | ++----------+----------------------+ + .. _class_SpatialMaterial_uv2_triplanar: - :ref:`bool` **uv2_triplanar** ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ + .. _class_SpatialMaterial_uv2_triplanar_sharpness: - :ref:`float` **uv2_triplanar_sharpness** ++----------+------------------------------------------+ +| *Setter* | set_uv2_triplanar_blend_sharpness(value) | ++----------+------------------------------------------+ +| *Getter* | get_uv2_triplanar_blend_sharpness() | ++----------+------------------------------------------+ + .. _class_SpatialMaterial_vertex_color_is_srgb: - :ref:`bool` **vertex_color_is_srgb** ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ + .. _class_SpatialMaterial_vertex_color_use_as_albedo: - :ref:`bool` **vertex_color_use_as_albedo** ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ diff --git a/classes/class_spatialvelocitytracker.rst b/classes/class_spatialvelocitytracker.rst index 863c6b314..a727ccae3 100644 --- a/classes/class_spatialvelocitytracker.rst +++ b/classes/class_spatialvelocitytracker.rst @@ -8,6 +8,7 @@ SpatialVelocityTracker ====================== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description +Properties +---------- + ++-------------------------+----------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`track_physics_step` | ++-------------------------+----------------------------------------------------------------------------+ + Methods ------- @@ -33,20 +41,24 @@ Property Descriptions - :ref:`bool` **track_physics_step** ++----------+-------------------------------+ +| *Setter* | set_track_physics_step(value) | ++----------+-------------------------------+ +| *Getter* | is_tracking_physics_step() | ++----------+-------------------------------+ Method Descriptions ------------------- -.. _class_SpatialVelocityTracker_get_tracked_linear_velocity: + .. _class_SpatialVelocityTracker_get_tracked_linear_velocity: - :ref:`Vector3` **get_tracked_linear_velocity** **(** **)** const -.. _class_SpatialVelocityTracker_reset: + .. _class_SpatialVelocityTracker_reset: - void **reset** **(** :ref:`Vector3` position **)** -.. _class_SpatialVelocityTracker_update_position: + .. _class_SpatialVelocityTracker_update_position: - void **update_position** **(** :ref:`Vector3` position **)** - diff --git a/classes/class_spheremesh.rst b/classes/class_spheremesh.rst index dda71b7c7..ac57616e2 100644 --- a/classes/class_spheremesh.rst +++ b/classes/class_spheremesh.rst @@ -8,6 +8,7 @@ SphereMesh ========== **Inherits:** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,21 @@ Brief Description 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` | ++---------------------------+----------------------------------------------------------+ + Description ----------- @@ -25,22 +41,61 @@ Property Descriptions .. _class_SphereMesh_height: -- :ref:`float` **height** - Full height of the sphere. Defaults to 2.0. +- :ref:`float` **height** + ++----------+-------------------+ +| *Setter* | set_height(value) | ++----------+-------------------+ +| *Getter* | get_height() | ++----------+-------------------+ + +Full height of the sphere. Defaults to 2.0. .. _class_SphereMesh_is_hemisphere: -- :ref:`bool` **is_hemisphere** - 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. +- :ref:`bool` **is_hemisphere** + ++----------+--------------------------+ +| *Setter* | set_is_hemisphere(value) | ++----------+--------------------------+ +| *Getter* | get_is_hemisphere() | ++----------+--------------------------+ + +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: -- :ref:`int` **radial_segments** - Number of radial segments on the sphere. Defaults to 64. +- :ref:`int` **radial_segments** + ++----------+----------------------------+ +| *Setter* | set_radial_segments(value) | ++----------+----------------------------+ +| *Getter* | get_radial_segments() | ++----------+----------------------------+ + +Number of radial segments on the sphere. Defaults to 64. .. _class_SphereMesh_radius: -- :ref:`float` **radius** - Radius of sphere. Defaults to 1.0. +- :ref:`float` **radius** + ++----------+-------------------+ +| *Setter* | set_radius(value) | ++----------+-------------------+ +| *Getter* | get_radius() | ++----------+-------------------+ + +Radius of sphere. Defaults to 1.0. .. _class_SphereMesh_rings: -- :ref:`int` **rings** - Number of segments along the height of the sphere. Defaults to 32. +- :ref:`int` **rings** ++----------+------------------+ +| *Setter* | set_rings(value) | ++----------+------------------+ +| *Getter* | get_rings() | ++----------+------------------+ + +Number of segments along the height of the sphere. Defaults to 32. diff --git a/classes/class_sphereshape.rst b/classes/class_sphereshape.rst index b2a54ed19..d77e8ed52 100644 --- a/classes/class_sphereshape.rst +++ b/classes/class_sphereshape.rst @@ -8,6 +8,7 @@ SphereShape =========== **Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Sphere shape for 3D collisions. +Properties +---------- + ++---------------------------+-----------------------------------------+ +| :ref:`float` | :ref:`radius` | ++---------------------------+-----------------------------------------+ + Description ----------- @@ -25,6 +33,13 @@ Property Descriptions .. _class_SphereShape_radius: -- :ref:`float` **radius** - The sphere's radius. The shape's diameter is double the radius. +- :ref:`float` **radius** ++----------+-------------------+ +| *Setter* | set_radius(value) | ++----------+-------------------+ +| *Getter* | get_radius() | ++----------+-------------------+ + +The sphere's radius. The shape's diameter is double the radius. diff --git a/classes/class_spinbox.rst b/classes/class_spinbox.rst index fc0a17f5b..b1438e975 100644 --- a/classes/class_spinbox.rst +++ b/classes/class_spinbox.rst @@ -8,6 +8,7 @@ SpinBox ======= **Inherits:** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,17 @@ Brief Description Numerical input text field. +Properties +---------- + ++-----------------------------+-----------------------------------------+ +| :ref:`bool` | :ref:`editable` | ++-----------------------------+-----------------------------------------+ +| :ref:`String` | :ref:`prefix` | ++-----------------------------+-----------------------------------------+ +| :ref:`String` | :ref:`suffix` | ++-----------------------------+-----------------------------------------+ + Methods ------- @@ -22,6 +34,13 @@ Methods | :ref:`LineEdit` | :ref:`get_line_edit` **(** **)** | +----------------------------------+---------------------------------------------------------------+ +Theme Properties +---------------- + ++-------------------------------+-------------------------------------+ +| :ref:`Texture` | :ref:`updown` | ++-------------------------------+-------------------------------------+ + Description ----------- @@ -34,20 +53,36 @@ Property Descriptions - :ref:`bool` **editable** ++----------+---------------------+ +| *Setter* | set_editable(value) | ++----------+---------------------+ +| *Getter* | is_editable() | ++----------+---------------------+ + .. _class_SpinBox_prefix: - :ref:`String` **prefix** ++----------+-------------------+ +| *Setter* | set_prefix(value) | ++----------+-------------------+ +| *Getter* | get_prefix() | ++----------+-------------------+ + .. _class_SpinBox_suffix: - :ref:`String` **suffix** ++----------+-------------------+ +| *Setter* | set_suffix(value) | ++----------+-------------------+ +| *Getter* | get_suffix() | ++----------+-------------------+ Method Descriptions ------------------- -.. _class_SpinBox_get_line_edit: + .. _class_SpinBox_get_line_edit: - :ref:`LineEdit` **get_line_edit** **(** **)** - diff --git a/classes/class_splitcontainer.rst b/classes/class_splitcontainer.rst index bcefb18d2..66c575e2c 100644 --- a/classes/class_splitcontainer.rst +++ b/classes/class_splitcontainer.rst @@ -8,7 +8,9 @@ SplitContainer ============== **Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`HSplitContainer`, :ref:`VSplitContainer` + **Category:** Core Brief Description @@ -16,28 +18,37 @@ Brief Description Container for splitting and adjusting. +Properties +---------- + ++-----------------------------------------------------------------+--------------------------------------------------------------------+ +| :ref:`bool` | :ref:`collapsed` | ++-----------------------------------------------------------------+--------------------------------------------------------------------+ +| :ref:`DraggerVisibility` | :ref:`dragger_visibility` | ++-----------------------------------------------------------------+--------------------------------------------------------------------+ +| :ref:`int` | :ref:`split_offset` | ++-----------------------------------------------------------------+--------------------------------------------------------------------+ + Signals ------- -.. _class_SplitContainer_dragged: + .. _class_SplitContainer_dragged: - **dragged** **(** :ref:`int` offset **)** Emitted when the dragger is dragged by user. - Enumerations ------------ .. _enum_SplitContainer_DraggerVisibility: -enum **DraggerVisibility** +enum **DraggerVisibility**: - **DRAGGER_VISIBLE** = **0** --- The split dragger is visible. - **DRAGGER_HIDDEN** = **1** --- The split dragger is invisible. - **DRAGGER_HIDDEN_COLLAPSED** = **2** --- The split dragger is invisible and collapsed. - Description ----------- @@ -50,12 +61,31 @@ Property Descriptions - :ref:`bool` **collapsed** ++----------+----------------------+ +| *Setter* | set_collapsed(value) | ++----------+----------------------+ +| *Getter* | is_collapsed() | ++----------+----------------------+ + .. _class_SplitContainer_dragger_visibility: -- :ref:`DraggerVisibility` **dragger_visibility** - Determines whether the dragger is visible. +- :ref:`DraggerVisibility` **dragger_visibility** + ++----------+-------------------------------+ +| *Setter* | set_dragger_visibility(value) | ++----------+-------------------------------+ +| *Getter* | get_dragger_visibility() | ++----------+-------------------------------+ + +Determines whether the dragger is visible. .. _class_SplitContainer_split_offset: - :ref:`int` **split_offset** ++----------+-------------------------+ +| *Setter* | set_split_offset(value) | ++----------+-------------------------+ +| *Getter* | get_split_offset() | ++----------+-------------------------+ diff --git a/classes/class_spotlight.rst b/classes/class_spotlight.rst index 748b3eae4..c46781a95 100644 --- a/classes/class_spotlight.rst +++ b/classes/class_spotlight.rst @@ -8,6 +8,7 @@ SpotLight ========= **Inherits:** :ref:`Light` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,19 @@ Brief Description 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` | ++---------------------------+-----------------------------------------------------------------------+ + Description ----------- @@ -24,7 +38,6 @@ Tutorials --------- - :doc:`../tutorials/3d/lights_and_shadows` - Property Descriptions --------------------- @@ -32,16 +45,39 @@ Property Descriptions - :ref:`float` **spot_angle** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + .. _class_SpotLight_spot_angle_attenuation: - :ref:`float` **spot_angle_attenuation** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + .. _class_SpotLight_spot_attenuation: - :ref:`float` **spot_attenuation** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + .. _class_SpotLight_spot_range: - :ref:`float` **spot_range** ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ diff --git a/classes/class_springarm.rst b/classes/class_springarm.rst index bba85d2a2..394957ece 100644 --- a/classes/class_springarm.rst +++ b/classes/class_springarm.rst @@ -8,6 +8,7 @@ SpringArm ========= **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,19 @@ Brief Description +Properties +---------- + ++---------------------------+-------------------------------------------------------+ +| :ref:`int` | :ref:`collision_mask` | ++---------------------------+-------------------------------------------------------+ +| :ref:`float` | :ref:`margin` | ++---------------------------+-------------------------------------------------------+ +| :ref:`Shape` | :ref:`shape` | ++---------------------------+-------------------------------------------------------+ +| :ref:`float` | :ref:`spring_length` | ++---------------------------+-------------------------------------------------------+ + Methods ------- @@ -35,36 +49,58 @@ Property Descriptions - :ref:`int` **collision_mask** ++----------+---------------------------+ +| *Setter* | set_collision_mask(value) | ++----------+---------------------------+ +| *Getter* | get_collision_mask() | ++----------+---------------------------+ + .. _class_SpringArm_margin: - :ref:`float` **margin** ++----------+-------------------+ +| *Setter* | set_margin(value) | ++----------+-------------------+ +| *Getter* | get_margin() | ++----------+-------------------+ + .. _class_SpringArm_shape: - :ref:`Shape` **shape** ++----------+------------------+ +| *Setter* | set_shape(value) | ++----------+------------------+ +| *Getter* | get_shape() | ++----------+------------------+ + .. _class_SpringArm_spring_length: - :ref:`float` **spring_length** ++----------+-------------------+ +| *Setter* | set_length(value) | ++----------+-------------------+ +| *Getter* | get_length() | ++----------+-------------------+ Method Descriptions ------------------- -.. _class_SpringArm_add_excluded_object: + .. _class_SpringArm_add_excluded_object: - void **add_excluded_object** **(** :ref:`RID` RID **)** -.. _class_SpringArm_clear_excluded_objects: + .. _class_SpringArm_clear_excluded_objects: - void **clear_excluded_objects** **(** **)** -.. _class_SpringArm_get_hit_length: + .. _class_SpringArm_get_hit_length: - :ref:`float` **get_hit_length** **(** **)** -.. _class_SpringArm_remove_excluded_object: + .. _class_SpringArm_remove_excluded_object: - :ref:`bool` **remove_excluded_object** **(** :ref:`RID` RID **)** - diff --git a/classes/class_sprite.rst b/classes/class_sprite.rst index 2fb2d3900..ad42425b6 100644 --- a/classes/class_sprite.rst +++ b/classes/class_sprite.rst @@ -8,6 +8,7 @@ Sprite ====== **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,35 @@ Brief Description 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` | ++-------------------------------+------------------------------------------------------------+ + Methods ------- @@ -27,19 +57,18 @@ Methods Signals ------- -.. _class_Sprite_frame_changed: + .. _class_Sprite_frame_changed: - **frame_changed** **(** **)** Emitted when the :ref:`frame` changes. -.. _class_Sprite_texture_changed: + .. _class_Sprite_texture_changed: - **texture_changed** **(** **)** Emitted when the :ref:`texture` changes. - Description ----------- @@ -50,64 +79,158 @@ Property Descriptions .. _class_Sprite_centered: -- :ref:`bool` **centered** - If ``true`` texture is centered. Default value: ``true``. +- :ref:`bool` **centered** + ++----------+---------------------+ +| *Setter* | set_centered(value) | ++----------+---------------------+ +| *Getter* | is_centered() | ++----------+---------------------+ + +If ``true`` texture is centered. Default value: ``true``. .. _class_Sprite_flip_h: -- :ref:`bool` **flip_h** - If ``true`` texture is flipped horizontally. Default value: ``false``. +- :ref:`bool` **flip_h** + ++----------+-------------------+ +| *Setter* | set_flip_h(value) | ++----------+-------------------+ +| *Getter* | is_flipped_h() | ++----------+-------------------+ + +If ``true`` texture is flipped horizontally. Default value: ``false``. .. _class_Sprite_flip_v: -- :ref:`bool` **flip_v** - If ``true`` texture is flipped vertically. Default value: ``false``. +- :ref:`bool` **flip_v** + ++----------+-------------------+ +| *Setter* | set_flip_v(value) | ++----------+-------------------+ +| *Getter* | is_flipped_v() | ++----------+-------------------+ + +If ``true`` texture is flipped vertically. Default value: ``false``. .. _class_Sprite_frame: -- :ref:`int` **frame** - Current frame to display from sprite sheet. :ref:`vframes` or :ref:`hframes` must be greater than 1. +- :ref:`int` **frame** + ++----------+------------------+ +| *Setter* | set_frame(value) | ++----------+------------------+ +| *Getter* | get_frame() | ++----------+------------------+ + +Current frame to display from sprite sheet. :ref:`vframes` or :ref:`hframes` must be greater than 1. .. _class_Sprite_hframes: -- :ref:`int` **hframes** - The number of columns in the sprite sheet. +- :ref:`int` **hframes** + ++----------+--------------------+ +| *Setter* | set_hframes(value) | ++----------+--------------------+ +| *Getter* | get_hframes() | ++----------+--------------------+ + +The number of columns in the sprite sheet. .. _class_Sprite_normal_map: -- :ref:`Texture` **normal_map** - The normal map gives depth to the Sprite. +- :ref:`Texture` **normal_map** + ++----------+-----------------------+ +| *Setter* | set_normal_map(value) | ++----------+-----------------------+ +| *Getter* | get_normal_map() | ++----------+-----------------------+ + +The normal map gives depth to the Sprite. .. _class_Sprite_offset: -- :ref:`Vector2` **offset** - The texture's drawing offset. +- :ref:`Vector2` **offset** + ++----------+-------------------+ +| *Setter* | set_offset(value) | ++----------+-------------------+ +| *Getter* | get_offset() | ++----------+-------------------+ + +The texture's drawing offset. .. _class_Sprite_region_enabled: -- :ref:`bool` **region_enabled** - If ``true`` texture is cut from a larger atlas texture. See ``region_rect``. Default value: ``false``. +- :ref:`bool` **region_enabled** + ++----------+-------------------+ +| *Setter* | set_region(value) | ++----------+-------------------+ +| *Getter* | is_region() | ++----------+-------------------+ + +If ``true`` texture is cut from a larger atlas texture. See ``region_rect``. Default value: ``false``. .. _class_Sprite_region_filter_clip: -- :ref:`bool` **region_filter_clip** - If ``true`` the outermost pixels get blurred out. +- :ref:`bool` **region_filter_clip** + ++----------+---------------------------------+ +| *Setter* | set_region_filter_clip(value) | ++----------+---------------------------------+ +| *Getter* | is_region_filter_clip_enabled() | ++----------+---------------------------------+ + +If ``true`` the outermost pixels get blurred out. .. _class_Sprite_region_rect: -- :ref:`Rect2` **region_rect** - The region of the atlas texture to display. :ref:`region_enabled` must be ``true``. +- :ref:`Rect2` **region_rect** + ++----------+------------------------+ +| *Setter* | set_region_rect(value) | ++----------+------------------------+ +| *Getter* | get_region_rect() | ++----------+------------------------+ + +The region of the atlas texture to display. :ref:`region_enabled` must be ``true``. .. _class_Sprite_texture: -- :ref:`Texture` **texture** - :ref:`Texture` object to draw. +- :ref:`Texture` **texture** + ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + +:ref:`Texture` object to draw. .. _class_Sprite_vframes: -- :ref:`int` **vframes** - The number of rows in the sprite sheet. +- :ref:`int` **vframes** ++----------+--------------------+ +| *Setter* | set_vframes(value) | ++----------+--------------------+ +| *Getter* | get_vframes() | ++----------+--------------------+ + +The number of rows in the sprite sheet. Method Descriptions ------------------- -.. _class_Sprite_get_rect: + .. _class_Sprite_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_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 71a77fec9..1b65adeef 100644 --- a/classes/class_sprite3d.rst +++ b/classes/class_sprite3d.rst @@ -8,6 +8,7 @@ Sprite3D ======== **Inherits:** :ref:`SpriteBase3D` **<** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,16 +16,32 @@ Brief Description 2D Sprite node in 3D world. +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` | ++-------------------------------+------------------------------------------------------+ + Signals ------- -.. _class_Sprite3D_frame_changed: + .. _class_Sprite3D_frame_changed: - **frame_changed** **(** **)** Emitted when the :ref:`frame` changes. - Description ----------- @@ -35,26 +52,73 @@ Property Descriptions .. _class_Sprite3D_frame: -- :ref:`int` **frame** - Current frame to display from sprite sheet. :ref:`vframes` or :ref:`hframes` must be greater than 1. +- :ref:`int` **frame** + ++----------+------------------+ +| *Setter* | set_frame(value) | ++----------+------------------+ +| *Getter* | get_frame() | ++----------+------------------+ + +Current frame to display from sprite sheet. :ref:`vframes` or :ref:`hframes` must be greater than 1. .. _class_Sprite3D_hframes: -- :ref:`int` **hframes** - The number of columns in the sprite sheet. +- :ref:`int` **hframes** + ++----------+--------------------+ +| *Setter* | set_hframes(value) | ++----------+--------------------+ +| *Getter* | get_hframes() | ++----------+--------------------+ + +The number of columns in the sprite sheet. .. _class_Sprite3D_region_enabled: -- :ref:`bool` **region_enabled** - If ``true`` texture will be cut from a larger atlas texture. See :ref:`region_rect`. Default value: ``false``. +- :ref:`bool` **region_enabled** + ++----------+-------------------+ +| *Setter* | set_region(value) | ++----------+-------------------+ +| *Getter* | is_region() | ++----------+-------------------+ + +If ``true`` texture will be cut from a larger atlas texture. See :ref:`region_rect`. Default value: ``false``. .. _class_Sprite3D_region_rect: -- :ref:`Rect2` **region_rect** - The region of the atlas texture to display. :ref:`region_enabled` must be ``true``. +- :ref:`Rect2` **region_rect** + ++----------+------------------------+ +| *Setter* | set_region_rect(value) | ++----------+------------------------+ +| *Getter* | get_region_rect() | ++----------+------------------------+ + +The region of the atlas texture to display. :ref:`region_enabled` must be ``true``. .. _class_Sprite3D_texture: -- :ref:`Texture` **texture** - :ref:`Texture` object to draw. +- :ref:`Texture` **texture** + ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + +:ref:`Texture` object to draw. .. _class_Sprite3D_vframes: -- :ref:`int` **vframes** - The number of rows in the sprite sheet. +- :ref:`int` **vframes** ++----------+--------------------+ +| *Setter* | set_vframes(value) | ++----------+--------------------+ +| *Getter* | get_vframes() | ++----------+--------------------+ + +The number of rows in the sprite sheet. diff --git a/classes/class_spritebase3d.rst b/classes/class_spritebase3d.rst index 99260741d..c38bb8f64 100644 --- a/classes/class_spritebase3d.rst +++ b/classes/class_spritebase3d.rst @@ -8,7 +8,9 @@ SpriteBase3D ============ **Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`AnimatedSprite3D`, :ref:`Sprite3D` + **Category:** Core Brief Description @@ -16,6 +18,35 @@ Brief Description 2D Sprite node in 3D environment. +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` | ++-----------------------------------------------------+------------------------------------------------------+ + Methods ------- @@ -30,7 +61,7 @@ Enumerations .. _enum_SpriteBase3D_AlphaCutMode: -enum **AlphaCutMode** +enum **AlphaCutMode**: - **ALPHA_CUT_DISABLED** = **0** - **ALPHA_CUT_DISCARD** = **1** @@ -38,14 +69,13 @@ enum **AlphaCutMode** .. _enum_SpriteBase3D_DrawFlags: -enum **DrawFlags** +enum **DrawFlags**: - **FLAG_TRANSPARENT** = **0** --- If set, the texture's transparency and the opacity are used to make those parts of the Sprite invisible. - **FLAG_SHADED** = **1** --- If set, the Light in the Environment has effects on the Sprite. - **FLAG_DOUBLE_SIDED** = **2** --- If set, texture can be seen from the back as well, if not, it is invisible when looking at it from behind. - **FLAG_MAX** = **3** --- Used internally to mark the end of the Flags section. - Description ----------- @@ -58,60 +88,152 @@ Property Descriptions - :ref:`AlphaCutMode` **alpha_cut** ++----------+---------------------------+ +| *Setter* | set_alpha_cut_mode(value) | ++----------+---------------------------+ +| *Getter* | get_alpha_cut_mode() | ++----------+---------------------------+ + .. _class_SpriteBase3D_axis: -- :ref:`Axis` **axis** - The direction in which the front of the texture faces. +- :ref:`Axis` **axis** + ++----------+-----------------+ +| *Setter* | set_axis(value) | ++----------+-----------------+ +| *Getter* | get_axis() | ++----------+-----------------+ + +The direction in which the front of the texture faces. .. _class_SpriteBase3D_centered: -- :ref:`bool` **centered** - If ``true`` texture will be centered. Default value: ``true``. +- :ref:`bool` **centered** + ++----------+---------------------+ +| *Setter* | set_centered(value) | ++----------+---------------------+ +| *Getter* | is_centered() | ++----------+---------------------+ + +If ``true`` texture will be centered. Default value: ``true``. .. _class_SpriteBase3D_double_sided: -- :ref:`bool` **double_sided** - 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``. +- :ref:`bool` **double_sided** + ++----------+----------------------+ +| *Setter* | set_draw_flag(value) | ++----------+----------------------+ +| *Getter* | get_draw_flag() | ++----------+----------------------+ + +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: -- :ref:`bool` **flip_h** - If ``true`` texture is flipped horizontally. Default value: ``false``. +- :ref:`bool` **flip_h** + ++----------+-------------------+ +| *Setter* | set_flip_h(value) | ++----------+-------------------+ +| *Getter* | is_flipped_h() | ++----------+-------------------+ + +If ``true`` texture is flipped horizontally. Default value: ``false``. .. _class_SpriteBase3D_flip_v: -- :ref:`bool` **flip_v** - If ``true`` texture is flipped vertically. Default value: ``false``. +- :ref:`bool` **flip_v** + ++----------+-------------------+ +| *Setter* | set_flip_v(value) | ++----------+-------------------+ +| *Getter* | is_flipped_v() | ++----------+-------------------+ + +If ``true`` texture is flipped vertically. Default value: ``false``. .. _class_SpriteBase3D_modulate: -- :ref:`Color` **modulate** - A color value that gets multiplied on, could be used for mood-coloring or to simulate the color of light. +- :ref:`Color` **modulate** + ++----------+---------------------+ +| *Setter* | set_modulate(value) | ++----------+---------------------+ +| *Getter* | get_modulate() | ++----------+---------------------+ + +A color value that gets multiplied on, could be used for mood-coloring or to simulate the color of light. .. _class_SpriteBase3D_offset: -- :ref:`Vector2` **offset** - The texture's drawing offset. +- :ref:`Vector2` **offset** + ++----------+-------------------+ +| *Setter* | set_offset(value) | ++----------+-------------------+ +| *Getter* | get_offset() | ++----------+-------------------+ + +The texture's drawing offset. .. _class_SpriteBase3D_opacity: -- :ref:`float` **opacity** - The objects visibility on a scale from ``0`` fully invisible to ``1`` fully visible. +- :ref:`float` **opacity** + ++----------+--------------------+ +| *Setter* | set_opacity(value) | ++----------+--------------------+ +| *Getter* | get_opacity() | ++----------+--------------------+ + +The objects visibility on a scale from ``0`` fully invisible to ``1`` fully visible. .. _class_SpriteBase3D_pixel_size: -- :ref:`float` **pixel_size** - The size of one pixel's width on the Sprite to scale it in 3D. +- :ref:`float` **pixel_size** + ++----------+-----------------------+ +| *Setter* | set_pixel_size(value) | ++----------+-----------------------+ +| *Getter* | get_pixel_size() | ++----------+-----------------------+ + +The size of one pixel's width on the Sprite to scale it in 3D. .. _class_SpriteBase3D_shaded: -- :ref:`bool` **shaded** - If ``true`` the :ref:`Light` in the :ref:`Environment` has effects on the Sprite. Default value: ``false``. +- :ref:`bool` **shaded** + ++----------+----------------------+ +| *Setter* | set_draw_flag(value) | ++----------+----------------------+ +| *Getter* | get_draw_flag() | ++----------+----------------------+ + +If ``true`` the :ref:`Light` in the :ref:`Environment` has effects on the Sprite. Default value: ``false``. .. _class_SpriteBase3D_transparent: -- :ref:`bool` **transparent** - If ``true`` the texture's transparency and the opacity are used to make those parts of the Sprite invisible. Default value: ``true``. +- :ref:`bool` **transparent** ++----------+----------------------+ +| *Setter* | set_draw_flag(value) | ++----------+----------------------+ +| *Getter* | get_draw_flag() | ++----------+----------------------+ + +If ``true`` the texture's transparency and the opacity are used to make those parts of the Sprite invisible. Default value: ``true``. Method Descriptions ------------------- -.. _class_SpriteBase3D_generate_triangle_mesh: + .. _class_SpriteBase3D_generate_triangle_mesh: - :ref:`TriangleMesh` **generate_triangle_mesh** **(** **)** const -.. _class_SpriteBase3D_get_item_rect: + .. _class_SpriteBase3D_get_item_rect: - :ref:`Rect2` **get_item_rect** **(** **)** const - diff --git a/classes/class_spriteframes.rst b/classes/class_spriteframes.rst index 380c5c48a..2606510ce 100644 --- a/classes/class_spriteframes.rst +++ b/classes/class_spriteframes.rst @@ -8,6 +8,7 @@ SpriteFrames ============ **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Sprite frame library for AnimatedSprite. +Properties +---------- + ++---------------------------+------------------------------------------+ +| :ref:`Array` | :ref:`frames` | ++---------------------------+------------------------------------------+ + Methods ------- @@ -57,103 +65,109 @@ Description Sprite frame library for :ref:`AnimatedSprite`. Contains frames and animation data for playback. +Property Descriptions +--------------------- + + .. _class_SpriteFrames_frames: + +- :ref:`Array` **frames** + Method Descriptions ------------------- -.. _class_SpriteFrames_add_animation: + .. _class_SpriteFrames_add_animation: - void **add_animation** **(** :ref:`String` anim **)** Adds a new animation to the library. -.. _class_SpriteFrames_add_frame: + .. _class_SpriteFrames_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_clear: - void **clear** **(** :ref:`String` anim **)** Removes all frames from the given animation. -.. _class_SpriteFrames_clear_all: + .. _class_SpriteFrames_clear_all: - void **clear_all** **(** **)** Removes all animations. A "default" animation will be created. -.. _class_SpriteFrames_get_animation_loop: + .. _class_SpriteFrames_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_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_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_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_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_has_animation: - :ref:`bool` **has_animation** **(** :ref:`String` anim **)** const If ``true`` the named animation exists. -.. _class_SpriteFrames_remove_animation: + .. _class_SpriteFrames_remove_animation: - void **remove_animation** **(** :ref:`String` anim **)** Removes the given animation. -.. _class_SpriteFrames_remove_frame: + .. _class_SpriteFrames_remove_frame: - void **remove_frame** **(** :ref:`String` anim, :ref:`int` idx **)** Removes the animation's selected frame. -.. _class_SpriteFrames_rename_animation: + .. _class_SpriteFrames_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_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_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_set_frame: - void **set_frame** **(** :ref:`String` anim, :ref:`int` idx, :ref:`Texture` txt **)** Sets the texture of the given frame. - diff --git a/classes/class_staticbody.rst b/classes/class_staticbody.rst index b994134f5..b69500bfd 100644 --- a/classes/class_staticbody.rst +++ b/classes/class_staticbody.rst @@ -8,6 +8,7 @@ StaticBody ========== **Inherits:** :ref:`PhysicsBody` **<** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,21 @@ Brief Description 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` | ++-----------------------------------------------+------------------------------------------------------------------------------+ + Description ----------- @@ -29,22 +45,59 @@ Property Descriptions .. _class_StaticBody_bounce: -- :ref:`float` **bounce** - The body bounciness. +- :ref:`float` **bounce** + ++----------+-------------------+ +| *Setter* | set_bounce(value) | ++----------+-------------------+ +| *Getter* | get_bounce() | ++----------+-------------------+ + +The body bounciness. .. _class_StaticBody_constant_angular_velocity: -- :ref:`Vector3` **constant_angular_velocity** - 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. +- :ref:`Vector3` **constant_angular_velocity** + ++----------+--------------------------------------+ +| *Setter* | set_constant_angular_velocity(value) | ++----------+--------------------------------------+ +| *Getter* | get_constant_angular_velocity() | ++----------+--------------------------------------+ + +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: -- :ref:`Vector3` **constant_linear_velocity** - 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. +- :ref:`Vector3` **constant_linear_velocity** + ++----------+-------------------------------------+ +| *Setter* | set_constant_linear_velocity(value) | ++----------+-------------------------------------+ +| *Getter* | get_constant_linear_velocity() | ++----------+-------------------------------------+ + +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: -- :ref:`float` **friction** - The body friction, from 0 (frictionless) to 1 (full friction). +- :ref:`float` **friction** + ++----------+---------------------+ +| *Setter* | set_friction(value) | ++----------+---------------------+ +| *Getter* | get_friction() | ++----------+---------------------+ + +The body friction, from 0 (frictionless) to 1 (full friction). .. _class_StaticBody_physics_material_override: - :ref:`PhysicsMaterial` **physics_material_override** ++----------+--------------------------------------+ +| *Setter* | set_physics_material_override(value) | ++----------+--------------------------------------+ +| *Getter* | get_physics_material_override() | ++----------+--------------------------------------+ diff --git a/classes/class_staticbody2d.rst b/classes/class_staticbody2d.rst index b30df0021..35518b21d 100644 --- a/classes/class_staticbody2d.rst +++ b/classes/class_staticbody2d.rst @@ -8,6 +8,7 @@ StaticBody2D ============ **Inherits:** :ref:`PhysicsBody2D` **<** :ref:`CollisionObject2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,21 @@ Brief Description 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` | ++-----------------------------------------------+--------------------------------------------------------------------------------+ + Description ----------- @@ -27,22 +43,59 @@ Property Descriptions .. _class_StaticBody2D_bounce: -- :ref:`float` **bounce** - The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounciness). +- :ref:`float` **bounce** + ++----------+-------------------+ +| *Setter* | set_bounce(value) | ++----------+-------------------+ +| *Getter* | get_bounce() | ++----------+-------------------+ + +The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounciness). .. _class_StaticBody2D_constant_angular_velocity: -- :ref:`float` **constant_angular_velocity** - Constant angular velocity for the body. This does not rotate the body, but affects colliding bodies, as if it were rotating. +- :ref:`float` **constant_angular_velocity** + ++----------+--------------------------------------+ +| *Setter* | set_constant_angular_velocity(value) | ++----------+--------------------------------------+ +| *Getter* | get_constant_angular_velocity() | ++----------+--------------------------------------+ + +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: -- :ref:`Vector2` **constant_linear_velocity** - Constant linear velocity for the body. This does not move the body, but affects colliding bodies, as if it were moving. +- :ref:`Vector2` **constant_linear_velocity** + ++----------+-------------------------------------+ +| *Setter* | set_constant_linear_velocity(value) | ++----------+-------------------------------------+ +| *Getter* | get_constant_linear_velocity() | ++----------+-------------------------------------+ + +Constant linear velocity for the body. This does not move the body, but affects colliding bodies, as if it were moving. .. _class_StaticBody2D_friction: -- :ref:`float` **friction** - The body's friction. Values range from ``0`` (no friction) to ``1`` (full friction). +- :ref:`float` **friction** + ++----------+---------------------+ +| *Setter* | set_friction(value) | ++----------+---------------------+ +| *Getter* | get_friction() | ++----------+---------------------+ + +The body's friction. Values range from ``0`` (no friction) to ``1`` (full friction). .. _class_StaticBody2D_physics_material_override: - :ref:`PhysicsMaterial` **physics_material_override** ++----------+--------------------------------------+ +| *Setter* | set_physics_material_override(value) | ++----------+--------------------------------------+ +| *Getter* | get_physics_material_override() | ++----------+--------------------------------------+ diff --git a/classes/class_streampeer.rst b/classes/class_streampeer.rst index b9283d314..260f232f2 100644 --- a/classes/class_streampeer.rst +++ b/classes/class_streampeer.rst @@ -8,7 +8,9 @@ StreamPeer ========== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`StreamPeerBuffer`, :ref:`StreamPeerSSL`, :ref:`StreamPeerTCP`, :ref:`StreamPeerGDNative` + **Category:** Core Brief Description @@ -16,6 +18,13 @@ Brief Description Abstraction and base class for stream-based protocols. +Properties +---------- + ++-------------------------+------------------------------------------------+ +| :ref:`bool` | :ref:`big_endian` | ++-------------------------+------------------------------------------------+ + Methods ------- @@ -91,190 +100,196 @@ Property Descriptions .. _class_StreamPeer_big_endian: -- :ref:`bool` **big_endian** - If ``true``, this ``StreamPeer`` will using big-endian format for encoding and decoding. +- :ref:`bool` **big_endian** ++----------+-------------------------+ +| *Setter* | set_big_endian(value) | ++----------+-------------------------+ +| *Getter* | is_big_endian_enabled() | ++----------+-------------------------+ + +If ``true``, this ``StreamPeer`` will using big-endian format for encoding and decoding. Method Descriptions ------------------- -.. _class_StreamPeer_get_16: + .. _class_StreamPeer_get_16: - :ref:`int` **get_16** **(** **)** Get a signed 16 bit value from the stream. -.. _class_StreamPeer_get_32: + .. _class_StreamPeer_get_32: - :ref:`int` **get_32** **(** **)** Get a signed 32 bit value from the stream. -.. _class_StreamPeer_get_64: + .. _class_StreamPeer_get_64: - :ref:`int` **get_64** **(** **)** Get a signed 64 bit value from the stream. -.. _class_StreamPeer_get_8: + .. _class_StreamPeer_get_8: - :ref:`int` **get_8** **(** **)** Get a signed byte from the stream. -.. _class_StreamPeer_get_available_bytes: + .. _class_StreamPeer_get_available_bytes: - :ref:`int` **get_available_bytes** **(** **)** const Return the amount of bytes this ``StreamPeer`` has available. -.. _class_StreamPeer_get_data: + .. _class_StreamPeer_get_data: - :ref:`Array` **get_data** **(** :ref:`int` bytes **)** Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an Error code and a data array. -.. _class_StreamPeer_get_double: + .. _class_StreamPeer_get_double: - :ref:`float` **get_double** **(** **)** Get a double-precision float from the stream. -.. _class_StreamPeer_get_float: + .. _class_StreamPeer_get_float: - :ref:`float` **get_float** **(** **)** Get a single-precision float from the stream. -.. _class_StreamPeer_get_partial_data: + .. _class_StreamPeer_get_partial_data: - :ref:`Array` **get_partial_data** **(** :ref:`int` bytes **)** Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an Error code, and a data array. -.. _class_StreamPeer_get_string: + .. _class_StreamPeer_get_string: - :ref:`String` **get_string** **(** :ref:`int` bytes **)** Get a string with byte-length "bytes" from the stream. -.. _class_StreamPeer_get_u16: + .. _class_StreamPeer_get_u16: - :ref:`int` **get_u16** **(** **)** Get an unsigned 16 bit value from the stream. -.. _class_StreamPeer_get_u32: + .. _class_StreamPeer_get_u32: - :ref:`int` **get_u32** **(** **)** Get an unsigned 32 bit value from the stream. -.. _class_StreamPeer_get_u64: + .. _class_StreamPeer_get_u64: - :ref:`int` **get_u64** **(** **)** Get an unsigned 64 bit value from the stream. -.. _class_StreamPeer_get_u8: + .. _class_StreamPeer_get_u8: - :ref:`int` **get_u8** **(** **)** Get an unsigned byte from the stream. -.. _class_StreamPeer_get_utf8_string: + .. _class_StreamPeer_get_utf8_string: - :ref:`String` **get_utf8_string** **(** :ref:`int` bytes **)** Get a utf8 string with byte-length "bytes" from the stream (this decodes the string sent as utf8). -.. _class_StreamPeer_get_var: + .. _class_StreamPeer_get_var: - :ref:`Variant` **get_var** **(** **)** Get a Variant from the stream. -.. _class_StreamPeer_put_16: + .. _class_StreamPeer_put_16: - void **put_16** **(** :ref:`int` value **)** Put a signed 16 bit value into the stream. -.. _class_StreamPeer_put_32: + .. _class_StreamPeer_put_32: - void **put_32** **(** :ref:`int` value **)** Put a signed 32 bit value into the stream. -.. _class_StreamPeer_put_64: + .. _class_StreamPeer_put_64: - void **put_64** **(** :ref:`int` value **)** Put a signed 64 bit value into the stream. -.. _class_StreamPeer_put_8: + .. _class_StreamPeer_put_8: - void **put_8** **(** :ref:`int` value **)** Put a signed byte into the stream. -.. _class_StreamPeer_put_data: + .. _class_StreamPeer_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_put_double: - void **put_double** **(** :ref:`float` value **)** Put a double-precision float into the stream. -.. _class_StreamPeer_put_float: + .. _class_StreamPeer_put_float: - void **put_float** **(** :ref:`float` value **)** Put a single-precision float into the stream. -.. _class_StreamPeer_put_partial_data: + .. _class_StreamPeer_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_u16: + .. _class_StreamPeer_put_u16: - void **put_u16** **(** :ref:`int` value **)** Put an unsigned 16 bit value into the stream. -.. _class_StreamPeer_put_u32: + .. _class_StreamPeer_put_u32: - void **put_u32** **(** :ref:`int` value **)** Put an unsigned 32 bit value into the stream. -.. _class_StreamPeer_put_u64: + .. _class_StreamPeer_put_u64: - void **put_u64** **(** :ref:`int` value **)** Put an unsigned 64 bit value into the stream. -.. _class_StreamPeer_put_u8: + .. _class_StreamPeer_put_u8: - void **put_u8** **(** :ref:`int` value **)** Put an unsigned byte into the stream. -.. _class_StreamPeer_put_utf8_string: + .. _class_StreamPeer_put_utf8_string: - void **put_utf8_string** **(** :ref:`String` value **)** Put a zero-terminated utf8 string into the stream. -.. _class_StreamPeer_put_var: + .. _class_StreamPeer_put_var: - void **put_var** **(** :ref:`Variant` value **)** Put a Variant into the stream. - diff --git a/classes/class_streampeerbuffer.rst b/classes/class_streampeerbuffer.rst index 7fc8d409a..975bd5e0c 100644 --- a/classes/class_streampeerbuffer.rst +++ b/classes/class_streampeerbuffer.rst @@ -8,6 +8,7 @@ StreamPeerBuffer ================ **Inherits:** :ref:`StreamPeer` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description +Properties +---------- + ++-------------------------------------------+------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`data_array` | ++-------------------------------------------+------------------------------------------------------+ + Methods ------- @@ -39,32 +47,36 @@ Property Descriptions - :ref:`PoolByteArray` **data_array** ++----------+-----------------------+ +| *Setter* | set_data_array(value) | ++----------+-----------------------+ +| *Getter* | get_data_array() | ++----------+-----------------------+ Method Descriptions ------------------- -.. _class_StreamPeerBuffer_clear: + .. _class_StreamPeerBuffer_clear: - void **clear** **(** **)** -.. _class_StreamPeerBuffer_duplicate: + .. _class_StreamPeerBuffer_duplicate: - :ref:`StreamPeerBuffer` **duplicate** **(** **)** const -.. _class_StreamPeerBuffer_get_position: + .. _class_StreamPeerBuffer_get_position: - :ref:`int` **get_position** **(** **)** const -.. _class_StreamPeerBuffer_get_size: + .. _class_StreamPeerBuffer_get_size: - :ref:`int` **get_size** **(** **)** const -.. _class_StreamPeerBuffer_resize: + .. _class_StreamPeerBuffer_resize: - void **resize** **(** :ref:`int` size **)** -.. _class_StreamPeerBuffer_seek: + .. _class_StreamPeerBuffer_seek: - void **seek** **(** :ref:`int` position **)** - diff --git a/classes/class_streampeergdnative.rst b/classes/class_streampeergdnative.rst index 8e1ae50e9..0974e906b 100644 --- a/classes/class_streampeergdnative.rst +++ b/classes/class_streampeergdnative.rst @@ -8,6 +8,7 @@ StreamPeerGDNative ================== **Inherits:** :ref:`StreamPeer` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_streampeerssl.rst b/classes/class_streampeerssl.rst index bd482074b..79a6f17b2 100644 --- a/classes/class_streampeerssl.rst +++ b/classes/class_streampeerssl.rst @@ -8,6 +8,7 @@ StreamPeerSSL ============= **Inherits:** :ref:`StreamPeer` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description SSL Stream peer. +Properties +---------- + ++-------------------------+-------------------------------------------------------------------+ +| :ref:`bool` | :ref:`blocking_handshake` | ++-------------------------+-------------------------------------------------------------------+ + Methods ------- @@ -35,14 +43,13 @@ Enumerations .. _enum_StreamPeerSSL_Status: -enum **Status** +enum **Status**: - **STATUS_DISCONNECTED** = **0** --- A status representing a ``StreamPeerSSL`` that is disconnected. - **STATUS_CONNECTED** = **2** --- A status representing a ``StreamPeerSSL`` that is connected to a host. - **STATUS_ERROR** = **3** - **STATUS_ERROR_HOSTNAME_MISMATCH** = **4** --- An error status that shows a mismatch in the SSL certificate domain presented by the host and the domain requested for validation. - Description ----------- @@ -52,7 +59,6 @@ Tutorials --------- - :doc:`../tutorials/networking/ssl_certificates` - Property Descriptions --------------------- @@ -60,36 +66,40 @@ Property Descriptions - :ref:`bool` **blocking_handshake** ++----------+---------------------------------------+ +| *Setter* | set_blocking_handshake_enabled(value) | ++----------+---------------------------------------+ +| *Getter* | is_blocking_handshake_enabled() | ++----------+---------------------------------------+ Method Descriptions ------------------- -.. _class_StreamPeerSSL_accept_stream: + .. _class_StreamPeerSSL_accept_stream: - :ref:`Error` **accept_stream** **(** :ref:`StreamPeer` base **)** -.. _class_StreamPeerSSL_connect_to_stream: + .. _class_StreamPeerSSL_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_disconnect_from_stream: - void **disconnect_from_stream** **(** **)** Disconnect from host. -.. _class_StreamPeerSSL_get_status: + .. _class_StreamPeerSSL_get_status: - :ref:`Status` **get_status** **(** **)** const Return the status of the connection, one of STATUS\_\* enum. -.. _class_StreamPeerSSL_poll: + .. _class_StreamPeerSSL_poll: - void **poll** **(** **)** Poll the connection to check for incoming bytes. Call this right before "get_available_bytes()" for it to work properly. - diff --git a/classes/class_streampeertcp.rst b/classes/class_streampeertcp.rst index 5db4c03a8..7d1bf4048 100644 --- a/classes/class_streampeertcp.rst +++ b/classes/class_streampeertcp.rst @@ -8,6 +8,7 @@ StreamPeerTCP ============= **Inherits:** :ref:`StreamPeer` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -39,13 +40,12 @@ Enumerations .. _enum_StreamPeerTCP_Status: -enum **Status** +enum **Status**: - **STATUS_NONE** = **0** --- The initial status of the ``StreamPeerTCP``, also the status after a disconnect. - **STATUS_CONNECTING** = **1** --- A status representing a ``StreamPeerTCP`` that is connecting to a host. - **STATUS_CONNECTED** = **2** --- A status representing a ``StreamPeerTCP`` that is connected to a host. -- **STATUS_ERROR** = **3** --- A staus representing a ``StreamPeerTCP`` in error state. - +- **STATUS_ERROR** = **3** --- A status representing a ``StreamPeerTCP`` in error state. Description ----------- @@ -55,41 +55,41 @@ 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_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_disconnect_from_host: - void **disconnect_from_host** **(** **)** Disconnect from host. -.. _class_StreamPeerTCP_get_connected_host: + .. _class_StreamPeerTCP_get_connected_host: - :ref:`String` **get_connected_host** **(** **)** const Return the IP of this peer. -.. _class_StreamPeerTCP_get_connected_port: + .. _class_StreamPeerTCP_get_connected_port: - :ref:`int` **get_connected_port** **(** **)** const Return the port of this peer. -.. _class_StreamPeerTCP_get_status: + .. _class_StreamPeerTCP_get_status: - :ref:`Status` **get_status** **(** **)** const Return the status of the connection, one of STATUS\_\* enum. -.. _class_StreamPeerTCP_is_connected_to_host: + .. _class_StreamPeerTCP_is_connected_to_host: - :ref:`bool` **is_connected_to_host** **(** **)** const -.. _class_StreamPeerTCP_set_no_delay: + .. _class_StreamPeerTCP_set_no_delay: - void **set_no_delay** **(** :ref:`bool` enabled **)** @@ -97,4 +97,3 @@ Disable Nagle algorithm to improve latency for small packets. Note that for applications that send large packets, or need to transfer a lot of data, this can reduce total bandwidth. - diff --git a/classes/class_streamtexture.rst b/classes/class_streamtexture.rst index f362c4a30..cd6529884 100644 --- a/classes/class_streamtexture.rst +++ b/classes/class_streamtexture.rst @@ -8,6 +8,7 @@ StreamTexture ============= **Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description A .stex texture. +Properties +---------- + ++-----------------------------+-------------------------------------------------+ +| :ref:`String` | :ref:`load_path` | ++-----------------------------+-------------------------------------------------+ + Description ----------- @@ -25,6 +33,13 @@ Property Descriptions .. _class_StreamTexture_load_path: -- :ref:`String` **load_path** - The StreamTexture's filepath to a .stex file. +- :ref:`String` **load_path** ++----------+-----------------+ +| *Setter* | load(value) | ++----------+-----------------+ +| *Getter* | get_load_path() | ++----------+-----------------+ + +The StreamTexture's filepath to a .stex file. diff --git a/classes/class_string.rst b/classes/class_string.rst index 1fdce9dfc..46e1b19f2 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -213,451 +213,451 @@ This is the built-in string class (and the one used by GDScript). It supports Un Method Descriptions ------------------- -.. _class_String_String: + .. _class_String_String: - :ref:`String` **String** **(** :ref:`bool` from **)** Constructs a new String from the given :ref:`bool`. -.. _class_String_String: + .. _class_String_String: - :ref:`String` **String** **(** :ref:`int` from **)** Constructs a new String from the given :ref:`int`. -.. _class_String_String: + .. _class_String_String: - :ref:`String` **String** **(** :ref:`float` from **)** Constructs a new String from the given :ref:`float`. -.. _class_String_String: + .. _class_String_String: - :ref:`String` **String** **(** :ref:`Vector2` from **)** Constructs a new String from the given :ref:`Vector2`. -.. _class_String_String: + .. _class_String_String: - :ref:`String` **String** **(** :ref:`Rect2` from **)** Constructs a new String from the given :ref:`Rect2`. -.. _class_String_String: + .. _class_String_String: - :ref:`String` **String** **(** :ref:`Vector3` from **)** Constructs a new String from the given :ref:`Vector3`. -.. _class_String_String: + .. _class_String_String: - :ref:`String` **String** **(** :ref:`Transform2D` from **)** Constructs a new String from the given :ref:`Transform2D`. -.. _class_String_String: + .. _class_String_String: - :ref:`String` **String** **(** :ref:`Plane` from **)** Constructs a new String from the given :ref:`Plane`. -.. _class_String_String: + .. _class_String_String: - :ref:`String` **String** **(** :ref:`Quat` from **)** Constructs a new String from the given :ref:`Quat`. -.. _class_String_String: + .. _class_String_String: - :ref:`String` **String** **(** :ref:`AABB` from **)** Constructs a new String from the given :ref:`AABB`. -.. _class_String_String: + .. _class_String_String: - :ref:`String` **String** **(** :ref:`Basis` from **)** Constructs a new String from the given :ref:`Basis`. -.. _class_String_String: + .. _class_String_String: - :ref:`String` **String** **(** :ref:`Transform` from **)** Constructs a new String from the given :ref:`Transform`. -.. _class_String_String: + .. _class_String_String: - :ref:`String` **String** **(** :ref:`Color` from **)** Constructs a new String from the given :ref:`Color`. -.. _class_String_String: + .. _class_String_String: - :ref:`String` **String** **(** :ref:`NodePath` from **)** Constructs a new String from the given :ref:`NodePath`. -.. _class_String_String: + .. _class_String_String: - :ref:`String` **String** **(** :ref:`RID` from **)** Constructs a new String from the given :ref:`RID`. -.. _class_String_String: + .. _class_String_String: - :ref:`String` **String** **(** :ref:`Dictionary` from **)** Constructs a new String from the given :ref:`Dictionary`. -.. _class_String_String: + .. _class_String_String: - :ref:`String` **String** **(** :ref:`Array` from **)** Constructs a new String from the given :ref:`Array`. -.. _class_String_String: + .. _class_String_String: - :ref:`String` **String** **(** :ref:`PoolByteArray` from **)** Constructs a new String from the given :ref:`PoolByteArray`. -.. _class_String_String: + .. _class_String_String: - :ref:`String` **String** **(** :ref:`PoolIntArray` from **)** Constructs a new String from the given :ref:`PoolIntArray`. -.. _class_String_String: + .. _class_String_String: - :ref:`String` **String** **(** :ref:`PoolRealArray` from **)** Constructs a new String from the given :ref:`PoolRealArray`. -.. _class_String_String: + .. _class_String_String: - :ref:`String` **String** **(** :ref:`PoolStringArray` from **)** Constructs a new String from the given :ref:`PoolStringArray`. -.. _class_String_String: + .. _class_String_String: - :ref:`String` **String** **(** :ref:`PoolVector2Array` from **)** Constructs a new String from the given :ref:`PoolVector2Array`. -.. _class_String_String: + .. _class_String_String: - :ref:`String` **String** **(** :ref:`PoolVector3Array` from **)** Constructs a new String from the given :ref:`PoolVector3Array`. -.. _class_String_String: + .. _class_String_String: - :ref:`String` **String** **(** :ref:`PoolColorArray` from **)** Constructs a new String from the given :ref:`PoolColorArray`. -.. _class_String_begins_with: + .. _class_String_begins_with: - :ref:`bool` **begins_with** **(** :ref:`String` text **)** Returns ``true`` if the string begins with the given string. -.. _class_String_bigrams: + .. _class_String_bigrams: - :ref:`PoolStringArray` **bigrams** **(** **)** Returns the bigrams (pairs of consecutive letters) of this string. -.. _class_String_c_escape: + .. _class_String_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_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_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_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_dedent: - :ref:`String` **dedent** **(** **)** Removes indentation from string. -.. _class_String_empty: + .. _class_String_empty: - :ref:`bool` **empty** **(** **)** Returns ``true`` if the string is empty. -.. _class_String_ends_with: + .. _class_String_ends_with: - :ref:`bool` **ends_with** **(** :ref:`String` text **)** Returns ``true`` if the string ends with the given string. -.. _class_String_erase: + .. _class_String_erase: - void **erase** **(** :ref:`int` position, :ref:`int` chars **)** Erases ``chars`` characters from the string starting from ``position``. -.. _class_String_find: + .. _class_String_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_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_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_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_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_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_get_extension: - :ref:`String` **get_extension** **(** **)** If the string is a valid file path, returns the extension. -.. _class_String_get_file: + .. _class_String_get_file: - :ref:`String` **get_file** **(** **)** If the string is a valid file path, returns the filename. -.. _class_String_hash: + .. _class_String_hash: - :ref:`int` **hash** **(** **)** Hashes the string and returns a 32-bit integer. -.. _class_String_hex_to_int: + .. _class_String_hex_to_int: - :ref:`int` **hex_to_int** **(** **)** Converts a string containing a hexadecimal number into an integer. -.. _class_String_insert: + .. _class_String_insert: - :ref:`String` **insert** **(** :ref:`int` position, :ref:`String` what **)** Inserts a substring at a given position. -.. _class_String_is_abs_path: + .. _class_String_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_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_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_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_is_valid_float: - :ref:`bool` **is_valid_float** **(** **)** Returns ``true`` if this string contains a valid float. -.. _class_String_is_valid_html_color: + .. _class_String_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_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_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_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_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_left: - :ref:`String` **left** **(** :ref:`int` position **)** Returns a number of characters from the left of the string. -.. _class_String_length: + .. _class_String_length: - :ref:`int` **length** **(** **)** Returns the string's amount of characters. -.. _class_String_lstrip: + .. _class_String_lstrip: - :ref:`String` **lstrip** **(** :ref:`String` chars **)** Returns a copy of the string with characters removed from the left. -.. _class_String_match: + .. _class_String_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_matchn: - :ref:`bool` **matchn** **(** :ref:`String` expr **)** Does a simple case insensitive expression match, using ? and \* wildcards (see :ref:`match`). -.. _class_String_md5_buffer: + .. _class_String_md5_buffer: - :ref:`PoolByteArray` **md5_buffer** **(** **)** Returns the MD5 hash of the string as an array of bytes. -.. _class_String_md5_text: + .. _class_String_md5_text: - :ref:`String` **md5_text** **(** **)** Returns the MD5 hash of the string as a string. -.. _class_String_nocasecmp_to: + .. _class_String_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_ord_at: - :ref:`int` **ord_at** **(** :ref:`int` at **)** Returns the character code at position ``at``. -.. _class_String_pad_decimals: + .. _class_String_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_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_percent_decode: - :ref:`String` **percent_decode** **(** **)** Decode a percent-encoded string. See :ref:`percent_encode`. -.. _class_String_percent_encode: + .. _class_String_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_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_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_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_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_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_right: - :ref:`String` **right** **(** :ref:`int` position **)** Returns the right side of the string from a given position. -.. _class_String_rsplit: + .. _class_String_rsplit: - :ref:`PoolStringArray` **rsplit** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True, :ref:`int` maxsplit=0 **)** @@ -667,29 +667,29 @@ 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_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_sha256_buffer: - :ref:`PoolByteArray` **sha256_buffer** **(** **)** -.. _class_String_sha256_text: + .. _class_String_sha256_text: - :ref:`String` **sha256_text** **(** **)** Returns the SHA-256 hash of the string as a string. -.. _class_String_similarity: + .. _class_String_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_split: - :ref:`PoolStringArray` **split** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True, :ref:`int` maxsplit=0 **)** @@ -699,7 +699,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_split_floats: - :ref:`PoolRealArray` **split_floats** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** @@ -707,76 +707,75 @@ 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_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_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_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 to_utf8() with the assumption that all the characters the String contains are only ASCII characters. -.. _class_String_to_float: + .. _class_String_to_float: - :ref:`float` **to_float** **(** **)** Converts a string containing a decimal number into a ``float``. -.. _class_String_to_int: + .. _class_String_to_int: - :ref:`int` **to_int** **(** **)** Converts a string containing an integer number into an ``int``. -.. _class_String_to_lower: + .. _class_String_to_lower: - :ref:`String` **to_lower** **(** **)** Returns the string converted to lowercase. -.. _class_String_to_upper: + .. _class_String_to_upper: - :ref:`String` **to_upper** **(** **)** Returns the string converted to uppercase. -.. _class_String_to_utf8: + .. _class_String_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 to_ascii(), but supports all UTF-8 characters. Therefore, you should prefer this function over to_ascii(). -.. _class_String_trim_prefix: + .. _class_String_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_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_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_xml_unescape: - :ref:`String` **xml_unescape** **(** **)** Returns a copy of the string with escaped characters replaced by their meanings according to the XML standard. - diff --git a/classes/class_stylebox.rst b/classes/class_stylebox.rst index 862a05ff7..32d1d1c0f 100644 --- a/classes/class_stylebox.rst +++ b/classes/class_stylebox.rst @@ -8,7 +8,9 @@ StyleBox ======== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`StyleBoxLine`, :ref:`StyleBoxFlat`, :ref:`StyleBoxTexture`, :ref:`StyleBoxEmpty` + **Category:** Core Brief Description @@ -16,6 +18,19 @@ Brief Description 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` | ++---------------------------+--------------------------------------------------------------------+ + Methods ------- @@ -45,52 +60,74 @@ Property Descriptions - :ref:`float` **content_margin_bottom** ++----------+---------------------------+ +| *Setter* | set_default_margin(value) | ++----------+---------------------------+ +| *Getter* | get_default_margin() | ++----------+---------------------------+ + .. _class_StyleBox_content_margin_left: - :ref:`float` **content_margin_left** ++----------+---------------------------+ +| *Setter* | set_default_margin(value) | ++----------+---------------------------+ +| *Getter* | get_default_margin() | ++----------+---------------------------+ + .. _class_StyleBox_content_margin_right: - :ref:`float` **content_margin_right** ++----------+---------------------------+ +| *Setter* | set_default_margin(value) | ++----------+---------------------------+ +| *Getter* | get_default_margin() | ++----------+---------------------------+ + .. _class_StyleBox_content_margin_top: - :ref:`float` **content_margin_top** ++----------+---------------------------+ +| *Setter* | set_default_margin(value) | ++----------+---------------------------+ +| *Getter* | get_default_margin() | ++----------+---------------------------+ Method Descriptions ------------------- -.. _class_StyleBox_draw: + .. _class_StyleBox_draw: - void **draw** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect **)** const -.. _class_StyleBox_get_center_size: + .. _class_StyleBox_get_center_size: - :ref:`Vector2` **get_center_size** **(** **)** const -.. _class_StyleBox_get_margin: + .. _class_StyleBox_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_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_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_test_mask: - :ref:`bool` **test_mask** **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** const Test a position in a rectangle, return whether it passes the mask test. - diff --git a/classes/class_styleboxempty.rst b/classes/class_styleboxempty.rst index 8389c0a4b..825268f74 100644 --- a/classes/class_styleboxempty.rst +++ b/classes/class_styleboxempty.rst @@ -8,6 +8,7 @@ StyleBoxEmpty ============= **Inherits:** :ref:`StyleBox` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_styleboxflat.rst b/classes/class_styleboxflat.rst index 3e73dc972..ac0f6d28b 100644 --- a/classes/class_styleboxflat.rst +++ b/classes/class_styleboxflat.rst @@ -8,6 +8,7 @@ StyleBoxFlat ============ **Inherits:** :ref:`StyleBox` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,53 @@ Brief Description 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` | ++---------------------------+----------------------------------------------------------------------------------+ + Methods ------- @@ -67,43 +115,123 @@ Property Descriptions .. _class_StyleBoxFlat_anti_aliasing: -- :ref:`bool` **anti_aliasing** - 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. +- :ref:`bool` **anti_aliasing** + ++----------+-------------------------+ +| *Setter* | set_anti_aliased(value) | ++----------+-------------------------+ +| *Getter* | is_anti_aliased() | ++----------+-------------------------+ + +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: -- :ref:`int` **anti_aliasing_size** - This changes the size of the faded ring. Higher values can be used to achieve a "blurry" effect. +- :ref:`int` **anti_aliasing_size** + ++----------+--------------------+ +| *Setter* | set_aa_size(value) | ++----------+--------------------+ +| *Getter* | get_aa_size() | ++----------+--------------------+ + +This changes the size of the faded ring. Higher values can be used to achieve a "blurry" effect. .. _class_StyleBoxFlat_bg_color: -- :ref:`Color` **bg_color** - The background color of the stylebox. +- :ref:`Color` **bg_color** + ++----------+---------------------+ +| *Setter* | set_bg_color(value) | ++----------+---------------------+ +| *Getter* | get_bg_color() | ++----------+---------------------+ + +The background color of the stylebox. .. _class_StyleBoxFlat_border_blend: -- :ref:`bool` **border_blend** - When set to true, the border will fade into the background color. +- :ref:`bool` **border_blend** + ++----------+-------------------------+ +| *Setter* | set_border_blend(value) | ++----------+-------------------------+ +| *Getter* | get_border_blend() | ++----------+-------------------------+ + +When set to true, the border will fade into the background color. .. _class_StyleBoxFlat_border_color: -- :ref:`Color` **border_color** - Sets the color of the border. +- :ref:`Color` **border_color** + ++----------+-------------------------+ +| *Setter* | set_border_color(value) | ++----------+-------------------------+ +| *Getter* | get_border_color() | ++----------+-------------------------+ + +Sets the color of the border. .. _class_StyleBoxFlat_border_width_bottom: -- :ref:`int` **border_width_bottom** - Border width for the bottom border. +- :ref:`int` **border_width_bottom** + ++----------+-------------------------+ +| *Setter* | set_border_width(value) | ++----------+-------------------------+ +| *Getter* | get_border_width() | ++----------+-------------------------+ + +Border width for the bottom border. .. _class_StyleBoxFlat_border_width_left: -- :ref:`int` **border_width_left** - Border width for the left border. +- :ref:`int` **border_width_left** + ++----------+-------------------------+ +| *Setter* | set_border_width(value) | ++----------+-------------------------+ +| *Getter* | get_border_width() | ++----------+-------------------------+ + +Border width for the left border. .. _class_StyleBoxFlat_border_width_right: -- :ref:`int` **border_width_right** - Border width for the right border. +- :ref:`int` **border_width_right** + ++----------+-------------------------+ +| *Setter* | set_border_width(value) | ++----------+-------------------------+ +| *Getter* | get_border_width() | ++----------+-------------------------+ + +Border width for the right border. .. _class_StyleBoxFlat_border_width_top: -- :ref:`int` **border_width_top** - Border width for the top border. +- :ref:`int` **border_width_top** + ++----------+-------------------------+ +| *Setter* | set_border_width(value) | ++----------+-------------------------+ +| *Getter* | get_border_width() | ++----------+-------------------------+ + +Border width for the top border. .. _class_StyleBoxFlat_corner_detail: -- :ref:`int` **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`) into account. +- :ref:`int` **corner_detail** + ++----------+--------------------------+ +| *Setter* | set_corner_detail(value) | ++----------+--------------------------+ +| *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`) into account. For corner radius smaller than 10: 4-5 should be enough @@ -111,74 +239,160 @@ For corner radius smaller than 30: 8-12 should be enough ... .. _class_StyleBoxFlat_corner_radius_bottom_left: -- :ref:`int` **corner_radius_bottom_left** - The corner radius of the bottom left corner. When set to 0 the corner is not rounded. +- :ref:`int` **corner_radius_bottom_left** + ++----------+--------------------------+ +| *Setter* | set_corner_radius(value) | ++----------+--------------------------+ +| *Getter* | get_corner_radius() | ++----------+--------------------------+ + +The corner radius of the bottom left corner. When set to 0 the corner is not rounded. .. _class_StyleBoxFlat_corner_radius_bottom_right: -- :ref:`int` **corner_radius_bottom_right** - The corner radius of the bottom right corner. When set to 0 the corner is not rounded. +- :ref:`int` **corner_radius_bottom_right** + ++----------+--------------------------+ +| *Setter* | set_corner_radius(value) | ++----------+--------------------------+ +| *Getter* | get_corner_radius() | ++----------+--------------------------+ + +The corner radius of the bottom right corner. When set to 0 the corner is not rounded. .. _class_StyleBoxFlat_corner_radius_top_left: -- :ref:`int` **corner_radius_top_left** - The corner radius of the top left corner. When set to 0 the corner is not rounded. +- :ref:`int` **corner_radius_top_left** + ++----------+--------------------------+ +| *Setter* | set_corner_radius(value) | ++----------+--------------------------+ +| *Getter* | get_corner_radius() | ++----------+--------------------------+ + +The corner radius of the top left corner. When set to 0 the corner is not rounded. .. _class_StyleBoxFlat_corner_radius_top_right: -- :ref:`int` **corner_radius_top_right** - The corner radius of the top right corner. When set to 0 the corner is not rounded. +- :ref:`int` **corner_radius_top_right** + ++----------+--------------------------+ +| *Setter* | set_corner_radius(value) | ++----------+--------------------------+ +| *Getter* | get_corner_radius() | ++----------+--------------------------+ + +The corner radius of the top right corner. When set to 0 the corner is not rounded. .. _class_StyleBoxFlat_draw_center: -- :ref:`bool` **draw_center** - Toggels drawing of the inner part of the stylebox. +- :ref:`bool` **draw_center** + ++----------+--------------------------+ +| *Setter* | set_draw_center(value) | ++----------+--------------------------+ +| *Getter* | is_draw_center_enabled() | ++----------+--------------------------+ + +Toggels drawing of the inner part of the stylebox. .. _class_StyleBoxFlat_expand_margin_bottom: -- :ref:`float` **expand_margin_bottom** - 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. +- :ref:`float` **expand_margin_bottom** + ++----------+--------------------------+ +| *Setter* | set_expand_margin(value) | ++----------+--------------------------+ +| *Getter* | get_expand_margin() | ++----------+--------------------------+ + +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: -- :ref:`float` **expand_margin_left** - 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. +- :ref:`float` **expand_margin_left** + ++----------+--------------------------+ +| *Setter* | set_expand_margin(value) | ++----------+--------------------------+ +| *Getter* | get_expand_margin() | ++----------+--------------------------+ + +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: -- :ref:`float` **expand_margin_right** - 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. +- :ref:`float` **expand_margin_right** + ++----------+--------------------------+ +| *Setter* | set_expand_margin(value) | ++----------+--------------------------+ +| *Getter* | get_expand_margin() | ++----------+--------------------------+ + +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: -- :ref:`float` **expand_margin_top** - 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. +- :ref:`float` **expand_margin_top** + ++----------+--------------------------+ +| *Setter* | set_expand_margin(value) | ++----------+--------------------------+ +| *Getter* | get_expand_margin() | ++----------+--------------------------+ + +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: -- :ref:`Color` **shadow_color** - The color of the shadow. (This has no effect when shadow_size < 1) +- :ref:`Color` **shadow_color** + ++----------+-------------------------+ +| *Setter* | set_shadow_color(value) | ++----------+-------------------------+ +| *Getter* | get_shadow_color() | ++----------+-------------------------+ + +The color of the shadow. (This has no effect when shadow_size < 1) .. _class_StyleBoxFlat_shadow_size: -- :ref:`int` **shadow_size** - The shadow size in pixels. +- :ref:`int` **shadow_size** ++----------+------------------------+ +| *Setter* | set_shadow_size(value) | ++----------+------------------------+ +| *Getter* | get_shadow_size() | ++----------+------------------------+ + +The shadow size in pixels. Method Descriptions ------------------- -.. _class_StyleBoxFlat_get_border_width_min: + .. _class_StyleBoxFlat_get_border_width_min: - :ref:`int` **get_border_width_min** **(** **)** const -.. _class_StyleBoxFlat_set_border_width_all: + .. _class_StyleBoxFlat_set_border_width_all: - void **set_border_width_all** **(** :ref:`int` width **)** -.. _class_StyleBoxFlat_set_corner_radius_all: + .. _class_StyleBoxFlat_set_corner_radius_all: - void **set_corner_radius_all** **(** :ref:`int` radius **)** -.. _class_StyleBoxFlat_set_corner_radius_individual: + .. _class_StyleBoxFlat_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_set_expand_margin_all: - void **set_expand_margin_all** **(** :ref:`float` size **)** -.. _class_StyleBoxFlat_set_expand_margin_individual: + .. _class_StyleBoxFlat_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 3d210a0df..19fb3800b 100644 --- a/classes/class_styleboxline.rst +++ b/classes/class_styleboxline.rst @@ -8,6 +8,7 @@ StyleBoxLine ============ **Inherits:** :ref:`StyleBox` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,21 @@ 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` | ++---------------------------+--------------------------------------------------+ + Property Descriptions --------------------- @@ -22,20 +38,49 @@ Property Descriptions - :ref:`Color` **color** ++----------+------------------+ +| *Setter* | set_color(value) | ++----------+------------------+ +| *Getter* | get_color() | ++----------+------------------+ + .. _class_StyleBoxLine_grow_begin: - :ref:`float` **grow_begin** ++----------+-----------------------+ +| *Setter* | set_grow_begin(value) | ++----------+-----------------------+ +| *Getter* | get_grow_begin() | ++----------+-----------------------+ + .. _class_StyleBoxLine_grow_end: - :ref:`float` **grow_end** ++----------+---------------------+ +| *Setter* | set_grow_end(value) | ++----------+---------------------+ +| *Getter* | get_grow_end() | ++----------+---------------------+ + .. _class_StyleBoxLine_thickness: - :ref:`int` **thickness** ++----------+----------------------+ +| *Setter* | set_thickness(value) | ++----------+----------------------+ +| *Getter* | get_thickness() | ++----------+----------------------+ + .. _class_StyleBoxLine_vertical: - :ref:`bool` **vertical** ++----------+---------------------+ +| *Setter* | set_vertical(value) | ++----------+---------------------+ +| *Getter* | is_vertical() | ++----------+---------------------+ diff --git a/classes/class_styleboxtexture.rst b/classes/class_styleboxtexture.rst index aab34241d..8726cfb5b 100644 --- a/classes/class_styleboxtexture.rst +++ b/classes/class_styleboxtexture.rst @@ -8,6 +8,7 @@ StyleBoxTexture =============== **Inherits:** :ref:`StyleBox` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,41 @@ Brief Description 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` | ++--------------------------------------------------------------+-------------------------------------------------------------------------------+ + Methods ------- @@ -27,23 +63,21 @@ Methods Signals ------- -.. _class_StyleBoxTexture_texture_changed: + .. _class_StyleBoxTexture_texture_changed: - **texture_changed** **(** **)** - Enumerations ------------ .. _enum_StyleBoxTexture_AxisStretchMode: -enum **AxisStretchMode** +enum **AxisStretchMode**: - **AXIS_STRETCH_MODE_STRETCH** = **0** - **AXIS_STRETCH_MODE_TILE** = **1** - **AXIS_STRETCH_MODE_TILE_FIT** = **2** - Description ----------- @@ -56,72 +90,160 @@ Property Descriptions - :ref:`AxisStretchMode` **axis_stretch_horizontal** ++----------+--------------------------------+ +| *Setter* | set_h_axis_stretch_mode(value) | ++----------+--------------------------------+ +| *Getter* | get_h_axis_stretch_mode() | ++----------+--------------------------------+ + .. _class_StyleBoxTexture_axis_stretch_vertical: - :ref:`AxisStretchMode` **axis_stretch_vertical** ++----------+--------------------------------+ +| *Setter* | set_v_axis_stretch_mode(value) | ++----------+--------------------------------+ +| *Getter* | get_v_axis_stretch_mode() | ++----------+--------------------------------+ + .. _class_StyleBoxTexture_draw_center: - :ref:`bool` **draw_center** ++----------+--------------------------+ +| *Setter* | set_draw_center(value) | ++----------+--------------------------+ +| *Getter* | is_draw_center_enabled() | ++----------+--------------------------+ + .. _class_StyleBoxTexture_expand_margin_bottom: - :ref:`float` **expand_margin_bottom** ++----------+-------------------------------+ +| *Setter* | set_expand_margin_size(value) | ++----------+-------------------------------+ +| *Getter* | get_expand_margin_size() | ++----------+-------------------------------+ + .. _class_StyleBoxTexture_expand_margin_left: - :ref:`float` **expand_margin_left** ++----------+-------------------------------+ +| *Setter* | set_expand_margin_size(value) | ++----------+-------------------------------+ +| *Getter* | get_expand_margin_size() | ++----------+-------------------------------+ + .. _class_StyleBoxTexture_expand_margin_right: - :ref:`float` **expand_margin_right** ++----------+-------------------------------+ +| *Setter* | set_expand_margin_size(value) | ++----------+-------------------------------+ +| *Getter* | get_expand_margin_size() | ++----------+-------------------------------+ + .. _class_StyleBoxTexture_expand_margin_top: - :ref:`float` **expand_margin_top** ++----------+-------------------------------+ +| *Setter* | set_expand_margin_size(value) | ++----------+-------------------------------+ +| *Getter* | get_expand_margin_size() | ++----------+-------------------------------+ + .. _class_StyleBoxTexture_margin_bottom: - :ref:`float` **margin_bottom** ++----------+------------------------+ +| *Setter* | set_margin_size(value) | ++----------+------------------------+ +| *Getter* | get_margin_size() | ++----------+------------------------+ + .. _class_StyleBoxTexture_margin_left: - :ref:`float` **margin_left** ++----------+------------------------+ +| *Setter* | set_margin_size(value) | ++----------+------------------------+ +| *Getter* | get_margin_size() | ++----------+------------------------+ + .. _class_StyleBoxTexture_margin_right: - :ref:`float` **margin_right** ++----------+------------------------+ +| *Setter* | set_margin_size(value) | ++----------+------------------------+ +| *Getter* | get_margin_size() | ++----------+------------------------+ + .. _class_StyleBoxTexture_margin_top: - :ref:`float` **margin_top** ++----------+------------------------+ +| *Setter* | set_margin_size(value) | ++----------+------------------------+ +| *Getter* | get_margin_size() | ++----------+------------------------+ + .. _class_StyleBoxTexture_modulate_color: - :ref:`Color` **modulate_color** ++----------+---------------------+ +| *Setter* | set_modulate(value) | ++----------+---------------------+ +| *Getter* | get_modulate() | ++----------+---------------------+ + .. _class_StyleBoxTexture_normal_map: - :ref:`Texture` **normal_map** ++----------+-----------------------+ +| *Setter* | set_normal_map(value) | ++----------+-----------------------+ +| *Getter* | get_normal_map() | ++----------+-----------------------+ + .. _class_StyleBoxTexture_region_rect: - :ref:`Rect2` **region_rect** ++----------+------------------------+ +| *Setter* | set_region_rect(value) | ++----------+------------------------+ +| *Getter* | get_region_rect() | ++----------+------------------------+ + .. _class_StyleBoxTexture_texture: - :ref:`Texture` **texture** ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ Method Descriptions ------------------- -.. _class_StyleBoxTexture_set_expand_margin_all: + .. _class_StyleBoxTexture_set_expand_margin_all: - void **set_expand_margin_all** **(** :ref:`float` size **)** -.. _class_StyleBoxTexture_set_expand_margin_individual: + .. _class_StyleBoxTexture_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 5a479430e..336017cee 100644 --- a/classes/class_surfacetool.rst +++ b/classes/class_surfacetool.rst @@ -8,6 +8,7 @@ SurfaceTool =========== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -84,109 +85,109 @@ It is very important that vertex attributes are passed **before** the call to :r Method Descriptions ------------------- -.. _class_SurfaceTool_add_bones: + .. _class_SurfaceTool_add_bones: - void **add_bones** **(** :ref:`PoolIntArray` bones **)** Add an array of bones for the next Vertex to use. -.. _class_SurfaceTool_add_color: + .. _class_SurfaceTool_add_color: - void **add_color** **(** :ref:`Color` color **)** Specify a :ref:`Color` for the next Vertex to use. -.. _class_SurfaceTool_add_index: + .. _class_SurfaceTool_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_add_normal: - void **add_normal** **(** :ref:`Vector3` normal **)** Specify a normal for the next Vertex to use. -.. _class_SurfaceTool_add_smooth_group: + .. _class_SurfaceTool_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_add_tangent: - void **add_tangent** **(** :ref:`Plane` tangent **)** Specify a Tangent for the next Vertex to use. -.. _class_SurfaceTool_add_to_format: + .. _class_SurfaceTool_add_to_format: - void **add_to_format** **(** :ref:`int` flags **)** -.. _class_SurfaceTool_add_triangle_fan: + .. _class_SurfaceTool_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=[ ] **)** Insert a triangle fan made of array data into :ref:`Mesh` being constructed. -.. _class_SurfaceTool_add_uv: + .. _class_SurfaceTool_add_uv: - void **add_uv** **(** :ref:`Vector2` uv **)** Specify UV Coordinate for next Vertex to use. -.. _class_SurfaceTool_add_uv2: + .. _class_SurfaceTool_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_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_add_weights: - void **add_weights** **(** :ref:`PoolRealArray` weights **)** Specify weight value for next Vertex to use. -.. _class_SurfaceTool_append_from: + .. _class_SurfaceTool_append_from: - void **append_from** **(** :ref:`Mesh` existing, :ref:`int` surface, :ref:`Transform` transform **)** -.. _class_SurfaceTool_begin: + .. _class_SurfaceTool_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_clear: - void **clear** **(** **)** Clear all information passed into the surface tool so far. -.. _class_SurfaceTool_commit: + .. _class_SurfaceTool_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_create_from: - void **create_from** **(** :ref:`Mesh` existing, :ref:`int` surface **)** -.. _class_SurfaceTool_deindex: + .. _class_SurfaceTool_deindex: - void **deindex** **(** **)** Removes index array by expanding Vertex array. -.. _class_SurfaceTool_generate_normals: + .. _class_SurfaceTool_generate_normals: - void **generate_normals** **(** :ref:`bool` flip=false **)** @@ -194,20 +195,19 @@ Generates normals from Vertices so you do not have to do it manually. Setting "flip" ``true`` inverts resulting normals. -.. _class_SurfaceTool_generate_tangents: + .. _class_SurfaceTool_generate_tangents: - void **generate_tangents** **(** **)** -.. _class_SurfaceTool_index: + .. _class_SurfaceTool_index: - void **index** **(** **)** Shrinks Vertex array by creating an index array. Avoids reusing Vertices. -.. _class_SurfaceTool_set_material: + .. _class_SurfaceTool_set_material: - void **set_material** **(** :ref:`Material` material **)** Sets :ref:`Material` to be used by the :ref:`Mesh` you are constructing. - diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index c8113619a..520df957c 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -8,6 +8,7 @@ TabContainer ============ **Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,19 @@ Brief Description 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` | ++---------------------------------------------+--------------------------------------------------------------------------------+ + Methods ------- @@ -48,40 +62,79 @@ Methods | 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` | ++---------------------------------+--------------------------------------------------------------------+ + Signals ------- -.. _class_TabContainer_pre_popup_pressed: + .. _class_TabContainer_pre_popup_pressed: - **pre_popup_pressed** **(** **)** Emitted when the ``TabContainer``'s :ref:`Popup` button is clicked. See :ref:`set_popup` for details. -.. _class_TabContainer_tab_changed: + .. _class_TabContainer_tab_changed: - **tab_changed** **(** :ref:`int` tab **)** Emitted when switching to another tab. -.. _class_TabContainer_tab_selected: + .. _class_TabContainer_tab_selected: - **tab_selected** **(** :ref:`int` tab **)** Emitted when a tab is selected, even if it is the current tab. - Enumerations ------------ .. _enum_TabContainer_TabAlign: -enum **TabAlign** +enum **TabAlign**: - **ALIGN_LEFT** = **0** - **ALIGN_CENTER** = **1** - **ALIGN_RIGHT** = **2** - Description ----------- @@ -98,102 +151,130 @@ Property Descriptions .. _class_TabContainer_current_tab: -- :ref:`int` **current_tab** - 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``. +- :ref:`int` **current_tab** + ++----------+------------------------+ +| *Setter* | set_current_tab(value) | ++----------+------------------------+ +| *Getter* | get_current_tab() | ++----------+------------------------+ + +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: - :ref:`bool` **drag_to_rearrange_enabled** ++----------+--------------------------------------+ +| *Setter* | set_drag_to_rearrange_enabled(value) | ++----------+--------------------------------------+ +| *Getter* | get_drag_to_rearrange_enabled() | ++----------+--------------------------------------+ + .. _class_TabContainer_tab_align: -- :ref:`TabAlign` **tab_align** - The alignment of all tabs in the tab container. See the ``ALIGN_*`` constants for details. +- :ref:`TabAlign` **tab_align** + ++----------+----------------------+ +| *Setter* | set_tab_align(value) | ++----------+----------------------+ +| *Getter* | get_tab_align() | ++----------+----------------------+ + +The alignment of all tabs in the tab container. See the ``ALIGN_*`` constants for details. .. _class_TabContainer_tabs_visible: -- :ref:`bool` **tabs_visible** - If ``true`` tabs are visible. If ``false`` tabs' content and titles are hidden. Default value: ``true``. +- :ref:`bool` **tabs_visible** ++----------+-------------------------+ +| *Setter* | set_tabs_visible(value) | ++----------+-------------------------+ +| *Getter* | are_tabs_visible() | ++----------+-------------------------+ + +If ``true`` tabs are visible. If ``false`` tabs' content and titles are hidden. Default value: ``true``. Method Descriptions ------------------- -.. _class_TabContainer_get_current_tab_control: + .. _class_TabContainer_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_get_popup: - :ref:`Popup` **get_popup** **(** **)** const Returns the :ref:`Popup` node instance if one has been set already with :ref:`set_popup`. -.. _class_TabContainer_get_previous_tab: + .. _class_TabContainer_get_previous_tab: - :ref:`int` **get_previous_tab** **(** **)** const Returns the previously active tab index. -.. _class_TabContainer_get_tab_control: + .. _class_TabContainer_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_get_tab_count: - :ref:`int` **get_tab_count** **(** **)** const Returns the number of tabs. -.. _class_TabContainer_get_tab_disabled: + .. _class_TabContainer_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_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_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`. -.. _class_TabContainer_get_tabs_rearrange_group: + .. _class_TabContainer_get_tabs_rearrange_group: - :ref:`int` **get_tabs_rearrange_group** **(** **)** const -.. _class_TabContainer_set_popup: + .. _class_TabContainer_set_popup: - void **set_popup** **(** :ref:`Node` popup **)** If set on a :ref:`Popup` node instance, a popup menu icon appears in the top-right corner of the ``TabContainer``. Clicking it will expand the :ref:`Popup` node. -.. _class_TabContainer_set_tab_disabled: + .. _class_TabContainer_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`. -.. _class_TabContainer_set_tab_icon: + .. _class_TabContainer_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_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`. -.. _class_TabContainer_set_tabs_rearrange_group: + .. _class_TabContainer_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 50c2d274f..1e6476334 100644 --- a/classes/class_tabs.rst +++ b/classes/class_tabs.rst @@ -8,6 +8,7 @@ Tabs ==== **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,21 @@ Brief Description 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` | ++---------------------------------------------------------------------+------------------------------------------------------------------------+ + Methods ------- @@ -56,40 +72,80 @@ Methods | 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` | ++---------------------------------+------------------------------------------------------------+ + Signals ------- -.. _class_Tabs_reposition_active_tab_request: + .. _class_Tabs_reposition_active_tab_request: - **reposition_active_tab_request** **(** :ref:`int` idx_to **)** -.. _class_Tabs_right_button_pressed: + .. _class_Tabs_right_button_pressed: - **right_button_pressed** **(** :ref:`int` tab **)** -.. _class_Tabs_tab_changed: + .. _class_Tabs_tab_changed: - **tab_changed** **(** :ref:`int` tab **)** -.. _class_Tabs_tab_clicked: + .. _class_Tabs_tab_clicked: - **tab_clicked** **(** :ref:`int` tab **)** -.. _class_Tabs_tab_close: + .. _class_Tabs_tab_close: - **tab_close** **(** :ref:`int` tab **)** -.. _class_Tabs_tab_hover: + .. _class_Tabs_tab_hover: - **tab_hover** **(** :ref:`int` tab **)** - Enumerations ------------ .. _enum_Tabs_CloseButtonDisplayPolicy: -enum **CloseButtonDisplayPolicy** +enum **CloseButtonDisplayPolicy**: - **CLOSE_BUTTON_SHOW_NEVER** = **0** - **CLOSE_BUTTON_SHOW_ACTIVE_ONLY** = **1** @@ -98,14 +154,13 @@ enum **CloseButtonDisplayPolicy** .. _enum_Tabs_TabAlign: -enum **TabAlign** +enum **TabAlign**: - **ALIGN_LEFT** = **0** - **ALIGN_CENTER** = **1** - **ALIGN_RIGHT** = **2** - **ALIGN_MAX** = **3** - Description ----------- @@ -118,100 +173,128 @@ Property Descriptions - :ref:`int` **current_tab** ++----------+------------------------+ +| *Setter* | set_current_tab(value) | ++----------+------------------------+ +| *Getter* | get_current_tab() | ++----------+------------------------+ + .. _class_Tabs_drag_to_rearrange_enabled: - :ref:`bool` **drag_to_rearrange_enabled** ++----------+--------------------------------------+ +| *Setter* | set_drag_to_rearrange_enabled(value) | ++----------+--------------------------------------+ +| *Getter* | get_drag_to_rearrange_enabled() | ++----------+--------------------------------------+ + .. _class_Tabs_scrolling_enabled: - :ref:`bool` **scrolling_enabled** ++----------+------------------------------+ +| *Setter* | set_scrolling_enabled(value) | ++----------+------------------------------+ +| *Getter* | get_scrolling_enabled() | ++----------+------------------------------+ + .. _class_Tabs_tab_align: - :ref:`TabAlign` **tab_align** ++----------+----------------------+ +| *Setter* | set_tab_align(value) | ++----------+----------------------+ +| *Getter* | get_tab_align() | ++----------+----------------------+ + .. _class_Tabs_tab_close_display_policy: - :ref:`CloseButtonDisplayPolicy` **tab_close_display_policy** ++----------+-------------------------------------+ +| *Setter* | set_tab_close_display_policy(value) | ++----------+-------------------------------------+ +| *Getter* | get_tab_close_display_policy() | ++----------+-------------------------------------+ Method Descriptions ------------------- -.. _class_Tabs_add_tab: + .. _class_Tabs_add_tab: - void **add_tab** **(** :ref:`String` title="", :ref:`Texture` icon=null **)** -.. _class_Tabs_ensure_tab_visible: + .. _class_Tabs_ensure_tab_visible: - void **ensure_tab_visible** **(** :ref:`int` idx **)** -.. _class_Tabs_get_offset_buttons_visible: + .. _class_Tabs_get_offset_buttons_visible: - :ref:`bool` **get_offset_buttons_visible** **(** **)** const -.. _class_Tabs_get_select_with_rmb: + .. _class_Tabs_get_select_with_rmb: - :ref:`bool` **get_select_with_rmb** **(** **)** const -.. _class_Tabs_get_tab_count: + .. _class_Tabs_get_tab_count: - :ref:`int` **get_tab_count** **(** **)** const -.. _class_Tabs_get_tab_disabled: + .. _class_Tabs_get_tab_disabled: - :ref:`bool` **get_tab_disabled** **(** :ref:`int` tab_idx **)** const -.. _class_Tabs_get_tab_icon: + .. _class_Tabs_get_tab_icon: - :ref:`Texture` **get_tab_icon** **(** :ref:`int` tab_idx **)** const -.. _class_Tabs_get_tab_offset: + .. _class_Tabs_get_tab_offset: - :ref:`int` **get_tab_offset** **(** **)** const -.. _class_Tabs_get_tab_rect: + .. _class_Tabs_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_get_tab_title: - :ref:`String` **get_tab_title** **(** :ref:`int` tab_idx **)** const -.. _class_Tabs_get_tabs_rearrange_group: + .. _class_Tabs_get_tabs_rearrange_group: - :ref:`int` **get_tabs_rearrange_group** **(** **)** const -.. _class_Tabs_move_tab: + .. _class_Tabs_move_tab: - void **move_tab** **(** :ref:`int` from, :ref:`int` to **)** Rearrange tab. -.. _class_Tabs_remove_tab: + .. _class_Tabs_remove_tab: - void **remove_tab** **(** :ref:`int` tab_idx **)** -.. _class_Tabs_set_select_with_rmb: + .. _class_Tabs_set_select_with_rmb: - void **set_select_with_rmb** **(** :ref:`bool` enabled **)** -.. _class_Tabs_set_tab_disabled: + .. _class_Tabs_set_tab_disabled: - void **set_tab_disabled** **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** -.. _class_Tabs_set_tab_icon: + .. _class_Tabs_set_tab_icon: - void **set_tab_icon** **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** -.. _class_Tabs_set_tab_title: + .. _class_Tabs_set_tab_title: - void **set_tab_title** **(** :ref:`int` tab_idx, :ref:`String` title **)** -.. _class_Tabs_set_tabs_rearrange_group: + .. _class_Tabs_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 724d436d1..3f76bdeae 100644 --- a/classes/class_tcp_server.rst +++ b/classes/class_tcp_server.rst @@ -8,6 +8,7 @@ TCP_Server ========== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -36,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_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_listen: - :ref:`Error` **listen** **(** :ref:`int` port, :ref:`String` bind_address="*" **)** @@ -54,16 +55,15 @@ 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_stop: - void **stop** **(** **)** Stop listening. -.. _class_TCP_Server_take_connection: + .. _class_TCP_Server_take_connection: - :ref:`StreamPeerTCP` **take_connection** **(** **)** If a connection is available, return a StreamPeerTCP with the connection/ - diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 9ead4ac3d..1edb96394 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -8,6 +8,7 @@ TextEdit ======== **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,45 @@ Brief Description 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` | ++-----------------------------+----------------------------------------------------------------------------------+ + Methods ------- @@ -104,42 +144,112 @@ Methods | 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` | ++---------------------------------+--------------------------------------------------------------------------------+ + Signals ------- -.. _class_TextEdit_breakpoint_toggled: + .. _class_TextEdit_breakpoint_toggled: - **breakpoint_toggled** **(** :ref:`int` row **)** Emitted when a breakpoint is placed via the breakpoint gutter. -.. _class_TextEdit_cursor_changed: + .. _class_TextEdit_cursor_changed: - **cursor_changed** **(** **)** Emitted when the cursor changes. -.. _class_TextEdit_request_completion: + .. _class_TextEdit_request_completion: - **request_completion** **(** **)** -.. _class_TextEdit_symbol_lookup: + .. _class_TextEdit_symbol_lookup: - **symbol_lookup** **(** :ref:`String` symbol, :ref:`int` row, :ref:`int` column **)** -.. _class_TextEdit_text_changed: + .. _class_TextEdit_text_changed: - **text_changed** **(** **)** Emitted when the text changes. - Enumerations ------------ .. _enum_TextEdit_MenuItems: -enum **MenuItems** +enum **MenuItems**: - **MENU_CUT** = **0** --- Cuts (Copies and clears) the selected text. - **MENU_COPY** = **1** --- Copies the selected text. @@ -151,13 +261,12 @@ enum **MenuItems** .. _enum_TextEdit_SearchFlags: -enum **SearchFlags** +enum **SearchFlags**: - **SEARCH_MATCH_CASE** = **1** --- Match case when searching. - **SEARCH_WHOLE_WORDS** = **2** --- Match whole words when searching. - **SEARCH_BACKWARDS** = **4** --- Search from end to beginning. - Description ----------- @@ -168,300 +277,422 @@ Property Descriptions .. _class_TextEdit_breakpoint_gutter: -- :ref:`bool` **breakpoint_gutter** - If ``true`` the breakpoint gutter is visible. +- :ref:`bool` **breakpoint_gutter** + ++----------+--------------------------------------+ +| *Setter* | set_breakpoint_gutter_enabled(value) | ++----------+--------------------------------------+ +| *Getter* | is_breakpoint_gutter_enabled() | ++----------+--------------------------------------+ + +If ``true`` the breakpoint gutter is visible. .. _class_TextEdit_caret_blink: -- :ref:`bool` **caret_blink** - If ``true`` the caret (visual cursor) blinks. +- :ref:`bool` **caret_blink** + ++----------+---------------------------------+ +| *Setter* | cursor_set_blink_enabled(value) | ++----------+---------------------------------+ +| *Getter* | cursor_get_blink_enabled() | ++----------+---------------------------------+ + +If ``true`` the caret (visual cursor) blinks. .. _class_TextEdit_caret_blink_speed: -- :ref:`float` **caret_blink_speed** - Duration (in seconds) of a caret's blinking cycle. +- :ref:`float` **caret_blink_speed** + ++----------+-------------------------------+ +| *Setter* | cursor_set_blink_speed(value) | ++----------+-------------------------------+ +| *Getter* | cursor_get_blink_speed() | ++----------+-------------------------------+ + +Duration (in seconds) of a caret's blinking cycle. .. _class_TextEdit_caret_block_mode: -- :ref:`bool` **caret_block_mode** - If ``true`` the caret displays as a rectangle. +- :ref:`bool` **caret_block_mode** + ++----------+------------------------------+ +| *Setter* | cursor_set_block_mode(value) | ++----------+------------------------------+ +| *Getter* | cursor_is_block_mode() | ++----------+------------------------------+ + +If ``true`` the caret displays as a rectangle. If ``false`` the caret displays as a bar. .. _class_TextEdit_caret_moving_by_right_click: -- :ref:`bool` **caret_moving_by_right_click** - If ``true`` a right click moves the cursor at the mouse position before displaying the context menu. +- :ref:`bool` **caret_moving_by_right_click** + ++----------+------------------------------------+ +| *Setter* | set_right_click_moves_caret(value) | ++----------+------------------------------------+ +| *Getter* | is_right_click_moving_caret() | ++----------+------------------------------------+ + +If ``true`` a right click moves the cursor at the mouse position before displaying the context menu. If ``false`` the context menu disregards mouse location. .. _class_TextEdit_context_menu_enabled: -- :ref:`bool` **context_menu_enabled** - If ``true`` a right click displays the context menu. +- :ref:`bool` **context_menu_enabled** + ++----------+---------------------------------+ +| *Setter* | set_context_menu_enabled(value) | ++----------+---------------------------------+ +| *Getter* | is_context_menu_enabled() | ++----------+---------------------------------+ + +If ``true`` a right click displays the context menu. .. _class_TextEdit_hiding_enabled: - :ref:`int` **hiding_enabled** ++----------+---------------------------+ +| *Setter* | set_hiding_enabled(value) | ++----------+---------------------------+ +| *Getter* | is_hiding_enabled() | ++----------+---------------------------+ + .. _class_TextEdit_highlight_all_occurrences: - :ref:`bool` **highlight_all_occurrences** ++----------+----------------------------------------+ +| *Setter* | set_highlight_all_occurrences(value) | ++----------+----------------------------------------+ +| *Getter* | is_highlight_all_occurrences_enabled() | ++----------+----------------------------------------+ + .. _class_TextEdit_highlight_current_line: -- :ref:`bool` **highlight_current_line** - If ``true`` the line containing the cursor is highlighted. +- :ref:`bool` **highlight_current_line** + ++----------+-------------------------------------+ +| *Setter* | set_highlight_current_line(value) | ++----------+-------------------------------------+ +| *Getter* | is_highlight_current_line_enabled() | ++----------+-------------------------------------+ + +If ``true`` the line containing the cursor is highlighted. .. _class_TextEdit_override_selected_font_color: - :ref:`bool` **override_selected_font_color** ++----------+-----------------------------------------+ +| *Setter* | set_override_selected_font_color(value) | ++----------+-----------------------------------------+ +| *Getter* | is_overriding_selected_font_color() | ++----------+-----------------------------------------+ + .. _class_TextEdit_readonly: -- :ref:`bool` **readonly** - If ``true`` read-only mode is enabled. Existing text cannot be modified and new text cannot be added. +- :ref:`bool` **readonly** + ++----------+---------------------+ +| *Setter* | set_readonly(value) | ++----------+---------------------+ +| *Getter* | is_readonly() | ++----------+---------------------+ + +If ``true`` read-only mode is enabled. Existing text cannot be modified and new text cannot be added. .. _class_TextEdit_show_line_numbers: -- :ref:`bool` **show_line_numbers** - If ``true`` line numbers are displayed to the left of the text. +- :ref:`bool` **show_line_numbers** + ++----------+--------------------------------+ +| *Setter* | set_show_line_numbers(value) | ++----------+--------------------------------+ +| *Getter* | is_show_line_numbers_enabled() | ++----------+--------------------------------+ + +If ``true`` line numbers are displayed to the left of the text. .. _class_TextEdit_smooth_scrolling: - :ref:`bool` **smooth_scrolling** ++----------+---------------------------------+ +| *Setter* | set_smooth_scroll_enable(value) | ++----------+---------------------------------+ +| *Getter* | is_smooth_scroll_enabled() | ++----------+---------------------------------+ + .. _class_TextEdit_syntax_highlighting: - :ref:`bool` **syntax_highlighting** ++----------+------------------------------+ +| *Setter* | set_syntax_coloring(value) | ++----------+------------------------------+ +| *Getter* | is_syntax_coloring_enabled() | ++----------+------------------------------+ + .. _class_TextEdit_text: -- :ref:`String` **text** - String value of the :ref:`TextEdit`. +- :ref:`String` **text** + ++----------+-----------------+ +| *Setter* | set_text(value) | ++----------+-----------------+ +| *Getter* | get_text() | ++----------+-----------------+ + +String value of the :ref:`TextEdit`. .. _class_TextEdit_v_scroll_speed: -- :ref:`float` **v_scroll_speed** - If ``true``, enables text wrapping when it goes beyond he edge of what is visible. +- :ref:`float` **v_scroll_speed** + ++----------+---------------------------+ +| *Setter* | set_v_scroll_speed(value) | ++----------+---------------------------+ +| *Getter* | get_v_scroll_speed() | ++----------+---------------------------+ + +If ``true``, enables text wrapping when it goes beyond he edge of what is visible. .. _class_TextEdit_wrap_enabled: - :ref:`bool` **wrap_enabled** ++----------+-------------------------+ +| *Setter* | set_wrap_enabled(value) | ++----------+-------------------------+ +| *Getter* | is_wrap_enabled() | ++----------+-------------------------+ Method Descriptions ------------------- -.. _class_TextEdit_add_color_region: + .. _class_TextEdit_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_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_can_fold: - :ref:`bool` **can_fold** **(** :ref:`int` line **)** const -.. _class_TextEdit_clear_colors: + .. _class_TextEdit_clear_colors: - void **clear_colors** **(** **)** Clear all the syntax coloring information. -.. _class_TextEdit_clear_undo_history: + .. _class_TextEdit_clear_undo_history: - void **clear_undo_history** **(** **)** Clear the undo history. -.. _class_TextEdit_copy: + .. _class_TextEdit_copy: - void **copy** **(** **)** Copy the current selection. -.. _class_TextEdit_cursor_get_column: + .. _class_TextEdit_cursor_get_column: - :ref:`int` **cursor_get_column** **(** **)** const Return the column the editing cursor is at. -.. _class_TextEdit_cursor_get_line: + .. _class_TextEdit_cursor_get_line: - :ref:`int` **cursor_get_line** **(** **)** const Return the line the editing cursor is at. -.. _class_TextEdit_cursor_set_column: + .. _class_TextEdit_cursor_set_column: - void **cursor_set_column** **(** :ref:`int` column, :ref:`bool` adjust_viewport=true **)** -.. _class_TextEdit_cursor_set_line: + .. _class_TextEdit_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_cut: - void **cut** **(** **)** Cut the current selection. -.. _class_TextEdit_deselect: + .. _class_TextEdit_deselect: - void **deselect** **(** **)** Clears the current selection. -.. _class_TextEdit_fold_all_lines: + .. _class_TextEdit_fold_all_lines: - void **fold_all_lines** **(** **)** -.. _class_TextEdit_fold_line: + .. _class_TextEdit_fold_line: - void **fold_line** **(** :ref:`int` line **)** -.. _class_TextEdit_get_breakpoints: + .. _class_TextEdit_get_breakpoints: - :ref:`Array` **get_breakpoints** **(** **)** const Return an array containing the line number of each breakpoint. -.. _class_TextEdit_get_keyword_color: + .. _class_TextEdit_get_keyword_color: - :ref:`Color` **get_keyword_color** **(** :ref:`String` keyword **)** const -.. _class_TextEdit_get_line: + .. _class_TextEdit_get_line: - :ref:`String` **get_line** **(** :ref:`int` line **)** const Return the text of a specific line. -.. _class_TextEdit_get_line_count: + .. _class_TextEdit_get_line_count: - :ref:`int` **get_line_count** **(** **)** const Return the amount of total lines in the text. -.. _class_TextEdit_get_menu: + .. _class_TextEdit_get_menu: - :ref:`PopupMenu` **get_menu** **(** **)** const -.. _class_TextEdit_get_selection_from_column: + .. _class_TextEdit_get_selection_from_column: - :ref:`int` **get_selection_from_column** **(** **)** const Return the selection begin column. -.. _class_TextEdit_get_selection_from_line: + .. _class_TextEdit_get_selection_from_line: - :ref:`int` **get_selection_from_line** **(** **)** const Return the selection begin line. -.. _class_TextEdit_get_selection_text: + .. _class_TextEdit_get_selection_text: - :ref:`String` **get_selection_text** **(** **)** const Return the text inside the selection. -.. _class_TextEdit_get_selection_to_column: + .. _class_TextEdit_get_selection_to_column: - :ref:`int` **get_selection_to_column** **(** **)** const Return the selection end column. -.. _class_TextEdit_get_selection_to_line: + .. _class_TextEdit_get_selection_to_line: - :ref:`int` **get_selection_to_line** **(** **)** const Return the selection end line. -.. _class_TextEdit_get_word_under_cursor: + .. _class_TextEdit_get_word_under_cursor: - :ref:`String` **get_word_under_cursor** **(** **)** const -.. _class_TextEdit_has_keyword_color: + .. _class_TextEdit_has_keyword_color: - :ref:`bool` **has_keyword_color** **(** :ref:`String` keyword **)** const -.. _class_TextEdit_insert_text_at_cursor: + .. _class_TextEdit_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_is_folded: - :ref:`bool` **is_folded** **(** :ref:`int` line **)** const -.. _class_TextEdit_is_line_hidden: + .. _class_TextEdit_is_line_hidden: - :ref:`bool` **is_line_hidden** **(** :ref:`int` line **)** const -.. _class_TextEdit_is_selection_active: + .. _class_TextEdit_is_selection_active: - :ref:`bool` **is_selection_active** **(** **)** const Return true if the selection is active. -.. _class_TextEdit_menu_option: + .. _class_TextEdit_menu_option: - void **menu_option** **(** :ref:`int` option **)** -.. _class_TextEdit_paste: + .. _class_TextEdit_paste: - void **paste** **(** **)** Paste the current selection. -.. _class_TextEdit_redo: + .. _class_TextEdit_redo: - void **redo** **(** **)** Perform redo operation. -.. _class_TextEdit_remove_breakpoints: + .. _class_TextEdit_remove_breakpoints: - void **remove_breakpoints** **(** **)** Removes all the breakpoints (without firing "breakpoint_toggled" signal). -.. _class_TextEdit_search: + .. _class_TextEdit_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_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_select_all: - void **select_all** **(** **)** Select all the text. -.. _class_TextEdit_set_line_as_hidden: + .. _class_TextEdit_set_line_as_hidden: - void **set_line_as_hidden** **(** :ref:`int` line, :ref:`bool` enable **)** -.. _class_TextEdit_toggle_fold_line: + .. _class_TextEdit_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_undo: - void **undo** **(** **)** Perform undo operation. -.. _class_TextEdit_unfold_line: + .. _class_TextEdit_unfold_line: - void **unfold_line** **(** :ref:`int` line **)** -.. _class_TextEdit_unhide_all_lines: + .. _class_TextEdit_unhide_all_lines: - void **unhide_all_lines** **(** **)** - diff --git a/classes/class_textfile.rst b/classes/class_textfile.rst index 6e508cb97..4b4841cdb 100644 --- a/classes/class_textfile.rst +++ b/classes/class_textfile.rst @@ -8,6 +8,7 @@ TextFile ======== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_texture.rst b/classes/class_texture.rst index 85a73e9cb..c53646bd7 100644 --- a/classes/class_texture.rst +++ b/classes/class_texture.rst @@ -8,7 +8,9 @@ Texture ======= **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`CurveTexture`, :ref:`AtlasTexture`, :ref:`ProxyTexture`, :ref:`GradientTexture`, :ref:`ViewportTexture`, :ref:`AnimatedTexture`, :ref:`StreamTexture`, :ref:`ImageTexture`, :ref:`LargeTexture` + **Category:** Core Brief Description @@ -16,6 +18,13 @@ Brief Description Texture for 2D and 3D. +Properties +---------- + ++-----------------------+-----------------------------------+ +| :ref:`int` | :ref:`flags` | ++-----------------------+-----------------------------------+ + Methods ------- @@ -42,7 +51,7 @@ Enumerations .. _enum_Texture_Flags: -enum **Flags** +enum **Flags**: - **FLAGS_DEFAULT** = **7** --- Default flags. Generate mipmaps, repeat, and filter are enabled. - **FLAG_MIPMAPS** = **1** --- Generate mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio. @@ -55,7 +64,6 @@ More effective on planes often shown going to the horrizon as those textures (Wa - **FLAG_MIRRORED_REPEAT** = **32** --- Repeats texture with alternate sections mirrored. - **FLAG_VIDEO_SURFACE** = **2048** --- Texture is a video surface. - Description ----------- @@ -68,48 +76,54 @@ Property Descriptions .. _class_Texture_flags: -- :ref:`int` **flags** - The texture's flags. +- :ref:`int` **flags** ++----------+------------------+ +| *Setter* | set_flags(value) | ++----------+------------------+ +| *Getter* | get_flags() | ++----------+------------------+ + +The texture's flags. Method Descriptions ------------------- -.. _class_Texture_draw: + .. _class_Texture_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_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_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_get_data: - :ref:`Image` **get_data** **(** **)** const -.. _class_Texture_get_height: + .. _class_Texture_get_height: - :ref:`int` **get_height** **(** **)** const Return the texture height. -.. _class_Texture_get_size: + .. _class_Texture_get_size: - :ref:`Vector2` **get_size** **(** **)** const Return the texture size. -.. _class_Texture_get_width: + .. _class_Texture_get_width: - :ref:`int` **get_width** **(** **)** const Return the texture width. -.. _class_Texture_has_alpha: + .. _class_Texture_has_alpha: - :ref:`bool` **has_alpha** **(** **)** const - diff --git a/classes/class_texture3d.rst b/classes/class_texture3d.rst index 244aee133..9e8b68f89 100644 --- a/classes/class_texture3d.rst +++ b/classes/class_texture3d.rst @@ -8,6 +8,7 @@ Texture3D ========= **Inherits:** :ref:`TextureLayered` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_texturearray.rst b/classes/class_texturearray.rst index bb694b048..b29d53a7e 100644 --- a/classes/class_texturearray.rst +++ b/classes/class_texturearray.rst @@ -8,6 +8,7 @@ TextureArray ============ **Inherits:** :ref:`TextureLayered` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_texturebutton.rst b/classes/class_texturebutton.rst index 3b975482e..cce3efab4 100644 --- a/classes/class_texturebutton.rst +++ b/classes/class_texturebutton.rst @@ -8,6 +8,7 @@ TextureButton ============= **Inherits:** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,12 +16,33 @@ Brief Description 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` | ++----------------------------------------------------+-------------------------------------------------------------------+ + Enumerations ------------ .. _enum_TextureButton_StretchMode: -enum **StretchMode** +enum **StretchMode**: - **STRETCH_SCALE** = **0** --- Scale to fit the node's bounding rectangle. - **STRETCH_TILE** = **1** --- Tile inside the node's bounding rectangle. @@ -30,7 +52,6 @@ enum **StretchMode** - **STRETCH_KEEP_ASPECT_CENTERED** = **5** --- Scale the texture to fit the node's bounding rectangle, center it, and maintain its aspect ratio. - **STRETCH_KEEP_ASPECT_COVERED** = **6** --- Scale the texture so that the shorter side fits the bounding rectangle. The other side clips to the node's limits. - Description ----------- @@ -43,34 +64,97 @@ Property Descriptions .. _class_TextureButton_expand: -- :ref:`bool` **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``. +- :ref:`bool` **expand** + ++----------+-------------------+ +| *Setter* | set_expand(value) | ++----------+-------------------+ +| *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``. .. _class_TextureButton_stretch_mode: -- :ref:`StretchMode` **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. +- :ref:`StretchMode` **stretch_mode** + ++----------+-------------------------+ +| *Setter* | set_stretch_mode(value) | ++----------+-------------------------+ +| *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. .. _class_TextureButton_texture_click_mask: -- :ref:`BitMap` **texture_click_mask** - Pure black and white 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. +- :ref:`BitMap` **texture_click_mask** + ++----------+-----------------------+ +| *Setter* | set_click_mask(value) | ++----------+-----------------------+ +| *Getter* | get_click_mask() | ++----------+-----------------------+ + +Pure black and white 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: -- :ref:`Texture` **texture_disabled** - Texture to display when the node is disabled. See :ref:`BaseButton.disabled`. +- :ref:`Texture` **texture_disabled** + ++----------+-----------------------------+ +| *Setter* | set_disabled_texture(value) | ++----------+-----------------------------+ +| *Getter* | get_disabled_texture() | ++----------+-----------------------------+ + +Texture to display when the node is disabled. See :ref:`BaseButton.disabled`. .. _class_TextureButton_texture_focused: -- :ref:`Texture` **texture_focused** - Texture to display when the node has mouse or keyboard focus. +- :ref:`Texture` **texture_focused** + ++----------+----------------------------+ +| *Setter* | set_focused_texture(value) | ++----------+----------------------------+ +| *Getter* | get_focused_texture() | ++----------+----------------------------+ + +Texture to display when the node has mouse or keyboard focus. .. _class_TextureButton_texture_hover: -- :ref:`Texture` **texture_hover** - Texture to display when the mouse hovers the node. +- :ref:`Texture` **texture_hover** + ++----------+--------------------------+ +| *Setter* | set_hover_texture(value) | ++----------+--------------------------+ +| *Getter* | get_hover_texture() | ++----------+--------------------------+ + +Texture to display when the mouse hovers the node. .. _class_TextureButton_texture_normal: -- :ref:`Texture` **texture_normal** - Texture to display by default, when the node is **not** in the disabled, focused, hover or pressed state. +- :ref:`Texture` **texture_normal** + ++----------+---------------------------+ +| *Setter* | set_normal_texture(value) | ++----------+---------------------------+ +| *Getter* | get_normal_texture() | ++----------+---------------------------+ + +Texture to display by default, when the node is **not** in the disabled, focused, hover or pressed state. .. _class_TextureButton_texture_pressed: -- :ref:`Texture` **texture_pressed** - 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. +- :ref:`Texture` **texture_pressed** ++----------+----------------------------+ +| *Setter* | set_pressed_texture(value) | ++----------+----------------------------+ +| *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. diff --git a/classes/class_texturelayered.rst b/classes/class_texturelayered.rst index 79c836a25..3d9aba157 100644 --- a/classes/class_texturelayered.rst +++ b/classes/class_texturelayered.rst @@ -8,7 +8,9 @@ TextureLayered ============== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`TextureArray`, :ref:`Texture3D` + **Category:** Core Brief Description @@ -16,6 +18,15 @@ Brief Description +Properties +---------- + ++-------------------------------------+------------------------------------------+ +| :ref:`Dictionary` | :ref:`data` | ++-------------------------------------+------------------------------------------+ +| :ref:`int` | :ref:`flags` | ++-------------------------------------+------------------------------------------+ + Methods ------- @@ -42,14 +53,13 @@ Enumerations .. _enum_TextureLayered_Flags: -enum **Flags** +enum **Flags**: - **FLAG_MIPMAPS** = **1** - **FLAG_REPEAT** = **2** - **FLAG_FILTER** = **4** - **FLAGS_DEFAULT** = **4** - Property Descriptions --------------------- @@ -61,40 +71,44 @@ Property Descriptions - :ref:`int` **flags** ++----------+------------------+ +| *Setter* | set_flags(value) | ++----------+------------------+ +| *Getter* | get_flags() | ++----------+------------------+ Method Descriptions ------------------- -.. _class_TextureLayered_create: + .. _class_TextureLayered_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_get_depth: - :ref:`int` **get_depth** **(** **)** const -.. _class_TextureLayered_get_format: + .. _class_TextureLayered_get_format: - :ref:`Format` **get_format** **(** **)** const -.. _class_TextureLayered_get_height: + .. _class_TextureLayered_get_height: - :ref:`int` **get_height** **(** **)** const -.. _class_TextureLayered_get_layer_data: + .. _class_TextureLayered_get_layer_data: - :ref:`Image` **get_layer_data** **(** :ref:`int` layer **)** const -.. _class_TextureLayered_get_width: + .. _class_TextureLayered_get_width: - :ref:`int` **get_width** **(** **)** const -.. _class_TextureLayered_set_data_partial: + .. _class_TextureLayered_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_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 966115ced..a2710f81a 100644 --- a/classes/class_textureprogress.rst +++ b/classes/class_textureprogress.rst @@ -8,6 +8,7 @@ TextureProgress =============== **Inherits:** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,12 +16,47 @@ Brief Description 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` | ++-------------------------------+---------------------------------------------------------------------------+ + Enumerations ------------ .. _enum_TextureProgress_FillMode: -enum **FillMode** +enum **FillMode**: - **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. @@ -32,7 +68,6 @@ enum **FillMode** - **FILL_BILINEAR_TOP_AND_BOTTOM** = **7** - **FILL_CLOCKWISE_AND_COUNTER_CLOCKWISE** = **8** - Description ----------- @@ -43,66 +78,179 @@ Property Descriptions .. _class_TextureProgress_fill_mode: -- :ref:`int` **fill_mode** - The fill direction. Uses FILL\_\* constants. +- :ref:`int` **fill_mode** + ++----------+----------------------+ +| *Setter* | set_fill_mode(value) | ++----------+----------------------+ +| *Getter* | get_fill_mode() | ++----------+----------------------+ + +The fill direction. Uses FILL\_\* constants. .. _class_TextureProgress_nine_patch_stretch: -- :ref:`bool` **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``. +- :ref:`bool` **nine_patch_stretch** + ++----------+-------------------------------+ +| *Setter* | set_nine_patch_stretch(value) | ++----------+-------------------------------+ +| *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``. .. _class_TextureProgress_radial_center_offset: -- :ref:`Vector2` **radial_center_offset** - Offsets :ref:`texture_progress` if :ref:`fill_mode` is ``FILL_CLOCKWISE`` or ``FILL_COUNTER_CLOCKWISE``. +- :ref:`Vector2` **radial_center_offset** + ++----------+---------------------------------+ +| *Setter* | set_radial_center_offset(value) | ++----------+---------------------------------+ +| *Getter* | get_radial_center_offset() | ++----------+---------------------------------+ + +Offsets :ref:`texture_progress` if :ref:`fill_mode` is ``FILL_CLOCKWISE`` or ``FILL_COUNTER_CLOCKWISE``. .. _class_TextureProgress_radial_fill_degrees: -- :ref:`float` **radial_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. +- :ref:`float` **radial_fill_degrees** + ++----------+-------------------------+ +| *Setter* | set_fill_degrees(value) | ++----------+-------------------------+ +| *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. See :ref:`Range.value`, :ref:`Range.max_value`. .. _class_TextureProgress_radial_initial_angle: -- :ref:`float` **radial_initial_angle** - 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`. +- :ref:`float` **radial_initial_angle** + ++----------+---------------------------------+ +| *Setter* | set_radial_initial_angle(value) | ++----------+---------------------------------+ +| *Getter* | get_radial_initial_angle() | ++----------+---------------------------------+ + +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: -- :ref:`int` **stretch_margin_bottom** - The height of the 9-patch'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. +- :ref:`int` **stretch_margin_bottom** + ++----------+---------------------------+ +| *Setter* | set_stretch_margin(value) | ++----------+---------------------------+ +| *Getter* | get_stretch_margin() | ++----------+---------------------------+ + +The height of the 9-patch'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_TextureProgress_stretch_margin_left: -- :ref:`int` **stretch_margin_left** - The width of the 9-patch's left column. +- :ref:`int` **stretch_margin_left** + ++----------+---------------------------+ +| *Setter* | set_stretch_margin(value) | ++----------+---------------------------+ +| *Getter* | get_stretch_margin() | ++----------+---------------------------+ + +The width of the 9-patch's left column. .. _class_TextureProgress_stretch_margin_right: -- :ref:`int` **stretch_margin_right** - The width of the 9-patch's right column. +- :ref:`int` **stretch_margin_right** + ++----------+---------------------------+ +| *Setter* | set_stretch_margin(value) | ++----------+---------------------------+ +| *Getter* | get_stretch_margin() | ++----------+---------------------------+ + +The width of the 9-patch's right column. .. _class_TextureProgress_stretch_margin_top: -- :ref:`int` **stretch_margin_top** - The height of the 9-patch's top row. +- :ref:`int` **stretch_margin_top** + ++----------+---------------------------+ +| *Setter* | set_stretch_margin(value) | ++----------+---------------------------+ +| *Getter* | get_stretch_margin() | ++----------+---------------------------+ + +The height of the 9-patch's top row. .. _class_TextureProgress_texture_over: -- :ref:`Texture` **texture_over** - :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` **texture_over** + ++----------+-------------------------+ +| *Setter* | set_over_texture(value) | ++----------+-------------------------+ +| *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`. .. _class_TextureProgress_texture_progress: -- :ref:`Texture` **texture_progress** - :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` **texture_progress** + ++----------+-----------------------------+ +| *Setter* | set_progress_texture(value) | ++----------+-----------------------------+ +| *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``. The ``value`` property comes from :ref:`Range`. See :ref:`Range.value`, :ref:`Range.min_value`, :ref:`Range.max_value`. .. _class_TextureProgress_texture_under: -- :ref:`Texture` **texture_under** - :ref:`Texture` that draws under the progress bar. The bar's background. +- :ref:`Texture` **texture_under** + ++----------+--------------------------+ +| *Setter* | set_under_texture(value) | ++----------+--------------------------+ +| *Getter* | get_under_texture() | ++----------+--------------------------+ + +:ref:`Texture` that draws under the progress bar. The bar's background. .. _class_TextureProgress_tint_over: - :ref:`Color` **tint_over** ++----------+----------------------+ +| *Setter* | set_tint_over(value) | ++----------+----------------------+ +| *Getter* | get_tint_over() | ++----------+----------------------+ + .. _class_TextureProgress_tint_progress: - :ref:`Color` **tint_progress** ++----------+--------------------------+ +| *Setter* | set_tint_progress(value) | ++----------+--------------------------+ +| *Getter* | get_tint_progress() | ++----------+--------------------------+ + .. _class_TextureProgress_tint_under: - :ref:`Color` **tint_under** ++----------+-----------------------+ +| *Setter* | set_tint_under(value) | ++----------+-----------------------+ +| *Getter* | get_tint_under() | ++----------+-----------------------+ diff --git a/classes/class_texturerect.rst b/classes/class_texturerect.rst index 83548e8f7..3f64fa3a0 100644 --- a/classes/class_texturerect.rst +++ b/classes/class_texturerect.rst @@ -8,6 +8,7 @@ TextureRect =========== **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,12 +16,23 @@ Brief Description Control for drawing textures. +Properties +---------- + ++--------------------------------------------------+-----------------------------------------------------+ +| :ref:`bool` | :ref:`expand` | ++--------------------------------------------------+-----------------------------------------------------+ +| :ref:`StretchMode` | :ref:`stretch_mode` | ++--------------------------------------------------+-----------------------------------------------------+ +| :ref:`Texture` | :ref:`texture` | ++--------------------------------------------------+-----------------------------------------------------+ + Enumerations ------------ .. _enum_TextureRect_StretchMode: -enum **StretchMode** +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``. - **STRETCH_SCALE** = **1** --- Scale to fit the node's bounding rectangle. @@ -31,7 +43,6 @@ enum **StretchMode** - **STRETCH_KEEP_ASPECT_CENTERED** = **6** --- Scale the texture to fit the node's bounding rectangle, center it and maintain its aspect ratio. - **STRETCH_KEEP_ASPECT_COVERED** = **7** --- Scale the texture so that the shorter side fits the bounding rectangle. The other side clips to the node's limits. - Description ----------- @@ -42,14 +53,37 @@ Property Descriptions .. _class_TextureRect_expand: -- :ref:`bool` **expand** - If ``true`` the texture scales to fit its bounding rectangle. Default value: ``false``. +- :ref:`bool` **expand** + ++----------+-------------------+ +| *Setter* | set_expand(value) | ++----------+-------------------+ +| *Getter* | has_expand() | ++----------+-------------------+ + +If ``true`` the texture scales to fit its bounding rectangle. Default value: ``false``. .. _class_TextureRect_stretch_mode: -- :ref:`StretchMode` **stretch_mode** - Controls the texture's behavior when resizing the node's bounding rectangle. See :ref:`StretchMode`. +- :ref:`StretchMode` **stretch_mode** + ++----------+-------------------------+ +| *Setter* | set_stretch_mode(value) | ++----------+-------------------------+ +| *Getter* | get_stretch_mode() | ++----------+-------------------------+ + +Controls the texture's behavior when resizing the node's bounding rectangle. See :ref:`StretchMode`. .. _class_TextureRect_texture: -- :ref:`Texture` **texture** - The node's :ref:`Texture` resource. +- :ref:`Texture` **texture** ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + +The node's :ref:`Texture` resource. diff --git a/classes/class_theme.rst b/classes/class_theme.rst index 88a4a12d6..42d954c46 100644 --- a/classes/class_theme.rst +++ b/classes/class_theme.rst @@ -8,6 +8,7 @@ Theme ===== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Theme for controls. +Properties +---------- + ++-------------------------+-----------------------------------------------+ +| :ref:`Font` | :ref:`default_font` | ++-------------------------+-----------------------------------------------+ + Methods ------- @@ -88,121 +96,128 @@ Property Descriptions .. _class_Theme_default_font: -- :ref:`Font` **default_font** - The theme's default font. +- :ref:`Font` **default_font** ++----------+-------------------------+ +| *Setter* | set_default_font(value) | ++----------+-------------------------+ +| *Getter* | get_default_font() | ++----------+-------------------------+ + +The theme's default font. Method Descriptions ------------------- -.. _class_Theme_clear_color: + .. _class_Theme_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_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_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_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_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_copy_default_theme: - void **copy_default_theme** **(** **)** Sets theme values to a copy of the default theme values. -.. _class_Theme_get_color: + .. _class_Theme_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_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``. -.. _class_Theme_get_constant: + .. _class_Theme_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_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``. -.. _class_Theme_get_font: + .. _class_Theme_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_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``. -.. _class_Theme_get_icon: + .. _class_Theme_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_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``. -.. _class_Theme_get_stylebox: + .. _class_Theme_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_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``. -.. _class_Theme_get_stylebox_types: + .. _class_Theme_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``. -.. _class_Theme_get_type_list: + .. _class_Theme_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_has_color: - :ref:`bool` **has_color** **(** :ref:`String` name, :ref:`String` type **)** const @@ -210,7 +225,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_has_constant: - :ref:`bool` **has_constant** **(** :ref:`String` name, :ref:`String` type **)** const @@ -218,7 +233,7 @@ Returns ``true`` if constant with ``name`` is in ``type``. Returns ``false`` if Theme does not have ``type``. -.. _class_Theme_has_font: + .. _class_Theme_has_font: - :ref:`bool` **has_font** **(** :ref:`String` name, :ref:`String` type **)** const @@ -226,7 +241,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_has_icon: - :ref:`bool` **has_icon** **(** :ref:`String` name, :ref:`String` type **)** const @@ -234,7 +249,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_has_stylebox: - :ref:`bool` **has_stylebox** **(** :ref:`String` name, :ref:`String` type **)** const @@ -242,7 +257,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_set_color: - void **set_color** **(** :ref:`String` name, :ref:`String` type, :ref:`Color` color **)** @@ -250,7 +265,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_set_constant: - void **set_constant** **(** :ref:`String` name, :ref:`String` type, :ref:`int` constant **)** @@ -258,7 +273,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_set_font: - void **set_font** **(** :ref:`String` name, :ref:`String` type, :ref:`Font` font **)** @@ -266,7 +281,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_set_icon: - void **set_icon** **(** :ref:`String` name, :ref:`String` type, :ref:`Texture` texture **)** @@ -274,7 +289,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_set_stylebox: - void **set_stylebox** **(** :ref:`String` name, :ref:`String` type, :ref:`StyleBox` texture **)** @@ -282,4 +297,3 @@ Sets Theme's :ref:`StyleBox` to ``stylebox`` at ``name`` in ``ty Does nothing if Theme does not have ``type``. - diff --git a/classes/class_thread.rst b/classes/class_thread.rst index 5851fcf9a..8b9a6ddf1 100644 --- a/classes/class_thread.rst +++ b/classes/class_thread.rst @@ -8,6 +8,7 @@ Thread ====== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -33,13 +34,12 @@ Enumerations .. _enum_Thread_Priority: -enum **Priority** +enum **Priority**: - **PRIORITY_LOW** = **0** - **PRIORITY_NORMAL** = **1** - **PRIORITY_HIGH** = **2** - Description ----------- @@ -48,19 +48,19 @@ A unit of execution in a process. Can run methods on :ref:`Object` Method Descriptions ------------------- -.. _class_Thread_get_id: + .. _class_Thread_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_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`. -.. _class_Thread_start: + .. _class_Thread_start: - :ref:`Error` **start** **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=null, :ref:`int` priority=1 **)** @@ -68,10 +68,9 @@ 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_wait_to_finish: - :ref:`Variant` **wait_to_finish** **(** **)** Joins the ``Thread`` and waits for it to finish. Returns what the method called returned. - diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index 3a81f30b7..4bd6d7cb6 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -8,6 +8,7 @@ TileMap ======= **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,41 @@ Brief Description 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` | ++--------------------------------------------+-----------------------------------------------------------------------+ + Methods ------- @@ -65,19 +101,18 @@ Methods Signals ------- -.. _class_TileMap_settings_changed: + .. _class_TileMap_settings_changed: - **settings_changed** **(** **)** Emitted when a tilemap setting has changed. - Enumerations ------------ .. _enum_TileMap_HalfOffset: -enum **HalfOffset** +enum **HalfOffset**: - **HALF_OFFSET_X** = **0** --- Half offset on the X coordinate. - **HALF_OFFSET_Y** = **1** --- Half offset on the Y coordinate. @@ -85,7 +120,7 @@ enum **HalfOffset** .. _enum_TileMap_TileOrigin: -enum **TileOrigin** +enum **TileOrigin**: - **TILE_ORIGIN_TOP_LEFT** = **0** --- Tile origin at its top-left corner. - **TILE_ORIGIN_CENTER** = **1** --- Tile origin at its center. @@ -93,18 +128,16 @@ enum **TileOrigin** .. _enum_TileMap_Mode: -enum **Mode** +enum **Mode**: - **MODE_SQUARE** = **0** --- Orthogonal orientation mode. - **MODE_ISOMETRIC** = **1** --- Isometric orientation mode. - **MODE_CUSTOM** = **2** --- Custom orientation mode. - Constants --------- - **INVALID_CELL** = **-1** --- Returned when a cell doesn't exist. - Description ----------- @@ -114,7 +147,6 @@ Tutorials --------- - :doc:`../tutorials/2d/using_tilemaps` - Property Descriptions --------------------- @@ -122,139 +154,256 @@ Property Descriptions - :ref:`bool` **cell_clip_uv** ++----------+--------------------+ +| *Setter* | set_clip_uv(value) | ++----------+--------------------+ +| *Getter* | get_clip_uv() | ++----------+--------------------+ + .. _class_TileMap_cell_custom_transform: -- :ref:`Transform2D` **cell_custom_transform** - The custom :ref:`Transform2D` to be applied to the TileMap's cells. +- :ref:`Transform2D` **cell_custom_transform** + ++----------+-----------------------------+ +| *Setter* | set_custom_transform(value) | ++----------+-----------------------------+ +| *Getter* | get_custom_transform() | ++----------+-----------------------------+ + +The custom :ref:`Transform2D` to be applied to the TileMap's cells. .. _class_TileMap_cell_half_offset: -- :ref:`HalfOffset` **cell_half_offset** - Amount to offset alternating tiles. Uses HALF_OFFSET\_\* constants. Default value: HALF_OFFSET_DISABLED. +- :ref:`HalfOffset` **cell_half_offset** + ++----------+------------------------+ +| *Setter* | set_half_offset(value) | ++----------+------------------------+ +| *Getter* | get_half_offset() | ++----------+------------------------+ + +Amount to offset alternating tiles. Uses HALF_OFFSET\_\* constants. Default value: HALF_OFFSET_DISABLED. .. _class_TileMap_cell_quadrant_size: -- :ref:`int` **cell_quadrant_size** - The TileMap's quadrant size. Optimizes drawing by batching, using chunks of this size. Default value: 16. +- :ref:`int` **cell_quadrant_size** + ++----------+--------------------------+ +| *Setter* | set_quadrant_size(value) | ++----------+--------------------------+ +| *Getter* | get_quadrant_size() | ++----------+--------------------------+ + +The TileMap's quadrant size. Optimizes drawing by batching, using chunks of this size. Default value: 16. .. _class_TileMap_cell_size: -- :ref:`Vector2` **cell_size** - The TileMap's cell size. +- :ref:`Vector2` **cell_size** + ++----------+----------------------+ +| *Setter* | set_cell_size(value) | ++----------+----------------------+ +| *Getter* | get_cell_size() | ++----------+----------------------+ + +The TileMap's cell size. .. _class_TileMap_cell_tile_origin: -- :ref:`TileOrigin` **cell_tile_origin** - Position for tile origin. Uses TILE_ORIGIN\_\* constants. Default value: TILE_ORIGIN_TOP_LEFT. +- :ref:`TileOrigin` **cell_tile_origin** + ++----------+------------------------+ +| *Setter* | set_tile_origin(value) | ++----------+------------------------+ +| *Getter* | get_tile_origin() | ++----------+------------------------+ + +Position for tile origin. Uses TILE_ORIGIN\_\* constants. Default value: TILE_ORIGIN_TOP_LEFT. .. _class_TileMap_cell_y_sort: -- :ref:`bool` **cell_y_sort** - If ``true`` the TileMap's children will be drawn in order of their Y coordinate. Default value: ``false``. +- :ref:`bool` **cell_y_sort** + ++----------+--------------------------+ +| *Setter* | set_y_sort_mode(value) | ++----------+--------------------------+ +| *Getter* | is_y_sort_mode_enabled() | ++----------+--------------------------+ + +If ``true`` the TileMap's children will be drawn in order of their Y coordinate. Default value: ``false``. .. _class_TileMap_collision_bounce: -- :ref:`float` **collision_bounce** - Bounce value for static body collisions (see ``collision_use_kinematic``). Default value: 0. +- :ref:`float` **collision_bounce** + ++----------+-----------------------------+ +| *Setter* | set_collision_bounce(value) | ++----------+-----------------------------+ +| *Getter* | get_collision_bounce() | ++----------+-----------------------------+ + +Bounce value for static body collisions (see ``collision_use_kinematic``). Default value: 0. .. _class_TileMap_collision_friction: -- :ref:`float` **collision_friction** - Friction value for static body collisions (see ``collision_use_kinematic``). Default value: 1. +- :ref:`float` **collision_friction** + ++----------+-------------------------------+ +| *Setter* | set_collision_friction(value) | ++----------+-------------------------------+ +| *Getter* | get_collision_friction() | ++----------+-------------------------------+ + +Friction value for static body collisions (see ``collision_use_kinematic``). Default value: 1. .. _class_TileMap_collision_layer: -- :ref:`int` **collision_layer** - The collision layer(s) for all colliders in the TileMap. +- :ref:`int` **collision_layer** + ++----------+----------------------------+ +| *Setter* | set_collision_layer(value) | ++----------+----------------------------+ +| *Getter* | get_collision_layer() | ++----------+----------------------------+ + +The collision layer(s) for all colliders in the TileMap. .. _class_TileMap_collision_mask: -- :ref:`int` **collision_mask** - The collision mask(s) for all colliders in the TileMap. +- :ref:`int` **collision_mask** + ++----------+---------------------------+ +| *Setter* | set_collision_mask(value) | ++----------+---------------------------+ +| *Getter* | get_collision_mask() | ++----------+---------------------------+ + +The collision mask(s) for all colliders in the TileMap. .. _class_TileMap_collision_use_kinematic: -- :ref:`bool` **collision_use_kinematic** - If ``true`` TileMap collisions will be handled as a kinematic body. If ``false`` collisions will be handled as static body. Default value: ``false``. +- :ref:`bool` **collision_use_kinematic** + ++----------+------------------------------------+ +| *Setter* | set_collision_use_kinematic(value) | ++----------+------------------------------------+ +| *Getter* | get_collision_use_kinematic() | ++----------+------------------------------------+ + +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: -- :ref:`Mode` **mode** - The TileMap orientation mode. Uses MODE\_\* constants. Default value: MODE_SQUARE. +- :ref:`Mode` **mode** + ++----------+-----------------+ +| *Setter* | set_mode(value) | ++----------+-----------------+ +| *Getter* | get_mode() | ++----------+-----------------+ + +The TileMap orientation mode. Uses MODE\_\* constants. Default value: MODE_SQUARE. .. _class_TileMap_occluder_light_mask: -- :ref:`int` **occluder_light_mask** - The light mask assigned to all light occluders in the TileMap. The TileSet's light occluders will cast shadows only from Light2D(s) that have the same light mask(s). +- :ref:`int` **occluder_light_mask** + ++----------+--------------------------------+ +| *Setter* | set_occluder_light_mask(value) | ++----------+--------------------------------+ +| *Getter* | get_occluder_light_mask() | ++----------+--------------------------------+ + +The light mask assigned to all light occluders in the TileMap. The TileSet's light occluders will cast shadows only from Light2D(s) that have the same light mask(s). .. _class_TileMap_tile_set: -- :ref:`TileSet` **tile_set** - The assigned :ref:`TileSet`. +- :ref:`TileSet` **tile_set** ++----------+--------------------+ +| *Setter* | set_tileset(value) | ++----------+--------------------+ +| *Getter* | get_tileset() | ++----------+--------------------+ + +The assigned :ref:`TileSet`. Method Descriptions ------------------- -.. _class_TileMap_clear: + .. _class_TileMap_clear: - void **clear** **(** **)** Clears all cells. -.. _class_TileMap_fix_invalid_tiles: + .. _class_TileMap_fix_invalid_tiles: - void **fix_invalid_tiles** **(** **)** Clears cells that do not exist in the tileset. -.. _class_TileMap_get_cell: + .. _class_TileMap_get_cell: - :ref:`int` **get_cell** **(** :ref:`int` x, :ref:`int` y **)** const Returns the tile index of the given cell. -.. _class_TileMap_get_cellv: + .. _class_TileMap_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_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_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_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_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_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_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_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_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_map_to_world: - :ref:`Vector2` **map_to_world** **(** :ref:`Vector2` map_position, :ref:`bool` ignore_half_ofs=false **)** const @@ -262,7 +411,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_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 ) **)** @@ -276,7 +425,7 @@ Note that data such as navigation polygons and collision shapes are not immediat If you need these to be immediately updated, you can call :ref:`update_dirty_quadrants`. -.. _class_TileMap_set_cellv: + .. _class_TileMap_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 **)** @@ -290,25 +439,25 @@ Note that data such as navigation polygons and collision shapes are not immediat If you need these to be immediately updated, you can call :ref:`update_dirty_quadrants`. -.. _class_TileMap_set_collision_layer_bit: + .. _class_TileMap_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_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_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_update_bitmask_region: - void **update_bitmask_region** **(** :ref:`Vector2` start=Vector2( 0, 0 ), :ref:`Vector2` end=Vector2( 0, 0 ) **)** @@ -316,16 +465,15 @@ 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_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_world_to_map: - :ref:`Vector2` **world_to_map** **(** :ref:`Vector2` world_position **)** const Returns the tilemap (grid-based) coordinatescorresponding to the given global position. - diff --git a/classes/class_tileset.rst b/classes/class_tileset.rst index 20b043d7a..33fa68a2d 100644 --- a/classes/class_tileset.rst +++ b/classes/class_tileset.rst @@ -8,6 +8,7 @@ TileSet ======= **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -125,7 +126,7 @@ Enumerations .. _enum_TileSet_BitmaskMode: -enum **BitmaskMode** +enum **BitmaskMode**: - **BITMASK_2X2** = **0** - **BITMASK_3X3_MINIMAL** = **1** @@ -133,7 +134,7 @@ enum **BitmaskMode** .. _enum_TileSet_TileMode: -enum **TileMode** +enum **TileMode**: - **SINGLE_TILE** = **0** - **AUTO_TILE** = **1** @@ -141,7 +142,7 @@ enum **TileMode** .. _enum_TileSet_AutotileBindings: -enum **AutotileBindings** +enum **AutotileBindings**: - **BIND_TOPLEFT** = **1** - **BIND_TOP** = **2** @@ -152,7 +153,6 @@ enum **AutotileBindings** - **BIND_BOTTOM** = **128** - **BIND_BOTTOMRIGHT** = **256** - Description ----------- @@ -163,264 +163,263 @@ Tiles are referenced by a unique integer ID. Method Descriptions ------------------- -.. _class_TileSet__forward_subtile_selection: + .. _class_TileSet__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__is_tile_bound: - :ref:`bool` **_is_tile_bound** **(** :ref:`int` drawn_id, :ref:`int` neighbor_id **)** virtual -.. _class_TileSet_autotile_get_bitmask_mode: + .. _class_TileSet_autotile_get_bitmask_mode: - :ref:`BitmaskMode` **autotile_get_bitmask_mode** **(** :ref:`int` id **)** const -.. _class_TileSet_autotile_get_size: + .. _class_TileSet_autotile_get_size: - :ref:`Vector2` **autotile_get_size** **(** :ref:`int` id **)** const -.. _class_TileSet_autotile_set_bitmask_mode: + .. _class_TileSet_autotile_set_bitmask_mode: - void **autotile_set_bitmask_mode** **(** :ref:`int` id, :ref:`BitmaskMode` mode **)** -.. _class_TileSet_autotile_set_size: + .. _class_TileSet_autotile_set_size: - void **autotile_set_size** **(** :ref:`int` id, :ref:`Vector2` size **)** -.. _class_TileSet_clear: + .. _class_TileSet_clear: - void **clear** **(** **)** Clears all tiles. -.. _class_TileSet_create_tile: + .. _class_TileSet_create_tile: - void **create_tile** **(** :ref:`int` id **)** Creates a new tile which will be referenced by the given ID. -.. _class_TileSet_find_tile_by_name: + .. _class_TileSet_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_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_get_tiles_ids: - :ref:`Array` **get_tiles_ids** **(** **)** const Returns an array of all currently used tile IDs. -.. _class_TileSet_remove_tile: + .. _class_TileSet_remove_tile: - void **remove_tile** **(** :ref:`int` id **)** Removes the tile referenced by the given ID. -.. _class_TileSet_tile_add_shape: + .. _class_TileSet_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 ) **)** -.. _class_TileSet_tile_get_light_occluder: + .. _class_TileSet_tile_get_light_occluder: - :ref:`OccluderPolygon2D` **tile_get_light_occluder** **(** :ref:`int` id **)** const Returns the light occluder of the tile. -.. _class_TileSet_tile_get_material: + .. _class_TileSet_tile_get_material: - :ref:`ShaderMaterial` **tile_get_material** **(** :ref:`int` id **)** const Returns the material of the tile. -.. _class_TileSet_tile_get_modulate: + .. _class_TileSet_tile_get_modulate: - :ref:`Color` **tile_get_modulate** **(** :ref:`int` id **)** const -.. _class_TileSet_tile_get_name: + .. _class_TileSet_tile_get_name: - :ref:`String` **tile_get_name** **(** :ref:`int` id **)** const Returns the name of the tile. -.. _class_TileSet_tile_get_navigation_polygon: + .. _class_TileSet_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_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_tile_get_normal_map: - :ref:`Texture` **tile_get_normal_map** **(** :ref:`int` id **)** const -.. _class_TileSet_tile_get_occluder_offset: + .. _class_TileSet_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_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_tile_get_shape: - :ref:`Shape2D` **tile_get_shape** **(** :ref:`int` id, :ref:`int` shape_id **)** const -.. _class_TileSet_tile_get_shape_count: + .. _class_TileSet_tile_get_shape_count: - :ref:`int` **tile_get_shape_count** **(** :ref:`int` id **)** const -.. _class_TileSet_tile_get_shape_offset: + .. _class_TileSet_tile_get_shape_offset: - :ref:`Vector2` **tile_get_shape_offset** **(** :ref:`int` id, :ref:`int` shape_id **)** const -.. _class_TileSet_tile_get_shape_one_way: + .. _class_TileSet_tile_get_shape_one_way: - :ref:`bool` **tile_get_shape_one_way** **(** :ref:`int` id, :ref:`int` shape_id **)** const -.. _class_TileSet_tile_get_shape_transform: + .. _class_TileSet_tile_get_shape_transform: - :ref:`Transform2D` **tile_get_shape_transform** **(** :ref:`int` id, :ref:`int` shape_id **)** const -.. _class_TileSet_tile_get_shapes: + .. _class_TileSet_tile_get_shapes: - :ref:`Array` **tile_get_shapes** **(** :ref:`int` id **)** const Returns the array of shapes of the tile. -.. _class_TileSet_tile_get_texture: + .. _class_TileSet_tile_get_texture: - :ref:`Texture` **tile_get_texture** **(** :ref:`int` id **)** const Returns the texture of the tile. -.. _class_TileSet_tile_get_texture_offset: + .. _class_TileSet_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_tile_get_tile_mode: - :ref:`TileMode` **tile_get_tile_mode** **(** :ref:`int` id **)** const -.. _class_TileSet_tile_get_z_index: + .. _class_TileSet_tile_get_z_index: - :ref:`int` **tile_get_z_index** **(** :ref:`int` id **)** const -.. _class_TileSet_tile_set_light_occluder: + .. _class_TileSet_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_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_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_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_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_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_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_tile_set_occluder_offset: - void **tile_set_occluder_offset** **(** :ref:`int` id, :ref:`Vector2` occluder_offset **)** Set an offset for the tile's light occluder. -.. _class_TileSet_tile_set_region: + .. _class_TileSet_tile_set_region: - void **tile_set_region** **(** :ref:`int` id, :ref:`Rect2` region **)** Set the tile's sub-region in the texture. This is common in texture atlases. -.. _class_TileSet_tile_set_shape: + .. _class_TileSet_tile_set_shape: - void **tile_set_shape** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Shape2D` shape **)** -.. _class_TileSet_tile_set_shape_offset: + .. _class_TileSet_tile_set_shape_offset: - void **tile_set_shape_offset** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Vector2` shape_offset **)** -.. _class_TileSet_tile_set_shape_one_way: + .. _class_TileSet_tile_set_shape_one_way: - void **tile_set_shape_one_way** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`bool` one_way **)** -.. _class_TileSet_tile_set_shape_transform: + .. _class_TileSet_tile_set_shape_transform: - void **tile_set_shape_transform** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Transform2D` shape_transform **)** -.. _class_TileSet_tile_set_shapes: + .. _class_TileSet_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_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_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_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_tile_set_z_index: - void **tile_set_z_index** **(** :ref:`int` id, :ref:`int` z_index **)** Sets the tile's drawing index. - diff --git a/classes/class_timer.rst b/classes/class_timer.rst index 2c6da7290..238fef8b7 100644 --- a/classes/class_timer.rst +++ b/classes/class_timer.rst @@ -8,6 +8,7 @@ Timer ===== **Inherits:** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,23 @@ Brief Description 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` | ++------------------------------------------------------+-----------------------------------------------+ + Methods ------- @@ -29,24 +47,22 @@ Methods Signals ------- -.. _class_Timer_timeout: + .. _class_Timer_timeout: - **timeout** **(** **)** Emitted when the Timer reaches 0. - Enumerations ------------ .. _enum_Timer_TimerProcessMode: -enum **TimerProcessMode** +enum **TimerProcessMode**: - **TIMER_PROCESS_PHYSICS** = **0** --- Update the Timer during the physics step at each frame (fixed framerate processing). - **TIMER_PROCESS_IDLE** = **1** --- Update the Timer during the idle time at each frame. - Description ----------- @@ -57,39 +73,84 @@ Property Descriptions .. _class_Timer_autostart: -- :ref:`bool` **autostart** - If ``true``, Timer will automatically start when entering the scene tree. Default value: ``false``. +- :ref:`bool` **autostart** + ++----------+----------------------+ +| *Setter* | set_autostart(value) | ++----------+----------------------+ +| *Getter* | has_autostart() | ++----------+----------------------+ + +If ``true``, Timer will automatically start when entering the scene tree. Default value: ``false``. .. _class_Timer_one_shot: -- :ref:`bool` **one_shot** - If ``true``, Timer will stop when reaching 0. If ``false``, it will restart. Default value: ``false``. +- :ref:`bool` **one_shot** + ++----------+---------------------+ +| *Setter* | set_one_shot(value) | ++----------+---------------------+ +| *Getter* | is_one_shot() | ++----------+---------------------+ + +If ``true``, Timer will stop when reaching 0. If ``false``, it will restart. Default value: ``false``. .. _class_Timer_paused: -- :ref:`bool` **paused** - If ``true``, the timer is paused and will not process until it is unpaused again, even if :ref:`start` is called. +- :ref:`bool` **paused** + ++----------+-------------------+ +| *Setter* | set_paused(value) | ++----------+-------------------+ +| *Getter* | is_paused() | ++----------+-------------------+ + +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: -- :ref:`TimerProcessMode` **process_mode** - Processing mode. Uses TIMER_PROCESS\_\* constants as value. +- :ref:`TimerProcessMode` **process_mode** + ++----------+-------------------------------+ +| *Setter* | set_timer_process_mode(value) | ++----------+-------------------------------+ +| *Getter* | get_timer_process_mode() | ++----------+-------------------------------+ + +Processing mode. Uses TIMER_PROCESS\_\* constants as value. .. _class_Timer_time_left: -- :ref:`float` **time_left** - The timer's remaining time in seconds. Returns 0 if the timer is inactive. +- :ref:`float` **time_left** + ++----------+-----------------+ +| *Getter* | get_time_left() | ++----------+-----------------+ + +The timer's remaining time in seconds. Returns 0 if the timer is inactive. .. _class_Timer_wait_time: -- :ref:`float` **wait_time** - Wait time in seconds. +- :ref:`float` **wait_time** ++----------+----------------------+ +| *Setter* | set_wait_time(value) | ++----------+----------------------+ +| *Getter* | get_wait_time() | ++----------+----------------------+ + +Wait time in seconds. Method Descriptions ------------------- -.. _class_Timer_is_stopped: + .. _class_Timer_is_stopped: - :ref:`bool` **is_stopped** **(** **)** const Returns ``true`` if the timer is stopped. -.. _class_Timer_start: + .. _class_Timer_start: - void **start** **(** :ref:`float` time_sec=-1 **)** @@ -97,10 +158,9 @@ Starts the timer. Sets ``wait_time`` to ``time_sec`` if ``time_sec`` > 0. This a Note: this method will not resume a paused timer. See :ref:`set_paused`. -.. _class_Timer_stop: + .. _class_Timer_stop: - void **stop** **(** **)** Stop (cancel) the Timer. - diff --git a/classes/class_toolbutton.rst b/classes/class_toolbutton.rst index 65c21889b..308f89d06 100644 --- a/classes/class_toolbutton.rst +++ b/classes/class_toolbutton.rst @@ -8,6 +8,7 @@ ToolButton ========== **Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,33 @@ Brief Description 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` | ++---------------------------------+------------------------------------------------------------------+ + Description ----------- diff --git a/classes/class_touchscreenbutton.rst b/classes/class_touchscreenbutton.rst index a139a1b43..2979be3a6 100644 --- a/classes/class_touchscreenbutton.rst +++ b/classes/class_touchscreenbutton.rst @@ -8,6 +8,7 @@ TouchScreenButton ================= **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,29 @@ Brief Description 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` | ++--------------------------------------------------------------+-----------------------------------------------------------------+ + Methods ------- @@ -25,30 +49,28 @@ Methods Signals ------- -.. _class_TouchScreenButton_pressed: + .. _class_TouchScreenButton_pressed: - **pressed** **(** **)** Emitted when the button is pressed (down). -.. _class_TouchScreenButton_released: + .. _class_TouchScreenButton_released: - **released** **(** **)** Emitted when the button is released (up). - Enumerations ------------ .. _enum_TouchScreenButton_VisibilityMode: -enum **VisibilityMode** +enum **VisibilityMode**: - **VISIBILITY_ALWAYS** = **0** --- Always visible. - **VISIBILITY_TOUCHSCREEN_ONLY** = **1** --- Visible on touch screens only. - Description ----------- @@ -59,48 +81,118 @@ Property Descriptions .. _class_TouchScreenButton_action: -- :ref:`String` **action** - The button's action. Actions can be handled with :ref:`InputEventAction`. +- :ref:`String` **action** + ++----------+-------------------+ +| *Setter* | set_action(value) | ++----------+-------------------+ +| *Getter* | get_action() | ++----------+-------------------+ + +The button's action. Actions can be handled with :ref:`InputEventAction`. .. _class_TouchScreenButton_bitmask: -- :ref:`BitMap` **bitmask** - The button's bitmask. +- :ref:`BitMap` **bitmask** + ++----------+--------------------+ +| *Setter* | set_bitmask(value) | ++----------+--------------------+ +| *Getter* | get_bitmask() | ++----------+--------------------+ + +The button's bitmask. .. _class_TouchScreenButton_normal: -- :ref:`Texture` **normal** - The button's texture for the normal state. +- :ref:`Texture` **normal** + ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + +The button's texture for the normal state. .. _class_TouchScreenButton_passby_press: -- :ref:`bool` **passby_press** - If ``true`` passby presses are enabled. +- :ref:`bool` **passby_press** + ++----------+---------------------------+ +| *Setter* | set_passby_press(value) | ++----------+---------------------------+ +| *Getter* | is_passby_press_enabled() | ++----------+---------------------------+ + +If ``true`` passby presses are enabled. .. _class_TouchScreenButton_pressed: -- :ref:`Texture` **pressed** - The button's texture for the pressed state. +- :ref:`Texture` **pressed** + ++----------+----------------------------+ +| *Setter* | set_texture_pressed(value) | ++----------+----------------------------+ +| *Getter* | get_texture_pressed() | ++----------+----------------------------+ + +The button's texture for the pressed state. .. _class_TouchScreenButton_shape: -- :ref:`Shape2D` **shape** - The button's shape. +- :ref:`Shape2D` **shape** + ++----------+------------------+ +| *Setter* | set_shape(value) | ++----------+------------------+ +| *Getter* | get_shape() | ++----------+------------------+ + +The button's shape. .. _class_TouchScreenButton_shape_centered: -- :ref:`bool` **shape_centered** - If ``true`` the button's shape is centered. +- :ref:`bool` **shape_centered** + ++----------+---------------------------+ +| *Setter* | set_shape_centered(value) | ++----------+---------------------------+ +| *Getter* | is_shape_centered() | ++----------+---------------------------+ + +If ``true`` the button's shape is centered. .. _class_TouchScreenButton_shape_visible: -- :ref:`bool` **shape_visible** - If ``true`` the button's shape is visible. +- :ref:`bool` **shape_visible** + ++----------+--------------------------+ +| *Setter* | set_shape_visible(value) | ++----------+--------------------------+ +| *Getter* | is_shape_visible() | ++----------+--------------------------+ + +If ``true`` the button's shape is visible. .. _class_TouchScreenButton_visibility_mode: -- :ref:`VisibilityMode` **visibility_mode** - The button's visibility mode. See ``VISIBILITY_*`` constants. +- :ref:`VisibilityMode` **visibility_mode** ++----------+----------------------------+ +| *Setter* | set_visibility_mode(value) | ++----------+----------------------------+ +| *Getter* | get_visibility_mode() | ++----------+----------------------------+ + +The button's visibility mode. See ``VISIBILITY_*`` constants. Method Descriptions ------------------- -.. _class_TouchScreenButton_is_pressed: + .. _class_TouchScreenButton_is_pressed: - :ref:`bool` **is_pressed** **(** **)** const Returns ``true`` if this button is currently pressed. - diff --git a/classes/class_transform.rst b/classes/class_transform.rst index 3dd1aa025..51eaf1089 100644 --- a/classes/class_transform.rst +++ b/classes/class_transform.rst @@ -14,6 +14,15 @@ Brief Description 3D Transformation. 3x4 matrix. +Properties +---------- + ++-------------------------------+---------------------------------------+ +| :ref:`Basis` | :ref:`basis` | ++-------------------------------+---------------------------------------+ +| :ref:`Vector3` | :ref:`origin` | ++-------------------------------+---------------------------------------+ + Methods ------- @@ -56,7 +65,6 @@ Constants - **FLIP_X** = **Transform( -1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )** - **FLIP_Y** = **Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )** - **FLIP_Z** = **Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )** - Description ----------- @@ -67,71 +75,73 @@ Tutorials - :doc:`../tutorials/math/index` - :doc:`../tutorials/3d/using_transforms` - Property Descriptions --------------------- .. _class_Transform_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. +- :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: -- :ref:`Vector3` **origin** - The translation offset of the transform. +- :ref:`Vector3` **origin** +The translation offset of the transform. Method Descriptions ------------------- -.. _class_Transform_Transform: + .. _class_Transform_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: + .. _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: + .. _class_Transform_Transform: - :ref:`Transform` **Transform** **(** :ref:`Transform2D` from **)** Constructs the Transform from a :ref:`Transform2D`. -.. _class_Transform_Transform: + .. _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: + .. _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_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_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_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_looking_at: - :ref:`Transform` **looking_at** **(** :ref:`Vector3` target, :ref:`Vector3` up **)** @@ -141,40 +151,39 @@ 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_orthonormalized: - :ref:`Transform` **orthonormalized** **(** **)** Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors. -.. _class_Transform_rotated: + .. _class_Transform_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_scaled: - :ref:`Transform` **scaled** **(** :ref:`Vector3` scale **)** Scales the transform by the specified 3D scaling factors. -.. _class_Transform_translated: + .. _class_Transform_translated: - :ref:`Transform` **translated** **(** :ref:`Vector3` ofs **)** Translates the transform by the specified offset. -.. _class_Transform_xform: + .. _class_Transform_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_xform_inv: - :ref:`Variant` **xform_inv** **(** :ref:`Variant` v **)** Inverse-transforms the given :ref:`Vector3`, :ref:`Plane`, or :ref:`AABB` by this transform. - diff --git a/classes/class_transform2d.rst b/classes/class_transform2d.rst index d68574f5a..b43db4c29 100644 --- a/classes/class_transform2d.rst +++ b/classes/class_transform2d.rst @@ -14,6 +14,17 @@ Brief Description 2D Transformation. 3x2 matrix. +Properties +---------- + ++-------------------------------+-----------------------------------------+ +| :ref:`Vector2` | :ref:`origin` | ++-------------------------------+-----------------------------------------+ +| :ref:`Vector2` | :ref:`x` | ++-------------------------------+-----------------------------------------+ +| :ref:`Vector2` | :ref:`y` | ++-------------------------------+-----------------------------------------+ + Methods ------- @@ -59,7 +70,6 @@ Constants - **IDENTITY** = **Transform2D( 1, 0, 0, 1, 0, 0 )** - **FLIP_X** = **Transform2D( -1, 0, 0, 1, 0, 0 )** - **FLIP_Y** = **Transform2D( 1, 0, 0, -1, 0, 0 )** - Description ----------- @@ -70,120 +80,124 @@ Property Descriptions .. _class_Transform2D_origin: -- :ref:`Vector2` **origin** - The transform's translation offset. +- :ref:`Vector2` **origin** + +The transform's translation offset. .. _class_Transform2D_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. +- :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: -- :ref:`Vector2` **y** - The Y 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. +- :ref:`Vector2` **y** +The Y 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. Method Descriptions ------------------- -.. _class_Transform2D_Transform2D: + .. _class_Transform2D_Transform2D: - :ref:`Transform2D` **Transform2D** **(** :ref:`Transform` from **)** Constructs the transform from a 3D :ref:`Transform`. -.. _class_Transform2D_Transform2D: + .. _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: + .. _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_affine_inverse: - :ref:`Transform2D` **affine_inverse** **(** **)** Returns the inverse of the matrix. -.. _class_Transform2D_basis_xform: + .. _class_Transform2D_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_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_get_origin: - :ref:`Vector2` **get_origin** **(** **)** Returns the transform's origin (translation). -.. _class_Transform2D_get_rotation: + .. _class_Transform2D_get_rotation: - :ref:`float` **get_rotation** **(** **)** Returns the transform's rotation (in radians). -.. _class_Transform2D_get_scale: + .. _class_Transform2D_get_scale: - :ref:`Vector2` **get_scale** **(** **)** Returns the scale. -.. _class_Transform2D_interpolate_with: + .. _class_Transform2D_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_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_orthonormalized: - :ref:`Transform2D` **orthonormalized** **(** **)** Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors. -.. _class_Transform2D_rotated: + .. _class_Transform2D_rotated: - :ref:`Transform2D` **rotated** **(** :ref:`float` phi **)** Rotates the transform by the given angle (in radians). -.. _class_Transform2D_scaled: + .. _class_Transform2D_scaled: - :ref:`Transform2D` **scaled** **(** :ref:`Vector2` scale **)** Scales the transform by the given factor. -.. _class_Transform2D_translated: + .. _class_Transform2D_translated: - :ref:`Transform2D` **translated** **(** :ref:`Vector2` offset **)** Translates the transform by the given offset. -.. _class_Transform2D_xform: + .. _class_Transform2D_xform: - :ref:`Variant` **xform** **(** :ref:`Variant` v **)** Transforms the given :ref:`Vector2` or :ref:`Rect2` by this transform. -.. _class_Transform2D_xform_inv: + .. _class_Transform2D_xform_inv: - :ref:`Variant` **xform_inv** **(** :ref:`Variant` v **)** Inverse-transforms the given :ref:`Vector2` or :ref:`Rect2` by this transform. - diff --git a/classes/class_translation.rst b/classes/class_translation.rst index 98819b3d5..e236b75ef 100644 --- a/classes/class_translation.rst +++ b/classes/class_translation.rst @@ -8,7 +8,9 @@ Translation =========== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`PHashTranslation` + **Category:** Core Brief Description @@ -16,6 +18,13 @@ Brief Description Language Translation. +Properties +---------- + ++-----------------------------+-----------------------------------------+ +| :ref:`String` | :ref:`locale` | ++-----------------------------+-----------------------------------------+ + Methods ------- @@ -43,36 +52,40 @@ Property Descriptions - :ref:`String` **locale** ++----------+-------------------+ +| *Setter* | set_locale(value) | ++----------+-------------------+ +| *Getter* | get_locale() | ++----------+-------------------+ Method Descriptions ------------------- -.. _class_Translation_add_message: + .. _class_Translation_add_message: - void **add_message** **(** :ref:`String` src_message, :ref:`String` xlated_message **)** Add a message for translation. -.. _class_Translation_erase_message: + .. _class_Translation_erase_message: - void **erase_message** **(** :ref:`String` src_message **)** Erase a message. -.. _class_Translation_get_message: + .. _class_Translation_get_message: - :ref:`String` **get_message** **(** :ref:`String` src_message **)** const Return a message for translation. -.. _class_Translation_get_message_count: + .. _class_Translation_get_message_count: - :ref:`int` **get_message_count** **(** **)** const -.. _class_Translation_get_message_list: + .. _class_Translation_get_message_list: - :ref:`PoolStringArray` **get_message_list** **(** **)** const Return all the messages (keys). - diff --git a/classes/class_translationserver.rst b/classes/class_translationserver.rst index b38814ccb..12e2ef323 100644 --- a/classes/class_translationserver.rst +++ b/classes/class_translationserver.rst @@ -8,6 +8,7 @@ TranslationServer ================= **Inherits:** :ref:`Object` + **Category:** Core Brief Description @@ -37,32 +38,31 @@ Methods Method Descriptions ------------------- -.. _class_TranslationServer_add_translation: + .. _class_TranslationServer_add_translation: - void **add_translation** **(** :ref:`Translation` translation **)** -.. _class_TranslationServer_clear: + .. _class_TranslationServer_clear: - void **clear** **(** **)** -.. _class_TranslationServer_get_locale: + .. _class_TranslationServer_get_locale: - :ref:`String` **get_locale** **(** **)** const -.. _class_TranslationServer_get_locale_name: + .. _class_TranslationServer_get_locale_name: - :ref:`String` **get_locale_name** **(** :ref:`String` locale **)** const -.. _class_TranslationServer_remove_translation: + .. _class_TranslationServer_remove_translation: - void **remove_translation** **(** :ref:`Translation` translation **)** -.. _class_TranslationServer_set_locale: + .. _class_TranslationServer_set_locale: - void **set_locale** **(** :ref:`String` locale **)** -.. _class_TranslationServer_translate: + .. _class_TranslationServer_translate: - :ref:`String` **translate** **(** :ref:`String` message **)** const - diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 09e4a50e2..613d4edc9 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -8,6 +8,7 @@ Tree ==== **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,25 @@ Brief Description 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` | ++-----------------------------------------+------------------------------------------------------+ + Methods ------- @@ -66,102 +86,182 @@ Methods | 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_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` | ++---------------------------------+------------------------------------------------------------------------------+ + Signals ------- -.. _class_Tree_button_pressed: + .. _class_Tree_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`). -.. _class_Tree_cell_selected: + .. _class_Tree_cell_selected: - **cell_selected** **(** **)** Emitted when a cell is selected. -.. _class_Tree_column_title_pressed: + .. _class_Tree_column_title_pressed: - **column_title_pressed** **(** :ref:`int` column **)** Emitted when a column's title is pressed. -.. _class_Tree_custom_popup_edited: + .. _class_Tree_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_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_item_activated: - **item_activated** **(** **)** Emitted when an item's label is double-clicked. -.. _class_Tree_item_collapsed: + .. _class_Tree_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_item_custom_button_pressed: - **item_custom_button_pressed** **(** **)** -.. _class_Tree_item_double_clicked: + .. _class_Tree_item_double_clicked: - **item_double_clicked** **(** **)** Emitted when an item's icon is double-clicked. -.. _class_Tree_item_edited: + .. _class_Tree_item_edited: - **item_edited** **(** **)** Emitted when an item is edited. -.. _class_Tree_item_rmb_edited: + .. _class_Tree_item_rmb_edited: - **item_rmb_edited** **(** **)** Emitted when an item is edited using the right mouse button. -.. _class_Tree_item_rmb_selected: + .. _class_Tree_item_rmb_selected: - **item_rmb_selected** **(** :ref:`Vector2` position **)** Emitted when an item is selected with right mouse button. -.. _class_Tree_item_selected: + .. _class_Tree_item_selected: - **item_selected** **(** **)** Emitted when an item is selected with right mouse button. -.. _class_Tree_multi_selected: + .. _class_Tree_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_nothing_selected: - **nothing_selected** **(** **)** - Enumerations ------------ .. _enum_Tree_DropModeFlags: -enum **DropModeFlags** +enum **DropModeFlags**: - **DROP_MODE_DISABLED** = **0** - **DROP_MODE_ON_ITEM** = **1** @@ -169,13 +269,12 @@ enum **DropModeFlags** .. _enum_Tree_SelectMode: -enum **SelectMode** +enum **SelectMode**: - **SELECT_SINGLE** = **0** --- Allow selection of a single item at a time. - **SELECT_ROW** = **1** - **SELECT_MULTI** = **2** --- Allow selection of multiple items at the same time. - Description ----------- @@ -199,85 +298,140 @@ Property Descriptions .. _class_Tree_allow_reselect: -- :ref:`bool` **allow_reselect** - If ``true`` the currently selected cell may be selected again. +- :ref:`bool` **allow_reselect** + ++----------+---------------------------+ +| *Setter* | set_allow_reselect(value) | ++----------+---------------------------+ +| *Getter* | get_allow_reselect() | ++----------+---------------------------+ + +If ``true`` the currently selected cell may be selected again. .. _class_Tree_allow_rmb_select: -- :ref:`bool` **allow_rmb_select** - If ``true`` a right mouse button click can select items. +- :ref:`bool` **allow_rmb_select** + ++----------+-----------------------------+ +| *Setter* | set_allow_rmb_select(value) | ++----------+-----------------------------+ +| *Getter* | get_allow_rmb_select() | ++----------+-----------------------------+ + +If ``true`` a right mouse button click can select items. .. _class_Tree_columns: -- :ref:`int` **columns** - The amount of columns. +- :ref:`int` **columns** + ++----------+--------------------+ +| *Setter* | set_columns(value) | ++----------+--------------------+ +| *Getter* | get_columns() | ++----------+--------------------+ + +The amount of columns. .. _class_Tree_drop_mode_flags: -- :ref:`int` **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:`can_drop_data` is recommended. +- :ref:`int` **drop_mode_flags** + ++----------+----------------------------+ +| *Setter* | set_drop_mode_flags(value) | ++----------+----------------------------+ +| *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:`can_drop_data` is recommended. .. _class_Tree_hide_folding: -- :ref:`bool` **hide_folding** - If ``true`` the folding arrow is hidden. +- :ref:`bool` **hide_folding** + ++----------+-------------------------+ +| *Setter* | set_hide_folding(value) | ++----------+-------------------------+ +| *Getter* | is_folding_hidden() | ++----------+-------------------------+ + +If ``true`` the folding arrow is hidden. .. _class_Tree_hide_root: -- :ref:`bool` **hide_root** - If ``true`` the tree's root is hidden. +- :ref:`bool` **hide_root** + ++----------+----------------------+ +| *Setter* | set_hide_root(value) | ++----------+----------------------+ +| *Getter* | is_root_hidden() | ++----------+----------------------+ + +If ``true`` the tree's root is hidden. .. _class_Tree_select_mode: -- :ref:`SelectMode` **select_mode** - Allow single or multiple selection. See the ``SELECT_*`` constants. +- :ref:`SelectMode` **select_mode** ++----------+------------------------+ +| *Setter* | set_select_mode(value) | ++----------+------------------------+ +| *Getter* | get_select_mode() | ++----------+------------------------+ + +Allow single or multiple selection. See the ``SELECT_*`` constants. Method Descriptions ------------------- -.. _class_Tree_are_column_titles_visible: + .. _class_Tree_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_clear: - void **clear** **(** **)** Clears the tree. This removes all items. -.. _class_Tree_create_item: + .. _class_Tree_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_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_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_get_column_title: - :ref:`String` **get_column_title** **(** :ref:`int` column **)** const Returns the column's title. -.. _class_Tree_get_column_width: + .. _class_Tree_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_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`. -.. _class_Tree_get_drop_section_at_position: + .. _class_Tree_get_drop_section_at_position: - :ref:`int` **get_drop_section_at_position** **(** :ref:`Vector2` position **)** const @@ -285,88 +439,87 @@ If :ref:`drop_mode_flags` includes ``DROP_MODE_INBET Otherwise, returns 0. If there are no tree item at ``position``, returns -100. -.. _class_Tree_get_edited: + .. _class_Tree_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_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_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_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_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_get_pressed_button: - :ref:`int` **get_pressed_button** **(** **)** const Returns the last pressed button's index. -.. _class_Tree_get_root: + .. _class_Tree_get_root: - :ref:`TreeItem` **get_root** **(** **)** Returns the tree's root item. -.. _class_Tree_get_scroll: + .. _class_Tree_get_scroll: - :ref:`Vector2` **get_scroll** **(** **)** const Returns the current scrolling position. -.. _class_Tree_get_selected: + .. _class_Tree_get_selected: - :ref:`TreeItem` **get_selected** **(** **)** const Returns the currently selected item. -.. _class_Tree_get_selected_column: + .. _class_Tree_get_selected_column: - :ref:`int` **get_selected_column** **(** **)** const Returns the current selection's column. -.. _class_Tree_set_column_expand: + .. _class_Tree_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_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_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_set_column_titles_visible: - void **set_column_titles_visible** **(** :ref:`bool` visible **)** If ``true`` column titles are visible. - diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index 721e5d230..58c7de428 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -8,6 +8,7 @@ TreeItem ======== **Inherits:** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,17 @@ Brief Description 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` | ++-------------------------+--------------------------------------------------------------------+ + Methods ------- @@ -133,7 +145,7 @@ Enumerations .. _enum_TreeItem_TreeCellMode: -enum **TreeCellMode** +enum **TreeCellMode**: - **CELL_MODE_STRING** = **0** --- Cell contains a string. - **CELL_MODE_CHECK** = **1** --- Cell can be checked. @@ -144,13 +156,12 @@ enum **TreeCellMode** .. _enum_TreeItem_TextAlign: -enum **TextAlign** +enum **TextAlign**: - **ALIGN_LEFT** = **0** --- Align text to the left. See ``set_text_align()``. - **ALIGN_CENTER** = **1** --- Center text. See ``set_text_align()``. - **ALIGN_RIGHT** = **2** --- Align text to the right. See ``set_text_align()``. - Description ----------- @@ -161,324 +172,346 @@ Property Descriptions .. _class_TreeItem_collapsed: -- :ref:`bool` **collapsed** - If ``true`` the TreeItem is collapsed. +- :ref:`bool` **collapsed** + ++----------+----------------------+ +| *Setter* | set_collapsed(value) | ++----------+----------------------+ +| *Getter* | is_collapsed() | ++----------+----------------------+ + +If ``true`` the TreeItem is collapsed. .. _class_TreeItem_custom_minimum_height: -- :ref:`int` **custom_minimum_height** - The custom minimum height. +- :ref:`int` **custom_minimum_height** + ++----------+----------------------------------+ +| *Setter* | set_custom_minimum_height(value) | ++----------+----------------------------------+ +| *Getter* | get_custom_minimum_height() | ++----------+----------------------------------+ + +The custom minimum height. .. _class_TreeItem_disable_folding: -- :ref:`bool` **disable_folding** - If ``true`` folding is disabled for this TreeItem. +- :ref:`bool` **disable_folding** ++----------+----------------------------+ +| *Setter* | set_disable_folding(value) | ++----------+----------------------------+ +| *Getter* | is_folding_disabled() | ++----------+----------------------------+ + +If ``true`` folding is disabled for this TreeItem. Method Descriptions ------------------- -.. _class_TreeItem_add_button: + .. _class_TreeItem_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 ``get_buton_count()`` immediately after this method. Optionally, the button can be ``disabled`` and have a ``tooltip``. -.. _class_TreeItem_clear_custom_bg_color: + .. _class_TreeItem_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_clear_custom_color: - void **clear_custom_color** **(** :ref:`int` column **)** Resets the color for the given column to default. -.. _class_TreeItem_deselect: + .. _class_TreeItem_deselect: - void **deselect** **(** :ref:`int` column **)** Deselects the given column. -.. _class_TreeItem_erase_button: + .. _class_TreeItem_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_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_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_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_get_children: - :ref:`TreeItem` **get_children** **(** **)** Returns the TreeItem's child items. -.. _class_TreeItem_get_custom_bg_color: + .. _class_TreeItem_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_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_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_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_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_get_metadata: - :ref:`Variant` **get_metadata** **(** :ref:`int` column **)** const -.. _class_TreeItem_get_next: + .. _class_TreeItem_get_next: - :ref:`TreeItem` **get_next** **(** **)** Returns the next TreeItem in the tree. -.. _class_TreeItem_get_next_visible: + .. _class_TreeItem_get_next_visible: - :ref:`TreeItem` **get_next_visible** **(** **)** Returns the next visible TreeItem in the tree. -.. _class_TreeItem_get_parent: + .. _class_TreeItem_get_parent: - :ref:`TreeItem` **get_parent** **(** **)** Returns the parent TreeItem. -.. _class_TreeItem_get_prev: + .. _class_TreeItem_get_prev: - :ref:`TreeItem` **get_prev** **(** **)** Returns the previous TreeItem in the tree. -.. _class_TreeItem_get_prev_visible: + .. _class_TreeItem_get_prev_visible: - :ref:`TreeItem` **get_prev_visible** **(** **)** Returns the previous visible TreeItem in the tree. -.. _class_TreeItem_get_range: + .. _class_TreeItem_get_range: - :ref:`float` **get_range** **(** :ref:`int` column **)** const -.. _class_TreeItem_get_range_config: + .. _class_TreeItem_get_range_config: - :ref:`Dictionary` **get_range_config** **(** :ref:`int` column **)** -.. _class_TreeItem_get_text: + .. _class_TreeItem_get_text: - :ref:`String` **get_text** **(** :ref:`int` column **)** const Returns the given column's text. -.. _class_TreeItem_get_text_align: + .. _class_TreeItem_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_get_tooltip: - :ref:`String` **get_tooltip** **(** :ref:`int` column **)** const Returns the given column's tooltip. -.. _class_TreeItem_is_button_disabled: + .. _class_TreeItem_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_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_is_custom_set_as_button: - :ref:`bool` **is_custom_set_as_button** **(** :ref:`int` column **)** const -.. _class_TreeItem_is_editable: + .. _class_TreeItem_is_editable: - :ref:`bool` **is_editable** **(** :ref:`int` column **)** Returns ``true`` if column ``column`` is editable. -.. _class_TreeItem_is_selectable: + .. _class_TreeItem_is_selectable: - :ref:`bool` **is_selectable** **(** :ref:`int` column **)** const Returns ``true`` if column ``column`` is selectable. -.. _class_TreeItem_is_selected: + .. _class_TreeItem_is_selected: - :ref:`bool` **is_selected** **(** :ref:`int` column **)** Returns ``true`` if column ``column`` is selected. -.. _class_TreeItem_move_to_bottom: + .. _class_TreeItem_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_move_to_top: - void **move_to_top** **(** **)** Moves this TreeItem to the top in the :ref:`Tree` hierarchy. -.. _class_TreeItem_remove_child: + .. _class_TreeItem_remove_child: - void **remove_child** **(** :ref:`Object` child **)** Removes the given child TreeItem. -.. _class_TreeItem_select: + .. _class_TreeItem_select: - void **select** **(** :ref:`int` column **)** Selects the column ``column``. -.. _class_TreeItem_set_button: + .. _class_TreeItem_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_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_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_set_custom_as_button: - void **set_custom_as_button** **(** :ref:`int` column, :ref:`bool` enable **)** -.. _class_TreeItem_set_custom_bg_color: + .. _class_TreeItem_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_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_set_custom_draw: - void **set_custom_draw** **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** Sets the given column's custom draw callback to ``callback`` method on ``object``. -.. _class_TreeItem_set_editable: + .. _class_TreeItem_set_editable: - void **set_editable** **(** :ref:`int` column, :ref:`bool` enabled **)** If ``true`` column ``column`` is editable. -.. _class_TreeItem_set_expand_right: + .. _class_TreeItem_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_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_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_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_set_metadata: - void **set_metadata** **(** :ref:`int` column, :ref:`Variant` meta **)** -.. _class_TreeItem_set_range: + .. _class_TreeItem_set_range: - void **set_range** **(** :ref:`int` column, :ref:`float` value **)** -.. _class_TreeItem_set_range_config: + .. _class_TreeItem_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_set_selectable: - void **set_selectable** **(** :ref:`int` column, :ref:`bool` selectable **)** If ``true`` the given column is selectable. -.. _class_TreeItem_set_text: + .. _class_TreeItem_set_text: - void **set_text** **(** :ref:`int` column, :ref:`String` text **)** -.. _class_TreeItem_set_text_align: + .. _class_TreeItem_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_set_tooltip: - void **set_tooltip** **(** :ref:`int` column, :ref:`String` tooltip **)** Sets the given column's tooltip text. - diff --git a/classes/class_trianglemesh.rst b/classes/class_trianglemesh.rst index f3ae1b62d..4f7087ff5 100644 --- a/classes/class_trianglemesh.rst +++ b/classes/class_trianglemesh.rst @@ -8,6 +8,7 @@ TriangleMesh ============ **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_tween.rst b/classes/class_tween.rst index 412a92c5e..bf69d6a6d 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -8,6 +8,7 @@ Tween ===== **Inherits:** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,17 @@ Brief Description Smoothly animates a node's properties over time. +Properties +---------- + ++------------------------------------------------------+-----------------------------------------------------------------+ +| :ref:`TweenProcessMode` | :ref:`playback_process_mode` | ++------------------------------------------------------+-----------------------------------------------------------------+ +| :ref:`float` | :ref:`playback_speed` | ++------------------------------------------------------+-----------------------------------------------------------------+ +| :ref:`bool` | :ref:`repeat` | ++------------------------------------------------------+-----------------------------------------------------------------+ + Methods ------- @@ -67,38 +79,37 @@ Methods Signals ------- -.. _class_Tween_tween_completed: + .. _class_Tween_tween_completed: - **tween_completed** **(** :ref:`Object` object, :ref:`NodePath` key **)** Emitted when a tween ends. -.. _class_Tween_tween_started: + .. _class_Tween_tween_started: - **tween_started** **(** :ref:`Object` object, :ref:`NodePath` key **)** Emitted when a tween starts. -.. _class_Tween_tween_step: + .. _class_Tween_tween_step: - **tween_step** **(** :ref:`Object` object, :ref:`NodePath` key, :ref:`float` elapsed, :ref:`Object` value **)** Emitted at each step of the animation. - Enumerations ------------ .. _enum_Tween_TweenProcessMode: -enum **TweenProcessMode** +enum **TweenProcessMode**: - **TWEEN_PROCESS_PHYSICS** = **0** --- The tween updates with the ``_physics_process`` callback. - **TWEEN_PROCESS_IDLE** = **1** --- The tween updates with the ``_process`` callback. .. _enum_Tween_EaseType: -enum **EaseType** +enum **EaseType**: - **EASE_IN** = **0** --- The interpolation starts slowly and speeds up towards the end. - **EASE_OUT** = **1** --- The interpolation starts quickly and slows down towards the end. @@ -107,7 +118,7 @@ enum **EaseType** .. _enum_Tween_TransitionType: -enum **TransitionType** +enum **TransitionType**: - **TRANS_LINEAR** = **0** --- The animation is interpolated linearly. - **TRANS_SINE** = **1** --- The animation is interpolated using a sine function. @@ -121,7 +132,6 @@ enum **TransitionType** - **TRANS_BOUNCE** = **9** --- The animation is interpolated by bouncing at the end. - **TRANS_BACK** = **10** --- The animation is interpolated backing out at ends. - Description ----------- @@ -146,21 +156,44 @@ Property Descriptions .. _class_Tween_playback_process_mode: -- :ref:`TweenProcessMode` **playback_process_mode** - The tween's animation process thread. See :ref:`TweenProcessMode`. Default value: :ref:`TWEEN_PROCESS_IDLE`. +- :ref:`TweenProcessMode` **playback_process_mode** + ++----------+-------------------------------+ +| *Setter* | set_tween_process_mode(value) | ++----------+-------------------------------+ +| *Getter* | get_tween_process_mode() | ++----------+-------------------------------+ + +The tween's animation process thread. See :ref:`TweenProcessMode`. Default value: :ref:`TWEEN_PROCESS_IDLE`. .. _class_Tween_playback_speed: -- :ref:`float` **playback_speed** - 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. +- :ref:`float` **playback_speed** + ++----------+------------------------+ +| *Setter* | set_speed_scale(value) | ++----------+------------------------+ +| *Getter* | get_speed_scale() | ++----------+------------------------+ + +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: -- :ref:`bool` **repeat** - If ``true`` the tween loops. +- :ref:`bool` **repeat** ++----------+-------------------+ +| *Setter* | set_repeat(value) | ++----------+-------------------+ +| *Getter* | is_repeat() | ++----------+-------------------+ + +If ``true`` the tween loops. Method Descriptions ------------------- -.. _class_Tween_follow_method: + .. _class_Tween_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 **)** @@ -168,7 +201,7 @@ Follows ``method`` of ``object`` and applies the returned value on ``target_meth 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_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 **)** @@ -176,25 +209,25 @@ Follows ``property`` of ``object`` and applies it on ``target_property`` of ``ta 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_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_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_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. -.. _class_Tween_interpolate_method: + .. _class_Tween_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 **)** @@ -202,7 +235,7 @@ Animates ``method`` of ``object`` from ``initial_val`` to ``final_val`` for ``du 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_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 **)** @@ -210,79 +243,79 @@ Animates ``property`` of ``object`` from ``initial_val`` to ``final_val`` for `` 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_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_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_remove_all: - :ref:`bool` **remove_all** **(** **)** Stops animation and removes all tweens. -.. _class_Tween_reset: + .. _class_Tween_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_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_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_resume_all: - :ref:`bool` **resume_all** **(** **)** Continues animating all stopped tweens. -.. _class_Tween_seek: + .. _class_Tween_seek: - :ref:`bool` **seek** **(** :ref:`float` time **)** Sets the interpolation to the given ``time`` in seconds. -.. _class_Tween_set_active: + .. _class_Tween_set_active: - void **set_active** **(** :ref:`bool` active **)** Activates/deactivates the tween. See also :ref:`stop_all` and :ref:`resume_all`. -.. _class_Tween_start: + .. _class_Tween_start: - :ref:`bool` **start** **(** **)** Starts the tween. You can define animations both before and after this. -.. _class_Tween_stop: + .. _class_Tween_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_stop_all: - :ref:`bool` **stop_all** **(** **)** Stops animating all tweens. -.. _class_Tween_targeting_method: + .. _class_Tween_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 **)** @@ -290,7 +323,7 @@ Animates ``method`` of ``object`` from the value returned by ``initial_method`` 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_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 **)** @@ -298,10 +331,9 @@ Animates ``property`` of ``object`` from the current value of the ``initial_val` 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_tell: - :ref:`float` **tell** **(** **)** const Returns the current time of the tween. - diff --git a/classes/class_undoredo.rst b/classes/class_undoredo.rst index bb7f2f887..42a2e2253 100644 --- a/classes/class_undoredo.rst +++ b/classes/class_undoredo.rst @@ -8,6 +8,7 @@ UndoRedo ======== **Inherits:** :ref:`Object` + **Category:** Core Brief Description @@ -51,13 +52,12 @@ Enumerations .. _enum_UndoRedo_MergeMode: -enum **MergeMode** +enum **MergeMode**: - **MERGE_DISABLE** = **0** - **MERGE_ENDS** = **1** - **MERGE_ALL** = **2** - Description ----------- @@ -93,67 +93,67 @@ If you don't need to register a method you can leave :ref:`add_do_method` **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_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_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_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_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_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_clear_history: - void **clear_history** **(** **)** Clear the undo/redo history and associated references. -.. _class_UndoRedo_commit_action: + .. _class_UndoRedo_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_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`. -.. _class_UndoRedo_get_current_action_name: + .. _class_UndoRedo_get_current_action_name: - :ref:`String` **get_current_action_name** **(** **)** const Get the name of the current action. -.. _class_UndoRedo_get_version: + .. _class_UndoRedo_get_version: - :ref:`int` **get_version** **(** **)** const @@ -161,16 +161,15 @@ 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_redo: - :ref:`bool` **redo** **(** **)** Redo last action. -.. _class_UndoRedo_undo: + .. _class_UndoRedo_undo: - :ref:`bool` **undo** **(** **)** Undo last action. - diff --git a/classes/class_upnp.rst b/classes/class_upnp.rst index 0b6bc3b13..1308392b4 100644 --- a/classes/class_upnp.rst +++ b/classes/class_upnp.rst @@ -8,6 +8,7 @@ UPNP ==== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,17 @@ Brief Description UPNP network functions. +Properties +---------- + ++-----------------------------+----------------------------------------------------------------+ +| :ref:`bool` | :ref:`discover_ipv6` | ++-----------------------------+----------------------------------------------------------------+ +| :ref:`int` | :ref:`discover_local_port` | ++-----------------------------+----------------------------------------------------------------+ +| :ref:`String` | :ref:`discover_multicast_if` | ++-----------------------------+----------------------------------------------------------------+ + Methods ------- @@ -47,7 +59,7 @@ Enumerations .. _enum_UPNP_UPNPResult: -enum **UPNPResult** +enum **UPNPResult**: - **UPNP_RESULT_SUCCESS** = **0** --- UPNP command or discovery was successful. - **UPNP_RESULT_NOT_AUTHORIZED** = **1** --- Not authorized to use the command on the :ref:`UPNPDevice`. May be returned when the user disabled UPNP on their router. @@ -79,7 +91,6 @@ enum **UPNPResult** - **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. - Description ----------- @@ -90,27 +101,50 @@ Property Descriptions .. _class_UPNP_discover_ipv6: -- :ref:`bool` **discover_ipv6** - If ``true``, IPv6 is used for :ref:`UPNPDevice` discovery. +- :ref:`bool` **discover_ipv6** + ++----------+--------------------------+ +| *Setter* | set_discover_ipv6(value) | ++----------+--------------------------+ +| *Getter* | is_discover_ipv6() | ++----------+--------------------------+ + +If ``true``, IPv6 is used for :ref:`UPNPDevice` discovery. .. _class_UPNP_discover_local_port: -- :ref:`int` **discover_local_port** - 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. +- :ref:`int` **discover_local_port** + ++----------+--------------------------------+ +| *Setter* | set_discover_local_port(value) | ++----------+--------------------------------+ +| *Getter* | get_discover_local_port() | ++----------+--------------------------------+ + +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: -- :ref:`String` **discover_multicast_if** - Multicast interface to use for discovery. Uses the default multicast interface if empty. +- :ref:`String` **discover_multicast_if** ++----------+----------------------------------+ +| *Setter* | set_discover_multicast_if(value) | ++----------+----------------------------------+ +| *Getter* | get_discover_multicast_if() | ++----------+----------------------------------+ + +Multicast interface to use for discovery. Uses the default multicast interface if empty. Method Descriptions ------------------- -.. _class_UPNP_add_device: + .. _class_UPNP_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_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 @@ -122,62 +156,61 @@ The description (``desc``) is shown in some router UIs and can be used to point See :ref:`UPNPResult` for possible return values. -.. _class_UPNP_clear_devices: + .. _class_UPNP_clear_devices: - void **clear_devices** **(** **)** Clears the list of discovered devices. -.. _class_UPNP_delete_port_mapping: + .. _class_UPNP_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. -.. _class_UPNP_discover: + .. _class_UPNP_discover: - :ref:`int` **discover** **(** :ref:`int` timeout=2000, :ref:`int` ttl=2, :ref:`String` device_filter="InternetGatewayDevice" **)** Discovers local :ref:`UPNPDevice`\ s. Clears the list of previously discovered devices. -Filters for IGD (InternetGatewayDevice) type devices by default, as those manage port forwarding. ``timeout`` is the time to wait for responses in miliseconds. ``ttl`` is the time-to-live; only touch this if you know what you're doing. +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. -.. _class_UPNP_get_device: + .. _class_UPNP_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_get_device_count: - :ref:`int` **get_device_count** **(** **)** const Returns the number of discovered :ref:`UPNPDevice`\ s. -.. _class_UPNP_get_gateway: + .. _class_UPNP_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_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. -.. _class_UPNP_remove_device: + .. _class_UPNP_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_set_device: - void **set_device** **(** :ref:`int` index, :ref:`UPNPDevice` device **)** Sets the device at ``index`` from the list of discovered devices to ``device``. - diff --git a/classes/class_upnpdevice.rst b/classes/class_upnpdevice.rst index 2af0a6ecb..6ed8fc99d 100644 --- a/classes/class_upnpdevice.rst +++ b/classes/class_upnpdevice.rst @@ -8,6 +8,7 @@ UPNPDevice ========== **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,23 @@ Brief Description 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` | ++---------------------------------------------+------------------------------------------------------------+ + Methods ------- @@ -33,7 +51,7 @@ Enumerations .. _enum_UPNPDevice_IGDStatus: -enum **IGDStatus** +enum **IGDStatus**: - **IGD_STATUS_OK** = **0** --- OK. - **IGD_STATUS_HTTP_ERROR** = **1** --- HTTP error. @@ -46,7 +64,6 @@ enum **IGDStatus** - **IGD_STATUS_MALLOC_ERROR** = **8** --- Memory allocation error. - **IGD_STATUS_UNKNOWN_ERROR** = **9** --- Unknown error. - Description ----------- @@ -57,54 +74,100 @@ Property Descriptions .. _class_UPNPDevice_description_url: -- :ref:`String` **description_url** - URL to the device description. +- :ref:`String` **description_url** + ++----------+----------------------------+ +| *Setter* | set_description_url(value) | ++----------+----------------------------+ +| *Getter* | get_description_url() | ++----------+----------------------------+ + +URL to the device description. .. _class_UPNPDevice_igd_control_url: -- :ref:`String` **igd_control_url** - IDG control URL. +- :ref:`String` **igd_control_url** + ++----------+----------------------------+ +| *Setter* | set_igd_control_url(value) | ++----------+----------------------------+ +| *Getter* | get_igd_control_url() | ++----------+----------------------------+ + +IDG control URL. .. _class_UPNPDevice_igd_our_addr: -- :ref:`String` **igd_our_addr** - Address of the local machine in the network connecting it to this :ref:`UPNPDevice`. +- :ref:`String` **igd_our_addr** + ++----------+-------------------------+ +| *Setter* | set_igd_our_addr(value) | ++----------+-------------------------+ +| *Getter* | get_igd_our_addr() | ++----------+-------------------------+ + +Address of the local machine in the network connecting it to this :ref:`UPNPDevice`. .. _class_UPNPDevice_igd_service_type: -- :ref:`String` **igd_service_type** - IGD service type. +- :ref:`String` **igd_service_type** + ++----------+-----------------------------+ +| *Setter* | set_igd_service_type(value) | ++----------+-----------------------------+ +| *Getter* | get_igd_service_type() | ++----------+-----------------------------+ + +IGD service type. .. _class_UPNPDevice_igd_status: -- :ref:`IGDStatus` **igd_status** - IGD status. See :ref:`IGDStatus`. +- :ref:`IGDStatus` **igd_status** + ++----------+-----------------------+ +| *Setter* | set_igd_status(value) | ++----------+-----------------------+ +| *Getter* | get_igd_status() | ++----------+-----------------------+ + +IGD status. See :ref:`IGDStatus`. .. _class_UPNPDevice_service_type: -- :ref:`String` **service_type** - Service type. +- :ref:`String` **service_type** ++----------+-------------------------+ +| *Setter* | set_service_type(value) | ++----------+-------------------------+ +| *Getter* | get_service_type() | ++----------+-------------------------+ + +Service type. Method Descriptions ------------------- -.. _class_UPNPDevice_add_port_mapping: + .. _class_UPNPDevice_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`. -.. _class_UPNPDevice_delete_port_mapping: + .. _class_UPNPDevice_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`. -.. _class_UPNPDevice_is_valid_gateway: + .. _class_UPNPDevice_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_query_external_address: - :ref:`String` **query_external_address** **(** **)** const Returns the external IP address of this :ref:`UPNPDevice` or an empty string. - diff --git a/classes/class_vboxcontainer.rst b/classes/class_vboxcontainer.rst index 64149059c..7680bdbd2 100644 --- a/classes/class_vboxcontainer.rst +++ b/classes/class_vboxcontainer.rst @@ -8,6 +8,7 @@ VBoxContainer ============= **Inherits:** :ref:`BoxContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Vertical box container. +Theme Properties +---------------- + ++-----------------------+---------------------------------------------------+ +| :ref:`int` | :ref:`separation` | ++-----------------------+---------------------------------------------------+ + Description ----------- diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index b66d8d6fb..c6c96bfc4 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -14,6 +14,15 @@ Brief Description Vector used for 2D math. +Properties +---------- + ++---------------------------+---------------------------+ +| :ref:`float` | :ref:`x` | ++---------------------------+---------------------------+ +| :ref:`float` | :ref:`y` | ++---------------------------+---------------------------+ + Methods ------- @@ -84,7 +93,6 @@ Constants - **RIGHT** = **Vector2( 1, 0 )** --- Right unit vector. - **UP** = **Vector2( 0, -1 )** --- Up unit vector. - **DOWN** = **Vector2( 0, 1 )** --- Down unit vector. - Description ----------- @@ -94,35 +102,37 @@ Tutorials --------- - :doc:`../tutorials/math/index` - Property Descriptions --------------------- .. _class_Vector2_x: -- :ref:`float` **x** - The vector's x component. +- :ref:`float` **x** + +The vector's x component. .. _class_Vector2_y: -- :ref:`float` **y** - The vector's y component. +- :ref:`float` **y** +The vector's y component. Method Descriptions ------------------- -.. _class_Vector2_Vector2: + .. _class_Vector2_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_abs: - :ref:`Vector2` **abs** **(** **)** Returns a new vector with all components in absolute values (i.e. positive). -.. _class_Vector2_angle: + .. _class_Vector2_angle: - :ref:`float` **angle** **(** **)** @@ -130,133 +140,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_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_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_aspect: - :ref:`float` **aspect** **(** **)** Returns the ratio of x to y. -.. _class_Vector2_bounce: + .. _class_Vector2_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_ceil: - :ref:`Vector2` **ceil** **(** **)** Returns the vector with all components rounded up. -.. _class_Vector2_clamped: + .. _class_Vector2_clamped: - :ref:`Vector2` **clamped** **(** :ref:`float` length **)** Returns the vector with a maximum length. -.. _class_Vector2_cross: + .. _class_Vector2_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_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_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. -.. _class_Vector2_distance_to: + .. _class_Vector2_distance_to: - :ref:`float` **distance_to** **(** :ref:`Vector2` to **)** Returns the distance to vector ``b``. -.. _class_Vector2_dot: + .. _class_Vector2_dot: - :ref:`float` **dot** **(** :ref:`Vector2` with **)** Returns the dot product with vector ``b``. -.. _class_Vector2_floor: + .. _class_Vector2_floor: - :ref:`Vector2` **floor** **(** **)** Returns the vector with all components rounded down. -.. _class_Vector2_is_normalized: + .. _class_Vector2_is_normalized: - :ref:`bool` **is_normalized** **(** **)** Returns ``true`` if the vector is normalized. -.. _class_Vector2_length: + .. _class_Vector2_length: - :ref:`float` **length** **(** **)** Returns the vector's length. -.. _class_Vector2_length_squared: + .. _class_Vector2_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. -.. _class_Vector2_linear_interpolate: + .. _class_Vector2_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_normalized: - :ref:`Vector2` **normalized** **(** **)** Returns the vector scaled to unit length. Equivalent to ``v / v.length()``. -.. _class_Vector2_project: + .. _class_Vector2_project: - :ref:`Vector2` **project** **(** :ref:`Vector2` b **)** Returns the vector projected onto the vector ``b``. -.. _class_Vector2_reflect: + .. _class_Vector2_reflect: - :ref:`Vector2` **reflect** **(** :ref:`Vector2` n **)** Returns the vector reflected from a plane defined by the given normal. -.. _class_Vector2_rotated: + .. _class_Vector2_rotated: - :ref:`Vector2` **rotated** **(** :ref:`float` phi **)** Returns the vector rotated by ``phi`` radians. -.. _class_Vector2_round: + .. _class_Vector2_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_slerp: - :ref:`Vector2` **slerp** **(** :ref:`Vector2` b, :ref:`float` t **)** @@ -264,22 +274,21 @@ 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_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_snapped: - :ref:`Vector2` **snapped** **(** :ref:`Vector2` by **)** Returns the vector snapped to a grid with the given size. -.. _class_Vector2_tangent: + .. _class_Vector2_tangent: - :ref:`Vector2` **tangent** **(** **)** Returns a perpendicular vector. - diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index f99013830..304406cb6 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -14,6 +14,17 @@ Brief Description Vector class, which performs basic 3D vector math operations. +Properties +---------- + ++---------------------------+---------------------------+ +| :ref:`float` | :ref:`x` | ++---------------------------+---------------------------+ +| :ref:`float` | :ref:`y` | ++---------------------------+---------------------------+ +| :ref:`float` | :ref:`z` | ++---------------------------+---------------------------+ + Methods ------- @@ -89,7 +100,6 @@ Constants - **DOWN** = **Vector3( 0, -1, 0 )** --- Down unit vector. - **FORWARD** = **Vector3( 0, 0, -1 )** --- Forward unit vector. - **BACK** = **Vector3( 0, 0, 1 )** --- Back unit vector. - Description ----------- @@ -99,171 +109,175 @@ Tutorials --------- - :doc:`../tutorials/math/index` - Property Descriptions --------------------- .. _class_Vector3_x: -- :ref:`float` **x** - The vector's x component. +- :ref:`float` **x** + +The vector's x component. .. _class_Vector3_y: -- :ref:`float` **y** - The vector's y component. +- :ref:`float` **y** + +The vector's y component. .. _class_Vector3_z: -- :ref:`float` **z** - The vector's z component. +- :ref:`float` **z** +The vector's z component. Method Descriptions ------------------- -.. _class_Vector3_Vector3: + .. _class_Vector3_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_abs: - :ref:`Vector3` **abs** **(** **)** Returns a new vector with all components in absolute values (i.e. positive). -.. _class_Vector3_angle_to: + .. _class_Vector3_angle_to: - :ref:`float` **angle_to** **(** :ref:`Vector3` to **)** Returns the minimum angle to the given vector. -.. _class_Vector3_bounce: + .. _class_Vector3_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_ceil: - :ref:`Vector3` **ceil** **(** **)** Returns a new vector with all components rounded up. -.. _class_Vector3_cross: + .. _class_Vector3_cross: - :ref:`Vector3` **cross** **(** :ref:`Vector3` b **)** Returns the cross product with ``b``. -.. _class_Vector3_cubic_interpolate: + .. _class_Vector3_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_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. -.. _class_Vector3_distance_to: + .. _class_Vector3_distance_to: - :ref:`float` **distance_to** **(** :ref:`Vector3` b **)** Returns the distance to ``b``. -.. _class_Vector3_dot: + .. _class_Vector3_dot: - :ref:`float` **dot** **(** :ref:`Vector3` b **)** Returns the dot product with ``b``. -.. _class_Vector3_floor: + .. _class_Vector3_floor: - :ref:`Vector3` **floor** **(** **)** Returns a new vector with all components rounded down. -.. _class_Vector3_inverse: + .. _class_Vector3_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_is_normalized: - :ref:`bool` **is_normalized** **(** **)** Returns ``true`` if the vector is normalized. -.. _class_Vector3_length: + .. _class_Vector3_length: - :ref:`float` **length** **(** **)** Returns the vector's length. -.. _class_Vector3_length_squared: + .. _class_Vector3_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. -.. _class_Vector3_linear_interpolate: + .. _class_Vector3_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_max_axis: - :ref:`int` **max_axis** **(** **)** Returns the axis of the vector's largest value. See ``AXIS_*`` constants. -.. _class_Vector3_min_axis: + .. _class_Vector3_min_axis: - :ref:`int` **min_axis** **(** **)** Returns the axis of the vector's smallest value. See ``AXIS_*`` constants. -.. _class_Vector3_normalized: + .. _class_Vector3_normalized: - :ref:`Vector3` **normalized** **(** **)** Returns the vector scaled to unit length. Equivalent to ``v / v.length()``. -.. _class_Vector3_outer: + .. _class_Vector3_outer: - :ref:`Basis` **outer** **(** :ref:`Vector3` b **)** Returns the outer product with ``b``. -.. _class_Vector3_project: + .. _class_Vector3_project: - :ref:`Vector3` **project** **(** :ref:`Vector3` b **)** Returns the vector projected onto the vector ``b``. -.. _class_Vector3_reflect: + .. _class_Vector3_reflect: - :ref:`Vector3` **reflect** **(** :ref:`Vector3` n **)** Returns the vector reflected from a plane defined by the given normal. -.. _class_Vector3_rotated: + .. _class_Vector3_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_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_slerp: - :ref:`Vector3` **slerp** **(** :ref:`Vector3` b, :ref:`float` t **)** @@ -271,22 +285,21 @@ 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_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_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_to_diagonal_matrix: - :ref:`Basis` **to_diagonal_matrix** **(** **)** Returns a diagonal matrix with the vector as main diagonal. - diff --git a/classes/class_vehiclebody.rst b/classes/class_vehiclebody.rst index 608091d39..d469dc8b8 100644 --- a/classes/class_vehiclebody.rst +++ b/classes/class_vehiclebody.rst @@ -8,6 +8,7 @@ VehicleBody =========== **Inherits:** :ref:`RigidBody` **<** :ref:`PhysicsBody` **<** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,17 @@ Brief Description Physics body that simulates the behaviour of a car. +Properties +---------- + ++---------------------------+-----------------------------------------------------+ +| :ref:`float` | :ref:`brake` | ++---------------------------+-----------------------------------------------------+ +| :ref:`float` | :ref:`engine_force` | ++---------------------------+-----------------------------------------------------+ +| :ref:`float` | :ref:`steering` | ++---------------------------+-----------------------------------------------------+ + Description ----------- @@ -27,16 +39,39 @@ Property Descriptions .. _class_VehicleBody_brake: -- :ref:`float` **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. +- :ref:`float` **brake** + ++----------+------------------+ +| *Setter* | set_brake(value) | ++----------+------------------+ +| *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. .. _class_VehicleBody_engine_force: -- :ref:`float` **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. +- :ref:`float` **engine_force** + ++----------+-------------------------+ +| *Setter* | set_engine_force(value) | ++----------+-------------------------+ +| *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. A negative value will result in the vehicle reversing. .. _class_VehicleBody_steering: -- :ref:`float` **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. +- :ref:`float` **steering** ++----------+---------------------+ +| *Setter* | set_steering(value) | ++----------+---------------------+ +| *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. diff --git a/classes/class_vehiclewheel.rst b/classes/class_vehiclewheel.rst index 2338e7fee..4a7344941 100644 --- a/classes/class_vehiclewheel.rst +++ b/classes/class_vehiclewheel.rst @@ -8,6 +8,7 @@ VehicleWheel ============ **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,33 @@ Brief Description 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` | ++---------------------------+----------------------------------------------------------------------+ + Methods ------- @@ -34,64 +62,150 @@ Property Descriptions .. _class_VehicleWheel_damping_compression: -- :ref:`float` **damping_compression** - 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. +- :ref:`float` **damping_compression** + ++----------+--------------------------------+ +| *Setter* | set_damping_compression(value) | ++----------+--------------------------------+ +| *Getter* | get_damping_compression() | ++----------+--------------------------------+ + +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: -- :ref:`float` **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 +- :ref:`float` **damping_relaxation** + ++----------+-------------------------------+ +| *Setter* | set_damping_relaxation(value) | ++----------+-------------------------------+ +| *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 .. _class_VehicleWheel_suspension_max_force: -- :ref:`float` **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. +- :ref:`float` **suspension_max_force** + ++----------+---------------------------------+ +| *Setter* | set_suspension_max_force(value) | ++----------+---------------------------------+ +| *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. .. _class_VehicleWheel_suspension_stiffness: -- :ref:`float` **suspension_stiffness** - 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. +- :ref:`float` **suspension_stiffness** + ++----------+---------------------------------+ +| *Setter* | set_suspension_stiffness(value) | ++----------+---------------------------------+ +| *Getter* | get_suspension_stiffness() | ++----------+---------------------------------+ + +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: -- :ref:`float` **suspension_travel** - 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 . +- :ref:`float` **suspension_travel** + ++----------+------------------------------+ +| *Setter* | set_suspension_travel(value) | ++----------+------------------------------+ +| *Getter* | get_suspension_travel() | ++----------+------------------------------+ + +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: -- :ref:`bool` **use_as_steering** - If true this wheel will be turned when the car steers. +- :ref:`bool` **use_as_steering** + ++----------+----------------------------+ +| *Setter* | set_use_as_steering(value) | ++----------+----------------------------+ +| *Getter* | is_used_as_steering() | ++----------+----------------------------+ + +If true this wheel will be turned when the car steers. .. _class_VehicleWheel_use_as_traction: -- :ref:`bool` **use_as_traction** - If true this wheel transfers engine force to the ground to propel the vehicle forward. +- :ref:`bool` **use_as_traction** + ++----------+----------------------------+ +| *Setter* | set_use_as_traction(value) | ++----------+----------------------------+ +| *Getter* | is_used_as_traction() | ++----------+----------------------------+ + +If true this wheel transfers engine force to the ground to propel the vehicle forward. .. _class_VehicleWheel_wheel_friction_slip: -- :ref:`float` **wheel_friction_slip** - This determines how much grip this wheel has. It is combined with the friction setting of the surface the wheel is in contact with. 0.0 means no grip, 1.0 is normal grip. For a drift car setup, try setting the grip of the rear wheels slightly lower than the front wheels, or use a lower value to simulate tire wear. +- :ref:`float` **wheel_friction_slip** + ++----------+--------------------------+ +| *Setter* | set_friction_slip(value) | ++----------+--------------------------+ +| *Getter* | get_friction_slip() | ++----------+--------------------------+ + +This determines how much grip this wheel has. It is combined with the friction setting of the surface the wheel is in contact with. 0.0 means no grip, 1.0 is normal grip. For a drift car setup, try setting the grip of the rear wheels slightly lower than the front wheels, or use a lower value to simulate tire wear. It's best to set this to 1.0 when starting out. .. _class_VehicleWheel_wheel_radius: -- :ref:`float` **wheel_radius** - The radius of the wheel in meters. +- :ref:`float` **wheel_radius** + ++----------+-------------------+ +| *Setter* | set_radius(value) | ++----------+-------------------+ +| *Getter* | get_radius() | ++----------+-------------------+ + +The radius of the wheel in meters. .. _class_VehicleWheel_wheel_rest_length: -- :ref:`float` **wheel_rest_length** - 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. +- :ref:`float` **wheel_rest_length** + ++----------+-----------------------------------+ +| *Setter* | set_suspension_rest_length(value) | ++----------+-----------------------------------+ +| *Getter* | get_suspension_rest_length() | ++----------+-----------------------------------+ + +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: -- :ref:`float` **wheel_roll_influence** - This value effects the roll of your vehicle. If set to 0.0 for all wheels your vehicle will be prone to rolling over while a value of 1.0 will resist body roll. +- :ref:`float` **wheel_roll_influence** ++----------+---------------------------+ +| *Setter* | set_roll_influence(value) | ++----------+---------------------------+ +| *Getter* | get_roll_influence() | ++----------+---------------------------+ + +This value effects the roll of your vehicle. If set to 0.0 for all wheels your vehicle will be prone to rolling over while a value of 1.0 will resist body roll. Method Descriptions ------------------- -.. _class_VehicleWheel_get_skidinfo: + .. _class_VehicleWheel_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_is_in_contact: - :ref:`bool` **is_in_contact** **(** **)** const Returns true if this wheel is in contact with a surface. - diff --git a/classes/class_videoplayer.rst b/classes/class_videoplayer.rst index 588c5d66b..ecb396837 100644 --- a/classes/class_videoplayer.rst +++ b/classes/class_videoplayer.rst @@ -8,6 +8,7 @@ VideoPlayer =========== **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,31 @@ Brief Description 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` | ++---------------------------------------+-----------------------------------------------------------+ + Methods ------- @@ -33,13 +59,12 @@ Methods Signals ------- -.. _class_VideoPlayer_finished: + .. _class_VideoPlayer_finished: - **finished** **(** **)** Emitted when playback is finished. - Description ----------- @@ -50,76 +75,152 @@ Property Descriptions .. _class_VideoPlayer_audio_track: -- :ref:`int` **audio_track** - The embedded audio track to play. +- :ref:`int` **audio_track** + ++----------+------------------------+ +| *Setter* | set_audio_track(value) | ++----------+------------------------+ +| *Getter* | get_audio_track() | ++----------+------------------------+ + +The embedded audio track to play. .. _class_VideoPlayer_autoplay: -- :ref:`bool` **autoplay** - If ``true`` playback starts when the scene loads. Default value: ``false``. +- :ref:`bool` **autoplay** + ++----------+---------------------+ +| *Setter* | set_autoplay(value) | ++----------+---------------------+ +| *Getter* | has_autoplay() | ++----------+---------------------+ + +If ``true`` playback starts when the scene loads. Default value: ``false``. .. _class_VideoPlayer_buffering_msec: -- :ref:`int` **buffering_msec** - Amount of time in milliseconds to store in buffer while playing. +- :ref:`int` **buffering_msec** + ++----------+---------------------------+ +| *Setter* | set_buffering_msec(value) | ++----------+---------------------------+ +| *Getter* | get_buffering_msec() | ++----------+---------------------------+ + +Amount of time in milliseconds to store in buffer while playing. .. _class_VideoPlayer_bus: -- :ref:`String` **bus** - Audio bus to use for sound playback. +- :ref:`String` **bus** + ++----------+----------------+ +| *Setter* | set_bus(value) | ++----------+----------------+ +| *Getter* | get_bus() | ++----------+----------------+ + +Audio bus to use for sound playback. .. _class_VideoPlayer_expand: -- :ref:`bool` **expand** - If ``true`` the video scales to the control size. Default value: ``true``. +- :ref:`bool` **expand** + ++----------+-------------------+ +| *Setter* | set_expand(value) | ++----------+-------------------+ +| *Getter* | has_expand() | ++----------+-------------------+ + +If ``true`` the video scales to the control size. Default value: ``true``. .. _class_VideoPlayer_paused: -- :ref:`bool` **paused** - If ``true`` the video is paused. +- :ref:`bool` **paused** + ++----------+-------------------+ +| *Setter* | set_paused(value) | ++----------+-------------------+ +| *Getter* | is_paused() | ++----------+-------------------+ + +If ``true`` the video is paused. .. _class_VideoPlayer_stream: - :ref:`VideoStream` **stream** ++----------+-------------------+ +| *Setter* | set_stream(value) | ++----------+-------------------+ +| *Getter* | get_stream() | ++----------+-------------------+ + .. _class_VideoPlayer_stream_position: -- :ref:`float` **stream_position** - The current position of the stream, in seconds. +- :ref:`float` **stream_position** + ++----------+----------------------------+ +| *Setter* | set_stream_position(value) | ++----------+----------------------------+ +| *Getter* | get_stream_position() | ++----------+----------------------------+ + +The current position of the stream, in seconds. .. _class_VideoPlayer_volume: -- :ref:`float` **volume** - Audio volume as a linear value. +- :ref:`float` **volume** + ++----------+-------------------+ +| *Setter* | set_volume(value) | ++----------+-------------------+ +| *Getter* | get_volume() | ++----------+-------------------+ + +Audio volume as a linear value. .. _class_VideoPlayer_volume_db: -- :ref:`float` **volume_db** - Audio volume in dB. +- :ref:`float` **volume_db** ++----------+----------------------+ +| *Setter* | set_volume_db(value) | ++----------+----------------------+ +| *Getter* | get_volume_db() | ++----------+----------------------+ + +Audio volume in dB. Method Descriptions ------------------- -.. _class_VideoPlayer_get_stream_name: + .. _class_VideoPlayer_get_stream_name: - :ref:`String` **get_stream_name** **(** **)** const Returns the video stream's name. -.. _class_VideoPlayer_get_video_texture: + .. _class_VideoPlayer_get_video_texture: - :ref:`Texture` **get_video_texture** **(** **)** Returns the current frame as a :ref:`Texture`. -.. _class_VideoPlayer_is_playing: + .. _class_VideoPlayer_is_playing: - :ref:`bool` **is_playing** **(** **)** const Returns ``true`` if the video is playing. -.. _class_VideoPlayer_play: + .. _class_VideoPlayer_play: - void **play** **(** **)** Starts the video playback. -.. _class_VideoPlayer_stop: + .. _class_VideoPlayer_stop: - void **stop** **(** **)** Stops the video playback. - diff --git a/classes/class_videostream.rst b/classes/class_videostream.rst index 735fc8039..e3f423a90 100644 --- a/classes/class_videostream.rst +++ b/classes/class_videostream.rst @@ -8,7 +8,9 @@ VideoStream =========== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`VideoStreamWebm`, :ref:`VideoStreamTheora` + **Category:** Core Brief Description diff --git a/classes/class_videostreamtheora.rst b/classes/class_videostreamtheora.rst index fc522ed76..b51f42cb6 100644 --- a/classes/class_videostreamtheora.rst +++ b/classes/class_videostreamtheora.rst @@ -8,6 +8,7 @@ VideoStreamTheora ================= **Inherits:** :ref:`VideoStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -27,12 +28,11 @@ Methods Method Descriptions ------------------- -.. _class_VideoStreamTheora_get_file: + .. _class_VideoStreamTheora_get_file: - :ref:`String` **get_file** **(** **)** -.. _class_VideoStreamTheora_set_file: + .. _class_VideoStreamTheora_set_file: - void **set_file** **(** :ref:`String` file **)** - diff --git a/classes/class_videostreamwebm.rst b/classes/class_videostreamwebm.rst index ce2ed3567..5a9283e61 100644 --- a/classes/class_videostreamwebm.rst +++ b/classes/class_videostreamwebm.rst @@ -8,6 +8,7 @@ VideoStreamWebm =============== **Inherits:** :ref:`VideoStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -27,12 +28,11 @@ Methods Method Descriptions ------------------- -.. _class_VideoStreamWebm_get_file: + .. _class_VideoStreamWebm_get_file: - :ref:`String` **get_file** **(** **)** -.. _class_VideoStreamWebm_set_file: + .. _class_VideoStreamWebm_set_file: - void **set_file** **(** :ref:`String` file **)** - diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index e10948639..5a243a4b0 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -8,6 +8,7 @@ Viewport ======== **Inherits:** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,65 @@ Brief Description 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:`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 ------- @@ -67,19 +127,18 @@ Methods Signals ------- -.. _class_Viewport_size_changed: + .. _class_Viewport_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. - Enumerations ------------ .. _enum_Viewport_UpdateMode: -enum **UpdateMode** +enum **UpdateMode**: - **UPDATE_DISABLED** = **0** --- Do not update the render target. - **UPDATE_ONCE** = **1** --- Update the render target once, then switch to ``UPDATE_DISABLED``. @@ -88,7 +147,7 @@ enum **UpdateMode** .. _enum_Viewport_RenderInfo: -enum **RenderInfo** +enum **RenderInfo**: - **RENDER_INFO_OBJECTS_IN_FRAME** = **0** --- Amount of objects in frame. - **RENDER_INFO_VERTICES_IN_FRAME** = **1** --- Amount of vertices in frame. @@ -100,7 +159,7 @@ enum **RenderInfo** .. _enum_Viewport_MSAA: -enum **MSAA** +enum **MSAA**: - **MSAA_DISABLED** = **0** --- Multisample anti-aliasing mode disabled. This is the default value. - **MSAA_2X** = **1** @@ -110,7 +169,7 @@ enum **MSAA** .. _enum_Viewport_ClearMode: -enum **ClearMode** +enum **ClearMode**: - **CLEAR_MODE_ALWAYS** = **0** --- Always clear the render target before drawing. - **CLEAR_MODE_NEVER** = **1** --- Never clear the render target. @@ -118,7 +177,7 @@ enum **ClearMode** .. _enum_Viewport_Usage: -enum **Usage** +enum **Usage**: - **USAGE_2D** = **0** - **USAGE_2D_NO_SAMPLING** = **1** @@ -127,7 +186,7 @@ enum **Usage** .. _enum_Viewport_DebugDraw: -enum **DebugDraw** +enum **DebugDraw**: - **DEBUG_DRAW_DISABLED** = **0** --- Objects are displayed normally. - **DEBUG_DRAW_UNSHADED** = **1** --- Objects are displayed without light information. @@ -136,7 +195,7 @@ enum **DebugDraw** .. _enum_Viewport_ShadowAtlasQuadrantSubdiv: -enum **ShadowAtlasQuadrantSubdiv** +enum **ShadowAtlasQuadrantSubdiv**: - **SHADOW_ATLAS_QUADRANT_SUBDIV_DISABLED** = **0** - **SHADOW_ATLAS_QUADRANT_SUBDIV_1** = **1** @@ -147,7 +206,6 @@ enum **ShadowAtlasQuadrantSubdiv** - **SHADOW_ATLAS_QUADRANT_SUBDIV_1024** = **6** - **SHADOW_ATLAS_QUADRANT_SUBDIV_MAX** = **7** --- Enum limiter. Do not use it directly. - Description ----------- @@ -168,244 +226,457 @@ Tutorials - :doc:`../tutorials/2d/2d_transforms` - :doc:`../tutorials/viewports/index` - Property Descriptions --------------------- .. _class_Viewport_arvr: -- :ref:`bool` **arvr** - If ``true`` the viewport will be used in AR/VR process. Default value: ``false``. +- :ref:`bool` **arvr** + ++----------+---------------------+ +| *Setter* | set_use_arvr(value) | ++----------+---------------------+ +| *Getter* | use_arvr() | ++----------+---------------------+ + +If ``true`` the viewport will be used in AR/VR process. Default value: ``false``. .. _class_Viewport_audio_listener_enable_2d: -- :ref:`bool` **audio_listener_enable_2d** - If ``true`` the viewport will process 2D audio streams. Default value: ``false``. +- :ref:`bool` **audio_listener_enable_2d** + ++----------+---------------------------------+ +| *Setter* | set_as_audio_listener_2d(value) | ++----------+---------------------------------+ +| *Getter* | is_audio_listener_2d() | ++----------+---------------------------------+ + +If ``true`` the viewport will process 2D audio streams. Default value: ``false``. .. _class_Viewport_audio_listener_enable_3d: -- :ref:`bool` **audio_listener_enable_3d** - If ``true`` the viewport will process 3D audio streams. Default value: ``false``. +- :ref:`bool` **audio_listener_enable_3d** + ++----------+------------------------------+ +| *Setter* | set_as_audio_listener(value) | ++----------+------------------------------+ +| *Getter* | is_audio_listener() | ++----------+------------------------------+ + +If ``true`` the viewport will process 3D audio streams. Default value: ``false``. .. _class_Viewport_canvas_transform: -- :ref:`Transform2D` **canvas_transform** - 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. +- :ref:`Transform2D` **canvas_transform** + ++----------+-----------------------------+ +| *Setter* | set_canvas_transform(value) | ++----------+-----------------------------+ +| *Getter* | get_canvas_transform() | ++----------+-----------------------------+ + +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: -- :ref:`DebugDraw` **debug_draw** - The overlay mode for test rendered geometry in debug purposes. Default value: ``DEBUG_DRAW_DISABLED``. +- :ref:`DebugDraw` **debug_draw** + ++----------+-----------------------+ +| *Setter* | set_debug_draw(value) | ++----------+-----------------------+ +| *Getter* | get_debug_draw() | ++----------+-----------------------+ + +The overlay mode for test rendered geometry in debug purposes. Default value: ``DEBUG_DRAW_DISABLED``. .. _class_Viewport_disable_3d: -- :ref:`bool` **disable_3d** - If ``true`` the viewport will disable 3D rendering. For actual disabling use ``usage``. Default value: ``false``. +- :ref:`bool` **disable_3d** + ++----------+-----------------------+ +| *Setter* | set_disable_3d(value) | ++----------+-----------------------+ +| *Getter* | is_3d_disabled() | ++----------+-----------------------+ + +If ``true`` the viewport will disable 3D rendering. For actual disabling use ``usage``. Default value: ``false``. .. _class_Viewport_global_canvas_transform: -- :ref:`Transform2D` **global_canvas_transform** - The global canvas transform of the viewport. The canvas transform is relative to this. +- :ref:`Transform2D` **global_canvas_transform** + ++----------+------------------------------------+ +| *Setter* | set_global_canvas_transform(value) | ++----------+------------------------------------+ +| *Getter* | get_global_canvas_transform() | ++----------+------------------------------------+ + +The global canvas transform of the viewport. The canvas transform is relative to this. .. _class_Viewport_gui_disable_input: -- :ref:`bool` **gui_disable_input** - If ``true`` the viewport will not receive input event. Default value: ``false``. +- :ref:`bool` **gui_disable_input** + ++----------+--------------------------+ +| *Setter* | set_disable_input(value) | ++----------+--------------------------+ +| *Getter* | is_input_disabled() | ++----------+--------------------------+ + +If ``true`` the viewport will not receive input event. Default value: ``false``. .. _class_Viewport_gui_snap_controls_to_pixels: -- :ref:`bool` **gui_snap_controls_to_pixels** - If ``true`` the GUI controls on the viewport will lay pixel perfectly. Default value: ``true``. +- :ref:`bool` **gui_snap_controls_to_pixels** + ++----------+--------------------------------------+ +| *Setter* | set_snap_controls_to_pixels(value) | ++----------+--------------------------------------+ +| *Getter* | is_snap_controls_to_pixels_enabled() | ++----------+--------------------------------------+ + +If ``true`` the GUI controls on the viewport will lay pixel perfectly. Default value: ``true``. .. _class_Viewport_hdr: -- :ref:`bool` **hdr** - If ``true`` the viewport rendering will receive benefits from High Dynamic Range algorithm. Default value: ``true``. +- :ref:`bool` **hdr** + ++----------+----------------+ +| *Setter* | set_hdr(value) | ++----------+----------------+ +| *Getter* | get_hdr() | ++----------+----------------+ + +If ``true`` the viewport rendering will receive benefits from High Dynamic Range algorithm. Default value: ``true``. .. _class_Viewport_keep_3d_linear: -- :ref:`bool` **keep_3d_linear** - 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. +- :ref:`bool` **keep_3d_linear** + ++----------+---------------------------+ +| *Setter* | set_keep_3d_linear(value) | ++----------+---------------------------+ +| *Getter* | get_keep_3d_linear() | ++----------+---------------------------+ + +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: -- :ref:`MSAA` **msaa** - The multisample anti-aliasing mode. Default value: ``MSAA_DISABLED``. +- :ref:`MSAA` **msaa** + ++----------+-----------------+ +| *Setter* | set_msaa(value) | ++----------+-----------------+ +| *Getter* | get_msaa() | ++----------+-----------------+ + +The multisample anti-aliasing mode. Default value: ``MSAA_DISABLED``. .. _class_Viewport_own_world: -- :ref:`bool` **own_world** - If ``true`` the viewport will use :ref:`World` defined in ``world`` property. Default value: ``false``. +- :ref:`bool` **own_world** + ++----------+--------------------------+ +| *Setter* | set_use_own_world(value) | ++----------+--------------------------+ +| *Getter* | is_using_own_world() | ++----------+--------------------------+ + +If ``true`` the viewport will use :ref:`World` defined in ``world`` property. Default value: ``false``. .. _class_Viewport_physics_object_picking: -- :ref:`bool` **physics_object_picking** - If ``true`` the objects rendered by viewport become subjects of mouse picking process. Default value: ``false``. +- :ref:`bool` **physics_object_picking** + ++----------+-----------------------------------+ +| *Setter* | set_physics_object_picking(value) | ++----------+-----------------------------------+ +| *Getter* | get_physics_object_picking() | ++----------+-----------------------------------+ + +If ``true`` the objects rendered by viewport become subjects of mouse picking process. Default value: ``false``. .. _class_Viewport_render_target_clear_mode: -- :ref:`ClearMode` **render_target_clear_mode** - The clear mode when viewport used as a render target. Default value: ``CLEAR_MODE_ALWAYS``. +- :ref:`ClearMode` **render_target_clear_mode** + ++----------+-----------------------+ +| *Setter* | set_clear_mode(value) | ++----------+-----------------------+ +| *Getter* | get_clear_mode() | ++----------+-----------------------+ + +The clear mode when viewport used as a render target. Default value: ``CLEAR_MODE_ALWAYS``. .. _class_Viewport_render_target_update_mode: -- :ref:`UpdateMode` **render_target_update_mode** - The update mode when viewport used as a render target. Default value: ``UPDATE_WHEN_VISIBLE``. +- :ref:`UpdateMode` **render_target_update_mode** + ++----------+------------------------+ +| *Setter* | set_update_mode(value) | ++----------+------------------------+ +| *Getter* | get_update_mode() | ++----------+------------------------+ + +The update mode when viewport used as a render target. Default value: ``UPDATE_WHEN_VISIBLE``. .. _class_Viewport_render_target_v_flip: -- :ref:`bool` **render_target_v_flip** - If ``true`` the result of rendering will be flipped vertically. Default value: ``false``. +- :ref:`bool` **render_target_v_flip** + ++----------+------------------+ +| *Setter* | set_vflip(value) | ++----------+------------------+ +| *Getter* | get_vflip() | ++----------+------------------+ + +If ``true`` the result of rendering will be flipped vertically. Default value: ``false``. .. _class_Viewport_shadow_atlas_quad_0: -- :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_0** - The subdivision amount of first quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_4``. +- :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_0** + ++----------+-----------------------------------------+ +| *Setter* | set_shadow_atlas_quadrant_subdiv(value) | ++----------+-----------------------------------------+ +| *Getter* | get_shadow_atlas_quadrant_subdiv() | ++----------+-----------------------------------------+ + +The subdivision amount of first quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_4``. .. _class_Viewport_shadow_atlas_quad_1: -- :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_1** - The subdivision amount of second quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_4``. +- :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_1** + ++----------+-----------------------------------------+ +| *Setter* | set_shadow_atlas_quadrant_subdiv(value) | ++----------+-----------------------------------------+ +| *Getter* | get_shadow_atlas_quadrant_subdiv() | ++----------+-----------------------------------------+ + +The subdivision amount of second quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_4``. .. _class_Viewport_shadow_atlas_quad_2: -- :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_2** - The subdivision amount of third quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_16``. +- :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_2** + ++----------+-----------------------------------------+ +| *Setter* | set_shadow_atlas_quadrant_subdiv(value) | ++----------+-----------------------------------------+ +| *Getter* | get_shadow_atlas_quadrant_subdiv() | ++----------+-----------------------------------------+ + +The subdivision amount of third quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_16``. .. _class_Viewport_shadow_atlas_quad_3: -- :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_3** - The subdivision amount of fourth quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_64``. +- :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_3** + ++----------+-----------------------------------------+ +| *Setter* | set_shadow_atlas_quadrant_subdiv(value) | ++----------+-----------------------------------------+ +| *Getter* | get_shadow_atlas_quadrant_subdiv() | ++----------+-----------------------------------------+ + +The subdivision amount of fourth quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_64``. .. _class_Viewport_shadow_atlas_size: -- :ref:`int` **shadow_atlas_size** - The resolution of shadow atlas. Both width and height is equal to one value. +- :ref:`int` **shadow_atlas_size** + ++----------+------------------------------+ +| *Setter* | set_shadow_atlas_size(value) | ++----------+------------------------------+ +| *Getter* | get_shadow_atlas_size() | ++----------+------------------------------+ + +The resolution of shadow atlas. Both width and height is equal to one value. .. _class_Viewport_size: -- :ref:`Vector2` **size** - The width and height of viewport. +- :ref:`Vector2` **size** + ++----------+-----------------+ +| *Setter* | set_size(value) | ++----------+-----------------+ +| *Getter* | get_size() | ++----------+-----------------+ + +The width and height of viewport. .. _class_Viewport_transparent_bg: -- :ref:`bool` **transparent_bg** - If ``true`` the viewport should render its background as transparent. Default value: ``false``. +- :ref:`bool` **transparent_bg** + ++----------+-----------------------------------+ +| *Setter* | set_transparent_background(value) | ++----------+-----------------------------------+ +| *Getter* | has_transparent_background() | ++----------+-----------------------------------+ + +If ``true`` the viewport should render its background as transparent. Default value: ``false``. .. _class_Viewport_usage: -- :ref:`Usage` **usage** - The rendering mode of viewport. Default value: ``USAGE_3D``. +- :ref:`Usage` **usage** + ++----------+------------------+ +| *Setter* | set_usage(value) | ++----------+------------------+ +| *Getter* | get_usage() | ++----------+------------------+ + +The rendering mode of viewport. Default value: ``USAGE_3D``. .. _class_Viewport_world: -- :ref:`World` **world** - The custom :ref:`World` which can be used as 3D environment source. +- :ref:`World` **world** + ++----------+------------------+ +| *Setter* | set_world(value) | ++----------+------------------+ +| *Getter* | get_world() | ++----------+------------------+ + +The custom :ref:`World` which can be used as 3D environment source. .. _class_Viewport_world_2d: -- :ref:`World2D` **world_2d** - The custom :ref:`World2D` which can be used as 2D environment source. +- :ref:`World2D` **world_2d** ++----------+---------------------+ +| *Setter* | set_world_2d(value) | ++----------+---------------------+ +| *Getter* | get_world_2d() | ++----------+---------------------+ + +The custom :ref:`World2D` which can be used as 2D environment source. Method Descriptions ------------------- -.. _class_Viewport_find_world: + .. _class_Viewport_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_find_world_2d: - :ref:`World2D` **find_world_2d** **(** **)** const Returns the 2D world of the viewport. -.. _class_Viewport_get_camera: + .. _class_Viewport_get_camera: - :ref:`Camera` **get_camera** **(** **)** const Returns the active 3D camera. -.. _class_Viewport_get_final_transform: + .. _class_Viewport_get_final_transform: - :ref:`Transform2D` **get_final_transform** **(** **)** const Returns the total transform of the viewport. -.. _class_Viewport_get_mouse_position: + .. _class_Viewport_get_mouse_position: - :ref:`Vector2` **get_mouse_position** **(** **)** const Returns the mouse position relative to the viewport. -.. _class_Viewport_get_render_info: + .. _class_Viewport_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_get_size_override: - :ref:`Vector2` **get_size_override** **(** **)** const Returns the size override set with :ref:`set_size_override`. -.. _class_Viewport_get_texture: + .. _class_Viewport_get_texture: - :ref:`ViewportTexture` **get_texture** **(** **)** const Returns the viewport's texture. -.. _class_Viewport_get_viewport_rid: + .. _class_Viewport_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_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_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`. -.. _class_Viewport_gui_has_modal_stack: + .. _class_Viewport_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_gui_is_dragging: - :ref:`bool` **gui_is_dragging** **(** **)** const -.. _class_Viewport_input: + .. _class_Viewport_input: - void **input** **(** :ref:`InputEvent` local_event **)** -.. _class_Viewport_is_size_override_enabled: + .. _class_Viewport_is_size_override_enabled: - :ref:`bool` **is_size_override_enabled** **(** **)** const Returns ``true`` if the size override is enabled. See :ref:`set_size_override`. -.. _class_Viewport_is_size_override_stretch_enabled: + .. _class_Viewport_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`. -.. _class_Viewport_set_attach_to_screen_rect: + .. _class_Viewport_set_attach_to_screen_rect: - void **set_attach_to_screen_rect** **(** :ref:`Rect2` rect **)** -.. _class_Viewport_set_size_override: + .. _class_Viewport_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_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_unhandled_input: - void **unhandled_input** **(** :ref:`InputEvent` local_event **)** -.. _class_Viewport_update_worlds: + .. _class_Viewport_update_worlds: - void **update_worlds** **(** **)** Forces update of the 2D and 3D worlds. -.. _class_Viewport_warp_mouse: + .. _class_Viewport_warp_mouse: - void **warp_mouse** **(** :ref:`Vector2` to_position **)** Warps the mouse to a position relative to the viewport. - diff --git a/classes/class_viewportcontainer.rst b/classes/class_viewportcontainer.rst index 9ca80ce0c..509ab787e 100644 --- a/classes/class_viewportcontainer.rst +++ b/classes/class_viewportcontainer.rst @@ -8,6 +8,7 @@ ViewportContainer ================= **Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description Control for holding :ref:`Viewport`\ s. +Properties +---------- + ++-------------------------+---------------------------------------------------------------+ +| :ref:`bool` | :ref:`stretch` | ++-------------------------+---------------------------------------------------------------+ +| :ref:`int` | :ref:`stretch_shrink` | ++-------------------------+---------------------------------------------------------------+ + Description ----------- @@ -25,10 +35,23 @@ Property Descriptions .. _class_ViewportContainer_stretch: -- :ref:`bool` **stretch** - If ``true`` the viewport will be scaled to the control's size. Default value:``false``. +- :ref:`bool` **stretch** + ++----------+----------------------+ +| *Setter* | set_stretch(value) | ++----------+----------------------+ +| *Getter* | is_stretch_enabled() | ++----------+----------------------+ + +If ``true`` the viewport will be scaled to the control's size. Default value:``false``. .. _class_ViewportContainer_stretch_shrink: - :ref:`int` **stretch_shrink** ++----------+---------------------------+ +| *Setter* | set_stretch_shrink(value) | ++----------+---------------------------+ +| *Getter* | get_stretch_shrink() | ++----------+---------------------------+ diff --git a/classes/class_viewporttexture.rst b/classes/class_viewporttexture.rst index f0d73e765..b47ab66e5 100644 --- a/classes/class_viewporttexture.rst +++ b/classes/class_viewporttexture.rst @@ -8,6 +8,7 @@ ViewportTexture =============== **Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Texture which displays the content of a :ref:`Viewport`. +Properties +---------- + ++---------------------------------+-----------------------------------------------------------+ +| :ref:`NodePath` | :ref:`viewport_path` | ++---------------------------------+-----------------------------------------------------------+ + Description ----------- @@ -27,6 +35,13 @@ Property Descriptions .. _class_ViewportTexture_viewport_path: -- :ref:`NodePath` **viewport_path** - The path to the :ref:`Viewport` node to display. This is relative to the scene root, not to the node which uses the texture. +- :ref:`NodePath` **viewport_path** ++----------+-----------------------------------+ +| *Setter* | set_viewport_path_in_scene(value) | ++----------+-----------------------------------+ +| *Getter* | get_viewport_path_in_scene() | ++----------+-----------------------------------+ + +The path to the :ref:`Viewport` node to display. This is relative to the scene root, not to the node which uses the texture. diff --git a/classes/class_visibilityenabler.rst b/classes/class_visibilityenabler.rst index 88c97deb5..b2cbf40f6 100644 --- a/classes/class_visibilityenabler.rst +++ b/classes/class_visibilityenabler.rst @@ -8,6 +8,7 @@ VisibilityEnabler ================= **Inherits:** :ref:`VisibilityNotifier` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,18 +16,26 @@ Brief Description Enable certain nodes only when visible. +Properties +---------- + ++-------------------------+-------------------------------------------------------------------+ +| :ref:`bool` | :ref:`freeze_bodies` | ++-------------------------+-------------------------------------------------------------------+ +| :ref:`bool` | :ref:`pause_animations` | ++-------------------------+-------------------------------------------------------------------+ + Enumerations ------------ .. _enum_VisibilityEnabler_Enabler: -enum **Enabler** +enum **Enabler**: - **ENABLER_PAUSE_ANIMATIONS** = **0** --- This enabler will pause :ref:`AnimationPlayer` nodes. - **ENABLER_FREEZE_BODIES** = **1** --- This enabler will freeze :ref:`RigidBody` nodes. - **ENABLER_MAX** = **2** - Description ----------- @@ -39,8 +48,19 @@ Property Descriptions - :ref:`bool` **freeze_bodies** ++----------+----------------------+ +| *Setter* | set_enabler(value) | ++----------+----------------------+ +| *Getter* | is_enabler_enabled() | ++----------+----------------------+ + .. _class_VisibilityEnabler_pause_animations: - :ref:`bool` **pause_animations** ++----------+----------------------+ +| *Setter* | set_enabler(value) | ++----------+----------------------+ +| *Getter* | is_enabler_enabled() | ++----------+----------------------+ diff --git a/classes/class_visibilityenabler2d.rst b/classes/class_visibilityenabler2d.rst index 9396fd69c..8d9f5917c 100644 --- a/classes/class_visibilityenabler2d.rst +++ b/classes/class_visibilityenabler2d.rst @@ -8,6 +8,7 @@ VisibilityEnabler2D =================== **Inherits:** :ref:`VisibilityNotifier2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,12 +16,29 @@ Brief Description 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` | ++-------------------------+---------------------------------------------------------------------------------+ + Enumerations ------------ .. _enum_VisibilityEnabler2D_Enabler: -enum **Enabler** +enum **Enabler**: - **ENABLER_PAUSE_ANIMATIONS** = **0** --- This enabler will pause :ref:`AnimationPlayer` nodes. - **ENABLER_FREEZE_BODIES** = **1** --- This enabler will freeze :ref:`RigidBody2D` nodes. @@ -30,7 +48,6 @@ enum **Enabler** - **ENABLER_PAUSE_ANIMATED_SPRITES** = **5** - **ENABLER_MAX** = **6** - Description ----------- @@ -43,24 +60,59 @@ Property Descriptions - :ref:`bool` **freeze_bodies** ++----------+----------------------+ +| *Setter* | set_enabler(value) | ++----------+----------------------+ +| *Getter* | is_enabler_enabled() | ++----------+----------------------+ + .. _class_VisibilityEnabler2D_pause_animated_sprites: - :ref:`bool` **pause_animated_sprites** ++----------+----------------------+ +| *Setter* | set_enabler(value) | ++----------+----------------------+ +| *Getter* | is_enabler_enabled() | ++----------+----------------------+ + .. _class_VisibilityEnabler2D_pause_animations: - :ref:`bool` **pause_animations** ++----------+----------------------+ +| *Setter* | set_enabler(value) | ++----------+----------------------+ +| *Getter* | is_enabler_enabled() | ++----------+----------------------+ + .. _class_VisibilityEnabler2D_pause_particles: - :ref:`bool` **pause_particles** ++----------+----------------------+ +| *Setter* | set_enabler(value) | ++----------+----------------------+ +| *Getter* | is_enabler_enabled() | ++----------+----------------------+ + .. _class_VisibilityEnabler2D_physics_process_parent: - :ref:`bool` **physics_process_parent** ++----------+----------------------+ +| *Setter* | set_enabler(value) | ++----------+----------------------+ +| *Getter* | is_enabler_enabled() | ++----------+----------------------+ + .. _class_VisibilityEnabler2D_process_parent: - :ref:`bool` **process_parent** ++----------+----------------------+ +| *Setter* | set_enabler(value) | ++----------+----------------------+ +| *Getter* | is_enabler_enabled() | ++----------+----------------------+ diff --git a/classes/class_visibilitynotifier.rst b/classes/class_visibilitynotifier.rst index 05a8b0afb..480f1fab4 100644 --- a/classes/class_visibilitynotifier.rst +++ b/classes/class_visibilitynotifier.rst @@ -8,7 +8,9 @@ VisibilityNotifier ================== **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`VisibilityEnabler` + **Category:** Core Brief Description @@ -16,6 +18,13 @@ Brief Description Detects when the node is visible on screen. +Properties +---------- + ++-------------------------+--------------------------------------------+ +| :ref:`AABB` | :ref:`aabb` | ++-------------------------+--------------------------------------------+ + Methods ------- @@ -26,31 +35,30 @@ Methods Signals ------- -.. _class_VisibilityNotifier_camera_entered: + .. _class_VisibilityNotifier_camera_entered: - **camera_entered** **(** :ref:`Camera` camera **)** Emitted when the VisibilityNotifier enters a :ref:`Camera`'s view. -.. _class_VisibilityNotifier_camera_exited: + .. _class_VisibilityNotifier_camera_exited: - **camera_exited** **(** :ref:`Camera` camera **)** Emitted when the VisibilityNotifier exits a :ref:`Camera`'s view. -.. _class_VisibilityNotifier_screen_entered: + .. _class_VisibilityNotifier_screen_entered: - **screen_entered** **(** **)** Emitted when the VisibilityNotifier enters the screen. -.. _class_VisibilityNotifier_screen_exited: + .. _class_VisibilityNotifier_screen_exited: - **screen_exited** **(** **)** Emitted when the VisibilityNotifier exits the screen. - Description ----------- @@ -61,16 +69,22 @@ Property Descriptions .. _class_VisibilityNotifier_aabb: -- :ref:`AABB` **aabb** - The VisibilityNotifier's bounding box. +- :ref:`AABB` **aabb** ++----------+-----------------+ +| *Setter* | set_aabb(value) | ++----------+-----------------+ +| *Getter* | get_aabb() | ++----------+-----------------+ + +The VisibilityNotifier's bounding box. Method Descriptions ------------------- -.. _class_VisibilityNotifier_is_on_screen: + .. _class_VisibilityNotifier_is_on_screen: - :ref:`bool` **is_on_screen** **(** **)** const If ``true`` the bounding box is on the screen. - diff --git a/classes/class_visibilitynotifier2d.rst b/classes/class_visibilitynotifier2d.rst index 43d1af049..56e8d4920 100644 --- a/classes/class_visibilitynotifier2d.rst +++ b/classes/class_visibilitynotifier2d.rst @@ -8,7 +8,9 @@ VisibilityNotifier2D ==================== **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`VisibilityEnabler2D` + **Category:** Core Brief Description @@ -16,6 +18,13 @@ Brief Description Detects when the node is visible on screen. +Properties +---------- + ++---------------------------+----------------------------------------------+ +| :ref:`Rect2` | :ref:`rect` | ++---------------------------+----------------------------------------------+ + Methods ------- @@ -26,31 +35,30 @@ Methods Signals ------- -.. _class_VisibilityNotifier2D_screen_entered: + .. _class_VisibilityNotifier2D_screen_entered: - **screen_entered** **(** **)** Emitted when the VisibilityNotifier2D enters the screen. -.. _class_VisibilityNotifier2D_screen_exited: + .. _class_VisibilityNotifier2D_screen_exited: - **screen_exited** **(** **)** Emitted when the VisibilityNotifier2D exits the screen. -.. _class_VisibilityNotifier2D_viewport_entered: + .. _class_VisibilityNotifier2D_viewport_entered: - **viewport_entered** **(** :ref:`Viewport` viewport **)** Emitted when the VisibilityNotifier2D enters a :ref:`Viewport`'s view. -.. _class_VisibilityNotifier2D_viewport_exited: + .. _class_VisibilityNotifier2D_viewport_exited: - **viewport_exited** **(** :ref:`Viewport` viewport **)** Emitted when the VisibilityNotifier2D exits a :ref:`Viewport`'s view. - Description ----------- @@ -61,16 +69,22 @@ Property Descriptions .. _class_VisibilityNotifier2D_rect: -- :ref:`Rect2` **rect** - The VisibilityNotifier2D's bounding rectangle. +- :ref:`Rect2` **rect** ++----------+-----------------+ +| *Setter* | set_rect(value) | ++----------+-----------------+ +| *Getter* | get_rect() | ++----------+-----------------+ + +The VisibilityNotifier2D's bounding rectangle. Method Descriptions ------------------- -.. _class_VisibilityNotifier2D_is_on_screen: + .. _class_VisibilityNotifier2D_is_on_screen: - :ref:`bool` **is_on_screen** **(** **)** const If ``true`` the bounding rectangle is on the screen. - diff --git a/classes/class_visualinstance.rst b/classes/class_visualinstance.rst index e88bdc130..d2dbe563d 100644 --- a/classes/class_visualinstance.rst +++ b/classes/class_visualinstance.rst @@ -8,7 +8,9 @@ VisualInstance ============== **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`BakedLightmap`, :ref:`Light`, :ref:`RootMotionView`, :ref:`ReflectionProbe`, :ref:`CSGShape`, :ref:`GIProbe`, :ref:`GeometryInstance` + **Category:** Core Brief Description @@ -16,6 +18,13 @@ Brief Description +Properties +---------- + ++-----------------------+--------------------------------------------+ +| :ref:`int` | :ref:`layers` | ++-----------------------+--------------------------------------------+ + Methods ------- @@ -36,25 +45,32 @@ Property Descriptions .. _class_VisualInstance_layers: -- :ref:`int` **layers** - The render layer(s) this VisualInstance is drawn on. +- :ref:`int` **layers** + ++----------+-----------------------+ +| *Setter* | set_layer_mask(value) | ++----------+-----------------------+ +| *Getter* | get_layer_mask() | ++----------+-----------------------+ + +The render layer(s) this VisualInstance is drawn on. This object will only be visible for :ref:`Camera`\ s whose cull mask includes the render object this VisualInstance is set to. - Method Descriptions ------------------- -.. _class_VisualInstance_get_aabb: + .. _class_VisualInstance_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_get_layer_mask_bit: - :ref:`bool` **get_layer_mask_bit** **(** :ref:`int` layer **)** const -.. _class_VisualInstance_get_transformed_aabb: + .. _class_VisualInstance_get_transformed_aabb: - :ref:`AABB` **get_transformed_aabb** **(** **)** const @@ -62,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_set_base: - void **set_base** **(** :ref:`RID` base **)** @@ -70,8 +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_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 6f47e7123..309d2ed68 100644 --- a/classes/class_visualscript.rst +++ b/classes/class_visualscript.rst @@ -8,6 +8,7 @@ VisualScript ============ **Inherits:** :ref:`Script` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -107,13 +108,12 @@ Methods Signals ------- -.. _class_VisualScript_node_ports_changed: + .. _class_VisualScript_node_ports_changed: - **node_ports_changed** **(** :ref:`String` function, :ref:`int` id **)** Emitted when the ports of a node are changed. - Description ----------- @@ -127,215 +127,214 @@ Tutorials --------- - :doc:`../getting_started/scripting/visual_script/index` - Method Descriptions ------------------- -.. _class_VisualScript_add_custom_signal: + .. _class_VisualScript_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_add_function: - void **add_function** **(** :ref:`String` name **)** Add a function with the specified name to the VisualScript. -.. _class_VisualScript_add_node: + .. _class_VisualScript_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_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_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`. -.. _class_VisualScript_custom_signal_get_argument_count: + .. _class_VisualScript_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_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_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_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_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_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_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_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_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`. -.. _class_VisualScript_get_function_node_id: + .. _class_VisualScript_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_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_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_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_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_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_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_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_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_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_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_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_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_remove_custom_signal: - void **remove_custom_signal** **(** :ref:`String` name **)** Remove a custom signal with the given name. -.. _class_VisualScript_remove_function: + .. _class_VisualScript_remove_function: - void **remove_function** **(** :ref:`String` name **)** Remove a specific function and its nodes from the script. -.. _class_VisualScript_remove_node: + .. _class_VisualScript_remove_node: - void **remove_node** **(** :ref:`String` func, :ref:`int` id **)** Remove a specific node. -.. _class_VisualScript_remove_variable: + .. _class_VisualScript_remove_variable: - void **remove_variable** **(** :ref:`String` name **)** Remove a variable with the given name. -.. _class_VisualScript_rename_custom_signal: + .. _class_VisualScript_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_rename_function: - void **rename_function** **(** :ref:`String` name, :ref:`String` new_name **)** Change the name of a function. -.. _class_VisualScript_rename_variable: + .. _class_VisualScript_rename_variable: - void **rename_variable** **(** :ref:`String` name, :ref:`String` new_name **)** Change the name of a variable. -.. _class_VisualScript_sequence_connect: + .. _class_VisualScript_sequence_connect: - void **sequence_connect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** @@ -343,46 +342,45 @@ Connect two sequence ports. The execution will flow from of ``from_node``'s ``fr 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_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`. -.. _class_VisualScript_set_function_scroll: + .. _class_VisualScript_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_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_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_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_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_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`. - diff --git a/classes/class_visualscriptbasictypeconstant.rst b/classes/class_visualscriptbasictypeconstant.rst index 9f45bdffa..6df1402bb 100644 --- a/classes/class_visualscriptbasictypeconstant.rst +++ b/classes/class_visualscriptbasictypeconstant.rst @@ -8,6 +8,7 @@ VisualScriptBasicTypeConstant ============================= **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description A Visual Script node representing a constant from the base types. +Properties +---------- + ++-----------------------------------------------------+-------------------------------------------------------------------+ +| :ref:`Variant.Type` | :ref:`basic_type` | ++-----------------------------------------------------+-------------------------------------------------------------------+ +| :ref:`String` | :ref:`constant` | ++-----------------------------------------------------+-------------------------------------------------------------------+ + Description ----------- @@ -25,10 +35,25 @@ Property Descriptions .. _class_VisualScriptBasicTypeConstant_basic_type: -- :ref:`Variant.Type` **basic_type** - The type to get the constant from. +- :ref:`Variant.Type` **basic_type** + ++----------+-----------------------+ +| *Setter* | set_basic_type(value) | ++----------+-----------------------+ +| *Getter* | get_basic_type() | ++----------+-----------------------+ + +The type to get the constant from. .. _class_VisualScriptBasicTypeConstant_constant: -- :ref:`String` **constant** - The name of the constant to return. +- :ref:`String` **constant** ++----------+--------------------------------+ +| *Setter* | set_basic_type_constant(value) | ++----------+--------------------------------+ +| *Getter* | get_basic_type_constant() | ++----------+--------------------------------+ + +The name of the constant to return. diff --git a/classes/class_visualscriptbuiltinfunc.rst b/classes/class_visualscriptbuiltinfunc.rst index 60a8ae5f3..c699a1bb5 100644 --- a/classes/class_visualscriptbuiltinfunc.rst +++ b/classes/class_visualscriptbuiltinfunc.rst @@ -8,6 +8,7 @@ VisualScriptBuiltinFunc ======================= **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,12 +16,19 @@ Brief Description A Visual Script node used to call built-in functions. +Properties +---------- + ++--------------------------------------------------------------+---------------------------------------------------------+ +| :ref:`BuiltinFunc` | :ref:`function` | ++--------------------------------------------------------------+---------------------------------------------------------+ + Enumerations ------------ .. _enum_VisualScriptBuiltinFunc_BuiltinFunc: -enum **BuiltinFunc** +enum **BuiltinFunc**: - **MATH_SIN** = **0** --- Return the sine of the input. - **MATH_COS** = **1** --- Return the cosine of the input. @@ -87,7 +95,6 @@ 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. - Description ----------- @@ -100,6 +107,13 @@ Property Descriptions .. _class_VisualScriptBuiltinFunc_function: -- :ref:`BuiltinFunc` **function** - The function to be executed. +- :ref:`BuiltinFunc` **function** ++----------+-----------------+ +| *Setter* | set_func(value) | ++----------+-----------------+ +| *Getter* | get_func() | ++----------+-----------------+ + +The function to be executed. diff --git a/classes/class_visualscriptclassconstant.rst b/classes/class_visualscriptclassconstant.rst index 25011b8f8..174218ea4 100644 --- a/classes/class_visualscriptclassconstant.rst +++ b/classes/class_visualscriptclassconstant.rst @@ -8,6 +8,7 @@ VisualScriptClassConstant ========================= **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description Gets a constant from a given class. +Properties +---------- + ++-----------------------------+-------------------------------------------------------------+ +| :ref:`String` | :ref:`base_type` | ++-----------------------------+-------------------------------------------------------------+ +| :ref:`String` | :ref:`constant` | ++-----------------------------+-------------------------------------------------------------+ + Description ----------- @@ -33,10 +43,25 @@ Property Descriptions .. _class_VisualScriptClassConstant_base_type: -- :ref:`String` **base_type** - The constant's parent class. +- :ref:`String` **base_type** + ++----------+----------------------+ +| *Setter* | set_base_type(value) | ++----------+----------------------+ +| *Getter* | get_base_type() | ++----------+----------------------+ + +The constant's parent class. .. _class_VisualScriptClassConstant_constant: -- :ref:`String` **constant** - The constant to return. See the given class for its available constants. +- :ref:`String` **constant** ++----------+---------------------------+ +| *Setter* | set_class_constant(value) | ++----------+---------------------------+ +| *Getter* | get_class_constant() | ++----------+---------------------------+ + +The constant to return. See the given class for its available constants. diff --git a/classes/class_visualscriptcomment.rst b/classes/class_visualscriptcomment.rst index ba999788b..c7531e606 100644 --- a/classes/class_visualscriptcomment.rst +++ b/classes/class_visualscriptcomment.rst @@ -8,6 +8,7 @@ VisualScriptComment =================== **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,17 @@ Brief Description A Visual Script node used to annotate the script. +Properties +---------- + ++-------------------------------+-----------------------------------------------------------+ +| :ref:`String` | :ref:`description` | ++-------------------------------+-----------------------------------------------------------+ +| :ref:`Vector2` | :ref:`size` | ++-------------------------------+-----------------------------------------------------------+ +| :ref:`String` | :ref:`title` | ++-------------------------------+-----------------------------------------------------------+ + Description ----------- @@ -27,14 +39,37 @@ Property Descriptions .. _class_VisualScriptComment_description: -- :ref:`String` **description** - The text inside the comment node. +- :ref:`String` **description** + ++----------+------------------------+ +| *Setter* | set_description(value) | ++----------+------------------------+ +| *Getter* | get_description() | ++----------+------------------------+ + +The text inside the comment node. .. _class_VisualScriptComment_size: -- :ref:`Vector2` **size** - The comment node's size (in pixels). +- :ref:`Vector2` **size** + ++----------+-----------------+ +| *Setter* | set_size(value) | ++----------+-----------------+ +| *Getter* | get_size() | ++----------+-----------------+ + +The comment node's size (in pixels). .. _class_VisualScriptComment_title: -- :ref:`String` **title** - The comment node's title. +- :ref:`String` **title** ++----------+------------------+ +| *Setter* | set_title(value) | ++----------+------------------+ +| *Getter* | get_title() | ++----------+------------------+ + +The comment node's title. diff --git a/classes/class_visualscriptcondition.rst b/classes/class_visualscriptcondition.rst index 605878810..a59b4f108 100644 --- a/classes/class_visualscriptcondition.rst +++ b/classes/class_visualscriptcondition.rst @@ -8,6 +8,7 @@ VisualScriptCondition ===================== **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_visualscriptconstant.rst b/classes/class_visualscriptconstant.rst index f3d66ea14..38bf88f90 100644 --- a/classes/class_visualscriptconstant.rst +++ b/classes/class_visualscriptconstant.rst @@ -8,6 +8,7 @@ VisualScriptConstant ==================== **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description Gets a contant's value. +Properties +---------- + ++-----------------------------------------------------+------------------------------------------------+ +| :ref:`Variant.Type` | :ref:`type` | ++-----------------------------------------------------+------------------------------------------------+ +| :ref:`Variant` | :ref:`value` | ++-----------------------------------------------------+------------------------------------------------+ + Description ----------- @@ -33,10 +43,25 @@ Property Descriptions .. _class_VisualScriptConstant_type: -- :ref:`Variant.Type` **type** - The constant's type. +- :ref:`Variant.Type` **type** + ++----------+--------------------------+ +| *Setter* | set_constant_type(value) | ++----------+--------------------------+ +| *Getter* | get_constant_type() | ++----------+--------------------------+ + +The constant's type. .. _class_VisualScriptConstant_value: -- :ref:`Variant` **value** - The constant's value. +- :ref:`Variant` **value** ++----------+---------------------------+ +| *Setter* | set_constant_value(value) | ++----------+---------------------------+ +| *Getter* | get_constant_value() | ++----------+---------------------------+ + +The constant's value. diff --git a/classes/class_visualscriptconstructor.rst b/classes/class_visualscriptconstructor.rst index 5cbd550b1..0151e6d11 100644 --- a/classes/class_visualscriptconstructor.rst +++ b/classes/class_visualscriptconstructor.rst @@ -8,6 +8,7 @@ VisualScriptConstructor ======================= **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -36,20 +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_get_constructor: - :ref:`Dictionary` **get_constructor** **(** **)** const -.. _class_VisualScriptConstructor_get_constructor_type: + .. _class_VisualScriptConstructor_get_constructor_type: - :ref:`Variant.Type` **get_constructor_type** **(** **)** const -.. _class_VisualScriptConstructor_set_constructor: + .. _class_VisualScriptConstructor_set_constructor: - void **set_constructor** **(** :ref:`Dictionary` constructor **)** -.. _class_VisualScriptConstructor_set_constructor_type: + .. _class_VisualScriptConstructor_set_constructor_type: - void **set_constructor_type** **(** :ref:`Variant.Type` type **)** - diff --git a/classes/class_visualscriptcustomnode.rst b/classes/class_visualscriptcustomnode.rst index 1ae5fe3b5..a2411a4f9 100644 --- a/classes/class_visualscriptcustomnode.rst +++ b/classes/class_visualscriptcustomnode.rst @@ -8,6 +8,7 @@ VisualScriptCustomNode ====================== **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -53,13 +54,12 @@ Enumerations .. _enum_VisualScriptCustomNode_StartMode: -enum **StartMode** +enum **StartMode**: - **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_RESUME_YIELD** = **2** --- The start mode used when :ref:`_step` is called after resuming from STEP_YIELD_BIT. - Constants --------- @@ -72,7 +72,6 @@ This is used by :ref:`VisualScriptCondition` to red - **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`. - Description ----------- @@ -81,85 +80,85 @@ A custom Visual Script node which can be scripted in powerful ways. Method Descriptions ------------------- -.. _class_VisualScriptCustomNode__get_caption: + .. _class_VisualScriptCustomNode__get_caption: - :ref:`String` **_get_caption** **(** **)** virtual Return the node's title. -.. _class_VisualScriptCustomNode__get_category: + .. _class_VisualScriptCustomNode__get_category: - :ref:`String` **_get_category** **(** **)** virtual Return the node's category. -.. _class_VisualScriptCustomNode__get_input_value_port_count: + .. _class_VisualScriptCustomNode__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__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__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__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__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__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__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__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__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__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. -.. _class_VisualScriptCustomNode__has_input_sequence_port: + .. _class_VisualScriptCustomNode__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__step: - :ref:`Variant` **_step** **(** :ref:`Array` inputs, :ref:`Array` outputs, :ref:`int` start_mode, :ref:`Array` working_mem **)** virtual @@ -177,4 +176,3 @@ The ``start_mode`` is usually ``START_MODE_BEGIN_SEQUENCE``, unless you have use When returning, you can mask the returned value with one of the STEP\_\* constants. - diff --git a/classes/class_visualscriptdeconstruct.rst b/classes/class_visualscriptdeconstruct.rst index 08e41a36b..cf272236f 100644 --- a/classes/class_visualscriptdeconstruct.rst +++ b/classes/class_visualscriptdeconstruct.rst @@ -8,6 +8,7 @@ VisualScriptDeconstruct ======================= **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description A Visual Script node which deconstructs a base type instance into its parts. +Properties +---------- + ++-----------------------------------------------------+-------------------------------------------------+ +| :ref:`Variant.Type` | :ref:`type` | ++-----------------------------------------------------+-------------------------------------------------+ + Description ----------- @@ -25,6 +33,13 @@ Property Descriptions .. _class_VisualScriptDeconstruct_type: -- :ref:`Variant.Type` **type** - The type to deconstruct. +- :ref:`Variant.Type` **type** ++----------+-----------------------------+ +| *Setter* | set_deconstruct_type(value) | ++----------+-----------------------------+ +| *Getter* | get_deconstruct_type() | ++----------+-----------------------------+ + +The type to deconstruct. diff --git a/classes/class_visualscripteditor.rst b/classes/class_visualscripteditor.rst index 3cd18eb05..dcdac1d86 100644 --- a/classes/class_visualscripteditor.rst +++ b/classes/class_visualscripteditor.rst @@ -8,6 +8,7 @@ VisualScriptEditor ================== **Inherits:** :ref:`Object` + **Category:** Core Brief Description @@ -27,26 +28,24 @@ Methods Signals ------- -.. _class_VisualScriptEditor_custom_nodes_updated: + .. _class_VisualScriptEditor_custom_nodes_updated: - **custom_nodes_updated** **(** **)** Emitted when a custom Visual Script node is added or removed. - Method Descriptions ------------------- -.. _class_VisualScriptEditor_add_custom_node: + .. _class_VisualScriptEditor_add_custom_node: - void **add_custom_node** **(** :ref:`String` name, :ref:`String` category, :ref:`Script` script **)** Add a custom Visual Script node to the editor. It'll be placed under "Custom Nodes" with the ``category`` as the parameter. -.. _class_VisualScriptEditor_remove_custom_node: + .. _class_VisualScriptEditor_remove_custom_node: - void **remove_custom_node** **(** :ref:`String` name, :ref:`String` category **)** Remove a custom Visual Script node from the editor. Custom nodes already placed on scripts won't be removed. - diff --git a/classes/class_visualscriptemitsignal.rst b/classes/class_visualscriptemitsignal.rst index a7835a9ce..9b9b6c8d1 100644 --- a/classes/class_visualscriptemitsignal.rst +++ b/classes/class_visualscriptemitsignal.rst @@ -8,6 +8,7 @@ VisualScriptEmitSignal ====================== **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Emits a specified signal. +Properties +---------- + ++-----------------------------+----------------------------------------------------+ +| :ref:`String` | :ref:`signal` | ++-----------------------------+----------------------------------------------------+ + Description ----------- @@ -33,6 +41,13 @@ Property Descriptions .. _class_VisualScriptEmitSignal_signal: -- :ref:`String` **signal** - The signal to emit. +- :ref:`String` **signal** ++----------+-------------------+ +| *Setter* | set_signal(value) | ++----------+-------------------+ +| *Getter* | get_signal() | ++----------+-------------------+ + +The signal to emit. diff --git a/classes/class_visualscriptenginesingleton.rst b/classes/class_visualscriptenginesingleton.rst index e02ee50bb..2b2463c0c 100644 --- a/classes/class_visualscriptenginesingleton.rst +++ b/classes/class_visualscriptenginesingleton.rst @@ -8,6 +8,7 @@ VisualScriptEngineSingleton =========================== **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description A Visual Script node returning a singleton from :ref:`@GlobalScope` +Properties +---------- + ++-----------------------------+-------------------------------------------------------------+ +| :ref:`String` | :ref:`constant` | ++-----------------------------+-------------------------------------------------------------+ + Description ----------- @@ -25,6 +33,13 @@ Property Descriptions .. _class_VisualScriptEngineSingleton_constant: -- :ref:`String` **constant** - The singleton's name. +- :ref:`String` **constant** ++----------+----------------------+ +| *Setter* | set_singleton(value) | ++----------+----------------------+ +| *Getter* | get_singleton() | ++----------+----------------------+ + +The singleton's name. diff --git a/classes/class_visualscriptexpression.rst b/classes/class_visualscriptexpression.rst index 3c7ab3872..a8bccb7cd 100644 --- a/classes/class_visualscriptexpression.rst +++ b/classes/class_visualscriptexpression.rst @@ -8,6 +8,7 @@ VisualScriptExpression ====================== **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_visualscriptfunction.rst b/classes/class_visualscriptfunction.rst index d45a7b9a8..1b8c9f771 100644 --- a/classes/class_visualscriptfunction.rst +++ b/classes/class_visualscriptfunction.rst @@ -8,6 +8,7 @@ VisualScriptFunction ==================== **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_visualscriptfunctioncall.rst b/classes/class_visualscriptfunctioncall.rst index 646aac8eb..9717e4f17 100644 --- a/classes/class_visualscriptfunctioncall.rst +++ b/classes/class_visualscriptfunctioncall.rst @@ -8,6 +8,7 @@ VisualScriptFunctionCall ======================== **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,12 +16,37 @@ 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` | ++---------------------------------------------------------------+--------------------------------------------------------------------------+ + Enumerations ------------ .. _enum_VisualScriptFunctionCall_CallMode: -enum **CallMode** +enum **CallMode**: - **CALL_MODE_SELF** = **0** - **CALL_MODE_NODE_PATH** = **1** @@ -30,7 +56,7 @@ enum **CallMode** .. _enum_VisualScriptFunctionCall_RPCCallMode: -enum **RPCCallMode** +enum **RPCCallMode**: - **RPC_DISABLED** = **0** - **RPC_RELIABLE** = **1** @@ -38,7 +64,6 @@ enum **RPCCallMode** - **RPC_RELIABLE_TO_ID** = **3** - **RPC_UNRELIABLE_TO_ID** = **4** - Property Descriptions --------------------- @@ -46,40 +71,99 @@ Property Descriptions - :ref:`String` **base_script** ++----------+------------------------+ +| *Setter* | set_base_script(value) | ++----------+------------------------+ +| *Getter* | get_base_script() | ++----------+------------------------+ + .. _class_VisualScriptFunctionCall_base_type: - :ref:`String` **base_type** ++----------+----------------------+ +| *Setter* | set_base_type(value) | ++----------+----------------------+ +| *Getter* | get_base_type() | ++----------+----------------------+ + .. _class_VisualScriptFunctionCall_basic_type: - :ref:`Variant.Type` **basic_type** ++----------+-----------------------+ +| *Setter* | set_basic_type(value) | ++----------+-----------------------+ +| *Getter* | get_basic_type() | ++----------+-----------------------+ + .. _class_VisualScriptFunctionCall_call_mode: - :ref:`CallMode` **call_mode** ++----------+----------------------+ +| *Setter* | set_call_mode(value) | ++----------+----------------------+ +| *Getter* | get_call_mode() | ++----------+----------------------+ + .. _class_VisualScriptFunctionCall_function: - :ref:`String` **function** ++----------+---------------------+ +| *Setter* | set_function(value) | ++----------+---------------------+ +| *Getter* | get_function() | ++----------+---------------------+ + .. _class_VisualScriptFunctionCall_node_path: - :ref:`NodePath` **node_path** ++----------+----------------------+ +| *Setter* | set_base_path(value) | ++----------+----------------------+ +| *Getter* | get_base_path() | ++----------+----------------------+ + .. _class_VisualScriptFunctionCall_rpc_call_mode: - :ref:`RPCCallMode` **rpc_call_mode** ++----------+--------------------------+ +| *Setter* | set_rpc_call_mode(value) | ++----------+--------------------------+ +| *Getter* | get_rpc_call_mode() | ++----------+--------------------------+ + .. _class_VisualScriptFunctionCall_singleton: - :ref:`String` **singleton** ++----------+----------------------+ +| *Setter* | set_singleton(value) | ++----------+----------------------+ +| *Getter* | get_singleton() | ++----------+----------------------+ + .. _class_VisualScriptFunctionCall_use_default_args: - :ref:`int` **use_default_args** ++----------+-----------------------------+ +| *Setter* | set_use_default_args(value) | ++----------+-----------------------------+ +| *Getter* | get_use_default_args() | ++----------+-----------------------------+ + .. _class_VisualScriptFunctionCall_validate: - :ref:`bool` **validate** ++----------+---------------------+ +| *Setter* | set_validate(value) | ++----------+---------------------+ +| *Getter* | get_validate() | ++----------+---------------------+ diff --git a/classes/class_visualscriptfunctionstate.rst b/classes/class_visualscriptfunctionstate.rst index e2ba47e1d..b0df906e5 100644 --- a/classes/class_visualscriptfunctionstate.rst +++ b/classes/class_visualscriptfunctionstate.rst @@ -8,6 +8,7 @@ VisualScriptFunctionState ========================= **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -29,16 +30,15 @@ Methods Method Descriptions ------------------- -.. _class_VisualScriptFunctionState_connect_to_signal: + .. _class_VisualScriptFunctionState_connect_to_signal: - void **connect_to_signal** **(** :ref:`Object` obj, :ref:`String` signals, :ref:`Array` args **)** -.. _class_VisualScriptFunctionState_is_valid: + .. _class_VisualScriptFunctionState_is_valid: - :ref:`bool` **is_valid** **(** **)** const -.. _class_VisualScriptFunctionState_resume: + .. _class_VisualScriptFunctionState_resume: - :ref:`Variant` **resume** **(** :ref:`Array` args=null **)** - diff --git a/classes/class_visualscriptglobalconstant.rst b/classes/class_visualscriptglobalconstant.rst index 3b3911949..6d352c9fe 100644 --- a/classes/class_visualscriptglobalconstant.rst +++ b/classes/class_visualscriptglobalconstant.rst @@ -8,6 +8,7 @@ VisualScriptGlobalConstant ========================== **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description +Properties +---------- + ++-----------------------+------------------------------------------------------------+ +| :ref:`int` | :ref:`constant` | ++-----------------------+------------------------------------------------------------+ + Property Descriptions --------------------- @@ -22,4 +30,9 @@ Property Descriptions - :ref:`int` **constant** ++----------+----------------------------+ +| *Setter* | set_global_constant(value) | ++----------+----------------------------+ +| *Getter* | get_global_constant() | ++----------+----------------------------+ diff --git a/classes/class_visualscriptindexget.rst b/classes/class_visualscriptindexget.rst index caf2731c5..08672421f 100644 --- a/classes/class_visualscriptindexget.rst +++ b/classes/class_visualscriptindexget.rst @@ -8,6 +8,7 @@ VisualScriptIndexGet ==================== **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_visualscriptindexset.rst b/classes/class_visualscriptindexset.rst index 6d577a284..847a9f494 100644 --- a/classes/class_visualscriptindexset.rst +++ b/classes/class_visualscriptindexset.rst @@ -8,6 +8,7 @@ VisualScriptIndexSet ==================== **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_visualscriptinputaction.rst b/classes/class_visualscriptinputaction.rst index d0eecc73f..ff1c638c9 100644 --- a/classes/class_visualscriptinputaction.rst +++ b/classes/class_visualscriptinputaction.rst @@ -8,6 +8,7 @@ VisualScriptInputAction ======================= **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,19 +16,27 @@ Brief Description +Properties +---------- + ++------------------------------------------------+-----------------------------------------------------+ +| :ref:`String` | :ref:`action` | ++------------------------------------------------+-----------------------------------------------------+ +| :ref:`Mode` | :ref:`mode` | ++------------------------------------------------+-----------------------------------------------------+ + Enumerations ------------ .. _enum_VisualScriptInputAction_Mode: -enum **Mode** +enum **Mode**: - **MODE_PRESSED** = **0** - **MODE_RELEASED** = **1** - **MODE_JUST_PRESSED** = **2** - **MODE_JUST_RELEASED** = **3** - Property Descriptions --------------------- @@ -35,8 +44,19 @@ Property Descriptions - :ref:`String` **action** ++----------+------------------------+ +| *Setter* | set_action_name(value) | ++----------+------------------------+ +| *Getter* | get_action_name() | ++----------+------------------------+ + .. _class_VisualScriptInputAction_mode: - :ref:`Mode` **mode** ++----------+------------------------+ +| *Setter* | set_action_mode(value) | ++----------+------------------------+ +| *Getter* | get_action_mode() | ++----------+------------------------+ diff --git a/classes/class_visualscriptiterator.rst b/classes/class_visualscriptiterator.rst index 2c479c313..e7921d069 100644 --- a/classes/class_visualscriptiterator.rst +++ b/classes/class_visualscriptiterator.rst @@ -8,6 +8,7 @@ VisualScriptIterator ==================== **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_visualscriptlocalvar.rst b/classes/class_visualscriptlocalvar.rst index 925383dfd..44f91c939 100644 --- a/classes/class_visualscriptlocalvar.rst +++ b/classes/class_visualscriptlocalvar.rst @@ -8,6 +8,7 @@ VisualScriptLocalVar ==================== **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description Gets a local variable's value. +Properties +---------- + ++-----------------------------------------------------+------------------------------------------------------+ +| :ref:`Variant.Type` | :ref:`type` | ++-----------------------------------------------------+------------------------------------------------------+ +| :ref:`String` | :ref:`var_name` | ++-----------------------------------------------------+------------------------------------------------------+ + Description ----------- @@ -33,10 +43,25 @@ Property Descriptions .. _class_VisualScriptLocalVar_type: -- :ref:`Variant.Type` **type** - The local variable's type. +- :ref:`Variant.Type` **type** + ++----------+---------------------+ +| *Setter* | set_var_type(value) | ++----------+---------------------+ +| *Getter* | get_var_type() | ++----------+---------------------+ + +The local variable's type. .. _class_VisualScriptLocalVar_var_name: -- :ref:`String` **var_name** - The local variable's name. +- :ref:`String` **var_name** ++----------+---------------------+ +| *Setter* | set_var_name(value) | ++----------+---------------------+ +| *Getter* | get_var_name() | ++----------+---------------------+ + +The local variable's name. diff --git a/classes/class_visualscriptlocalvarset.rst b/classes/class_visualscriptlocalvarset.rst index 5ae83b49f..ba4ef383e 100644 --- a/classes/class_visualscriptlocalvarset.rst +++ b/classes/class_visualscriptlocalvarset.rst @@ -8,6 +8,7 @@ VisualScriptLocalVarSet ======================= **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description Changes a local variable's value. +Properties +---------- + ++-----------------------------------------------------+---------------------------------------------------------+ +| :ref:`Variant.Type` | :ref:`type` | ++-----------------------------------------------------+---------------------------------------------------------+ +| :ref:`String` | :ref:`var_name` | ++-----------------------------------------------------+---------------------------------------------------------+ + Description ----------- @@ -37,10 +47,25 @@ Property Descriptions .. _class_VisualScriptLocalVarSet_type: -- :ref:`Variant.Type` **type** - The local variable's type. +- :ref:`Variant.Type` **type** + ++----------+---------------------+ +| *Setter* | set_var_type(value) | ++----------+---------------------+ +| *Getter* | get_var_type() | ++----------+---------------------+ + +The local variable's type. .. _class_VisualScriptLocalVarSet_var_name: -- :ref:`String` **var_name** - The local variable's name. +- :ref:`String` **var_name** ++----------+---------------------+ +| *Setter* | set_var_name(value) | ++----------+---------------------+ +| *Getter* | get_var_name() | ++----------+---------------------+ + +The local variable's name. diff --git a/classes/class_visualscriptmathconstant.rst b/classes/class_visualscriptmathconstant.rst index aac4a485c..84942f5c0 100644 --- a/classes/class_visualscriptmathconstant.rst +++ b/classes/class_visualscriptmathconstant.rst @@ -8,6 +8,7 @@ VisualScriptMathConstant ======================== **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,12 +16,19 @@ Brief Description Commonly used mathematical constants. +Properties +---------- + ++-----------------------------------------------------------------+----------------------------------------------------------+ +| :ref:`MathConstant` | :ref:`constant` | ++-----------------------------------------------------------------+----------------------------------------------------------+ + Enumerations ------------ .. _enum_VisualScriptMathConstant_MathConstant: -enum **MathConstant** +enum **MathConstant**: - **MATH_CONSTANT_ONE** = **0** --- Unity: ``1`` - **MATH_CONSTANT_PI** = **1** --- Pi: ``3.141593`` @@ -32,7 +40,6 @@ enum **MathConstant** - **MATH_CONSTANT_NAN** = **7** --- Not a number: ``nan`` - **MATH_CONSTANT_MAX** = **8** - Description ----------- @@ -51,6 +58,13 @@ Property Descriptions .. _class_VisualScriptMathConstant_constant: -- :ref:`MathConstant` **constant** - The math constant. +- :ref:`MathConstant` **constant** ++----------+--------------------------+ +| *Setter* | set_math_constant(value) | ++----------+--------------------------+ +| *Getter* | get_math_constant() | ++----------+--------------------------+ + +The math constant. diff --git a/classes/class_visualscriptnode.rst b/classes/class_visualscriptnode.rst index 25ae5fac6..71f64047b 100644 --- a/classes/class_visualscriptnode.rst +++ b/classes/class_visualscriptnode.rst @@ -8,7 +8,9 @@ VisualScriptNode ================ **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`VisualScriptLocalVar`, :ref:`VisualScriptSceneNode`, :ref:`VisualScriptBasicTypeConstant`, :ref:`VisualScriptSequence`, :ref:`VisualScriptVariableSet`, :ref:`VisualScriptSelf`, :ref:`VisualScriptConstant`, :ref:`VisualScriptReturn`, :ref:`VisualScriptSceneTree`, :ref:`VisualScriptIndexSet`, :ref:`VisualScriptResourcePath`, :ref:`VisualScriptPropertyGet`, :ref:`VisualScriptVariableGet`, :ref:`VisualScriptInputAction`, :ref:`VisualScriptEmitSignal`, :ref:`VisualScriptDeconstruct`, :ref:`VisualScriptTypeCast`, :ref:`VisualScriptGlobalConstant`, :ref:`VisualScriptFunctionCall`, :ref:`VisualScriptSwitch`, :ref:`VisualScriptBuiltinFunc`, :ref:`VisualScriptClassConstant`, :ref:`VisualScriptEngineSingleton`, :ref:`VisualScriptCondition`, :ref:`VisualScriptOperator`, :ref:`VisualScriptIterator`, :ref:`VisualScriptCustomNode`, :ref:`VisualScriptYield`, :ref:`VisualScriptSubCall`, :ref:`VisualScriptYieldSignal`, :ref:`VisualScriptIndexGet`, :ref:`VisualScriptLocalVarSet`, :ref:`VisualScriptWhile`, :ref:`VisualScriptConstructor`, :ref:`VisualScriptMathConstant`, :ref:`VisualScriptComment`, :ref:`VisualScriptExpression`, :ref:`VisualScriptPropertySet`, :ref:`VisualScriptFunction`, :ref:`VisualScriptPreload`, :ref:`VisualScriptSelect` + **Category:** Core Brief Description @@ -32,13 +34,12 @@ Methods Signals ------- -.. _class_VisualScriptNode_ports_changed: + .. _class_VisualScriptNode_ports_changed: - **ports_changed** **(** **)** Emitted when the available input/output ports are changed. - Description ----------- @@ -47,28 +48,27 @@ A node which is part of a :ref:`VisualScript`. Not to be con Method Descriptions ------------------- -.. _class_VisualScriptNode_get_default_input_value: + .. _class_VisualScriptNode_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_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_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_set_default_input_value: - void **set_default_input_value** **(** :ref:`int` port_idx, :ref:`Variant` value **)** Change the default value of a given port. - diff --git a/classes/class_visualscriptoperator.rst b/classes/class_visualscriptoperator.rst index aaa745b82..a88f13f8b 100644 --- a/classes/class_visualscriptoperator.rst +++ b/classes/class_visualscriptoperator.rst @@ -8,6 +8,7 @@ VisualScriptOperator ==================== **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description +Properties +---------- + ++-------------------------------------------------------------+------------------------------------------------------+ +| :ref:`Variant.Operator` | :ref:`operator` | ++-------------------------------------------------------------+------------------------------------------------------+ +| :ref:`Variant.Type` | :ref:`type` | ++-------------------------------------------------------------+------------------------------------------------------+ + Description ----------- @@ -35,8 +45,19 @@ Property Descriptions - :ref:`Variant.Operator` **operator** ++----------+---------------------+ +| *Setter* | set_operator(value) | ++----------+---------------------+ +| *Getter* | get_operator() | ++----------+---------------------+ + .. _class_VisualScriptOperator_type: - :ref:`Variant.Type` **type** ++----------+------------------+ +| *Setter* | set_typed(value) | ++----------+------------------+ +| *Getter* | get_typed() | ++----------+------------------+ diff --git a/classes/class_visualscriptpreload.rst b/classes/class_visualscriptpreload.rst index 0b408130a..eb1cee460 100644 --- a/classes/class_visualscriptpreload.rst +++ b/classes/class_visualscriptpreload.rst @@ -8,6 +8,7 @@ VisualScriptPreload =================== **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Creates a new :ref:`Resource` or loads one from the filesystem. +Properties +---------- + ++---------------------------------+-----------------------------------------------------+ +| :ref:`Resource` | :ref:`resource` | ++---------------------------------+-----------------------------------------------------+ + Description ----------- @@ -33,6 +41,13 @@ Property Descriptions .. _class_VisualScriptPreload_resource: -- :ref:`Resource` **resource** - The :ref:`Resource` to load. +- :ref:`Resource` **resource** ++----------+--------------------+ +| *Setter* | set_preload(value) | ++----------+--------------------+ +| *Getter* | get_preload() | ++----------+--------------------+ + +The :ref:`Resource` to load. diff --git a/classes/class_visualscriptpropertyget.rst b/classes/class_visualscriptpropertyget.rst index 94fa5e1a0..f6ec3391c 100644 --- a/classes/class_visualscriptpropertyget.rst +++ b/classes/class_visualscriptpropertyget.rst @@ -8,6 +8,7 @@ VisualScriptPropertyGet ======================= **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,18 +16,36 @@ 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` | ++--------------------------------------------------------+---------------------------------------------------------------+ + Enumerations ------------ .. _enum_VisualScriptPropertyGet_CallMode: -enum **CallMode** +enum **CallMode**: - **CALL_MODE_SELF** = **0** - **CALL_MODE_NODE_PATH** = **1** - **CALL_MODE_INSTANCE** = **2** - Property Descriptions --------------------- @@ -34,28 +53,69 @@ Property Descriptions - :ref:`String` **base_script** ++----------+------------------------+ +| *Setter* | set_base_script(value) | ++----------+------------------------+ +| *Getter* | get_base_script() | ++----------+------------------------+ + .. _class_VisualScriptPropertyGet_base_type: - :ref:`String` **base_type** ++----------+----------------------+ +| *Setter* | set_base_type(value) | ++----------+----------------------+ +| *Getter* | get_base_type() | ++----------+----------------------+ + .. _class_VisualScriptPropertyGet_basic_type: - :ref:`Variant.Type` **basic_type** ++----------+-----------------------+ +| *Setter* | set_basic_type(value) | ++----------+-----------------------+ +| *Getter* | get_basic_type() | ++----------+-----------------------+ + .. _class_VisualScriptPropertyGet_index: - :ref:`String` **index** ++----------+------------------+ +| *Setter* | set_index(value) | ++----------+------------------+ +| *Getter* | get_index() | ++----------+------------------+ + .. _class_VisualScriptPropertyGet_node_path: - :ref:`NodePath` **node_path** ++----------+----------------------+ +| *Setter* | set_base_path(value) | ++----------+----------------------+ +| *Getter* | get_base_path() | ++----------+----------------------+ + .. _class_VisualScriptPropertyGet_property: - :ref:`String` **property** ++----------+---------------------+ +| *Setter* | set_property(value) | ++----------+---------------------+ +| *Getter* | get_property() | ++----------+---------------------+ + .. _class_VisualScriptPropertyGet_set_mode: - :ref:`CallMode` **set_mode** ++----------+----------------------+ +| *Setter* | set_call_mode(value) | ++----------+----------------------+ +| *Getter* | get_call_mode() | ++----------+----------------------+ diff --git a/classes/class_visualscriptpropertyset.rst b/classes/class_visualscriptpropertyset.rst index 835c1961e..019dfbce8 100644 --- a/classes/class_visualscriptpropertyset.rst +++ b/classes/class_visualscriptpropertyset.rst @@ -8,6 +8,7 @@ VisualScriptPropertySet ======================= **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,12 +16,33 @@ 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` | ++--------------------------------------------------------+---------------------------------------------------------------+ + Enumerations ------------ .. _enum_VisualScriptPropertySet_CallMode: -enum **CallMode** +enum **CallMode**: - **CALL_MODE_SELF** = **0** - **CALL_MODE_NODE_PATH** = **1** @@ -29,7 +51,7 @@ enum **CallMode** .. _enum_VisualScriptPropertySet_AssignOp: -enum **AssignOp** +enum **AssignOp**: - **ASSIGN_OP_NONE** = **0** - **ASSIGN_OP_ADD** = **1** @@ -43,7 +65,6 @@ enum **AssignOp** - **ASSIGN_OP_BIT_OR** = **9** - **ASSIGN_OP_BIT_XOR** = **10** - Property Descriptions --------------------- @@ -51,32 +72,79 @@ Property Descriptions - :ref:`AssignOp` **assign_op** ++----------+----------------------+ +| *Setter* | set_assign_op(value) | ++----------+----------------------+ +| *Getter* | get_assign_op() | ++----------+----------------------+ + .. _class_VisualScriptPropertySet_base_script: - :ref:`String` **base_script** ++----------+------------------------+ +| *Setter* | set_base_script(value) | ++----------+------------------------+ +| *Getter* | get_base_script() | ++----------+------------------------+ + .. _class_VisualScriptPropertySet_base_type: - :ref:`String` **base_type** ++----------+----------------------+ +| *Setter* | set_base_type(value) | ++----------+----------------------+ +| *Getter* | get_base_type() | ++----------+----------------------+ + .. _class_VisualScriptPropertySet_basic_type: - :ref:`Variant.Type` **basic_type** ++----------+-----------------------+ +| *Setter* | set_basic_type(value) | ++----------+-----------------------+ +| *Getter* | get_basic_type() | ++----------+-----------------------+ + .. _class_VisualScriptPropertySet_index: - :ref:`String` **index** ++----------+------------------+ +| *Setter* | set_index(value) | ++----------+------------------+ +| *Getter* | get_index() | ++----------+------------------+ + .. _class_VisualScriptPropertySet_node_path: - :ref:`NodePath` **node_path** ++----------+----------------------+ +| *Setter* | set_base_path(value) | ++----------+----------------------+ +| *Getter* | get_base_path() | ++----------+----------------------+ + .. _class_VisualScriptPropertySet_property: - :ref:`String` **property** ++----------+---------------------+ +| *Setter* | set_property(value) | ++----------+---------------------+ +| *Getter* | get_property() | ++----------+---------------------+ + .. _class_VisualScriptPropertySet_set_mode: - :ref:`CallMode` **set_mode** ++----------+----------------------+ +| *Setter* | set_call_mode(value) | ++----------+----------------------+ +| *Getter* | get_call_mode() | ++----------+----------------------+ diff --git a/classes/class_visualscriptresourcepath.rst b/classes/class_visualscriptresourcepath.rst index 333f02302..5d0e9185b 100644 --- a/classes/class_visualscriptresourcepath.rst +++ b/classes/class_visualscriptresourcepath.rst @@ -8,6 +8,7 @@ VisualScriptResourcePath ======================== **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description +Properties +---------- + ++-----------------------------+--------------------------------------------------+ +| :ref:`String` | :ref:`path` | ++-----------------------------+--------------------------------------------------+ + Property Descriptions --------------------- @@ -22,4 +30,9 @@ Property Descriptions - :ref:`String` **path** ++----------+--------------------------+ +| *Setter* | set_resource_path(value) | ++----------+--------------------------+ +| *Getter* | get_resource_path() | ++----------+--------------------------+ diff --git a/classes/class_visualscriptreturn.rst b/classes/class_visualscriptreturn.rst index 8279f3bc5..ef56bf92f 100644 --- a/classes/class_visualscriptreturn.rst +++ b/classes/class_visualscriptreturn.rst @@ -8,6 +8,7 @@ VisualScriptReturn ================== **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description Exits a function and returns an optional value. +Properties +---------- + ++-----------------------------------------------------+----------------------------------------------------------------+ +| :ref:`bool` | :ref:`return_enabled` | ++-----------------------------------------------------+----------------------------------------------------------------+ +| :ref:`Variant.Type` | :ref:`return_type` | ++-----------------------------------------------------+----------------------------------------------------------------+ + Description ----------- @@ -35,10 +45,25 @@ Property Descriptions .. _class_VisualScriptReturn_return_enabled: -- :ref:`bool` **return_enabled** - If ``true`` the ``return`` input port is available. +- :ref:`bool` **return_enabled** + ++----------+--------------------------------+ +| *Setter* | set_enable_return_value(value) | ++----------+--------------------------------+ +| *Getter* | is_return_value_enabled() | ++----------+--------------------------------+ + +If ``true`` the ``return`` input port is available. .. _class_VisualScriptReturn_return_type: -- :ref:`Variant.Type` **return_type** - The return value's data type. +- :ref:`Variant.Type` **return_type** ++----------+------------------------+ +| *Setter* | set_return_type(value) | ++----------+------------------------+ +| *Getter* | get_return_type() | ++----------+------------------------+ + +The return value's data type. diff --git a/classes/class_visualscriptscenenode.rst b/classes/class_visualscriptscenenode.rst index 4dae7fedc..0011af3a8 100644 --- a/classes/class_visualscriptscenenode.rst +++ b/classes/class_visualscriptscenenode.rst @@ -8,6 +8,7 @@ VisualScriptSceneNode ===================== **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Node reference. +Properties +---------- + ++---------------------------------+---------------------------------------------------------+ +| :ref:`NodePath` | :ref:`node_path` | ++---------------------------------+---------------------------------------------------------+ + Description ----------- @@ -33,6 +41,13 @@ Property Descriptions .. _class_VisualScriptSceneNode_node_path: -- :ref:`NodePath` **node_path** - The node's path in the scene tree. +- :ref:`NodePath` **node_path** ++----------+----------------------+ +| *Setter* | set_node_path(value) | ++----------+----------------------+ +| *Getter* | get_node_path() | ++----------+----------------------+ + +The node's path in the scene tree. diff --git a/classes/class_visualscriptscenetree.rst b/classes/class_visualscriptscenetree.rst index 9d9acb7a7..2727f2d99 100644 --- a/classes/class_visualscriptscenetree.rst +++ b/classes/class_visualscriptscenetree.rst @@ -8,6 +8,7 @@ VisualScriptSceneTree ===================== **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_visualscriptselect.rst b/classes/class_visualscriptselect.rst index ce709a31c..e6f9caf2b 100644 --- a/classes/class_visualscriptselect.rst +++ b/classes/class_visualscriptselect.rst @@ -8,6 +8,7 @@ VisualScriptSelect ================== **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Chooses between two input values. +Properties +---------- + ++-----------------------------------------------------+--------------------------------------------+ +| :ref:`Variant.Type` | :ref:`type` | ++-----------------------------------------------------+--------------------------------------------+ + Description ----------- @@ -37,6 +45,13 @@ Property Descriptions .. _class_VisualScriptSelect_type: -- :ref:`Variant.Type` **type** - The input variables' type. +- :ref:`Variant.Type` **type** ++----------+------------------+ +| *Setter* | set_typed(value) | ++----------+------------------+ +| *Getter* | get_typed() | ++----------+------------------+ + +The input variables' type. diff --git a/classes/class_visualscriptself.rst b/classes/class_visualscriptself.rst index 0941bdfd9..db0bffe29 100644 --- a/classes/class_visualscriptself.rst +++ b/classes/class_visualscriptself.rst @@ -8,6 +8,7 @@ VisualScriptSelf ================ **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_visualscriptsequence.rst b/classes/class_visualscriptsequence.rst index a89d36783..964c0870d 100644 --- a/classes/class_visualscriptsequence.rst +++ b/classes/class_visualscriptsequence.rst @@ -8,6 +8,7 @@ VisualScriptSequence ==================== **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Executes a series of Sequence ports. +Properties +---------- + ++-----------------------+------------------------------------------------+ +| :ref:`int` | :ref:`steps` | ++-----------------------+------------------------------------------------+ + Description ----------- @@ -37,6 +45,13 @@ Property Descriptions .. _class_VisualScriptSequence_steps: -- :ref:`int` **steps** - The number of steps in the sequence. +- :ref:`int` **steps** ++----------+------------------+ +| *Setter* | set_steps(value) | ++----------+------------------+ +| *Getter* | get_steps() | ++----------+------------------+ + +The number of steps in the sequence. diff --git a/classes/class_visualscriptsubcall.rst b/classes/class_visualscriptsubcall.rst index dc8fb15fc..e2f9aaa0f 100644 --- a/classes/class_visualscriptsubcall.rst +++ b/classes/class_visualscriptsubcall.rst @@ -8,6 +8,7 @@ VisualScriptSubCall =================== **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -25,8 +26,7 @@ Methods Method Descriptions ------------------- -.. _class_VisualScriptSubCall__subcall: + .. _class_VisualScriptSubCall__subcall: - :ref:`Variant` **_subcall** **(** :ref:`Variant` arguments **)** virtual - diff --git a/classes/class_visualscriptswitch.rst b/classes/class_visualscriptswitch.rst index b452996b8..320e29420 100644 --- a/classes/class_visualscriptswitch.rst +++ b/classes/class_visualscriptswitch.rst @@ -8,6 +8,7 @@ VisualScriptSwitch ================== **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_visualscripttypecast.rst b/classes/class_visualscripttypecast.rst index f3a12d9ab..35d6659b5 100644 --- a/classes/class_visualscripttypecast.rst +++ b/classes/class_visualscripttypecast.rst @@ -8,6 +8,7 @@ VisualScriptTypeCast ==================== **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description +Properties +---------- + ++-----------------------------+------------------------------------------------------------+ +| :ref:`String` | :ref:`base_script` | ++-----------------------------+------------------------------------------------------------+ +| :ref:`String` | :ref:`base_type` | ++-----------------------------+------------------------------------------------------------+ + Property Descriptions --------------------- @@ -22,8 +32,19 @@ Property Descriptions - :ref:`String` **base_script** ++----------+------------------------+ +| *Setter* | set_base_script(value) | ++----------+------------------------+ +| *Getter* | get_base_script() | ++----------+------------------------+ + .. _class_VisualScriptTypeCast_base_type: - :ref:`String` **base_type** ++----------+----------------------+ +| *Setter* | set_base_type(value) | ++----------+----------------------+ +| *Getter* | get_base_type() | ++----------+----------------------+ diff --git a/classes/class_visualscriptvariableget.rst b/classes/class_visualscriptvariableget.rst index 3ac6d35a1..57024c9f0 100644 --- a/classes/class_visualscriptvariableget.rst +++ b/classes/class_visualscriptvariableget.rst @@ -8,6 +8,7 @@ VisualScriptVariableGet ======================= **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Gets a variable's value. +Properties +---------- + ++-----------------------------+---------------------------------------------------------+ +| :ref:`String` | :ref:`var_name` | ++-----------------------------+---------------------------------------------------------+ + Description ----------- @@ -33,6 +41,13 @@ Property Descriptions .. _class_VisualScriptVariableGet_var_name: -- :ref:`String` **var_name** - The variable's name. +- :ref:`String` **var_name** ++----------+---------------------+ +| *Setter* | set_variable(value) | ++----------+---------------------+ +| *Getter* | get_variable() | ++----------+---------------------+ + +The variable's name. diff --git a/classes/class_visualscriptvariableset.rst b/classes/class_visualscriptvariableset.rst index acc628782..106dc571a 100644 --- a/classes/class_visualscriptvariableset.rst +++ b/classes/class_visualscriptvariableset.rst @@ -8,6 +8,7 @@ VisualScriptVariableSet ======================= **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Changes a variable's value. +Properties +---------- + ++-----------------------------+---------------------------------------------------------+ +| :ref:`String` | :ref:`var_name` | ++-----------------------------+---------------------------------------------------------+ + Description ----------- @@ -35,6 +43,13 @@ Property Descriptions .. _class_VisualScriptVariableSet_var_name: -- :ref:`String` **var_name** - The variable's name. +- :ref:`String` **var_name** ++----------+---------------------+ +| *Setter* | set_variable(value) | ++----------+---------------------+ +| *Getter* | get_variable() | ++----------+---------------------+ + +The variable's name. diff --git a/classes/class_visualscriptwhile.rst b/classes/class_visualscriptwhile.rst index 3ae666e42..0cae77d6c 100644 --- a/classes/class_visualscriptwhile.rst +++ b/classes/class_visualscriptwhile.rst @@ -8,6 +8,7 @@ VisualScriptWhile ================= **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_visualscriptyield.rst b/classes/class_visualscriptyield.rst index 455af530d..1fd4fc400 100644 --- a/classes/class_visualscriptyield.rst +++ b/classes/class_visualscriptyield.rst @@ -8,6 +8,7 @@ VisualScriptYield ================= **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,18 +16,26 @@ Brief Description +Properties +---------- + ++----------------------------------------------------+-----------------------------------------------------+ +| :ref:`YieldMode` | :ref:`mode` | ++----------------------------------------------------+-----------------------------------------------------+ +| :ref:`float` | :ref:`wait_time` | ++----------------------------------------------------+-----------------------------------------------------+ + Enumerations ------------ .. _enum_VisualScriptYield_YieldMode: -enum **YieldMode** +enum **YieldMode**: - **YIELD_FRAME** = **1** - **YIELD_PHYSICS_FRAME** = **2** - **YIELD_WAIT** = **3** - Property Descriptions --------------------- @@ -34,8 +43,19 @@ Property Descriptions - :ref:`YieldMode` **mode** ++----------+-----------------------+ +| *Setter* | set_yield_mode(value) | ++----------+-----------------------+ +| *Getter* | get_yield_mode() | ++----------+-----------------------+ + .. _class_VisualScriptYield_wait_time: - :ref:`float` **wait_time** ++----------+----------------------+ +| *Setter* | set_wait_time(value) | ++----------+----------------------+ +| *Getter* | get_wait_time() | ++----------+----------------------+ diff --git a/classes/class_visualscriptyieldsignal.rst b/classes/class_visualscriptyieldsignal.rst index 0449d3244..7b4bdb019 100644 --- a/classes/class_visualscriptyieldsignal.rst +++ b/classes/class_visualscriptyieldsignal.rst @@ -8,6 +8,7 @@ VisualScriptYieldSignal ======================= **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,18 +16,30 @@ Brief Description +Properties +---------- + ++--------------------------------------------------------+-----------------------------------------------------------+ +| :ref:`String` | :ref:`base_type` | ++--------------------------------------------------------+-----------------------------------------------------------+ +| :ref:`CallMode` | :ref:`call_mode` | ++--------------------------------------------------------+-----------------------------------------------------------+ +| :ref:`NodePath` | :ref:`node_path` | ++--------------------------------------------------------+-----------------------------------------------------------+ +| :ref:`String` | :ref:`signal` | ++--------------------------------------------------------+-----------------------------------------------------------+ + Enumerations ------------ .. _enum_VisualScriptYieldSignal_CallMode: -enum **CallMode** +enum **CallMode**: - **CALL_MODE_SELF** = **0** - **CALL_MODE_NODE_PATH** = **1** - **CALL_MODE_INSTANCE** = **2** - Property Descriptions --------------------- @@ -34,16 +47,39 @@ Property Descriptions - :ref:`String` **base_type** ++----------+----------------------+ +| *Setter* | set_base_type(value) | ++----------+----------------------+ +| *Getter* | get_base_type() | ++----------+----------------------+ + .. _class_VisualScriptYieldSignal_call_mode: - :ref:`CallMode` **call_mode** ++----------+----------------------+ +| *Setter* | set_call_mode(value) | ++----------+----------------------+ +| *Getter* | get_call_mode() | ++----------+----------------------+ + .. _class_VisualScriptYieldSignal_node_path: - :ref:`NodePath` **node_path** ++----------+----------------------+ +| *Setter* | set_base_path(value) | ++----------+----------------------+ +| *Getter* | get_base_path() | ++----------+----------------------+ + .. _class_VisualScriptYieldSignal_signal: - :ref:`String` **signal** ++----------+-------------------+ +| *Setter* | set_signal(value) | ++----------+-------------------+ +| *Getter* | get_signal() | ++----------+-------------------+ diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index a8df598f7..5272a3f9b 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -8,6 +8,7 @@ VisualServer ============ **Inherits:** :ref:`Object` + **Category:** Core Brief Description @@ -731,21 +732,20 @@ Methods Signals ------- -.. _class_VisualServer_frame_post_draw: + .. _class_VisualServer_frame_post_draw: - **frame_post_draw** **(** **)** -.. _class_VisualServer_frame_pre_draw: + .. _class_VisualServer_frame_pre_draw: - **frame_pre_draw** **(** **)** - Enumerations ------------ .. _enum_VisualServer_ViewportRenderInfo: -enum **ViewportRenderInfo** +enum **ViewportRenderInfo**: - **VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME** = **0** - **VIEWPORT_RENDER_INFO_VERTICES_IN_FRAME** = **1** @@ -757,7 +757,7 @@ enum **ViewportRenderInfo** .. _enum_VisualServer_CubeMapSide: -enum **CubeMapSide** +enum **CubeMapSide**: - **CUBEMAP_LEFT** = **0** --- Marks the left side of a cubemap. - **CUBEMAP_RIGHT** = **1** --- Marks the right side of a cubemap. @@ -768,7 +768,7 @@ enum **CubeMapSide** .. _enum_VisualServer_TextureType: -enum **TextureType** +enum **TextureType**: - **TEXTURE_TYPE_2D** = **0** - **TEXTURE_TYPE_CUBEMAP** = **1** @@ -777,7 +777,7 @@ enum **TextureType** .. _enum_VisualServer_LightType: -enum **LightType** +enum **LightType**: - **LIGHT_DIRECTIONAL** = **0** --- Is a directional (sun) light. - **LIGHT_OMNI** = **1** --- is an omni light. @@ -785,7 +785,7 @@ enum **LightType** .. _enum_VisualServer_ArrayType: -enum **ArrayType** +enum **ArrayType**: - **ARRAY_VERTEX** = **0** --- Array is a vertex array. - **ARRAY_NORMAL** = **1** --- Array is a normal array. @@ -800,14 +800,14 @@ enum **ArrayType** .. _enum_VisualServer_BlendShapeMode: -enum **BlendShapeMode** +enum **BlendShapeMode**: - **BLEND_SHAPE_MODE_NORMALIZED** = **0** - **BLEND_SHAPE_MODE_RELATIVE** = **1** .. _enum_VisualServer_ShadowCastingSetting: -enum **ShadowCastingSetting** +enum **ShadowCastingSetting**: - **SHADOW_CASTING_SETTING_OFF** = **0** - **SHADOW_CASTING_SETTING_ON** = **1** @@ -816,7 +816,7 @@ enum **ShadowCastingSetting** .. _enum_VisualServer_CanvasOccluderPolygonCullMode: -enum **CanvasOccluderPolygonCullMode** +enum **CanvasOccluderPolygonCullMode**: - **CANVAS_OCCLUDER_POLYGON_CULL_DISABLED** = **0** --- Culling of the canvas occluder is disabled. - **CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE** = **1** --- Culling of the canvas occluder is clockwise. @@ -824,7 +824,7 @@ enum **CanvasOccluderPolygonCullMode** .. _enum_VisualServer_ParticlesDrawOrder: -enum **ParticlesDrawOrder** +enum **ParticlesDrawOrder**: - **PARTICLES_DRAW_ORDER_INDEX** = **0** - **PARTICLES_DRAW_ORDER_LIFETIME** = **1** @@ -832,7 +832,7 @@ enum **ParticlesDrawOrder** .. _enum_VisualServer_ViewportMSAA: -enum **ViewportMSAA** +enum **ViewportMSAA**: - **VIEWPORT_MSAA_DISABLED** = **0** --- Multisample antialiasing is disabled. - **VIEWPORT_MSAA_2X** = **1** --- Multisample antialiasing is set to 2X. @@ -842,7 +842,7 @@ enum **ViewportMSAA** .. _enum_VisualServer_ViewportUpdateMode: -enum **ViewportUpdateMode** +enum **ViewportUpdateMode**: - **VIEWPORT_UPDATE_DISABLED** = **0** - **VIEWPORT_UPDATE_ONCE** = **1** @@ -851,7 +851,7 @@ enum **ViewportUpdateMode** .. _enum_VisualServer_MultimeshColorFormat: -enum **MultimeshColorFormat** +enum **MultimeshColorFormat**: - **MULTIMESH_COLOR_NONE** = **0** - **MULTIMESH_COLOR_8BIT** = **1** @@ -859,7 +859,7 @@ enum **MultimeshColorFormat** .. _enum_VisualServer_LightDirectionalShadowMode: -enum **LightDirectionalShadowMode** +enum **LightDirectionalShadowMode**: - **LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL** = **0** - **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS** = **1** @@ -867,14 +867,14 @@ enum **LightDirectionalShadowMode** .. _enum_VisualServer_LightOmniShadowMode: -enum **LightOmniShadowMode** +enum **LightOmniShadowMode**: - **LIGHT_OMNI_SHADOW_DUAL_PARABOLOID** = **0** - **LIGHT_OMNI_SHADOW_CUBE** = **1** .. _enum_VisualServer_EnvironmentSSAOQuality: -enum **EnvironmentSSAOQuality** +enum **EnvironmentSSAOQuality**: - **ENV_SSAO_QUALITY_LOW** = **0** - **ENV_SSAO_QUALITY_MEDIUM** = **1** @@ -882,7 +882,7 @@ enum **EnvironmentSSAOQuality** .. _enum_VisualServer_LightParam: -enum **LightParam** +enum **LightParam**: - **LIGHT_PARAM_ENERGY** = **0** --- The light's energy. - **LIGHT_PARAM_SPECULAR** = **2** --- The light's influence on specularity. @@ -902,7 +902,7 @@ enum **LightParam** .. _enum_VisualServer_ScenarioDebugMode: -enum **ScenarioDebugMode** +enum **ScenarioDebugMode**: - **SCENARIO_DEBUG_DISABLED** = **0** - **SCENARIO_DEBUG_WIREFRAME** = **1** @@ -911,14 +911,14 @@ enum **ScenarioDebugMode** .. _enum_VisualServer_LightDirectionalShadowDepthRangeMode: -enum **LightDirectionalShadowDepthRangeMode** +enum **LightDirectionalShadowDepthRangeMode**: - **LIGHT_DIRECTIONAL_SHADOW_DEPTH_RANGE_STABLE** = **0** - **LIGHT_DIRECTIONAL_SHADOW_DEPTH_RANGE_OPTIMIZED** = **1** .. _enum_VisualServer_EnvironmentGlowBlendMode: -enum **EnvironmentGlowBlendMode** +enum **EnvironmentGlowBlendMode**: - **GLOW_BLEND_MODE_ADDITIVE** = **0** - **GLOW_BLEND_MODE_SCREEN** = **1** @@ -927,7 +927,7 @@ enum **EnvironmentGlowBlendMode** .. _enum_VisualServer_InstanceType: -enum **InstanceType** +enum **InstanceType**: - **INSTANCE_NONE** = **0** --- The instance does not have a type. - **INSTANCE_MESH** = **1** --- The instance is a mesh. @@ -943,7 +943,7 @@ enum **InstanceType** .. _enum_VisualServer_ShaderMode: -enum **ShaderMode** +enum **ShaderMode**: - **SHADER_SPATIAL** = **0** --- Shader is a 3D shader. - **SHADER_CANVAS_ITEM** = **1** --- Shader is a 2D shader. @@ -952,7 +952,7 @@ enum **ShaderMode** .. _enum_VisualServer_ViewportUsage: -enum **ViewportUsage** +enum **ViewportUsage**: - **VIEWPORT_USAGE_2D** = **0** --- The Viewport does not render 3D but samples. - **VIEWPORT_USAGE_2D_NO_SAMPLING** = **1** --- The Viewport does not render 3D and does not sample. @@ -961,7 +961,7 @@ enum **ViewportUsage** .. _enum_VisualServer_EnvironmentDOFBlurQuality: -enum **EnvironmentDOFBlurQuality** +enum **EnvironmentDOFBlurQuality**: - **ENV_DOF_BLUR_QUALITY_LOW** = **0** - **ENV_DOF_BLUR_QUALITY_MEDIUM** = **1** @@ -969,7 +969,7 @@ enum **EnvironmentDOFBlurQuality** .. _enum_VisualServer_PrimitiveType: -enum **PrimitiveType** +enum **PrimitiveType**: - **PRIMITIVE_POINTS** = **0** --- Primitive to draw consists of points. - **PRIMITIVE_LINES** = **1** --- Primitive to draw consists of lines. @@ -982,7 +982,7 @@ enum **PrimitiveType** .. _enum_VisualServer_InstanceFlags: -enum **InstanceFlags** +enum **InstanceFlags**: - **INSTANCE_FLAG_USE_BAKED_LIGHT** = **0** - **INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE** = **1** @@ -990,7 +990,7 @@ enum **InstanceFlags** .. _enum_VisualServer_ViewportClearMode: -enum **ViewportClearMode** +enum **ViewportClearMode**: - **VIEWPORT_CLEAR_ALWAYS** = **0** --- The viewport is always cleared before drawing. - **VIEWPORT_CLEAR_NEVER** = **1** --- The viewport is never cleared before drawing. @@ -998,14 +998,14 @@ enum **ViewportClearMode** .. _enum_VisualServer_LightOmniShadowDetail: -enum **LightOmniShadowDetail** +enum **LightOmniShadowDetail**: - **LIGHT_OMNI_SHADOW_DETAIL_VERTICAL** = **0** - **LIGHT_OMNI_SHADOW_DETAIL_HORIZONTAL** = **1** .. _enum_VisualServer_CanvasLightMode: -enum **CanvasLightMode** +enum **CanvasLightMode**: - **CANVAS_LIGHT_MODE_ADD** = **0** --- Adds light color additive to the canvas. - **CANVAS_LIGHT_MODE_SUB** = **1** --- Adds light color subtractive to the canvas. @@ -1014,7 +1014,7 @@ enum **CanvasLightMode** .. _enum_VisualServer_NinePatchAxisMode: -enum **NinePatchAxisMode** +enum **NinePatchAxisMode**: - **NINE_PATCH_STRETCH** = **0** --- The nine patch gets stretched where needed. - **NINE_PATCH_TILE** = **1** --- The nine patch gets filled with tiles where needed. @@ -1022,7 +1022,7 @@ enum **NinePatchAxisMode** .. _enum_VisualServer_ViewportDebugDraw: -enum **ViewportDebugDraw** +enum **ViewportDebugDraw**: - **VIEWPORT_DEBUG_DRAW_DISABLED** = **0** --- Debug draw is disabled. Default setting. - **VIEWPORT_DEBUG_DRAW_UNSHADED** = **1** --- Debug draw sets objects to unshaded. @@ -1031,14 +1031,14 @@ enum **ViewportDebugDraw** .. _enum_VisualServer_MultimeshTransformFormat: -enum **MultimeshTransformFormat** +enum **MultimeshTransformFormat**: - **MULTIMESH_TRANSFORM_2D** = **0** - **MULTIMESH_TRANSFORM_3D** = **1** .. _enum_VisualServer_ArrayFormat: -enum **ArrayFormat** +enum **ArrayFormat**: - **ARRAY_FORMAT_VERTEX** = **1** --- Flag used to mark a vertex array. - **ARRAY_FORMAT_NORMAL** = **2** --- Flag used to mark a normal array. @@ -1064,7 +1064,7 @@ enum **ArrayFormat** .. _enum_VisualServer_EnvironmentSSAOBlur: -enum **EnvironmentSSAOBlur** +enum **EnvironmentSSAOBlur**: - **ENV_SSAO_BLUR_DISABLED** = **0** - **ENV_SSAO_BLUR_1x1** = **1** @@ -1073,7 +1073,7 @@ enum **EnvironmentSSAOBlur** .. _enum_VisualServer_RenderInfo: -enum **RenderInfo** +enum **RenderInfo**: - **INFO_OBJECTS_IN_FRAME** = **0** --- The amount of objects in the frame. - **INFO_VERTICES_IN_FRAME** = **1** --- The amount of vertices in the frame. @@ -1088,14 +1088,14 @@ enum **RenderInfo** .. _enum_VisualServer_ReflectionProbeUpdateMode: -enum **ReflectionProbeUpdateMode** +enum **ReflectionProbeUpdateMode**: - **REFLECTION_PROBE_UPDATE_ONCE** = **0** - **REFLECTION_PROBE_UPDATE_ALWAYS** = **1** .. _enum_VisualServer_EnvironmentBG: -enum **EnvironmentBG** +enum **EnvironmentBG**: - **ENV_BG_CLEAR_COLOR** = **0** - **ENV_BG_COLOR** = **1** @@ -1107,7 +1107,7 @@ enum **EnvironmentBG** .. _enum_VisualServer_CanvasLightShadowFilter: -enum **CanvasLightShadowFilter** +enum **CanvasLightShadowFilter**: - **CANVAS_LIGHT_FILTER_NONE** = **0** - **CANVAS_LIGHT_FILTER_PCF3** = **1** @@ -1118,14 +1118,14 @@ enum **CanvasLightShadowFilter** .. _enum_VisualServer_Features: -enum **Features** +enum **Features**: - **FEATURE_SHADERS** = **0** - **FEATURE_MULTITHREADED** = **1** .. _enum_VisualServer_TextureFlags: -enum **TextureFlags** +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. - **TEXTURE_FLAG_REPEAT** = **2** --- Repeat (instead of clamp to edge). @@ -1140,14 +1140,13 @@ More effective on planes often shown going to the horrizon as those textures (Wa .. _enum_VisualServer_EnvironmentToneMapper: -enum **EnvironmentToneMapper** +enum **EnvironmentToneMapper**: - **ENV_TONE_MAPPER_LINEAR** = **0** - **ENV_TONE_MAPPER_REINHARDT** = **1** - **ENV_TONE_MAPPER_FILMIC** = **2** - **ENV_TONE_MAPPER_ACES** = **3** - Constants --------- @@ -1159,7 +1158,6 @@ Constants - **MAX_CURSORS** = **8** - **MATERIAL_RENDER_PRIORITY_MIN** = **-128** --- The minimum renderpriority of all materials. - **MATERIAL_RENDER_PRIORITY_MAX** = **127** --- The maximum renderpriority of all materials. - Description ----------- @@ -1170,83 +1168,83 @@ The visual server is completely opaque, the internals are entirely implementatio Method Descriptions ------------------- -.. _class_VisualServer_black_bars_set_images: + .. _class_VisualServer_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_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. -.. _class_VisualServer_camera_create: + .. _class_VisualServer_camera_create: - :ref:`RID` **camera_create** **(** **)** -.. _class_VisualServer_camera_set_cull_mask: + .. _class_VisualServer_camera_set_cull_mask: - void **camera_set_cull_mask** **(** :ref:`RID` camera, :ref:`int` layers **)** -.. _class_VisualServer_camera_set_environment: + .. _class_VisualServer_camera_set_environment: - void **camera_set_environment** **(** :ref:`RID` camera, :ref:`RID` env **)** -.. _class_VisualServer_camera_set_orthogonal: + .. _class_VisualServer_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_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_camera_set_transform: - void **camera_set_transform** **(** :ref:`RID` camera, :ref:`Transform` transform **)** -.. _class_VisualServer_camera_set_use_vertical_aspect: + .. _class_VisualServer_camera_set_use_vertical_aspect: - void **camera_set_use_vertical_aspect** **(** :ref:`RID` camera, :ref:`bool` enable **)** -.. _class_VisualServer_canvas_create: + .. _class_VisualServer_canvas_create: - :ref:`RID` **canvas_create** **(** **)** Creates a canvas and returns the assigned :ref:`RID`. -.. _class_VisualServer_canvas_item_add_circle: + .. _class_VisualServer_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_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_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_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_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_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 **)** @@ -1254,37 +1252,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_canvas_item_add_particles: - void **canvas_item_add_particles** **(** :ref:`RID` item, :ref:`RID` particles, :ref:`RID` texture, :ref:`RID` normal_map, :ref:`int` h_frames, :ref:`int` v_frames **)** Adds a particles system to the :ref:`CanvasItem`'s draw commands. -.. _class_VisualServer_canvas_item_add_polygon: + .. _class_VisualServer_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_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_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_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_canvas_item_add_set_transform: - void **canvas_item_add_set_transform** **(** :ref:`RID` item, :ref:`Transform2D` transform **)** @@ -1292,1213 +1290,1213 @@ 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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_canvas_light_create: - :ref:`RID` **canvas_light_create** **(** **)** Creates a canvas light. -.. _class_VisualServer_canvas_light_occluder_attach_to_canvas: + .. _class_VisualServer_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_canvas_light_occluder_create: - :ref:`RID` **canvas_light_occluder_create** **(** **)** Creates a light occluder. -.. _class_VisualServer_canvas_light_occluder_set_enabled: + .. _class_VisualServer_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_canvas_light_set_texture: - void **canvas_light_set_texture** **(** :ref:`RID` light, :ref:`RID` texture **)** -.. _class_VisualServer_canvas_light_set_texture_offset: + .. _class_VisualServer_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_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_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_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_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_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_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_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_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_directional_light_create: - :ref:`RID` **directional_light_create** **(** **)** -.. _class_VisualServer_draw: + .. _class_VisualServer_draw: - void **draw** **(** :ref:`bool` swap_buffers=true, :ref:`float` frame_step=0.0 **)** -.. _class_VisualServer_environment_create: + .. _class_VisualServer_environment_create: - :ref:`RID` **environment_create** **(** **)** -.. _class_VisualServer_environment_set_adjustment: + .. _class_VisualServer_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_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_environment_set_background: - void **environment_set_background** **(** :ref:`RID` env, :ref:`EnvironmentBG` bg **)** -.. _class_VisualServer_environment_set_bg_color: + .. _class_VisualServer_environment_set_bg_color: - void **environment_set_bg_color** **(** :ref:`RID` env, :ref:`Color` color **)** -.. _class_VisualServer_environment_set_bg_energy: + .. _class_VisualServer_environment_set_bg_energy: - void **environment_set_bg_energy** **(** :ref:`RID` env, :ref:`float` energy **)** -.. _class_VisualServer_environment_set_canvas_max_layer: + .. _class_VisualServer_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_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_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_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_environment_set_fog_depth: - void **environment_set_fog_depth** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` depth_begin, :ref:`float` depth_curve, :ref:`bool` transmit, :ref:`float` transmit_curve **)** -.. _class_VisualServer_environment_set_fog_height: + .. _class_VisualServer_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_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:`bool` bicubic_upscale **)** -.. _class_VisualServer_environment_set_sky: + .. _class_VisualServer_environment_set_sky: - void **environment_set_sky** **(** :ref:`RID` env, :ref:`RID` sky **)** -.. _class_VisualServer_environment_set_sky_custom_fov: + .. _class_VisualServer_environment_set_sky_custom_fov: - void **environment_set_sky_custom_fov** **(** :ref:`RID` env, :ref:`float` scale **)** -.. _class_VisualServer_environment_set_ssao: + .. _class_VisualServer_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_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_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_finish: - void **finish** **(** **)** Removes buffers and clears testcubes. -.. _class_VisualServer_force_draw: + .. _class_VisualServer_force_draw: - void **force_draw** **(** :ref:`bool` swap_buffers=true, :ref:`float` frame_step=0.0 **)** -.. _class_VisualServer_force_sync: + .. _class_VisualServer_force_sync: - void **force_sync** **(** **)** Synchronizes threads. -.. _class_VisualServer_free_rid: + .. _class_VisualServer_free_rid: - void **free_rid** **(** :ref:`RID` rid **)** Tries to free an object in the VisualServer. -.. _class_VisualServer_get_render_info: + .. _class_VisualServer_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_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_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_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_gi_probe_create: - :ref:`RID` **gi_probe_create** **(** **)** -.. _class_VisualServer_gi_probe_get_bias: + .. _class_VisualServer_gi_probe_get_bias: - :ref:`float` **gi_probe_get_bias** **(** :ref:`RID` probe **)** const -.. _class_VisualServer_gi_probe_get_bounds: + .. _class_VisualServer_gi_probe_get_bounds: - :ref:`AABB` **gi_probe_get_bounds** **(** :ref:`RID` probe **)** const -.. _class_VisualServer_gi_probe_get_cell_size: + .. _class_VisualServer_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_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_gi_probe_get_dynamic_range: - :ref:`int` **gi_probe_get_dynamic_range** **(** :ref:`RID` probe **)** const -.. _class_VisualServer_gi_probe_get_energy: + .. _class_VisualServer_gi_probe_get_energy: - :ref:`float` **gi_probe_get_energy** **(** :ref:`RID` probe **)** const -.. _class_VisualServer_gi_probe_get_normal_bias: + .. _class_VisualServer_gi_probe_get_normal_bias: - :ref:`float` **gi_probe_get_normal_bias** **(** :ref:`RID` probe **)** const -.. _class_VisualServer_gi_probe_get_propagation: + .. _class_VisualServer_gi_probe_get_propagation: - :ref:`float` **gi_probe_get_propagation** **(** :ref:`RID` probe **)** const -.. _class_VisualServer_gi_probe_get_to_cell_xform: + .. _class_VisualServer_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_gi_probe_is_compressed: - :ref:`bool` **gi_probe_is_compressed** **(** :ref:`RID` probe **)** const -.. _class_VisualServer_gi_probe_is_interior: + .. _class_VisualServer_gi_probe_is_interior: - :ref:`bool` **gi_probe_is_interior** **(** :ref:`RID` probe **)** const -.. _class_VisualServer_gi_probe_set_bias: + .. _class_VisualServer_gi_probe_set_bias: - void **gi_probe_set_bias** **(** :ref:`RID` probe, :ref:`float` bias **)** -.. _class_VisualServer_gi_probe_set_bounds: + .. _class_VisualServer_gi_probe_set_bounds: - void **gi_probe_set_bounds** **(** :ref:`RID` probe, :ref:`AABB` bounds **)** -.. _class_VisualServer_gi_probe_set_cell_size: + .. _class_VisualServer_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_gi_probe_set_compress: - void **gi_probe_set_compress** **(** :ref:`RID` probe, :ref:`bool` enable **)** -.. _class_VisualServer_gi_probe_set_dynamic_data: + .. _class_VisualServer_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_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_gi_probe_set_energy: - void **gi_probe_set_energy** **(** :ref:`RID` probe, :ref:`float` energy **)** -.. _class_VisualServer_gi_probe_set_interior: + .. _class_VisualServer_gi_probe_set_interior: - void **gi_probe_set_interior** **(** :ref:`RID` probe, :ref:`bool` enable **)** -.. _class_VisualServer_gi_probe_set_normal_bias: + .. _class_VisualServer_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_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_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_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. -.. _class_VisualServer_has_feature: + .. _class_VisualServer_has_feature: - :ref:`bool` **has_feature** **(** :ref:`Features` feature **)** const -.. _class_VisualServer_has_os_feature: + .. _class_VisualServer_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_immediate_begin: - void **immediate_begin** **(** :ref:`RID` immediate, :ref:`PrimitiveType` primitive, :ref:`RID` texture **)** -.. _class_VisualServer_immediate_clear: + .. _class_VisualServer_immediate_clear: - void **immediate_clear** **(** :ref:`RID` immediate **)** -.. _class_VisualServer_immediate_color: + .. _class_VisualServer_immediate_color: - void **immediate_color** **(** :ref:`RID` immediate, :ref:`Color` color **)** -.. _class_VisualServer_immediate_create: + .. _class_VisualServer_immediate_create: - :ref:`RID` **immediate_create** **(** **)** -.. _class_VisualServer_immediate_end: + .. _class_VisualServer_immediate_end: - void **immediate_end** **(** :ref:`RID` immediate **)** -.. _class_VisualServer_immediate_get_material: + .. _class_VisualServer_immediate_get_material: - :ref:`RID` **immediate_get_material** **(** :ref:`RID` immediate **)** const -.. _class_VisualServer_immediate_normal: + .. _class_VisualServer_immediate_normal: - void **immediate_normal** **(** :ref:`RID` immediate, :ref:`Vector3` normal **)** -.. _class_VisualServer_immediate_set_material: + .. _class_VisualServer_immediate_set_material: - void **immediate_set_material** **(** :ref:`RID` immediate, :ref:`RID` material **)** -.. _class_VisualServer_immediate_tangent: + .. _class_VisualServer_immediate_tangent: - void **immediate_tangent** **(** :ref:`RID` immediate, :ref:`Plane` tangent **)** -.. _class_VisualServer_immediate_uv: + .. _class_VisualServer_immediate_uv: - void **immediate_uv** **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** -.. _class_VisualServer_immediate_uv2: + .. _class_VisualServer_immediate_uv2: - void **immediate_uv2** **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** -.. _class_VisualServer_immediate_vertex: + .. _class_VisualServer_immediate_vertex: - void **immediate_vertex** **(** :ref:`RID` immediate, :ref:`Vector3` vertex **)** -.. _class_VisualServer_immediate_vertex_2d: + .. _class_VisualServer_immediate_vertex_2d: - void **immediate_vertex_2d** **(** :ref:`RID` immediate, :ref:`Vector2` vertex **)** -.. _class_VisualServer_init: + .. _class_VisualServer_init: - void **init** **(** **)** Initializes the visual server. -.. _class_VisualServer_instance_attach_object_instance_id: + .. _class_VisualServer_instance_attach_object_instance_id: - void **instance_attach_object_instance_id** **(** :ref:`RID` instance, :ref:`int` id **)** -.. _class_VisualServer_instance_attach_skeleton: + .. _class_VisualServer_instance_attach_skeleton: - void **instance_attach_skeleton** **(** :ref:`RID` instance, :ref:`RID` skeleton **)** -.. _class_VisualServer_instance_create: + .. _class_VisualServer_instance_create: - :ref:`RID` **instance_create** **(** **)** -.. _class_VisualServer_instance_create2: + .. _class_VisualServer_instance_create2: - :ref:`RID` **instance_create2** **(** :ref:`RID` base, :ref:`RID` scenario **)** -.. _class_VisualServer_instance_geometry_set_as_instance_lod: + .. _class_VisualServer_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_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_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_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_instance_geometry_set_material_override: - void **instance_geometry_set_material_override** **(** :ref:`RID` instance, :ref:`RID` material **)** -.. _class_VisualServer_instance_set_base: + .. _class_VisualServer_instance_set_base: - void **instance_set_base** **(** :ref:`RID` instance, :ref:`RID` base **)** -.. _class_VisualServer_instance_set_blend_shape_weight: + .. _class_VisualServer_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_instance_set_custom_aabb: - void **instance_set_custom_aabb** **(** :ref:`RID` instance, :ref:`AABB` aabb **)** -.. _class_VisualServer_instance_set_exterior: + .. _class_VisualServer_instance_set_exterior: - void **instance_set_exterior** **(** :ref:`RID` instance, :ref:`bool` enabled **)** -.. _class_VisualServer_instance_set_extra_visibility_margin: + .. _class_VisualServer_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_instance_set_layer_mask: - void **instance_set_layer_mask** **(** :ref:`RID` instance, :ref:`int` mask **)** -.. _class_VisualServer_instance_set_scenario: + .. _class_VisualServer_instance_set_scenario: - void **instance_set_scenario** **(** :ref:`RID` instance, :ref:`RID` scenario **)** -.. _class_VisualServer_instance_set_surface_material: + .. _class_VisualServer_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_instance_set_transform: - void **instance_set_transform** **(** :ref:`RID` instance, :ref:`Transform` transform **)** -.. _class_VisualServer_instance_set_use_lightmap: + .. _class_VisualServer_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_instance_set_visible: - void **instance_set_visible** **(** :ref:`RID` instance, :ref:`bool` visible **)** -.. _class_VisualServer_instances_cull_aabb: + .. _class_VisualServer_instances_cull_aabb: - :ref:`Array` **instances_cull_aabb** **(** :ref:`AABB` aabb, :ref:`RID` scenario **)** const -.. _class_VisualServer_instances_cull_convex: + .. _class_VisualServer_instances_cull_convex: - :ref:`Array` **instances_cull_convex** **(** :ref:`Array` convex, :ref:`RID` scenario **)** const -.. _class_VisualServer_instances_cull_ray: + .. _class_VisualServer_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_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_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_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_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_light_omni_set_shadow_mode: - void **light_omni_set_shadow_mode** **(** :ref:`RID` light, :ref:`LightOmniShadowMode` mode **)** -.. _class_VisualServer_light_set_color: + .. _class_VisualServer_light_set_color: - void **light_set_color** **(** :ref:`RID` light, :ref:`Color` color **)** -.. _class_VisualServer_light_set_cull_mask: + .. _class_VisualServer_light_set_cull_mask: - void **light_set_cull_mask** **(** :ref:`RID` light, :ref:`int` mask **)** -.. _class_VisualServer_light_set_negative: + .. _class_VisualServer_light_set_negative: - void **light_set_negative** **(** :ref:`RID` light, :ref:`bool` enable **)** -.. _class_VisualServer_light_set_param: + .. _class_VisualServer_light_set_param: - void **light_set_param** **(** :ref:`RID` light, :ref:`LightParam` param, :ref:`float` value **)** -.. _class_VisualServer_light_set_projector: + .. _class_VisualServer_light_set_projector: - void **light_set_projector** **(** :ref:`RID` light, :ref:`RID` texture **)** -.. _class_VisualServer_light_set_reverse_cull_face_mode: + .. _class_VisualServer_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_light_set_shadow: - void **light_set_shadow** **(** :ref:`RID` light, :ref:`bool` enabled **)** -.. _class_VisualServer_light_set_shadow_color: + .. _class_VisualServer_light_set_shadow_color: - void **light_set_shadow_color** **(** :ref:`RID` light, :ref:`Color` color **)** -.. _class_VisualServer_lightmap_capture_create: + .. _class_VisualServer_lightmap_capture_create: - :ref:`RID` **lightmap_capture_create** **(** **)** -.. _class_VisualServer_lightmap_capture_get_bounds: + .. _class_VisualServer_lightmap_capture_get_bounds: - :ref:`AABB` **lightmap_capture_get_bounds** **(** :ref:`RID` capture **)** const -.. _class_VisualServer_lightmap_capture_get_energy: + .. _class_VisualServer_lightmap_capture_get_energy: - :ref:`float` **lightmap_capture_get_energy** **(** :ref:`RID` capture **)** const -.. _class_VisualServer_lightmap_capture_get_octree: + .. _class_VisualServer_lightmap_capture_get_octree: - :ref:`PoolByteArray` **lightmap_capture_get_octree** **(** :ref:`RID` capture **)** const -.. _class_VisualServer_lightmap_capture_get_octree_cell_subdiv: + .. _class_VisualServer_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_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_lightmap_capture_set_bounds: - void **lightmap_capture_set_bounds** **(** :ref:`RID` capture, :ref:`AABB` bounds **)** -.. _class_VisualServer_lightmap_capture_set_energy: + .. _class_VisualServer_lightmap_capture_set_energy: - void **lightmap_capture_set_energy** **(** :ref:`RID` capture, :ref:`float` energy **)** -.. _class_VisualServer_lightmap_capture_set_octree: + .. _class_VisualServer_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_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_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_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_material_create: - :ref:`RID` **material_create** **(** **)** Returns an empty material. -.. _class_VisualServer_material_get_param: + .. _class_VisualServer_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_shader: + .. _class_VisualServer_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_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_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_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_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_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_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_mesh_clear: - void **mesh_clear** **(** :ref:`RID` mesh **)** Removes all surfaces from a mesh. -.. _class_VisualServer_mesh_create: + .. _class_VisualServer_mesh_create: - :ref:`RID` **mesh_create** **(** **)** Creates a new mesh. -.. _class_VisualServer_mesh_get_blend_shape_count: + .. _class_VisualServer_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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 **)** -.. _class_VisualServer_multimesh_get_aabb: + .. _class_VisualServer_multimesh_get_aabb: - :ref:`AABB` **multimesh_get_aabb** **(** :ref:`RID` multimesh **)** const -.. _class_VisualServer_multimesh_get_instance_count: + .. _class_VisualServer_multimesh_get_instance_count: - :ref:`int` **multimesh_get_instance_count** **(** :ref:`RID` multimesh **)** const -.. _class_VisualServer_multimesh_get_mesh: + .. _class_VisualServer_multimesh_get_mesh: - :ref:`RID` **multimesh_get_mesh** **(** :ref:`RID` multimesh **)** const -.. _class_VisualServer_multimesh_get_visible_instances: + .. _class_VisualServer_multimesh_get_visible_instances: - :ref:`int` **multimesh_get_visible_instances** **(** :ref:`RID` multimesh **)** const -.. _class_VisualServer_multimesh_instance_get_color: + .. _class_VisualServer_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_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_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_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_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_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_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_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_multimesh_set_as_bulk_array: - void **multimesh_set_as_bulk_array** **(** :ref:`RID` multimesh, :ref:`PoolRealArray` array **)** -.. _class_VisualServer_multimesh_set_mesh: + .. _class_VisualServer_multimesh_set_mesh: - void **multimesh_set_mesh** **(** :ref:`RID` multimesh, :ref:`RID` mesh **)** -.. _class_VisualServer_multimesh_set_visible_instances: + .. _class_VisualServer_multimesh_set_visible_instances: - void **multimesh_set_visible_instances** **(** :ref:`RID` multimesh, :ref:`int` visible **)** -.. _class_VisualServer_omni_light_create: + .. _class_VisualServer_omni_light_create: - :ref:`RID` **omni_light_create** **(** **)** -.. _class_VisualServer_particles_create: + .. _class_VisualServer_particles_create: - :ref:`RID` **particles_create** **(** **)** -.. _class_VisualServer_particles_get_current_aabb: + .. _class_VisualServer_particles_get_current_aabb: - :ref:`AABB` **particles_get_current_aabb** **(** :ref:`RID` particles **)** -.. _class_VisualServer_particles_get_emitting: + .. _class_VisualServer_particles_get_emitting: - :ref:`bool` **particles_get_emitting** **(** :ref:`RID` particles **)** -.. _class_VisualServer_particles_restart: + .. _class_VisualServer_particles_restart: - void **particles_restart** **(** :ref:`RID` particles **)** -.. _class_VisualServer_particles_set_amount: + .. _class_VisualServer_particles_set_amount: - void **particles_set_amount** **(** :ref:`RID` particles, :ref:`int` amount **)** -.. _class_VisualServer_particles_set_custom_aabb: + .. _class_VisualServer_particles_set_custom_aabb: - void **particles_set_custom_aabb** **(** :ref:`RID` particles, :ref:`AABB` aabb **)** -.. _class_VisualServer_particles_set_draw_order: + .. _class_VisualServer_particles_set_draw_order: - void **particles_set_draw_order** **(** :ref:`RID` particles, :ref:`ParticlesDrawOrder` order **)** -.. _class_VisualServer_particles_set_draw_pass_mesh: + .. _class_VisualServer_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_particles_set_draw_passes: - void **particles_set_draw_passes** **(** :ref:`RID` particles, :ref:`int` count **)** -.. _class_VisualServer_particles_set_emission_transform: + .. _class_VisualServer_particles_set_emission_transform: - void **particles_set_emission_transform** **(** :ref:`RID` particles, :ref:`Transform` transform **)** -.. _class_VisualServer_particles_set_emitting: + .. _class_VisualServer_particles_set_emitting: - void **particles_set_emitting** **(** :ref:`RID` particles, :ref:`bool` emitting **)** -.. _class_VisualServer_particles_set_explosiveness_ratio: + .. _class_VisualServer_particles_set_explosiveness_ratio: - void **particles_set_explosiveness_ratio** **(** :ref:`RID` particles, :ref:`float` ratio **)** -.. _class_VisualServer_particles_set_fixed_fps: + .. _class_VisualServer_particles_set_fixed_fps: - void **particles_set_fixed_fps** **(** :ref:`RID` particles, :ref:`int` fps **)** -.. _class_VisualServer_particles_set_fractional_delta: + .. _class_VisualServer_particles_set_fractional_delta: - void **particles_set_fractional_delta** **(** :ref:`RID` particles, :ref:`bool` enable **)** -.. _class_VisualServer_particles_set_lifetime: + .. _class_VisualServer_particles_set_lifetime: - void **particles_set_lifetime** **(** :ref:`RID` particles, :ref:`float` lifetime **)** -.. _class_VisualServer_particles_set_one_shot: + .. _class_VisualServer_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_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_particles_set_process_material: - void **particles_set_process_material** **(** :ref:`RID` particles, :ref:`RID` material **)** -.. _class_VisualServer_particles_set_randomness_ratio: + .. _class_VisualServer_particles_set_randomness_ratio: - void **particles_set_randomness_ratio** **(** :ref:`RID` particles, :ref:`float` ratio **)** -.. _class_VisualServer_particles_set_speed_scale: + .. _class_VisualServer_particles_set_speed_scale: - void **particles_set_speed_scale** **(** :ref:`RID` particles, :ref:`float` scale **)** -.. _class_VisualServer_particles_set_use_local_coordinates: + .. _class_VisualServer_particles_set_use_local_coordinates: - void **particles_set_use_local_coordinates** **(** :ref:`RID` particles, :ref:`bool` enable **)** -.. _class_VisualServer_reflection_probe_create: + .. _class_VisualServer_reflection_probe_create: - :ref:`RID` **reflection_probe_create** **(** **)** -.. _class_VisualServer_reflection_probe_set_as_interior: + .. _class_VisualServer_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_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_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_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_reflection_probe_set_extents: - void **reflection_probe_set_extents** **(** :ref:`RID` probe, :ref:`Vector3` extents **)** -.. _class_VisualServer_reflection_probe_set_intensity: + .. _class_VisualServer_reflection_probe_set_intensity: - void **reflection_probe_set_intensity** **(** :ref:`RID` probe, :ref:`float` intensity **)** -.. _class_VisualServer_reflection_probe_set_interior_ambient: + .. _class_VisualServer_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_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_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_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_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_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_request_frame_drawn_callback: - void **request_frame_drawn_callback** **(** :ref:`Object` where, :ref:`String` method, :ref:`Variant` userdata **)** @@ -2506,359 +2504,359 @@ 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_scenario_create: - :ref:`RID` **scenario_create** **(** **)** -.. _class_VisualServer_scenario_set_debug: + .. _class_VisualServer_scenario_set_debug: - void **scenario_set_debug** **(** :ref:`RID` scenario, :ref:`ScenarioDebugMode` debug_mode **)** -.. _class_VisualServer_scenario_set_environment: + .. _class_VisualServer_scenario_set_environment: - void **scenario_set_environment** **(** :ref:`RID` scenario, :ref:`RID` environment **)** -.. _class_VisualServer_scenario_set_fallback_environment: + .. _class_VisualServer_scenario_set_fallback_environment: - void **scenario_set_fallback_environment** **(** :ref:`RID` scenario, :ref:`RID` environment **)** -.. _class_VisualServer_scenario_set_reflection_atlas_size: + .. _class_VisualServer_scenario_set_reflection_atlas_size: - void **scenario_set_reflection_atlas_size** **(** :ref:`RID` scenario, :ref:`int` p_size, :ref:`int` subdiv **)** -.. _class_VisualServer_set_boot_image: + .. _class_VisualServer_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_set_debug_generate_wireframes: - void **set_debug_generate_wireframes** **(** :ref:`bool` generate **)** -.. _class_VisualServer_set_default_clear_color: + .. _class_VisualServer_set_default_clear_color: - void **set_default_clear_color** **(** :ref:`Color` color **)** -.. _class_VisualServer_shader_create: + .. _class_VisualServer_shader_create: - :ref:`RID` **shader_create** **(** **)** Creates an empty shader. -.. _class_VisualServer_shader_get_code: + .. _class_VisualServer_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_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_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_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_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_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_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_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_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_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_skeleton_create: - :ref:`RID` **skeleton_create** **(** **)** -.. _class_VisualServer_skeleton_get_bone_count: + .. _class_VisualServer_skeleton_get_bone_count: - :ref:`int` **skeleton_get_bone_count** **(** :ref:`RID` skeleton **)** const -.. _class_VisualServer_sky_create: + .. _class_VisualServer_sky_create: - :ref:`RID` **sky_create** **(** **)** Creates an empty sky. -.. _class_VisualServer_sky_set_texture: + .. _class_VisualServer_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_spot_light_create: - :ref:`RID` **spot_light_create** **(** **)** -.. _class_VisualServer_sync: + .. _class_VisualServer_sync: - void **sync** **(** **)** -.. _class_VisualServer_texture_allocate: + .. _class_VisualServer_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_texture_create: - :ref:`RID` **texture_create** **(** **)** Creates an empty texture. -.. _class_VisualServer_texture_create_from_image: + .. _class_VisualServer_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_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_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_texture_get_depth: - :ref:`int` **texture_get_depth** **(** :ref:`RID` texture **)** const -.. _class_VisualServer_texture_get_flags: + .. _class_VisualServer_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_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_texture_get_height: - :ref:`int` **texture_get_height** **(** :ref:`RID` texture **)** const Returns the texture's height. -.. _class_VisualServer_texture_get_path: + .. _class_VisualServer_texture_get_path: - :ref:`String` **texture_get_path** **(** :ref:`RID` texture **)** const Returns the texture's path. -.. _class_VisualServer_texture_get_texid: + .. _class_VisualServer_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_texture_get_type: - :ref:`TextureType` **texture_get_type** **(** :ref:`RID` texture **)** const -.. _class_VisualServer_texture_get_width: + .. _class_VisualServer_texture_get_width: - :ref:`int` **texture_get_width** **(** :ref:`RID` texture **)** const Returns the texture's width. -.. _class_VisualServer_texture_set_data: + .. _class_VisualServer_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_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_texture_set_flags: - void **texture_set_flags** **(** :ref:`RID` texture, :ref:`int` flags **)** Sets the texture's flags. See :ref:`TextureFlags` for options -.. _class_VisualServer_texture_set_path: + .. _class_VisualServer_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_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_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_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_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_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_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_viewport_create: - :ref:`RID` **viewport_create** **(** **)** Creates an empty viewport. -.. _class_VisualServer_viewport_detach: + .. _class_VisualServer_viewport_detach: - void **viewport_detach** **(** :ref:`RID` viewport **)** Detaches the viewport from the screen. -.. _class_VisualServer_viewport_get_render_info: + .. _class_VisualServer_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_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_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_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_layer: + .. _class_VisualServer_viewport_set_canvas_layer: - void **viewport_set_canvas_layer** **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`int` layer **)** Sets the renderlayer for a viewport's canvas. -.. _class_VisualServer_viewport_set_canvas_transform: + .. _class_VisualServer_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_viewport_set_clear_mode: - void **viewport_set_clear_mode** **(** :ref:`RID` viewport, :ref:`ViewportClearMode` clear_mode **)** Sets the clear mode of a viewport. See VIEWPORT_CLEAR_MODE\_\* constants for options. -.. _class_VisualServer_viewport_set_debug_draw: + .. _class_VisualServer_viewport_set_debug_draw: - void **viewport_set_debug_draw** **(** :ref:`RID` viewport, :ref:`ViewportDebugDraw` draw **)** Sets the debug draw mode of a viewport. See VIEWPORT_DEBUG_DRAW\_\* constants for options. -.. _class_VisualServer_viewport_set_disable_3d: + .. _class_VisualServer_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_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_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_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_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_viewport_set_hide_scenario: - void **viewport_set_hide_scenario** **(** :ref:`RID` viewport, :ref:`bool` hidden **)** -.. _class_VisualServer_viewport_set_msaa: + .. _class_VisualServer_viewport_set_msaa: - void **viewport_set_msaa** **(** :ref:`RID` viewport, :ref:`ViewportMSAA` msaa **)** Sets the anti-aliasing mode. see :ref:`ViewportMSAA` for options. -.. _class_VisualServer_viewport_set_parent_viewport: + .. _class_VisualServer_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_viewport_set_scenario: - void **viewport_set_scenario** **(** :ref:`RID` viewport, :ref:`RID` scenario **)** @@ -2866,52 +2864,51 @@ Sets a viewport's scenario. The scenario contains information about the :ref:`ScenarioDebugMode`, environment information, reflection atlas etc. -.. _class_VisualServer_viewport_set_shadow_atlas_quadrant_subdivision: + .. _class_VisualServer_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_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_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_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_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. -.. _class_VisualServer_viewport_set_usage: + .. _class_VisualServer_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. -.. _class_VisualServer_viewport_set_use_arvr: + .. _class_VisualServer_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_viewport_set_vflip: - void **viewport_set_vflip** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** If ``true`` the viewport's rendering is flipped vertically. - diff --git a/classes/class_visualshader.rst b/classes/class_visualshader.rst index f7665d443..66b8f12e8 100644 --- a/classes/class_visualshader.rst +++ b/classes/class_visualshader.rst @@ -8,6 +8,7 @@ VisualShader ============ **Inherits:** :ref:`Shader` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description +Properties +---------- + ++-------------------------------+------------------------------------------------------+ +| :ref:`Vector2` | :ref:`graph_offset` | ++-------------------------------+------------------------------------------------------+ + Methods ------- @@ -51,20 +59,18 @@ Enumerations .. _enum_VisualShader_Type: -enum **Type** +enum **Type**: - **TYPE_VERTEX** = **0** - **TYPE_FRAGMENT** = **1** - **TYPE_LIGHT** = **2** - **TYPE_MAX** = **3** - Constants --------- - **NODE_ID_INVALID** = **-1** - **NODE_ID_OUTPUT** = **0** - Property Descriptions --------------------- @@ -72,60 +78,64 @@ Property Descriptions - :ref:`Vector2` **graph_offset** ++----------+-------------------------+ +| *Setter* | set_graph_offset(value) | ++----------+-------------------------+ +| *Getter* | get_graph_offset() | ++----------+-------------------------+ Method Descriptions ------------------- -.. _class_VisualShader_add_node: + .. _class_VisualShader_add_node: - void **add_node** **(** :ref:`Type` type, :ref:`VisualShaderNode` node, :ref:`Vector2` position, :ref:`int` id **)** -.. _class_VisualShader_can_connect_nodes: + .. _class_VisualShader_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_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_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_get_node: - :ref:`VisualShaderNode` **get_node** **(** :ref:`Type` type, :ref:`int` id **)** const -.. _class_VisualShader_get_node_connections: + .. _class_VisualShader_get_node_connections: - :ref:`Array` **get_node_connections** **(** :ref:`Type` type **)** const -.. _class_VisualShader_get_node_list: + .. _class_VisualShader_get_node_list: - :ref:`PoolIntArray` **get_node_list** **(** :ref:`Type` type **)** const -.. _class_VisualShader_get_node_position: + .. _class_VisualShader_get_node_position: - :ref:`Vector2` **get_node_position** **(** :ref:`Type` type, :ref:`int` id **)** const -.. _class_VisualShader_get_valid_node_id: + .. _class_VisualShader_get_valid_node_id: - :ref:`int` **get_valid_node_id** **(** :ref:`Type` type **)** const -.. _class_VisualShader_is_node_connection: + .. _class_VisualShader_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_remove_node: - void **remove_node** **(** :ref:`Type` type, :ref:`int` id **)** -.. _class_VisualShader_set_mode: + .. _class_VisualShader_set_mode: - void **set_mode** **(** :ref:`Mode` mode **)** -.. _class_VisualShader_set_node_position: + .. _class_VisualShader_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 846f29f6f..10a08f154 100644 --- a/classes/class_visualshadernode.rst +++ b/classes/class_visualshadernode.rst @@ -8,7 +8,9 @@ VisualShaderNode ================ **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`VisualShaderNodeVectorFunc`, :ref:`VisualShaderNodeVectorCompose`, :ref:`VisualShaderNodeTransformDecompose`, :ref:`VisualShaderNodeCubeMapUniform`, :ref:`VisualShaderNodeUniform`, :ref:`VisualShaderNodeTransformVecMult`, :ref:`VisualShaderNodeVectorDecompose`, :ref:`VisualShaderNodeVec3Constant`, :ref:`VisualShaderNodeTransformMult`, :ref:`VisualShaderNodeCubeMap`, :ref:`VisualShaderNodeInput`, :ref:`VisualShaderNodeScalarConstant`, :ref:`VisualShaderNodeScalarFunc`, :ref:`VisualShaderNodeScalarOp`, :ref:`VisualShaderNodeTransformCompose`, :ref:`VisualShaderNodeVectorOp`, :ref:`VisualShaderNodeVectorLen`, :ref:`VisualShaderNodeColorOp`, :ref:`VisualShaderNodeTransformConstant`, :ref:`VisualShaderNodeOutput`, :ref:`VisualShaderNodeVectorInterp`, :ref:`VisualShaderNodeDotProduct`, :ref:`VisualShaderNodeTexture`, :ref:`VisualShaderNodeScalarInterp`, :ref:`VisualShaderNodeColorConstant` + **Category:** Core Brief Description @@ -16,6 +18,15 @@ Brief Description +Properties +---------- + ++---------------------------+--------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`default_input_values` | ++---------------------------+--------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`output_port_for_preview` | ++---------------------------+--------------------------------------------------------------------------------+ + Methods ------- @@ -28,11 +39,10 @@ Methods Signals ------- -.. _class_VisualShaderNode_editor_refresh_request: + .. _class_VisualShaderNode_editor_refresh_request: - **editor_refresh_request** **(** **)** - Property Descriptions --------------------- @@ -44,16 +54,20 @@ Property Descriptions - :ref:`int` **output_port_for_preview** ++----------+------------------------------------+ +| *Setter* | set_output_port_for_preview(value) | ++----------+------------------------------------+ +| *Getter* | get_output_port_for_preview() | ++----------+------------------------------------+ Method Descriptions ------------------- -.. _class_VisualShaderNode_get_input_port_default_value: + .. _class_VisualShaderNode_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_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 76bda407f..1960514d9 100644 --- a/classes/class_visualshadernodecolorconstant.rst +++ b/classes/class_visualshadernodecolorconstant.rst @@ -8,6 +8,7 @@ VisualShaderNodeColorConstant ============================= **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description +Properties +---------- + ++---------------------------+---------------------------------------------------------------+ +| :ref:`Color` | :ref:`constant` | ++---------------------------+---------------------------------------------------------------+ + Property Descriptions --------------------- @@ -22,4 +30,9 @@ Property Descriptions - :ref:`Color` **constant** ++----------+---------------------+ +| *Setter* | set_constant(value) | ++----------+---------------------+ +| *Getter* | get_constant() | ++----------+---------------------+ diff --git a/classes/class_visualshadernodecolorop.rst b/classes/class_visualshadernodecolorop.rst index 7dcabd09e..d209eb167 100644 --- a/classes/class_visualshadernodecolorop.rst +++ b/classes/class_visualshadernodecolorop.rst @@ -8,6 +8,7 @@ VisualShaderNodeColorOp ======================= **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,12 +16,19 @@ Brief Description +Properties +---------- + ++--------------------------------------------------------+---------------------------------------------------------+ +| :ref:`Operator` | :ref:`operator` | ++--------------------------------------------------------+---------------------------------------------------------+ + Enumerations ------------ .. _enum_VisualShaderNodeColorOp_Operator: -enum **Operator** +enum **Operator**: - **OP_SCREEN** = **0** - **OP_DIFFERENCE** = **1** @@ -32,7 +40,6 @@ enum **Operator** - **OP_SOFT_LIGHT** = **7** - **OP_HARD_LIGHT** = **8** - Property Descriptions --------------------- @@ -40,4 +47,9 @@ Property Descriptions - :ref:`Operator` **operator** ++----------+---------------------+ +| *Setter* | set_operator(value) | ++----------+---------------------+ +| *Getter* | get_operator() | ++----------+---------------------+ diff --git a/classes/class_visualshadernodecoloruniform.rst b/classes/class_visualshadernodecoloruniform.rst index c5a363479..608a8d12f 100644 --- a/classes/class_visualshadernodecoloruniform.rst +++ b/classes/class_visualshadernodecoloruniform.rst @@ -8,6 +8,7 @@ VisualShaderNodeColorUniform ============================ **Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_visualshadernodecubemap.rst b/classes/class_visualshadernodecubemap.rst index 8943cde74..3d7293116 100644 --- a/classes/class_visualshadernodecubemap.rst +++ b/classes/class_visualshadernodecubemap.rst @@ -8,6 +8,7 @@ VisualShaderNodeCubeMap ======================= **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,18 +16,26 @@ Brief Description +Properties +---------- + ++--------------------------------------------------------------+-----------------------------------------------------------------+ +| :ref:`CubeMap` | :ref:`cube_map` | ++--------------------------------------------------------------+-----------------------------------------------------------------+ +| :ref:`TextureType` | :ref:`texture_type` | ++--------------------------------------------------------------+-----------------------------------------------------------------+ + Enumerations ------------ .. _enum_VisualShaderNodeCubeMap_TextureType: -enum **TextureType** +enum **TextureType**: - **TYPE_DATA** = **0** - **TYPE_COLOR** = **1** - **TYPE_NORMALMAP** = **2** - Property Descriptions --------------------- @@ -34,8 +43,19 @@ Property Descriptions - :ref:`CubeMap` **cube_map** ++----------+---------------------+ +| *Setter* | set_cube_map(value) | ++----------+---------------------+ +| *Getter* | get_cube_map() | ++----------+---------------------+ + .. _class_VisualShaderNodeCubeMap_texture_type: - :ref:`TextureType` **texture_type** ++----------+-------------------------+ +| *Setter* | set_texture_type(value) | ++----------+-------------------------+ +| *Getter* | get_texture_type() | ++----------+-------------------------+ diff --git a/classes/class_visualshadernodecubemapuniform.rst b/classes/class_visualshadernodecubemapuniform.rst index e653ee1d8..41670b778 100644 --- a/classes/class_visualshadernodecubemapuniform.rst +++ b/classes/class_visualshadernodecubemapuniform.rst @@ -8,6 +8,7 @@ VisualShaderNodeCubeMapUniform ============================== **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_visualshadernodedotproduct.rst b/classes/class_visualshadernodedotproduct.rst index b709b79e5..e40fb8781 100644 --- a/classes/class_visualshadernodedotproduct.rst +++ b/classes/class_visualshadernodedotproduct.rst @@ -8,6 +8,7 @@ VisualShaderNodeDotProduct ========================== **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_visualshadernodeinput.rst b/classes/class_visualshadernodeinput.rst index 0b553a3bf..1259b8883 100644 --- a/classes/class_visualshadernodeinput.rst +++ b/classes/class_visualshadernodeinput.rst @@ -8,6 +8,7 @@ VisualShaderNodeInput ===================== **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,14 +16,20 @@ Brief Description +Properties +---------- + ++-----------------------------+-----------------------------------------------------------+ +| :ref:`String` | :ref:`input_name` | ++-----------------------------+-----------------------------------------------------------+ + Signals ------- -.. _class_VisualShaderNodeInput_input_type_changed: + .. _class_VisualShaderNodeInput_input_type_changed: - **input_type_changed** **(** **)** - Property Descriptions --------------------- @@ -30,4 +37,9 @@ Property Descriptions - :ref:`String` **input_name** ++----------+-----------------------+ +| *Setter* | set_input_name(value) | ++----------+-----------------------+ +| *Getter* | get_input_name() | ++----------+-----------------------+ diff --git a/classes/class_visualshadernodeoutput.rst b/classes/class_visualshadernodeoutput.rst index a1e4bd30b..438b63038 100644 --- a/classes/class_visualshadernodeoutput.rst +++ b/classes/class_visualshadernodeoutput.rst @@ -8,6 +8,7 @@ VisualShaderNodeOutput ====================== **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_visualshadernodescalarconstant.rst b/classes/class_visualshadernodescalarconstant.rst index e7dc745df..a26db5837 100644 --- a/classes/class_visualshadernodescalarconstant.rst +++ b/classes/class_visualshadernodescalarconstant.rst @@ -8,6 +8,7 @@ VisualShaderNodeScalarConstant ============================== **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description +Properties +---------- + ++---------------------------+----------------------------------------------------------------+ +| :ref:`float` | :ref:`constant` | ++---------------------------+----------------------------------------------------------------+ + Property Descriptions --------------------- @@ -22,4 +30,9 @@ Property Descriptions - :ref:`float` **constant** ++----------+---------------------+ +| *Setter* | set_constant(value) | ++----------+---------------------+ +| *Getter* | get_constant() | ++----------+---------------------+ diff --git a/classes/class_visualshadernodescalarfunc.rst b/classes/class_visualshadernodescalarfunc.rst index ecc43dbda..74e1a50e6 100644 --- a/classes/class_visualshadernodescalarfunc.rst +++ b/classes/class_visualshadernodescalarfunc.rst @@ -8,6 +8,7 @@ VisualShaderNodeScalarFunc ========================== **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,12 +16,19 @@ Brief Description +Properties +---------- + ++-----------------------------------------------------------+------------------------------------------------------------+ +| :ref:`Function` | :ref:`function` | ++-----------------------------------------------------------+------------------------------------------------------------+ + Enumerations ------------ .. _enum_VisualShaderNodeScalarFunc_Function: -enum **Function** +enum **Function**: - **FUNC_SIN** = **0** - **FUNC_COS** = **1** @@ -43,7 +51,6 @@ enum **Function** - **FUNC_SATURATE** = **18** - **FUNC_NEGATE** = **19** - Property Descriptions --------------------- @@ -51,4 +58,9 @@ Property Descriptions - :ref:`Function` **function** ++----------+---------------------+ +| *Setter* | set_function(value) | ++----------+---------------------+ +| *Getter* | get_function() | ++----------+---------------------+ diff --git a/classes/class_visualshadernodescalarinterp.rst b/classes/class_visualshadernodescalarinterp.rst index ae2f82c88..cbb7cac30 100644 --- a/classes/class_visualshadernodescalarinterp.rst +++ b/classes/class_visualshadernodescalarinterp.rst @@ -8,6 +8,7 @@ VisualShaderNodeScalarInterp ============================ **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_visualshadernodescalarop.rst b/classes/class_visualshadernodescalarop.rst index 0c7fefcfa..9b6f0ecc4 100644 --- a/classes/class_visualshadernodescalarop.rst +++ b/classes/class_visualshadernodescalarop.rst @@ -8,6 +8,7 @@ VisualShaderNodeScalarOp ======================== **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,12 +16,19 @@ Brief Description +Properties +---------- + ++---------------------------------------------------------+----------------------------------------------------------+ +| :ref:`Operator` | :ref:`operator` | ++---------------------------------------------------------+----------------------------------------------------------+ + Enumerations ------------ .. _enum_VisualShaderNodeScalarOp_Operator: -enum **Operator** +enum **Operator**: - **OP_ADD** = **0** - **OP_SUB** = **1** @@ -32,7 +40,6 @@ enum **Operator** - **OP_MIN** = **7** - **OP_ATAN2** = **8** - Property Descriptions --------------------- @@ -40,4 +47,9 @@ Property Descriptions - :ref:`Operator` **operator** ++----------+---------------------+ +| *Setter* | set_operator(value) | ++----------+---------------------+ +| *Getter* | get_operator() | ++----------+---------------------+ diff --git a/classes/class_visualshadernodescalaruniform.rst b/classes/class_visualshadernodescalaruniform.rst index a16fbfb6e..d033469a7 100644 --- a/classes/class_visualshadernodescalaruniform.rst +++ b/classes/class_visualshadernodescalaruniform.rst @@ -8,6 +8,7 @@ VisualShaderNodeScalarUniform ============================= **Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_visualshadernodetexture.rst b/classes/class_visualshadernodetexture.rst index 66a026c5c..fa9036719 100644 --- a/classes/class_visualshadernodetexture.rst +++ b/classes/class_visualshadernodetexture.rst @@ -8,6 +8,7 @@ VisualShaderNodeTexture ======================= **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,12 +16,23 @@ Brief Description +Properties +---------- + ++--------------------------------------------------------------+-----------------------------------------------------------------+ +| :ref:`Source` | :ref:`source` | ++--------------------------------------------------------------+-----------------------------------------------------------------+ +| :ref:`Texture` | :ref:`texture` | ++--------------------------------------------------------------+-----------------------------------------------------------------+ +| :ref:`TextureType` | :ref:`texture_type` | ++--------------------------------------------------------------+-----------------------------------------------------------------+ + Enumerations ------------ .. _enum_VisualShaderNodeTexture_Source: -enum **Source** +enum **Source**: - **SOURCE_TEXTURE** = **0** - **SOURCE_SCREEN** = **1** @@ -29,13 +41,12 @@ enum **Source** .. _enum_VisualShaderNodeTexture_TextureType: -enum **TextureType** +enum **TextureType**: - **TYPE_DATA** = **0** - **TYPE_COLOR** = **1** - **TYPE_NORMALMAP** = **2** - Property Descriptions --------------------- @@ -43,12 +54,29 @@ Property Descriptions - :ref:`Source` **source** ++----------+-------------------+ +| *Setter* | set_source(value) | ++----------+-------------------+ +| *Getter* | get_source() | ++----------+-------------------+ + .. _class_VisualShaderNodeTexture_texture: - :ref:`Texture` **texture** ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + .. _class_VisualShaderNodeTexture_texture_type: - :ref:`TextureType` **texture_type** ++----------+-------------------------+ +| *Setter* | set_texture_type(value) | ++----------+-------------------------+ +| *Getter* | get_texture_type() | ++----------+-------------------------+ diff --git a/classes/class_visualshadernodetextureuniform.rst b/classes/class_visualshadernodetextureuniform.rst index 4a4a4680b..ffc4e4152 100644 --- a/classes/class_visualshadernodetextureuniform.rst +++ b/classes/class_visualshadernodetextureuniform.rst @@ -8,6 +8,7 @@ VisualShaderNodeTextureUniform ============================== **Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,12 +16,21 @@ Brief Description +Properties +---------- + ++-----------------------------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`ColorDefault` | :ref:`color_default` | ++-----------------------------------------------------------------------+--------------------------------------------------------------------------+ +| :ref:`TextureType` | :ref:`texture_type` | ++-----------------------------------------------------------------------+--------------------------------------------------------------------------+ + Enumerations ------------ .. _enum_VisualShaderNodeTextureUniform_TextureType: -enum **TextureType** +enum **TextureType**: - **TYPE_DATA** = **0** - **TYPE_COLOR** = **1** @@ -29,12 +39,11 @@ enum **TextureType** .. _enum_VisualShaderNodeTextureUniform_ColorDefault: -enum **ColorDefault** +enum **ColorDefault**: - **COLOR_DEFAULT_WHITE** = **0** - **COLOR_DEFAULT_BLACK** = **1** - Property Descriptions --------------------- @@ -42,8 +51,19 @@ Property Descriptions - :ref:`ColorDefault` **color_default** ++----------+--------------------------+ +| *Setter* | set_color_default(value) | ++----------+--------------------------+ +| *Getter* | get_color_default() | ++----------+--------------------------+ + .. _class_VisualShaderNodeTextureUniform_texture_type: - :ref:`TextureType` **texture_type** ++----------+-------------------------+ +| *Setter* | set_texture_type(value) | ++----------+-------------------------+ +| *Getter* | get_texture_type() | ++----------+-------------------------+ diff --git a/classes/class_visualshadernodetransformcompose.rst b/classes/class_visualshadernodetransformcompose.rst index 3e10cf524..7492ef60e 100644 --- a/classes/class_visualshadernodetransformcompose.rst +++ b/classes/class_visualshadernodetransformcompose.rst @@ -8,6 +8,7 @@ VisualShaderNodeTransformCompose ================================ **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_visualshadernodetransformconstant.rst b/classes/class_visualshadernodetransformconstant.rst index c82b0153d..e1a818747 100644 --- a/classes/class_visualshadernodetransformconstant.rst +++ b/classes/class_visualshadernodetransformconstant.rst @@ -8,6 +8,7 @@ VisualShaderNodeTransformConstant ================================= **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description +Properties +---------- + ++-----------------------------------+-------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`constant` | ++-----------------------------------+-------------------------------------------------------------------+ + Property Descriptions --------------------- @@ -22,4 +30,9 @@ Property Descriptions - :ref:`Transform` **constant** ++----------+---------------------+ +| *Setter* | set_constant(value) | ++----------+---------------------+ +| *Getter* | get_constant() | ++----------+---------------------+ diff --git a/classes/class_visualshadernodetransformdecompose.rst b/classes/class_visualshadernodetransformdecompose.rst index 4dbd0710e..eb1b6202b 100644 --- a/classes/class_visualshadernodetransformdecompose.rst +++ b/classes/class_visualshadernodetransformdecompose.rst @@ -8,6 +8,7 @@ VisualShaderNodeTransformDecompose ================================== **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_visualshadernodetransformmult.rst b/classes/class_visualshadernodetransformmult.rst index 6966f8232..2cb33d6af 100644 --- a/classes/class_visualshadernodetransformmult.rst +++ b/classes/class_visualshadernodetransformmult.rst @@ -8,6 +8,7 @@ VisualShaderNodeTransformMult ============================= **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,17 +16,23 @@ Brief Description +Properties +---------- + ++--------------------------------------------------------------+---------------------------------------------------------------+ +| :ref:`Operator` | :ref:`operator` | ++--------------------------------------------------------------+---------------------------------------------------------------+ + Enumerations ------------ .. _enum_VisualShaderNodeTransformMult_Operator: -enum **Operator** +enum **Operator**: - **OP_AxB** = **0** - **OP_BxA** = **1** - Property Descriptions --------------------- @@ -33,4 +40,9 @@ Property Descriptions - :ref:`Operator` **operator** ++----------+---------------------+ +| *Setter* | set_operator(value) | ++----------+---------------------+ +| *Getter* | get_operator() | ++----------+---------------------+ diff --git a/classes/class_visualshadernodetransformuniform.rst b/classes/class_visualshadernodetransformuniform.rst index d3edc5dc7..75f34c019 100644 --- a/classes/class_visualshadernodetransformuniform.rst +++ b/classes/class_visualshadernodetransformuniform.rst @@ -8,6 +8,7 @@ VisualShaderNodeTransformUniform ================================ **Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_visualshadernodetransformvecmult.rst b/classes/class_visualshadernodetransformvecmult.rst index 6ccffd042..8fa7d9e61 100644 --- a/classes/class_visualshadernodetransformvecmult.rst +++ b/classes/class_visualshadernodetransformvecmult.rst @@ -8,6 +8,7 @@ VisualShaderNodeTransformVecMult ================================ **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,19 +16,25 @@ Brief Description +Properties +---------- + ++-----------------------------------------------------------------+------------------------------------------------------------------+ +| :ref:`Operator` | :ref:`operator` | ++-----------------------------------------------------------------+------------------------------------------------------------------+ + Enumerations ------------ .. _enum_VisualShaderNodeTransformVecMult_Operator: -enum **Operator** +enum **Operator**: - **OP_AxB** = **0** - **OP_BxA** = **1** - **OP_3x3_AxB** = **2** - **OP_3x3_BxA** = **3** - Property Descriptions --------------------- @@ -35,4 +42,9 @@ Property Descriptions - :ref:`Operator` **operator** ++----------+---------------------+ +| *Setter* | set_operator(value) | ++----------+---------------------+ +| *Getter* | get_operator() | ++----------+---------------------+ diff --git a/classes/class_visualshadernodeuniform.rst b/classes/class_visualshadernodeuniform.rst index c2479f05e..d6594fc88 100644 --- a/classes/class_visualshadernodeuniform.rst +++ b/classes/class_visualshadernodeuniform.rst @@ -8,7 +8,9 @@ VisualShaderNodeUniform ======================= **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`VisualShaderNodeVec3Uniform`, :ref:`VisualShaderNodeScalarUniform`, :ref:`VisualShaderNodeTextureUniform`, :ref:`VisualShaderNodeTransformUniform`, :ref:`VisualShaderNodeColorUniform` + **Category:** Core Brief Description @@ -16,6 +18,13 @@ Brief Description +Properties +---------- + ++-----------------------------+-----------------------------------------------------------------+ +| :ref:`String` | :ref:`uniform_name` | ++-----------------------------+-----------------------------------------------------------------+ + Property Descriptions --------------------- @@ -23,4 +32,9 @@ Property Descriptions - :ref:`String` **uniform_name** ++----------+-------------------------+ +| *Setter* | set_uniform_name(value) | ++----------+-------------------------+ +| *Getter* | get_uniform_name() | ++----------+-------------------------+ diff --git a/classes/class_visualshadernodevec3constant.rst b/classes/class_visualshadernodevec3constant.rst index a29a3206a..7a2ac555c 100644 --- a/classes/class_visualshadernodevec3constant.rst +++ b/classes/class_visualshadernodevec3constant.rst @@ -8,6 +8,7 @@ VisualShaderNodeVec3Constant ============================ **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description +Properties +---------- + ++-------------------------------+--------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`constant` | ++-------------------------------+--------------------------------------------------------------+ + Property Descriptions --------------------- @@ -22,4 +30,9 @@ Property Descriptions - :ref:`Vector3` **constant** ++----------+---------------------+ +| *Setter* | set_constant(value) | ++----------+---------------------+ +| *Getter* | get_constant() | ++----------+---------------------+ diff --git a/classes/class_visualshadernodevec3uniform.rst b/classes/class_visualshadernodevec3uniform.rst index 30f39567d..ce00a3193 100644 --- a/classes/class_visualshadernodevec3uniform.rst +++ b/classes/class_visualshadernodevec3uniform.rst @@ -8,6 +8,7 @@ VisualShaderNodeVec3Uniform =========================== **Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_visualshadernodevectorcompose.rst b/classes/class_visualshadernodevectorcompose.rst index 9c253ea9b..c45855bdd 100644 --- a/classes/class_visualshadernodevectorcompose.rst +++ b/classes/class_visualshadernodevectorcompose.rst @@ -8,6 +8,7 @@ VisualShaderNodeVectorCompose ============================= **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_visualshadernodevectordecompose.rst b/classes/class_visualshadernodevectordecompose.rst index 0425b0c5e..14c2d6c52 100644 --- a/classes/class_visualshadernodevectordecompose.rst +++ b/classes/class_visualshadernodevectordecompose.rst @@ -8,6 +8,7 @@ VisualShaderNodeVectorDecompose =============================== **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_visualshadernodevectorfunc.rst b/classes/class_visualshadernodevectorfunc.rst index beb9bb60c..60bafd846 100644 --- a/classes/class_visualshadernodevectorfunc.rst +++ b/classes/class_visualshadernodevectorfunc.rst @@ -8,6 +8,7 @@ VisualShaderNodeVectorFunc ========================== **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,12 +16,19 @@ Brief Description +Properties +---------- + ++-----------------------------------------------------------+------------------------------------------------------------+ +| :ref:`Function` | :ref:`function` | ++-----------------------------------------------------------+------------------------------------------------------------+ + Enumerations ------------ .. _enum_VisualShaderNodeVectorFunc_Function: -enum **Function** +enum **Function**: - **FUNC_NORMALIZE** = **0** - **FUNC_SATURATE** = **1** @@ -29,7 +37,6 @@ enum **Function** - **FUNC_RGB2HSV** = **4** - **FUNC_HSV2RGB** = **5** - Property Descriptions --------------------- @@ -37,4 +44,9 @@ Property Descriptions - :ref:`Function` **function** ++----------+---------------------+ +| *Setter* | set_function(value) | ++----------+---------------------+ +| *Getter* | get_function() | ++----------+---------------------+ diff --git a/classes/class_visualshadernodevectorinterp.rst b/classes/class_visualshadernodevectorinterp.rst index 15bb727d8..53a52afbd 100644 --- a/classes/class_visualshadernodevectorinterp.rst +++ b/classes/class_visualshadernodevectorinterp.rst @@ -8,6 +8,7 @@ VisualShaderNodeVectorInterp ============================ **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_visualshadernodevectorlen.rst b/classes/class_visualshadernodevectorlen.rst index 003b1e060..2b215d389 100644 --- a/classes/class_visualshadernodevectorlen.rst +++ b/classes/class_visualshadernodevectorlen.rst @@ -8,6 +8,7 @@ VisualShaderNodeVectorLen ========================= **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description diff --git a/classes/class_visualshadernodevectorop.rst b/classes/class_visualshadernodevectorop.rst index e2fb29226..28cc5f24f 100644 --- a/classes/class_visualshadernodevectorop.rst +++ b/classes/class_visualshadernodevectorop.rst @@ -8,6 +8,7 @@ VisualShaderNodeVectorOp ======================== **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,12 +16,19 @@ Brief Description +Properties +---------- + ++---------------------------------------------------------+----------------------------------------------------------+ +| :ref:`Operator` | :ref:`operator` | ++---------------------------------------------------------+----------------------------------------------------------+ + Enumerations ------------ .. _enum_VisualShaderNodeVectorOp_Operator: -enum **Operator** +enum **Operator**: - **OP_ADD** = **0** - **OP_SUB** = **1** @@ -32,7 +40,6 @@ enum **Operator** - **OP_MIN** = **7** - **OP_CROSS** = **8** - Property Descriptions --------------------- @@ -40,4 +47,9 @@ Property Descriptions - :ref:`Operator` **operator** ++----------+---------------------+ +| *Setter* | set_operator(value) | ++----------+---------------------+ +| *Getter* | get_operator() | ++----------+---------------------+ diff --git a/classes/class_vscrollbar.rst b/classes/class_vscrollbar.rst index 97789ebf6..f794b7887 100644 --- a/classes/class_vscrollbar.rst +++ b/classes/class_vscrollbar.rst @@ -8,6 +8,7 @@ VScrollBar ========== **Inherits:** :ref:`ScrollBar` **<** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,3 +16,26 @@ Brief Description Vertical version of :ref:`ScrollBar`, which goes from left (min) to right (max). +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` | ++---------------------------------+------------------------------------------------------------------+ + diff --git a/classes/class_vseparator.rst b/classes/class_vseparator.rst index 164153e0a..bdf24a766 100644 --- a/classes/class_vseparator.rst +++ b/classes/class_vseparator.rst @@ -8,6 +8,7 @@ VSeparator ========== **Inherits:** :ref:`Separator` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,15 @@ Brief Description Vertical version of :ref:`Separator`. +Theme Properties +---------------- + ++---------------------------------+------------------------------------------------+ +| :ref:`int` | :ref:`separation` | ++---------------------------------+------------------------------------------------+ +| :ref:`StyleBox` | :ref:`separator` | ++---------------------------------+------------------------------------------------+ + Description ----------- diff --git a/classes/class_vslider.rst b/classes/class_vslider.rst index b36108f7c..e1772beda 100644 --- a/classes/class_vslider.rst +++ b/classes/class_vslider.rst @@ -8,6 +8,7 @@ VSlider ======= **Inherits:** :ref:`Slider` **<** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,29 @@ Brief Description 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` | ++---------------------------------+-----------------------------------------------------------+ + Description ----------- diff --git a/classes/class_vsplitcontainer.rst b/classes/class_vsplitcontainer.rst index 687e4d0fb..af3f73ba0 100644 --- a/classes/class_vsplitcontainer.rst +++ b/classes/class_vsplitcontainer.rst @@ -8,6 +8,7 @@ VSplitContainer =============== **Inherits:** :ref:`SplitContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,19 @@ Brief Description Vertical split container. +Theme Properties +---------------- + ++---------------------------------+-----------------------------------------------------+ +| :ref:`int` | :ref:`autohide` | ++---------------------------------+-----------------------------------------------------+ +| :ref:`StyleBox` | :ref:`bg` | ++---------------------------------+-----------------------------------------------------+ +| :ref:`Texture` | :ref:`grabber` | ++---------------------------------+-----------------------------------------------------+ +| :ref:`int` | :ref:`separation` | ++---------------------------------+-----------------------------------------------------+ + Description ----------- diff --git a/classes/class_weakref.rst b/classes/class_weakref.rst index f60a2bd55..7003b2d06 100644 --- a/classes/class_weakref.rst +++ b/classes/class_weakref.rst @@ -8,6 +8,7 @@ WeakRef ======= **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -30,10 +31,9 @@ A weakref can hold a :ref:`Reference`, without contributing to Method Descriptions ------------------- -.. _class_WeakRef_get_ref: + .. _class_WeakRef_get_ref: - :ref:`Variant` **get_ref** **(** **)** const Returns the :ref:`Object` this weakref is referring to. - diff --git a/classes/class_websocketclient.rst b/classes/class_websocketclient.rst index 6cb7ff7d2..34e8e9c5c 100644 --- a/classes/class_websocketclient.rst +++ b/classes/class_websocketclient.rst @@ -8,6 +8,7 @@ WebSocketClient =============== **Inherits:** :ref:`WebSocketMultiplayerPeer` **<** :ref:`NetworkedMultiplayerPeer` **<** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description A WebSocket client implementation +Properties +---------- + ++-------------------------+-----------------------------------------------------+ +| :ref:`bool` | :ref:`verify_ssl` | ++-------------------------+-----------------------------------------------------+ + Methods ------- @@ -27,31 +35,30 @@ Methods Signals ------- -.. _class_WebSocketClient_connection_closed: + .. _class_WebSocketClient_connection_closed: - **connection_closed** **(** **)** Emitted when the connection to the server is closed. -.. _class_WebSocketClient_connection_error: + .. _class_WebSocketClient_connection_error: - **connection_error** **(** **)** Emitted when the connection to the server fails. -.. _class_WebSocketClient_connection_established: + .. _class_WebSocketClient_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_data_received: - **data_received** **(** **)** Emitted when a WebSocket message is received. Note: This signal is NOT emitted when used as high level multiplayer peer. - Description ----------- @@ -68,24 +75,30 @@ Property Descriptions .. _class_WebSocketClient_verify_ssl: -- :ref:`bool` **verify_ssl** - Enable or disable SSL certificate verification. Note: You must specify the certificates to be used in the project settings for it to work when exported. +- :ref:`bool` **verify_ssl** ++----------+-------------------------------+ +| *Setter* | set_verify_ssl_enabled(value) | ++----------+-------------------------------+ +| *Getter* | is_verify_ssl_enabled() | ++----------+-------------------------------+ + +Enable or disable SSL certificate verification. Note: You must specify the certificates to be used in the project settings for it to work when exported. Method Descriptions ------------------- -.. _class_WebSocketClient_connect_to_url: + .. _class_WebSocketClient_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: connnections 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_disconnect_from_host: - void **disconnect_from_host** **(** **)** Disconnect from the server if currently connected. - diff --git a/classes/class_websocketmultiplayerpeer.rst b/classes/class_websocketmultiplayerpeer.rst index 6e3890696..208f910c3 100644 --- a/classes/class_websocketmultiplayerpeer.rst +++ b/classes/class_websocketmultiplayerpeer.rst @@ -8,7 +8,9 @@ WebSocketMultiplayerPeer ======================== **Inherits:** :ref:`NetworkedMultiplayerPeer` **<** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` + **Inherited By:** :ref:`WebSocketClient`, :ref:`WebSocketServer` + **Category:** Core Brief Description @@ -26,13 +28,12 @@ Methods Signals ------- -.. _class_WebSocketMultiplayerPeer_peer_packet: + .. _class_WebSocketMultiplayerPeer_peer_packet: - **peer_packet** **(** :ref:`int` peer_source **)** Emitted when a packet is received from a peer. Note: this signal is only emitted when the client or server is configured to use Godot multiplayer API. - Description ----------- @@ -41,10 +42,9 @@ Base class for WebSocket server and client, allowing them to be used as network Method Descriptions ------------------- -.. _class_WebSocketMultiplayerPeer_get_peer: + .. _class_WebSocketMultiplayerPeer_get_peer: - :ref:`WebSocketPeer` **get_peer** **(** :ref:`int` peer_id **)** const Returns the :ref:`WebSocketPeer` associated to the given ``peer_id``. - diff --git a/classes/class_websocketpeer.rst b/classes/class_websocketpeer.rst index e989194e1..b610cb9d3 100644 --- a/classes/class_websocketpeer.rst +++ b/classes/class_websocketpeer.rst @@ -8,6 +8,7 @@ WebSocketPeer ============= **Inherits:** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -39,12 +40,11 @@ Enumerations .. _enum_WebSocketPeer_WriteMode: -enum **WriteMode** +enum **WriteMode**: - **WRITE_MODE_TEXT** = **0** --- Specify that WebSockets messages should be transferred as text payload (only valid UTF-8 is allowed). - **WRITE_MODE_BINARY** = **1** --- Specify that WebSockets messages should be transferred as binary payload (any byte combination is allowed). - Description ----------- @@ -55,46 +55,45 @@ You can choose to write to the socket in binary or text mode, and you can recogn Method Descriptions ------------------- -.. _class_WebSocketPeer_close: + .. _class_WebSocketPeer_close: - void **close** **(** **)** Close this WebSocket connection, actively disconnecting the peer. -.. _class_WebSocketPeer_get_connected_host: + .. _class_WebSocketPeer_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_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_get_write_mode: - :ref:`WriteMode` **get_write_mode** **(** **)** const Get the current selected write mode. See :ref:`WriteMode`. -.. _class_WebSocketPeer_is_connected_to_host: + .. _class_WebSocketPeer_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_set_write_mode: - void **set_write_mode** **(** :ref:`WriteMode` mode **)** Sets the socket to use the given :ref:`WriteMode`. -.. _class_WebSocketPeer_was_string_packet: + .. _class_WebSocketPeer_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` - diff --git a/classes/class_websocketserver.rst b/classes/class_websocketserver.rst index 19408e999..85da3b5aa 100644 --- a/classes/class_websocketserver.rst +++ b/classes/class_websocketserver.rst @@ -8,6 +8,7 @@ WebSocketServer =============== **Inherits:** :ref:`WebSocketMultiplayerPeer` **<** :ref:`NetworkedMultiplayerPeer` **<** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -37,25 +38,24 @@ Methods Signals ------- -.. _class_WebSocketServer_client_connected: + .. _class_WebSocketServer_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_client_disconnected: - **client_disconnected** **(** :ref:`int` id **)** Emitted when a client disconnects. -.. _class_WebSocketServer_data_received: + .. _class_WebSocketServer_data_received: - **data_received** **(** :ref:`int` id **)** Emitted when a new message is received. Note: This signal is NOT emitted when used as high level multiplayer peer. - Description ----------- @@ -68,37 +68,37 @@ Note: This class will not work in HTML5 exports due to browser restrictions. Method Descriptions ------------------- -.. _class_WebSocketServer_disconnect_peer: + .. _class_WebSocketServer_disconnect_peer: - void **disconnect_peer** **(** :ref:`int` id **)** Disconnects the given peer. -.. _class_WebSocketServer_get_peer_address: + .. _class_WebSocketServer_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_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_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_is_listening: - :ref:`bool` **is_listening** **(** **)** const Returns ``true`` if the server is actively listening on a port. -.. _class_WebSocketServer_listen: + .. _class_WebSocketServer_listen: - :ref:`Error` **listen** **(** :ref:`int` port, :ref:`PoolStringArray` protocols=PoolStringArray( ), :ref:`bool` gd_mp_api=false **)** @@ -108,10 +108,9 @@ You can specify the desired subprotocols via the "protocols" array. If the list 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_stop: - void **stop** **(** **)** Stop the server and clear its state. - diff --git a/classes/class_windowdialog.rst b/classes/class_windowdialog.rst index c8b1bf802..d8db75763 100644 --- a/classes/class_windowdialog.rst +++ b/classes/class_windowdialog.rst @@ -8,7 +8,9 @@ WindowDialog ============ **Inherits:** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Inherited By:** :ref:`AcceptDialog` + **Category:** Core Brief Description @@ -16,6 +18,15 @@ Brief Description Base class for window dialogs. +Properties +---------- + ++-----------------------------+------------------------------------------------------+ +| :ref:`bool` | :ref:`resizable` | ++-----------------------------+------------------------------------------------------+ +| :ref:`String` | :ref:`window_title` | ++-----------------------------+------------------------------------------------------+ + Methods ------- @@ -23,6 +34,29 @@ Methods | :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` | ++---------------------------------+--------------------------------------------------------------+ + Description ----------- @@ -33,20 +67,34 @@ Property Descriptions .. _class_WindowDialog_resizable: -- :ref:`bool` **resizable** - If ``true`` the user can resize the window. Default value: ``false``. +- :ref:`bool` **resizable** + ++----------+----------------------+ +| *Setter* | set_resizable(value) | ++----------+----------------------+ +| *Getter* | get_resizable() | ++----------+----------------------+ + +If ``true`` the user can resize the window. Default value: ``false``. .. _class_WindowDialog_window_title: -- :ref:`String` **window_title** - The text displayed in the window's title bar. +- :ref:`String` **window_title** ++----------+------------------+ +| *Setter* | set_title(value) | ++----------+------------------+ +| *Getter* | get_title() | ++----------+------------------+ + +The text displayed in the window's title bar. Method Descriptions ------------------- -.. _class_WindowDialog_get_close_button: + .. _class_WindowDialog_get_close_button: - :ref:`TextureButton` **get_close_button** **(** **)** Return the close :ref:`TextureButton`. - diff --git a/classes/class_world.rst b/classes/class_world.rst index 0a9069aa6..3766495dd 100644 --- a/classes/class_world.rst +++ b/classes/class_world.rst @@ -8,6 +8,7 @@ World ===== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,21 @@ Brief Description 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` | ++---------------------------------------------------------------+---------------------------------------------------------------+ + Description ----------- @@ -24,28 +40,60 @@ Tutorials --------- - :doc:`../tutorials/physics/ray-casting` - Property Descriptions --------------------- .. _class_World_direct_space_state: -- :ref:`PhysicsDirectSpaceState` **direct_space_state** - The World's physics direct space state, used for making various queries. Might be used only during ``_physics_process``. +- :ref:`PhysicsDirectSpaceState` **direct_space_state** + ++----------+--------------------------+ +| *Getter* | get_direct_space_state() | ++----------+--------------------------+ + +The World's physics direct space state, used for making various queries. Might be used only during ``_physics_process``. .. _class_World_environment: -- :ref:`Environment` **environment** - The World's :ref:`Environment`. +- :ref:`Environment` **environment** + ++----------+------------------------+ +| *Setter* | set_environment(value) | ++----------+------------------------+ +| *Getter* | get_environment() | ++----------+------------------------+ + +The World's :ref:`Environment`. .. _class_World_fallback_environment: -- :ref:`Environment` **fallback_environment** - The World's fallback_environment will be used if the World's :ref:`Environment` fails or is missing. +- :ref:`Environment` **fallback_environment** + ++----------+---------------------------------+ +| *Setter* | set_fallback_environment(value) | ++----------+---------------------------------+ +| *Getter* | get_fallback_environment() | ++----------+---------------------------------+ + +The World's fallback_environment will be used if the World's :ref:`Environment` fails or is missing. .. _class_World_scenario: -- :ref:`RID` **scenario** - The World's visual scenario. +- :ref:`RID` **scenario** + ++----------+----------------+ +| *Getter* | get_scenario() | ++----------+----------------+ + +The World's visual scenario. .. _class_World_space: -- :ref:`RID` **space** - The World's physics space. +- :ref:`RID` **space** ++----------+-------------+ +| *Getter* | get_space() | ++----------+-------------+ + +The World's physics space. diff --git a/classes/class_world2d.rst b/classes/class_world2d.rst index e9bef234b..49d7136fb 100644 --- a/classes/class_world2d.rst +++ b/classes/class_world2d.rst @@ -8,6 +8,7 @@ World2D ======= **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,17 @@ Brief Description Class that has everything pertaining to a 2D world. +Properties +---------- + ++-------------------------------------------------------------------+-------------------------------------------------------------+ +| :ref:`RID` | :ref:`canvas` | ++-------------------------------------------------------------------+-------------------------------------------------------------+ +| :ref:`Physics2DDirectSpaceState` | :ref:`direct_space_state` | ++-------------------------------------------------------------------+-------------------------------------------------------------+ +| :ref:`RID` | :ref:`space` | ++-------------------------------------------------------------------+-------------------------------------------------------------+ + Description ----------- @@ -24,20 +36,36 @@ Tutorials --------- - :doc:`../tutorials/physics/ray-casting` - Property Descriptions --------------------- .. _class_World2D_canvas: -- :ref:`RID` **canvas** - The :ref:`RID` of this world's canvas resource. Used by the :ref:`VisualServer` for 2D drawing. +- :ref:`RID` **canvas** + ++----------+--------------+ +| *Getter* | get_canvas() | ++----------+--------------+ + +The :ref:`RID` of this world's canvas resource. Used by the :ref:`VisualServer` for 2D drawing. .. _class_World2D_direct_space_state: -- :ref:`Physics2DDirectSpaceState` **direct_space_state** - The state of this world's physics space. This allows arbitrary querying for collision. +- :ref:`Physics2DDirectSpaceState` **direct_space_state** + ++----------+--------------------------+ +| *Getter* | get_direct_space_state() | ++----------+--------------------------+ + +The state of this world's physics space. This allows arbitrary querying for collision. .. _class_World2D_space: -- :ref:`RID` **space** - The :ref:`RID` of this world's physics space resource. Used by the :ref:`Physics2DServer` for 2D physics, treating it as both a space and an area. +- :ref:`RID` **space** ++----------+-------------+ +| *Getter* | get_space() | ++----------+-------------+ + +The :ref:`RID` of this world's physics space resource. Used by the :ref:`Physics2DServer` for 2D physics, treating it as both a space and an area. diff --git a/classes/class_worldenvironment.rst b/classes/class_worldenvironment.rst index 8ddc24c5b..0004abb58 100644 --- a/classes/class_worldenvironment.rst +++ b/classes/class_worldenvironment.rst @@ -8,6 +8,7 @@ WorldEnvironment ================ **Inherits:** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Default environment properties for the entire scene (post-processing effects, lightning and background settings). +Properties +---------- + ++---------------------------------------+--------------------------------------------------------+ +| :ref:`Environment` | :ref:`environment` | ++---------------------------------------+--------------------------------------------------------+ + Description ----------- @@ -28,12 +36,18 @@ Tutorials --------- - :doc:`../tutorials/3d/environment_and_post_processing` - Property Descriptions --------------------- .. _class_WorldEnvironment_environment: -- :ref:`Environment` **environment** - The :ref:`Environment` resource used by this ``WorldEnvironment``, defining the default properties. +- :ref:`Environment` **environment** ++----------+------------------------+ +| *Setter* | set_environment(value) | ++----------+------------------------+ +| *Getter* | get_environment() | ++----------+------------------------+ + +The :ref:`Environment` resource used by this ``WorldEnvironment``, defining the default properties. diff --git a/classes/class_xmlparser.rst b/classes/class_xmlparser.rst index fe6c3355a..cf47e40b7 100644 --- a/classes/class_xmlparser.rst +++ b/classes/class_xmlparser.rst @@ -8,6 +8,7 @@ XMLParser ========= **Inherits:** :ref:`Reference` **<** :ref:`Object` + **Category:** Core Brief Description @@ -59,7 +60,7 @@ Enumerations .. _enum_XMLParser_NodeType: -enum **NodeType** +enum **NodeType**: - **NODE_NONE** = **0** --- There's no node (no file or buffer opened) - **NODE_ELEMENT** = **1** --- Element (tag) @@ -69,7 +70,6 @@ enum **NodeType** - **NODE_CDATA** = **5** --- CDATA content - **NODE_UNKNOWN** = **6** --- Unknown node - Description ----------- @@ -78,106 +78,105 @@ 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_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_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_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_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_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_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_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_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_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_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_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_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_open: - :ref:`Error` **open** **(** :ref:`String` file **)** Open a XML file for parsing. This returns an error code. -.. _class_XMLParser_open_buffer: + .. _class_XMLParser_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_read: - :ref:`Error` **read** **(** **)** Read the next node of the file. This returns an error code. -.. _class_XMLParser_seek: + .. _class_XMLParser_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_skip_section: - void **skip_section** **(** **)** Skips the current section. If the node contains other elements, they will be ignored and the cursor will go to the closing of the current element. - diff --git a/classes/class_ysort.rst b/classes/class_ysort.rst index ff09d21ab..f3211aa68 100644 --- a/classes/class_ysort.rst +++ b/classes/class_ysort.rst @@ -8,6 +8,7 @@ YSort ===== **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + **Category:** Core Brief Description @@ -15,6 +16,13 @@ Brief Description Sort all child nodes based on their Y positions. +Properties +---------- + ++-------------------------+-----------------------------------------------+ +| :ref:`bool` | :ref:`sort_enabled` | ++-------------------------+-----------------------------------------------+ + Description ----------- @@ -27,4 +35,9 @@ Property Descriptions - :ref:`bool` **sort_enabled** ++----------+-------------------------+ +| *Setter* | set_sort_enabled(value) | ++----------+-------------------------+ +| *Getter* | is_sort_enabled() | ++----------+-------------------------+