From 40cb5153bd50c5fd024a575128a4a62f30a12411 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Sat, 2 Sep 2017 17:15:33 +0200 Subject: [PATCH] classref: Sync with current master branch --- classes/class_@gdscript.rst | 346 ++++++----- classes/class_@global scope.rst | 7 +- ...ss_@native.rst => class_@nativescript.rst} | 6 +- classes/class_acceptdialog.rst | 46 +- classes/class_animation.rst | 16 +- classes/class_animationplayer.rst | 160 ++--- classes/class_area.rst | 12 +- classes/class_area2d.rst | 12 +- classes/class_arraymesh.rst | 89 +-- classes/class_arvranchor.rst | 61 ++ classes/class_arvrcamera.rst | 17 + classes/class_arvrcontroller.rst | 79 +++ classes/class_arvrinterface.rst | 100 ++++ classes/class_arvrorigin.rst | 43 ++ classes/class_arvrpositionaltracker.rst | 74 +++ classes/class_arvrscriptinterface.rst | 98 +++ classes/class_arvrserver.rst | 121 ++++ classes/class_astar.rst | 8 +- classes/class_atlastexture.rst | 5 - classes/class_audioeffectcompressor.rst | 2 +- classes/class_audioserver.rst | 8 +- classes/class_audiostreamoggvorbis.rst | 31 +- classes/class_audiostreamplayer.rst | 71 +-- classes/class_audiostreamplayer2d.rst | 87 +-- classes/class_audiostreamplayer3d.rst | 159 ++--- classes/class_audiostreamrandompitch.rst | 22 +- classes/class_basebutton.rst | 84 +-- classes/class_basis.rst | 28 +- classes/class_bitmap.rst | 4 +- classes/class_bitmapfont.rst | 66 +-- classes/class_camera.rst | 2 +- classes/class_camera2d.rst | 174 +++--- classes/class_canvasitem.rst | 274 ++++----- classes/class_canvaslayer.rst | 66 +-- classes/class_classdb.rst | 94 +-- classes/class_collisionobject.rst | 140 +++-- classes/class_collisionobject2d.rst | 88 ++- classes/class_collisionshape.rst | 32 +- classes/class_collisionshape2d.rst | 30 +- classes/class_colorpicker.rst | 4 +- classes/class_configfile.rst | 12 +- classes/class_container.rst | 2 +- classes/class_control.rst | 469 ++++++++------- classes/class_convexpolygonshape.rst | 2 +- classes/class_cubemap.rst | 46 +- classes/class_cubemesh.rst | 2 +- classes/class_curve.rst | 102 ++-- classes/class_curve2d.rst | 84 +-- classes/class_curve3d.rst | 96 +-- classes/class_directionallight.rst | 1 + classes/class_directory.rst | 28 +- classes/class_editorfilesystem.rst | 1 + classes/class_editorfilesystemdirectory.rst | 54 +- classes/class_editorinterface.rst | 122 ++++ classes/class_editorplugin.rst | 252 +++----- classes/class_editorscript.rst | 24 +- classes/class_editorsettings.rst | 2 +- classes/class_editorspatialgizmo.rst | 70 ++- classes/class_encodedobjectasid.rst | 38 ++ classes/class_engine.rst | 20 +- classes/class_environment.rst | 560 +++++++++--------- classes/class_file.rst | 12 +- classes/class_font.rst | 40 +- classes/class_gdfunctionstate.rst | 4 +- classes/class_gdnative.rst | 61 ++ classes/class_gdnativeclass.rst | 8 +- classes/class_gdnativelibrary.rst | 18 +- classes/class_gdnativescript.rst | 62 -- classes/class_geometry.rst | 20 +- classes/class_geometryinstance.rst | 87 ++- classes/class_giprobe.rst | 96 +-- classes/class_gradient.rst | 4 +- classes/class_graphedit.rst | 10 +- classes/class_graphnode.rst | 128 ++-- classes/class_gridmap.rst | 160 ++--- classes/class_httpclient.rst | 12 +- classes/class_httprequest.rst | 56 +- classes/class_image.rst | 14 +- classes/class_imagetexture.rst | 54 +- classes/class_immediategeometry.rst | 10 +- classes/class_input.rst | 148 +++-- classes/class_inputevent.rst | 60 +- classes/class_inputeventkey.rst | 2 +- classes/class_inputmap.rst | 50 +- classes/class_instanceplaceholder.rst | 4 +- classes/class_interpolatedcamera.rst | 4 +- classes/class_ip.rst | 36 +- classes/class_itemlist.rst | 37 +- classes/class_kinematicbody.rst | 90 +-- classes/class_kinematicbody2d.rst | 90 +-- classes/class_light.rst | 73 ++- classes/class_light2d.rst | 12 +- classes/class_line2d.rst | 16 +- classes/class_lineedit.rst | 4 +- classes/class_mainloop.rst | 6 +- classes/class_material.rst | 29 +- classes/class_mesh.rst | 4 +- classes/class_meshdatatool.rst | 12 +- classes/class_meshlibrary.rst | 24 +- classes/class_multimeshinstance.rst | 16 +- classes/class_mutex.rst | 16 +- classes/class_nativescript.rst | 62 ++ classes/class_navigation.rst | 48 +- classes/class_navigation2d.rst | 8 +- classes/class_navigationmesh.rst | 6 + classes/class_navigationmeshinstance.rst | 22 +- classes/class_navigationpolygon.rst | 2 +- classes/class_networkedmultiplayerenet.rst | 30 +- classes/class_ninepatchrect.rst | 62 +- classes/class_node.rst | 368 ++++++------ classes/class_node2d.rst | 164 ++--- classes/class_object.rst | 196 +++--- classes/class_optionbutton.rst | 42 +- classes/class_os.rst | 40 +- classes/class_packeddatacontainer.rst | 4 +- classes/class_packetpeer.rst | 42 +- classes/class_packetpeerstream.rst | 34 +- classes/class_packetpeerudp.rst | 34 +- classes/class_particles.rst | 2 +- classes/class_particles2d.rst | 4 +- classes/class_particlesmaterial.rst | 32 +- classes/class_physics2ddirectspacestate.rst | 34 +- classes/class_physics2dserver.rst | 72 +-- .../class_physics2dshapequeryparameters.rst | 4 +- classes/class_physicsbody.rst | 50 +- classes/class_physicsbody2d.rst | 50 +- classes/class_physicsdirectbodystate.rst | 6 +- classes/class_physicsdirectspacestate.rst | 28 +- classes/class_physicsserver.rst | 76 +-- classes/class_physicsshapequeryparameters.rst | 4 +- classes/class_polygon2d.rst | 23 +- classes/class_popup.rst | 32 +- classes/class_popupmenu.rst | 226 +++---- classes/class_portal.rst | 111 ---- classes/class_prismmesh.rst | 2 +- classes/class_proceduralsky.rst | 10 + classes/class_range.rst | 4 +- classes/class_reference.rst | 2 +- classes/class_reflectionprobe.rst | 4 +- classes/class_regex.rst | 45 +- classes/class_regexmatch.rst | 40 +- classes/class_resource.rst | 54 +- classes/class_resourceinteractiveloader.rst | 24 +- classes/class_resourceloader.rst | 30 +- classes/class_resourcepreloader.rst | 10 +- classes/class_resourcesaver.rst | 14 +- classes/class_richtextlabel.rst | 4 +- classes/class_rigidbody2d.rst | 4 +- classes/class_room.rst | 48 -- classes/class_roombounds.rst | 43 -- classes/class_scenestate.rst | 4 +- classes/class_scenetree.rst | 50 +- classes/class_script.rst | 46 +- classes/class_scripteditor.rst | 16 +- classes/class_scrollbar.rst | 5 + classes/class_semaphore.rst | 14 +- classes/class_sky.rst | 13 +- classes/class_spatial.rst | 22 +- classes/class_spatialmaterial.rst | 105 +++- classes/class_spinbox.rst | 32 +- classes/class_spriteframes.rst | 68 +-- classes/class_streampeer.rst | 2 +- classes/class_streampeerssl.rst | 22 +- classes/class_string.rst | 2 +- classes/class_styleboxflat.rst | 211 +++++-- classes/class_styleboxtexture.rst | 123 ++-- classes/class_surfacetool.rst | 104 ++-- classes/class_tabcontainer.rst | 4 +- classes/class_tabs.rst | 24 +- classes/class_tcp_server.rst | 22 +- classes/class_textedit.rst | 218 ++++--- classes/class_texture.rst | 50 +- classes/class_textureprogress.rst | 107 ++-- classes/class_texturerect.rst | 30 +- classes/class_theme.rst | 8 +- classes/class_thread.rst | 20 +- classes/class_tilemap.rst | 210 +++---- classes/class_tileset.rst | 148 ++--- classes/class_touchscreenbutton.rst | 94 +-- classes/class_transform.rst | 6 + classes/class_transform2d.rst | 4 +- classes/class_tree.rst | 165 +++--- classes/class_treeitem.rst | 244 ++++---- classes/class_tween.rst | 50 +- classes/class_undoredo.rst | 52 +- classes/class_vector2.rst | 4 + classes/class_vector3.rst | 2 +- classes/class_viewport.rst | 295 ++++----- classes/class_visualinstance.rst | 2 +- classes/class_visualscript.rst | 186 +++--- .../class_visualscriptbasictypeconstant.rst | 2 +- classes/class_visualscriptclassconstant.rst | 2 +- classes/class_visualscriptconstant.rst | 2 +- classes/class_visualscriptenginesingleton.rst | 2 +- classes/class_visualscriptfunctionstate.rst | 16 +- classes/class_visualscriptglobalconstant.rst | 2 +- classes/class_visualscriptmathconstant.rst | 2 +- classes/class_visualscriptnode.rst | 2 +- classes/class_visualscriptpreload.rst | 14 +- classes/class_visualscriptpropertyset.rst | 2 +- classes/class_visualscriptsubcall.rst | 8 +- classes/class_visualserver.rst | 46 +- classes/class_weakref.rst | 8 +- 203 files changed, 6302 insertions(+), 5188 deletions(-) rename classes/{class_@native.rst => class_@nativescript.rst} (79%) create mode 100644 classes/class_arvranchor.rst create mode 100644 classes/class_arvrcamera.rst create mode 100644 classes/class_arvrcontroller.rst create mode 100644 classes/class_arvrinterface.rst create mode 100644 classes/class_arvrorigin.rst create mode 100644 classes/class_arvrpositionaltracker.rst create mode 100644 classes/class_arvrscriptinterface.rst create mode 100644 classes/class_arvrserver.rst create mode 100644 classes/class_editorinterface.rst create mode 100644 classes/class_encodedobjectasid.rst create mode 100644 classes/class_gdnative.rst delete mode 100644 classes/class_gdnativescript.rst create mode 100644 classes/class_nativescript.rst delete mode 100644 classes/class_portal.rst delete mode 100644 classes/class_room.rst delete mode 100644 classes/class_roombounds.rst diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 5d1743dc6..0f2f81535 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -16,153 +16,159 @@ Built-in GDScript functions. Member Functions ---------------- -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color8` **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8 **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`ColorN` **(** :ref:`String` name, :ref:`float` alpha **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`abs` **(** :ref:`float` s **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`acos` **(** :ref:`float` s **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`asin` **(** :ref:`float` s **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Nil` | :ref:`assert` **(** :ref:`bool` condition **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`atan` **(** :ref:`float` s **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`atan2` **(** :ref:`float` x, :ref:`float` y **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`bytes2var` **(** :ref:`PoolByteArray` bytes **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ceil` **(** :ref:`float` s **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`char` **(** :ref:`int` ascii **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`clamp` **(** :ref:`float` val, :ref:`float` min, :ref:`float` max **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`convert` **(** :ref:`Variant` what, :ref:`int` type **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`cos` **(** :ref:`float` s **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`cosh` **(** :ref:`float` s **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`db2linear` **(** :ref:`float` db **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`decimals` **(** :ref:`float` step **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dectime` **(** :ref:`float` value, :ref:`float` amount, :ref:`float` step **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`deg2rad` **(** :ref:`float` deg **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`dict2inst` **(** :ref:`Dictionary` dict **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ease` **(** :ref:`float` s, :ref:`float` curve **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`exp` **(** :ref:`float` s **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`floor` **(** :ref:`float` s **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fmod` **(** :ref:`float` x, :ref:`float` y **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fposmod` **(** :ref:`float` x, :ref:`float` y **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`FuncRef` | :ref:`funcref` **(** :ref:`Object` instance, :ref:`String` funcname **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hash` **(** :ref:`Variant` var:Variant **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`inst2dict` **(** :ref:`Object` inst **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`instance_from_id` **(** :ref:`int` instance_id **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`is_inf` **(** :ref:`float` s **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`is_nan` **(** :ref:`float` s **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`lerp` **(** :ref:`float` from, :ref:`float` to, :ref:`float` weight **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`linear2db` **(** :ref:`float` nrg **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`load` **(** :ref:`String` path **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`log` **(** :ref:`float` s **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`max` **(** :ref:`float` a, :ref:`float` b **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`min` **(** :ref:`float` a, :ref:`float` b **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`nearest_po2` **(** :ref:`int` val **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`parse_json` **(** :ref:`String` json **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`pow` **(** :ref:`float` x, :ref:`float` y **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`preload` **(** :ref:`String` path **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Nil` | :ref:`print` **(** :ref:`Variant` what, :ref:`Variant` ... **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Nil` | :ref:`print_stack` **(** **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Nil` | :ref:`printerr` **(** :ref:`Variant` what, :ref:`Variant` ... **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Nil` | :ref:`printraw` **(** :ref:`Variant` what, :ref:`Variant` ... **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Nil` | :ref:`prints` **(** :ref:`Variant` what, :ref:`Variant` ... **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Nil` | :ref:`printt` **(** :ref:`Variant` what, :ref:`Variant` ... **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rad2deg` **(** :ref:`float` rad **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rand_range` **(** :ref:`float` from, :ref:`float` to **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`rand_seed` **(** :ref:`int` seed **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`randf` **(** **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`randi` **(** **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Nil` | :ref:`randomize` **(** **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`range` **(** :ref:`Variant` ... **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`round` **(** :ref:`float` s **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Nil` | :ref:`seed` **(** :ref:`int` seed **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`sign` **(** :ref:`float` s **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`sin` **(** :ref:`float` s **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`sinh` **(** :ref:`float` s **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`sqrt` **(** :ref:`float` s **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`stepify` **(** :ref:`float` s, :ref:`float` step **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`str` **(** :ref:`Variant` what, :ref:`Variant` ... **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`str2var` **(** :ref:`String` string **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tan` **(** :ref:`float` s **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tanh` **(** :ref:`float` s **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`to_json` **(** :ref:`Variant` var:Variant **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`type_exists` **(** :ref:`String` type **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`typeof` **(** :ref:`Variant` what **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`validate_json` **(** :ref:`String` json **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`var2bytes` **(** :ref:`Variant` var **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`var2str` **(** :ref:`Variant` var **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`WeakRef` | :ref:`weakref` **(** :ref:`Object` obj **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`GDFunctionState` | :ref:`yield` **(** :ref:`Object` object, :ref:`String` signal **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`Color8` **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8 **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`ColorN` **(** :ref:`String` name, :ref:`float` alpha **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`abs` **(** :ref:`float` s **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`acos` **(** :ref:`float` s **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`asin` **(** :ref:`float` s **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`assert` **(** :ref:`bool` condition **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`atan` **(** :ref:`float` s **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`atan2` **(** :ref:`float` x, :ref:`float` y **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`bytes2var` **(** :ref:`PoolByteArray` bytes **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ceil` **(** :ref:`float` s **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`char` **(** :ref:`int` ascii **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`clamp` **(** :ref:`float` val, :ref:`float` min, :ref:`float` max **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`convert` **(** :ref:`Variant` what, :ref:`int` type **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`cos` **(** :ref:`float` s **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`cosh` **(** :ref:`float` s **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`db2linear` **(** :ref:`float` db **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`decimals` **(** :ref:`float` step **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`dectime` **(** :ref:`float` value, :ref:`float` amount, :ref:`float` step **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`deg2rad` **(** :ref:`float` deg **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`dict2inst` **(** :ref:`Dictionary` dict **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ease` **(** :ref:`float` s, :ref:`float` curve **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`exp` **(** :ref:`float` s **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`floor` **(** :ref:`float` s **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`fmod` **(** :ref:`float` x, :ref:`float` y **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`fposmod` **(** :ref:`float` x, :ref:`float` y **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`funcref` **(** :ref:`Object` instance, :ref:`String` funcname **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`hash` **(** :ref:`Variant` var **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`inst2dict` **(** :ref:`Object` inst **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`instance_from_id` **(** :ref:`int` instance_id **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`inverse_lerp` **(** :ref:`float` from, :ref:`float` to, :ref:`float` value **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`is_inf` **(** :ref:`float` s **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`is_nan` **(** :ref:`float` s **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`len` **(** :ref:`Variant` var **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`lerp` **(** :ref:`float` from, :ref:`float` to, :ref:`float` weight **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`linear2db` **(** :ref:`float` nrg **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`load` **(** :ref:`String` path **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`log` **(** :ref:`float` s **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`max` **(** :ref:`float` a, :ref:`float` b **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`min` **(** :ref:`float` a, :ref:`float` b **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`nearest_po2` **(** :ref:`int` val **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`parse_json` **(** :ref:`String` json **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`pow` **(** :ref:`float` x, :ref:`float` y **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`preload` **(** :ref:`String` path **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print` **(** **)** vararg | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_stack` **(** **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`printerr` **(** **)** vararg | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`printraw` **(** **)** vararg | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`prints` **(** **)** vararg | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`printt` **(** **)** vararg | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rad2deg` **(** :ref:`float` rad **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rand_range` **(** :ref:`float` from, :ref:`float` to **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`rand_seed` **(** :ref:`int` seed **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`randf` **(** **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`randi` **(** **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`randomize` **(** **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`range` **(** **)** vararg | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`range_lerp` **(** :ref:`float` value, :ref:`float` istart, :ref:`float` istop, :ref:`float` ostart, :ref:`float` ostop **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`round` **(** :ref:`float` s **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seed` **(** :ref:`int` seed **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`sign` **(** :ref:`float` s **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`sin` **(** :ref:`float` s **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`sinh` **(** :ref:`float` s **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`sqrt` **(** :ref:`float` s **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`stepify` **(** :ref:`float` s, :ref:`float` step **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`str` **(** **)** vararg | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`str2var` **(** :ref:`String` string **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tan` **(** :ref:`float` s **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tanh` **(** :ref:`float` s **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`to_json` **(** :ref:`Variant` var **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`type_exists` **(** :ref:`String` type **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`typeof` **(** :ref:`Variant` what **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`validate_json` **(** :ref:`String` json **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`var2bytes` **(** :ref:`Variant` var **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`var2str` **(** :ref:`Variant` var **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`weakref` **(** :ref:`Object` obj **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`GDFunctionState` | :ref:`yield` **(** :ref:`Object` object, :ref:`String` signal **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -211,7 +217,7 @@ Returns the principal value of the arc sine of s, expressed in radians. In trigo .. _class_@GDScript_assert: -- :ref:`Nil` **assert** **(** :ref:`bool` condition **)** +- void **assert** **(** :ref:`bool` condition **)** Assert that the condition is true. If the condition is false, generates an error. @@ -335,13 +341,13 @@ Module (remainder of x/y) that wraps equally in positive and negative. .. _class_@GDScript_funcref: -- :ref:`FuncRef` **funcref** **(** :ref:`Object` instance, :ref:`String` funcname **)** +- :ref:`Object` **funcref** **(** :ref:`Object` instance, :ref:`String` funcname **)** Return a reference to the specified function. .. _class_@GDScript_hash: -- :ref:`int` **hash** **(** :ref:`Variant` var:Variant **)** +- :ref:`int` **hash** **(** :ref:`Variant` var **)** Hash the variable passed and return an integer. @@ -357,6 +363,10 @@ Convert a script class instance to a dictionary (useful for serializing). Get an object by its ID. +.. _class_@GDScript_inverse_lerp: + +- :ref:`float` **inverse_lerp** **(** :ref:`float` from, :ref:`float` to, :ref:`float` value **)** + .. _class_@GDScript_is_inf: - :ref:`float` **is_inf** **(** :ref:`float` s **)** @@ -369,6 +379,10 @@ Returns whether s is an infinity value (either positive infinity or negative inf Returns whether s is a NaN (Not-A-Number) value. +.. _class_@GDScript_len: + +- :ref:`int` **len** **(** :ref:`Variant` var **)** + .. _class_@GDScript_lerp: - :ref:`float` **lerp** **(** :ref:`float` from, :ref:`float` to, :ref:`float` weight **)** @@ -383,7 +397,7 @@ Convert from linear energy to decibels (audio). .. _class_@GDScript_load: -- :ref:`Resource` **load** **(** :ref:`String` path **)** +- :ref:`Object` **load** **(** :ref:`String` path **)** Load a resource from the filesystem, pass a valid path as argument. @@ -433,37 +447,37 @@ Preload a resource from the filesystem. The resource is loaded during script par .. _class_@GDScript_print: -- :ref:`Nil` **print** **(** :ref:`Variant` what, :ref:`Variant` ... **)** +- void **print** **(** **)** vararg Print one or more arguments to strings in the best way possible to a console line. .. _class_@GDScript_print_stack: -- :ref:`Nil` **print_stack** **(** **)** +- void **print_stack** **(** **)** Print a stack track at code location, only works when running with debugger turned on. .. _class_@GDScript_printerr: -- :ref:`Nil` **printerr** **(** :ref:`Variant` what, :ref:`Variant` ... **)** +- void **printerr** **(** **)** vararg Print one or more arguments to strings in the best way possible to standard error line. .. _class_@GDScript_printraw: -- :ref:`Nil` **printraw** **(** :ref:`Variant` what, :ref:`Variant` ... **)** +- void **printraw** **(** **)** vararg Print one or more arguments to strings in the best way possible to console. No newline is added at the end. .. _class_@GDScript_prints: -- :ref:`Nil` **prints** **(** :ref:`Variant` what, :ref:`Variant` ... **)** +- void **prints** **(** **)** vararg Print one or more arguments to the console with a space between each argument. .. _class_@GDScript_printt: -- :ref:`Nil` **printt** **(** :ref:`Variant` what, :ref:`Variant` ... **)** +- void **printt** **(** **)** vararg Print one or more arguments to the console with a tab between each argument. @@ -499,16 +513,20 @@ Return a random 32 bits integer value. To obtain a random value between 0 to N ( .. _class_@GDScript_randomize: -- :ref:`Nil` **randomize** **(** **)** +- void **randomize** **(** **)** Randomize the seed (or the internal state) of the random number generator. Current implementation reseeds using a number based on time. .. _class_@GDScript_range: -- :ref:`Array` **range** **(** :ref:`Variant` ... **)** +- :ref:`Array` **range** **(** **)** vararg Return an array with the given range. Range can be 1 argument N (0 to N-1), two arguments (initial, final-1) or three arguments (initial, final-1, increment). +.. _class_@GDScript_range_lerp: + +- :ref:`float` **range_lerp** **(** :ref:`float` value, :ref:`float` istart, :ref:`float` istop, :ref:`float` ostart, :ref:`float` ostop **)** + .. _class_@GDScript_round: - :ref:`float` **round** **(** :ref:`float` s **)** @@ -517,7 +535,7 @@ Returns the integral value that is nearest to s, with halfway cases rounded away .. _class_@GDScript_seed: -- :ref:`Nil` **seed** **(** :ref:`int` seed **)** +- void **seed** **(** :ref:`int` seed **)** Set seed for the random number generator. @@ -553,7 +571,7 @@ Snap float value to a given step. .. _class_@GDScript_str: -- :ref:`String` **str** **(** :ref:`Variant` what, :ref:`Variant` ... **)** +- :ref:`String` **str** **(** **)** vararg Convert one or more arguments to string in the best way possible. @@ -577,7 +595,7 @@ Returns the hyperbolic tangent of s. .. _class_@GDScript_to_json: -- :ref:`String` **to_json** **(** :ref:`Variant` var:Variant **)** +- :ref:`String` **to_json** **(** :ref:`Variant` var **)** Convert a Variant to json text. @@ -593,7 +611,7 @@ Return the internal type of the given Variant object, using the TYPE\_\* enum in .. _class_@GDScript_validate_json: -- :ref:`Variant` **validate_json** **(** :ref:`String` json **)** +- :ref:`String` **validate_json** **(** :ref:`String` json **)** This method is used to validate the structure and data types of a piece of JSON, similar to XML Schema for XML. @@ -611,7 +629,7 @@ Convert a value to a formatted string that can later be parsed using :ref:`str2v .. _class_@GDScript_weakref: -- :ref:`WeakRef` **weakref** **(** :ref:`Object` obj **)** +- :ref:`Object` **weakref** **(** :ref:`Object` obj **)** Return a weak reference to an object. diff --git a/classes/class_@global scope.rst b/classes/class_@global scope.rst index 269b2a02c..34b4cd378 100644 --- a/classes/class_@global scope.rst +++ b/classes/class_@global scope.rst @@ -16,11 +16,11 @@ Global scope constants and variables. Member Variables ---------------- +- :ref:`ARVRServer` **ARVRServer** - :ref:`AudioServer` **AudioServer** - [AudioServer] singleton - :ref:`ClassDB` **ClassDB** - [ClassDB] singleton - :ref:`Engine` **Engine** - [Engine] singleton - :ref:`Geometry` **Geometry** - [Geometry] singleton -- :ref:`ProjectSettings` **ProjectSettings** - [ProjectSettings] singleton - :ref:`IP` **IP** - [IP] singleton - :ref:`Input` **Input** - [Input] singleton - :ref:`InputMap` **InputMap** - [InputMap] singleton @@ -29,6 +29,7 @@ Member Variables - :ref:`Performance` **Performance** - [Performance] singleton - :ref:`Physics2DServer` **Physics2DServer** - [Physics2DServer] singleton - :ref:`PhysicsServer` **PhysicsServer** - [PhysicsServer] singleton +- :ref:`ProjectSettings` **ProjectSettings** - [ProjectSettings] singleton - :ref:`ResourceLoader` **ResourceLoader** - [ResourceLoader] singleton - :ref:`ResourceSaver` **ResourceSaver** - [ResourceSaver] singleton - :ref:`TranslationServer` **TranslationServer** - [TranslationServer] singleton @@ -54,8 +55,8 @@ Numeric Constants - **KEY_TAB** = **16777218** --- Tab Key - **KEY_BACKTAB** = **16777219** --- Shift-Tab Key - **KEY_BACKSPACE** = **16777220** --- Backspace Key -- **KEY_RETURN** = **16777221** --- Return Key (On Main Keyboard) -- **KEY_ENTER** = **16777222** --- Enter Key (On Numpad) +- **KEY_ENTER** = **16777221** --- Return Key (On Main Keyboard) +- **KEY_KP_ENTER** = **16777222** --- Enter Key (On Numpad) - **KEY_INSERT** = **16777223** --- Insert Key - **KEY_DELETE** = **16777224** --- Delete Key - **KEY_PAUSE** = **16777225** --- Pause Key diff --git a/classes/class_@native.rst b/classes/class_@nativescript.rst similarity index 79% rename from classes/class_@native.rst rename to classes/class_@nativescript.rst index 172e3b12b..fbc5cfc28 100644 --- a/classes/class_@native.rst +++ b/classes/class_@nativescript.rst @@ -1,10 +1,10 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. -.. _class_@Native: +.. _class_@NativeScript: -@Native -======= +@NativeScript +============= **Category:** Core diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index e8f31b207..14afd27d1 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -20,25 +20,25 @@ Base dialog for user notification. Member Functions ---------------- -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Button` | :ref:`add_button` **(** :ref:`String` text, :ref:`bool` right=false, :ref:`String` action="" **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Button` | :ref:`add_cancel` **(** :ref:`String` name **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_hide_on_ok` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_label` **(** **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_ok` **(** **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_text` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`LineEdit` | :ref:`register_text_enter` **(** :ref:`Object` line_edit **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hide_on_ok` **(** :ref:`bool` enabled **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text` **(** :ref:`String` text **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Button` | :ref:`add_button` **(** :ref:`String` text, :ref:`bool` right=false, :ref:`String` action=null **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Button` | :ref:`add_cancel` **(** :ref:`String` name **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_hide_on_ok` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Label` | :ref:`get_label` **(** **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Button` | :ref:`get_ok` **(** **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_text` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`register_text_enter` **(** :ref:`Node` line_edit **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hide_on_ok` **(** :ref:`bool` enabled **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_text` **(** :ref:`String` text **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -66,7 +66,7 @@ Member Function Description .. _class_AcceptDialog_add_button: -- :ref:`Button` **add_button** **(** :ref:`String` text, :ref:`bool` right=false, :ref:`String` action="" **)** +- :ref:`Button` **add_button** **(** :ref:`String` text, :ref:`bool` right=false, :ref:`String` action=null **)** Add custom button to the dialog and return the created button. @@ -86,13 +86,13 @@ Return true if the dialog will be hidden when accepted (default true). .. _class_AcceptDialog_get_label: -- :ref:`Object` **get_label** **(** **)** +- :ref:`Label` **get_label** **(** **)** Return the label used for built-in text. .. _class_AcceptDialog_get_ok: -- :ref:`Object` **get_ok** **(** **)** +- :ref:`Button` **get_ok** **(** **)** Return the OK Button. @@ -104,7 +104,7 @@ Return the built-in label text. .. _class_AcceptDialog_register_text_enter: -- :ref:`LineEdit` **register_text_enter** **(** :ref:`Object` line_edit **)** +- void **register_text_enter** **(** :ref:`Node` line_edit **)** Register a :ref:`LineEdit` in the dialog. When the enter key is pressed, the dialog will be accepted. diff --git a/classes/class_animation.rst b/classes/class_animation.rst index 2de586966..93046e224 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -19,7 +19,7 @@ Member Functions ---------------- +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`add_track` **(** :ref:`int` type, :ref:`int` at_pos=-1 **)** | +| :ref:`int` | :ref:`add_track` **(** :ref:`int` type, :ref:`int` at_pos=null **)** | +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -47,7 +47,7 @@ Member Functions +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_step` **(** :ref:`float` size_sec **)** | +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`track_find_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`bool` exact=false **)** const | +| :ref:`int` | :ref:`track_find_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`bool` exact=null **)** const | +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`track_get_interpolation_loop_wrap` **(** :ref:`int` idx **)** const | +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -59,13 +59,13 @@ Member Functions +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`track_get_key_transition` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_get_key_value` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | +| :ref:`Variant` | :ref:`track_get_key_value` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`NodePath` | :ref:`track_get_path` **(** :ref:`int` idx **)** const | +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`track_get_type` **(** :ref:`int` idx **)** const | +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=1 **)** | +| void | :ref:`track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=null **)** | +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`track_is_imported` **(** :ref:`int` idx **)** const | +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -125,7 +125,7 @@ Member Function Description .. _class_Animation_add_track: -- :ref:`int` **add_track** **(** :ref:`int` type, :ref:`int` at_pos=-1 **)** +- :ref:`int` **add_track** **(** :ref:`int` type, :ref:`int` at_pos=null **)** Add a track to the Animation. The track type must be specified as any of the values in the TYPE\_\* enumeration. @@ -209,7 +209,7 @@ Set the animation step value. .. _class_Animation_track_find_key: -- :ref:`int` **track_find_key** **(** :ref:`int` idx, :ref:`float` time, :ref:`bool` exact=false **)** const +- :ref:`int` **track_find_key** **(** :ref:`int` idx, :ref:`float` time, :ref:`bool` exact=null **)** const Find the key index by time in a given track. Optionally, only find it if the exact time is given. @@ -243,7 +243,7 @@ Return the transition curve (easing) for a specific key (see built-in math funct .. _class_Animation_track_get_key_value: -- void **track_get_key_value** **(** :ref:`int` idx, :ref:`int` key_idx **)** const +- :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. @@ -261,7 +261,7 @@ Get the type of a track. .. _class_Animation_track_insert_key: -- void **track_insert_key** **(** :ref:`int` idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=1 **)** +- void **track_insert_key** **(** :ref:`int` idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=null **)** Insert a generic key in a given track. diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index c42b896ea..b95be41a5 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -18,83 +18,83 @@ Container and player of :ref:`Animation` resources. Member Functions ---------------- -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`add_animation` **(** :ref:`String` name, :ref:`Animation` animation **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`advance` **(** :ref:`float` delta **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`animation_get_next` **(** :ref:`String` anim_from **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`animation_set_next` **(** :ref:`String` anim_from, :ref:`String` anim_to **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_caches` **(** **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_queue` **(** **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`find_animation` **(** :ref:`Animation` animation **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Animation` | :ref:`get_animation` **(** :ref:`String` name **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_animation_list` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_animation_process_mode` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_autoplay` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_blend_time` **(** :ref:`String` anim_from, :ref:`String` anim_to **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_animation` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_current_animation_length` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_current_animation_pos` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_default_blend_time` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pos` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_root` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_speed_scale` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` name **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_active` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`String` name="", :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1, :ref:`bool` from_end=false **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play_backwards` **(** :ref:`String` name="", :ref:`float` custom_blend=-1 **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue` **(** :ref:`String` name **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_animation` **(** :ref:`String` name **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_animation` **(** :ref:`String` name, :ref:`String` newname **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`float` pos_sec, :ref:`bool` update=false **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_active` **(** :ref:`bool` active **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_animation_process_mode` **(** :ref:`int` mode **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_autoplay` **(** :ref:`String` name **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blend_time` **(** :ref:`String` anim_from, :ref:`String` anim_to, :ref:`float` sec **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_animation` **(** :ref:`String` anim **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_blend_time` **(** :ref:`float` sec **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_root` **(** :ref:`NodePath` path **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_speed_scale` **(** :ref:`float` speed **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** :ref:`bool` reset=true **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop_all` **(** **)** | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`add_animation` **(** :ref:`String` name, :ref:`Animation` animation **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`advance` **(** :ref:`float` delta **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`animation_get_next` **(** :ref:`String` anim_from **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`animation_set_next` **(** :ref:`String` anim_from, :ref:`String` anim_to **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_caches` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_queue` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`find_animation` **(** :ref:`Animation` animation **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Animation` | :ref:`get_animation` **(** :ref:`String` name **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_animation_list` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_animation_process_mode` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_autoplay` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_blend_time` **(** :ref:`String` anim_from, :ref:`String` anim_to **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_animation` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_current_animation_length` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_current_animation_pos` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_default_blend_time` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_pos` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_root` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_speed_scale` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` name **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_active` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`String` name=false, :ref:`float` custom_blend=1.0, :ref:`float` custom_speed=-1, :ref:`bool` from_end="" **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play_backwards` **(** :ref:`String` name=-1, :ref:`float` custom_blend="" **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue` **(** :ref:`String` name **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_animation` **(** :ref:`String` name **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_animation` **(** :ref:`String` name, :ref:`String` newname **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`float` pos_sec, :ref:`bool` update=null **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_active` **(** :ref:`bool` active **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_animation_process_mode` **(** :ref:`int` mode **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_autoplay` **(** :ref:`String` name **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blend_time` **(** :ref:`String` anim_from, :ref:`String` anim_to, :ref:`float` sec **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_current_animation` **(** :ref:`String` anim **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_blend_time` **(** :ref:`float` sec **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_root` **(** :ref:`NodePath` path **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_speed_scale` **(** :ref:`float` speed **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** :ref:`bool` reset=true **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop_all` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -260,13 +260,13 @@ Return whether an animation is playing. .. _class_AnimationPlayer_play: -- void **play** **(** :ref:`String` name="", :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1, :ref:`bool` from_end=false **)** +- void **play** **(** :ref:`String` name=false, :ref:`float` custom_blend=1.0, :ref:`float` custom_speed=-1, :ref:`bool` from_end="" **)** Play a given animation by the animation 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: -- void **play_backwards** **(** :ref:`String` name="", :ref:`float` custom_blend=-1 **)** +- void **play_backwards** **(** :ref:`String` name=-1, :ref:`float` custom_blend="" **)** Play a given animation by the animation name in reverse. @@ -290,7 +290,7 @@ Rename an existing animation. .. _class_AnimationPlayer_seek: -- void **seek** **(** :ref:`float` pos_sec, :ref:`bool` update=false **)** +- void **seek** **(** :ref:`float` pos_sec, :ref:`bool` update=null **)** Seek the animation to a given position in time (in seconds). If 'update' is true, the animation will be updated too, otherwise it will be updated at process time. diff --git a/classes/class_area.rst b/classes/class_area.rst index 68634bb0b..7cec9827d 100644 --- a/classes/class_area.rst +++ b/classes/class_area.rst @@ -63,9 +63,9 @@ Member Functions +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_using_reverb_bus` **(** **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Object` area **)** const | +| :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Node` area **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Object` body **)** const | +| :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Node` body **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_angular_damp` **(** :ref:`float` angular_damp **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ @@ -151,7 +151,7 @@ Member Variables - :ref:`float` **linear_damp** - :ref:`bool` **monitorable** - :ref:`bool` **monitoring** -- :ref:`int` **priority** +- :ref:`float` **priority** - :ref:`float` **reverb_bus_amount** - :ref:`bool` **reverb_bus_enable** - :ref:`String` **reverb_bus_name** @@ -288,13 +288,13 @@ Return whether this area detects bodies/areas entering/exiting it. .. _class_Area_overlaps_area: -- :ref:`bool` **overlaps_area** **(** :ref:`Object` area **)** const +- :ref:`bool` **overlaps_area** **(** :ref:`Node` area **)** const Return whether the area passed is totally or partially inside this area. .. _class_Area_overlaps_body: -- :ref:`bool` **overlaps_body** **(** :ref:`Object` body **)** const +- :ref:`bool` **overlaps_body** **(** :ref:`Node` body **)** const Return whether the body passed is totally or partially inside this area. @@ -394,7 +394,7 @@ Set whether this area can detect bodies/areas entering/exiting it. - void **set_priority** **(** :ref:`float` priority **)** -Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have an space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent. +Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have a space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent. Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important. diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index 079234e2c..9386cba9d 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -55,9 +55,9 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_overriding_audio_bus` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Object` area **)** const | +| :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Node` area **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Object` body **)** const | +| :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Node` body **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_angular_damp` **(** :ref:`float` angular_damp **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ @@ -135,7 +135,7 @@ Member Variables - :ref:`float` **linear_damp** - :ref:`bool` **monitorable** - :ref:`bool` **monitoring** -- :ref:`int` **priority** +- :ref:`float` **priority** - :ref:`int` **space_override** Description @@ -252,13 +252,13 @@ Return whether this area detects bodies/areas entering/exiting it. .. _class_Area2D_overlaps_area: -- :ref:`bool` **overlaps_area** **(** :ref:`Object` area **)** const +- :ref:`bool` **overlaps_area** **(** :ref:`Node` area **)** const Return whether the area passed is totally or partially inside this area. .. _class_Area2D_overlaps_body: -- :ref:`bool` **overlaps_body** **(** :ref:`Object` body **)** const +- :ref:`bool` **overlaps_body** **(** :ref:`Node` body **)** const Return whether the body passed is totally or partially inside this area. @@ -358,7 +358,7 @@ Set whether this area can detect bodies/areas entering/exiting it. - void **set_priority** **(** :ref:`float` priority **)** -Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have an space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent. +Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have a space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent. Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important. diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index a44b69caa..ee6cf7ae0 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -18,49 +18,49 @@ Brief Description Member Functions ---------------- -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_blend_shape` **(** :ref:`String` name **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_surface_from_arrays` **(** :ref:`int` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[], :ref:`int` compress_flags=97792 **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`center_geometry` **(** **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_blend_shapes` **(** **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_blend_shape_count` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_blend_shape_mode` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_blend_shape_name` **(** :ref:`int` index **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`get_custom_aabb` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_surface_count` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`regen_normalmaps` **(** **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blend_shape_mode` **(** :ref:`int` mode **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_aabb` **(** :ref:`Rect3` aabb **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_array_index_len` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_array_len` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_format` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`surface_get_material` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`surface_get_name` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_primitive_type` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_remove` **(** :ref:`int` surf_idx **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_set_material` **(** :ref:`int` surf_idx, :ref:`Material` material **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_set_name` **(** :ref:`int` surf_idx, :ref:`String` name **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_blend_shape` **(** :ref:`String` name **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_surface_from_arrays` **(** :ref:`int` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=null, :ref:`int` compress_flags=null **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`center_geometry` **(** **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_blend_shapes` **(** **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_blend_shape_count` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_blend_shape_mode` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_blend_shape_name` **(** :ref:`int` index **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`get_custom_aabb` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_surface_count` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`regen_normalmaps` **(** **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blend_shape_mode` **(** :ref:`int` mode **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_aabb` **(** :ref:`Rect3` aabb **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_array_index_len` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_array_len` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_format` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`surface_get_material` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`surface_get_name` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_primitive_type` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_remove` **(** :ref:`int` surf_idx **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_set_material` **(** :ref:`int` surf_idx, :ref:`Material` material **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_set_name` **(** :ref:`int` surf_idx, :ref:`String` name **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -76,6 +76,7 @@ Numeric Constants - **ARRAY_BONES** = **6** --- Array of bone indices, as a float array. Each element in groups of 4 floats. - **ARRAY_WEIGHTS** = **7** --- Array of bone weights, as a float array. Each element in groups of 4 floats. - **ARRAY_INDEX** = **8** --- Array of integers, used as indices referencing vertices. No index can be beyond the vertex array size. +- **ARRAY_MAX** = **9** - **ARRAY_FORMAT_VERTEX** = **1** --- Array format will include vertices (mandatory). - **ARRAY_FORMAT_NORMAL** = **2** --- Array format will include normals - **ARRAY_FORMAT_TANGENT** = **4** --- Array format will include tangents @@ -95,7 +96,7 @@ Member Function Description .. _class_ArrayMesh_add_surface_from_arrays: -- void **add_surface_from_arrays** **(** :ref:`int` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[], :ref:`int` compress_flags=97792 **)** +- void **add_surface_from_arrays** **(** :ref:`int` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=null, :ref:`int` compress_flags=null **)** Create a new surface (:ref:`get_surface_count` that will become surf_idx for this. diff --git a/classes/class_arvranchor.rst b/classes/class_arvranchor.rst new file mode 100644 index 000000000..5d6f81c2b --- /dev/null +++ b/classes/class_arvranchor.rst @@ -0,0 +1,61 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. + +.. _class_ARVRAnchor: + +ARVRAnchor +========== + +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_anchor_id` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_anchor_name` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_is_active` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_size` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------+ +| void | :ref:`set_anchor_id` **(** :ref:`int` anchor_id **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`int` **anchor_id** + +Member Function Description +--------------------------- + +.. _class_ARVRAnchor_get_anchor_id: + +- :ref:`int` **get_anchor_id** **(** **)** const + +.. _class_ARVRAnchor_get_anchor_name: + +- :ref:`String` **get_anchor_name** **(** **)** const + +.. _class_ARVRAnchor_get_is_active: + +- :ref:`bool` **get_is_active** **(** **)** const + +.. _class_ARVRAnchor_get_size: + +- :ref:`Vector3` **get_size** **(** **)** const + +.. _class_ARVRAnchor_set_anchor_id: + +- void **set_anchor_id** **(** :ref:`int` anchor_id **)** + + diff --git a/classes/class_arvrcamera.rst b/classes/class_arvrcamera.rst new file mode 100644 index 000000000..68dd9a730 --- /dev/null +++ b/classes/class_arvrcamera.rst @@ -0,0 +1,17 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. + +.. _class_ARVRCamera: + +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 new file mode 100644 index 000000000..c2c5cde21 --- /dev/null +++ b/classes/class_arvrcontroller.rst @@ -0,0 +1,79 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. + +.. _class_ARVRController: + +ARVRController +============== + +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_controller_id` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_controller_name` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_is_active` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_joystick_axis` **(** :ref:`int` axis **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_joystick_id` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`is_button_pressed` **(** :ref:`int` button **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_controller_id` **(** :ref:`int` controller_id **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ + +Signals +------- + +- **button_pressed** **(** :ref:`int` button **)** +- **button_release** **(** :ref:`int` button **)** + +Member Variables +---------------- + +- :ref:`int` **controller_id** + +Member Function Description +--------------------------- + +.. _class_ARVRController_get_controller_id: + +- :ref:`int` **get_controller_id** **(** **)** const + +.. _class_ARVRController_get_controller_name: + +- :ref:`String` **get_controller_name** **(** **)** const + +.. _class_ARVRController_get_is_active: + +- :ref:`bool` **get_is_active** **(** **)** const + +.. _class_ARVRController_get_joystick_axis: + +- :ref:`float` **get_joystick_axis** **(** :ref:`int` axis **)** const + +.. _class_ARVRController_get_joystick_id: + +- :ref:`int` **get_joystick_id** **(** **)** const + +.. _class_ARVRController_is_button_pressed: + +- :ref:`int` **is_button_pressed** **(** :ref:`int` button **)** const + +.. _class_ARVRController_set_controller_id: + +- void **set_controller_id** **(** :ref:`int` controller_id **)** + + diff --git a/classes/class_arvrinterface.rst b/classes/class_arvrinterface.rst new file mode 100644 index 000000000..8f23bff70 --- /dev/null +++ b/classes/class_arvrinterface.rst @@ -0,0 +1,100 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. + +.. _class_ARVRInterface: + +ARVRInterface +============= + +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`ARVRScriptInterface` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_recommended_render_targetsize` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`hmd_is_present` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`initialize` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_initialized` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_installed` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_primary` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_is_primary` **(** :ref:`bool` enable **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`supports_hmd` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`uninitialize` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`bool` **primary** + +Numeric Constants +----------------- + +- **EYE_MONO** = **0** +- **EYE_LEFT** = **1** +- **EYE_RIGHT** = **2** + +Member Function Description +--------------------------- + +.. _class_ARVRInterface_get_name: + +- :ref:`String` **get_name** **(** **)** const + +.. _class_ARVRInterface_get_recommended_render_targetsize: + +- :ref:`Vector2` **get_recommended_render_targetsize** **(** **)** + +.. _class_ARVRInterface_hmd_is_present: + +- :ref:`bool` **hmd_is_present** **(** **)** + +.. _class_ARVRInterface_initialize: + +- :ref:`bool` **initialize** **(** **)** + +.. _class_ARVRInterface_is_initialized: + +- :ref:`bool` **is_initialized** **(** **)** + +.. _class_ARVRInterface_is_installed: + +- :ref:`bool` **is_installed** **(** **)** + +.. _class_ARVRInterface_is_primary: + +- :ref:`bool` **is_primary** **(** **)** + +.. _class_ARVRInterface_set_is_primary: + +- void **set_is_primary** **(** :ref:`bool` enable **)** + +.. _class_ARVRInterface_supports_hmd: + +- :ref:`bool` **supports_hmd** **(** **)** + +.. _class_ARVRInterface_uninitialize: + +- void **uninitialize** **(** **)** + + diff --git a/classes/class_arvrorigin.rst b/classes/class_arvrorigin.rst new file mode 100644 index 000000000..a3d6a5290 --- /dev/null +++ b/classes/class_arvrorigin.rst @@ -0,0 +1,43 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. + +.. _class_ARVROrigin: + +ARVROrigin +========== + +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_world_scale` **(** **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_world_scale` **(** :ref:`float` world_scale **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **world_scale** + +Member Function Description +--------------------------- + +.. _class_ARVROrigin_get_world_scale: + +- :ref:`float` **get_world_scale** **(** **)** const + +.. _class_ARVROrigin_set_world_scale: + +- void **set_world_scale** **(** :ref:`float` world_scale **)** + + diff --git a/classes/class_arvrpositionaltracker.rst b/classes/class_arvrpositionaltracker.rst new file mode 100644 index 000000000..372067911 --- /dev/null +++ b/classes/class_arvrpositionaltracker.rst @@ -0,0 +1,74 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. + +.. _class_ARVRPositionalTracker: + +ARVRPositionalTracker +===================== + +**Inherits:** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_joy_id` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`get_orientation` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_position` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_tracks_orientation` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_tracks_position` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_transform` **(** :ref:`bool` adjust_by_reference_frame **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_type` **(** **)** const | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_ARVRPositionalTracker_get_joy_id: + +- :ref:`int` **get_joy_id** **(** **)** const + +.. _class_ARVRPositionalTracker_get_name: + +- :ref:`String` **get_name** **(** **)** const + +.. _class_ARVRPositionalTracker_get_orientation: + +- :ref:`Basis` **get_orientation** **(** **)** const + +.. _class_ARVRPositionalTracker_get_position: + +- :ref:`Vector3` **get_position** **(** **)** const + +.. _class_ARVRPositionalTracker_get_tracks_orientation: + +- :ref:`bool` **get_tracks_orientation** **(** **)** const + +.. _class_ARVRPositionalTracker_get_tracks_position: + +- :ref:`bool` **get_tracks_position** **(** **)** const + +.. _class_ARVRPositionalTracker_get_transform: + +- :ref:`Transform` **get_transform** **(** :ref:`bool` adjust_by_reference_frame **)** const + +.. _class_ARVRPositionalTracker_get_type: + +- :ref:`int` **get_type** **(** **)** const + + diff --git a/classes/class_arvrscriptinterface.rst b/classes/class_arvrscriptinterface.rst new file mode 100644 index 000000000..5bb8ffac8 --- /dev/null +++ b/classes/class_arvrscriptinterface.rst @@ -0,0 +1,98 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. + +.. _class_ARVRScriptInterface: + +ARVRScriptInterface +=================== + +**Inherits:** :ref:`ARVRInterface` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_get_projection_for_eye` **(** **)** virtual | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`commit_for_eye` **(** :ref:`int` eye, :ref:`RID` render_target **)** virtual | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_recommended_render_targetsize` **(** **)** virtual | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_transform_for_eye` **(** :ref:`int` eye, :ref:`Transform` cam_transform **)** virtual | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`hmd_is_present` **(** **)** virtual | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`initialize` **(** **)** virtual | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_initialized` **(** **)** virtual | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_installed` **(** **)** virtual | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_stereo` **(** **)** virtual | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`process` **(** **)** virtual | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`supports_hmd` **(** **)** virtual | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`uninitialize` **(** **)** virtual | ++------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_ARVRScriptInterface__get_projection_for_eye: + +- void **_get_projection_for_eye** **(** **)** virtual + +.. _class_ARVRScriptInterface_commit_for_eye: + +- void **commit_for_eye** **(** :ref:`int` eye, :ref:`RID` render_target **)** virtual + +.. _class_ARVRScriptInterface_get_recommended_render_targetsize: + +- :ref:`Vector2` **get_recommended_render_targetsize** **(** **)** virtual + +.. _class_ARVRScriptInterface_get_transform_for_eye: + +- :ref:`Transform` **get_transform_for_eye** **(** :ref:`int` eye, :ref:`Transform` cam_transform **)** virtual + +.. _class_ARVRScriptInterface_hmd_is_present: + +- :ref:`bool` **hmd_is_present** **(** **)** virtual + +.. _class_ARVRScriptInterface_initialize: + +- :ref:`bool` **initialize** **(** **)** virtual + +.. _class_ARVRScriptInterface_is_initialized: + +- :ref:`bool` **is_initialized** **(** **)** virtual + +.. _class_ARVRScriptInterface_is_installed: + +- :ref:`bool` **is_installed** **(** **)** virtual + +.. _class_ARVRScriptInterface_is_stereo: + +- :ref:`bool` **is_stereo** **(** **)** virtual + +.. _class_ARVRScriptInterface_process: + +- void **process** **(** **)** virtual + +.. _class_ARVRScriptInterface_supports_hmd: + +- :ref:`bool` **supports_hmd** **(** **)** virtual + +.. _class_ARVRScriptInterface_uninitialize: + +- void **uninitialize** **(** **)** virtual + + diff --git a/classes/class_arvrserver.rst b/classes/class_arvrserver.rst new file mode 100644 index 000000000..2f2f7d63a --- /dev/null +++ b/classes/class_arvrserver.rst @@ -0,0 +1,121 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. + +.. _class_ARVRServer: + +ARVRServer +========== + +**Inherits:** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_interface` **(** :ref:`ARVRInterface` arg0 **)** | ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ARVRInterface` | :ref:`find_interface` **(** :ref:`String` name **)** const | ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ARVRInterface` | :ref:`get_interface` **(** :ref:`int` idx **)** const | ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_interface_count` **(** **)** const | ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_reference_frame` **(** **)** const | ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ARVRPositionalTracker` | :ref:`get_tracker` **(** :ref:`int` idx **)** const | ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tracker_count` **(** **)** const | ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_world_scale` **(** **)** const | ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_interface` **(** :ref:`ARVRInterface` arg0 **)** | ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`request_reference_frame` **(** :ref:`bool` ignore_tilt, :ref:`bool` keep_height **)** | ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_primary_interface` **(** :ref:`ARVRInterface` arg0 **)** | ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_world_scale` **(** :ref:`float` arg0 **)** | ++------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Signals +------- + +- **interface_added** **(** :ref:`String` name **)** +- **interface_removed** **(** :ref:`String` name **)** +- **tracker_added** **(** :ref:`String` name, :ref:`int` type **)** +- **tracker_removed** **(** :ref:`String` name **)** + +Member Variables +---------------- + +- :ref:`float` **world_scale** + +Numeric Constants +----------------- + +- **TRACKER_CONTROLLER** = **1** +- **TRACKER_BASESTATION** = **2** +- **TRACKER_ANCHOR** = **4** +- **TRACKER_UNKNOWN** = **128** +- **TRACKER_ANY_KNOWN** = **127** +- **TRACKER_ANY** = **255** + +Member Function Description +--------------------------- + +.. _class_ARVRServer_add_interface: + +- void **add_interface** **(** :ref:`ARVRInterface` arg0 **)** + +.. _class_ARVRServer_find_interface: + +- :ref:`ARVRInterface` **find_interface** **(** :ref:`String` name **)** const + +.. _class_ARVRServer_get_interface: + +- :ref:`ARVRInterface` **get_interface** **(** :ref:`int` idx **)** const + +.. _class_ARVRServer_get_interface_count: + +- :ref:`int` **get_interface_count** **(** **)** const + +.. _class_ARVRServer_get_reference_frame: + +- :ref:`Transform` **get_reference_frame** **(** **)** const + +.. _class_ARVRServer_get_tracker: + +- :ref:`ARVRPositionalTracker` **get_tracker** **(** :ref:`int` idx **)** const + +.. _class_ARVRServer_get_tracker_count: + +- :ref:`int` **get_tracker_count** **(** **)** const + +.. _class_ARVRServer_get_world_scale: + +- :ref:`float` **get_world_scale** **(** **)** const + +.. _class_ARVRServer_remove_interface: + +- void **remove_interface** **(** :ref:`ARVRInterface` arg0 **)** + +.. _class_ARVRServer_request_reference_frame: + +- void **request_reference_frame** **(** :ref:`bool` ignore_tilt, :ref:`bool` keep_height **)** + +.. _class_ARVRServer_set_primary_interface: + +- void **set_primary_interface** **(** :ref:`ARVRInterface` arg0 **)** + +.. _class_ARVRServer_set_world_scale: + +- void **set_world_scale** **(** :ref:`float` arg0 **)** + + diff --git a/classes/class_astar.rst b/classes/class_astar.rst index 350cdbf50..975c6d87b 100644 --- a/classes/class_astar.rst +++ b/classes/class_astar.rst @@ -23,13 +23,13 @@ Member Functions +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_estimate_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector3` pos, :ref:`float` weight_scale=1 **)** | +| void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector3` pos, :ref:`float` weight_scale=null **)** | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`are_points_connected` **(** :ref:`int` id, :ref:`int` to_id **)** const | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`connect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** | +| void | :ref:`connect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=null **)** | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`disconnect_points` **(** :ref:`int` id, :ref:`int` to_id **)** | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -72,7 +72,7 @@ Member Function Description .. _class_AStar_add_point: -- void **add_point** **(** :ref:`int` id, :ref:`Vector3` pos, :ref:`float` weight_scale=1 **)** +- void **add_point** **(** :ref:`int` id, :ref:`Vector3` pos, :ref:`float` weight_scale=null **)** Add a new point at the given position ``pos`` with the given identifier ``id``. The ``weight_scale`` has to be 1 or larger. @@ -90,7 +90,7 @@ Clear all the points and segments from AStar instance. .. _class_AStar_connect_points: -- void **connect_points** **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** +- void **connect_points** **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=null **)** Create a segment between points ``id`` and ``to_id``. diff --git a/classes/class_atlastexture.rst b/classes/class_atlastexture.rst index 80b1ec4ad..695eb493f 100644 --- a/classes/class_atlastexture.rst +++ b/classes/class_atlastexture.rst @@ -32,11 +32,6 @@ Member Functions | void | :ref:`set_region` **(** :ref:`Rect2` region **)** | +--------------------------------+--------------------------------------------------------------------------------------------------+ -Signals -------- - -- **atlas_changed** **(** **)** - Member Variables ---------------- diff --git a/classes/class_audioeffectcompressor.rst b/classes/class_audioeffectcompressor.rst index c562314c4..33ad4bd46 100644 --- a/classes/class_audioeffectcompressor.rst +++ b/classes/class_audioeffectcompressor.rst @@ -56,7 +56,7 @@ Member Variables - :ref:`float` **mix** - :ref:`float` **ratio** - :ref:`float` **release_ms** -- :ref:`float` **sidechain** +- :ref:`String` **sidechain** - :ref:`float` **threshold** Member Function Description diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index 516238cb0..b7ea6778f 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -21,7 +21,7 @@ Member Functions +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_bus` **(** :ref:`int` at_pos=-1 **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_bus_effect` **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` arg2=-1 **)** | +| void | :ref:`add_bus_effect` **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` at_pos=null **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AudioBusLayout` | :ref:`generate_bus_layout` **(** **)** const | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -29,7 +29,7 @@ Member Functions +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AudioEffect` | :ref:`get_bus_effect` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_bus_effect_count` **(** :ref:`int` bus_idx, :ref:`Object` arg1, :ref:`int` arg2 **)** | +| :ref:`int` | :ref:`get_bus_effect_count` **(** :ref:`int` bus_idx **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_bus_index` **(** :ref:`String` bus_name **)** const | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -105,7 +105,7 @@ Member Function Description .. _class_AudioServer_add_bus_effect: -- void **add_bus_effect** **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` arg2=-1 **)** +- void **add_bus_effect** **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` at_pos=null **)** .. _class_AudioServer_generate_bus_layout: @@ -121,7 +121,7 @@ Member Function Description .. _class_AudioServer_get_bus_effect_count: -- void **get_bus_effect_count** **(** :ref:`int` bus_idx, :ref:`Object` arg1, :ref:`int` arg2 **)** +- :ref:`int` **get_bus_effect_count** **(** :ref:`int` bus_idx **)** .. _class_AudioServer_get_bus_index: diff --git a/classes/class_audiostreamoggvorbis.rst b/classes/class_audiostreamoggvorbis.rst index 4be97ee72..328116cfe 100644 --- a/classes/class_audiostreamoggvorbis.rst +++ b/classes/class_audiostreamoggvorbis.rst @@ -18,21 +18,26 @@ OGG Vorbis audio stream driver. Member Functions ---------------- -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_data` **(** **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_loop` **(** **)** const | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_data` **(** :ref:`PoolByteArray` data **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_loop` **(** :ref:`bool` enable **)** | -+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`get_data` **(** **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_loop_offset` **(** **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_loop` **(** **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_data` **(** :ref:`PoolByteArray` data **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_loop` **(** :ref:`bool` enable **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_loop_offset` **(** :ref:`float` seconds **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- - :ref:`PoolByteArray` **data** - :ref:`bool` **loop** +- :ref:`float` **loop_offset** Description ----------- @@ -46,6 +51,10 @@ Member Function Description - :ref:`PoolByteArray` **get_data** **(** **)** const +.. _class_AudioStreamOGGVorbis_get_loop_offset: + +- :ref:`float` **get_loop_offset** **(** **)** const + .. _class_AudioStreamOGGVorbis_has_loop: - :ref:`bool` **has_loop** **(** **)** const @@ -58,4 +67,8 @@ Member Function Description - void **set_loop** **(** :ref:`bool` enable **)** +.. _class_AudioStreamOGGVorbis_set_loop_offset: + +- void **set_loop_offset** **(** :ref:`float` seconds **)** + diff --git a/classes/class_audiostreamplayer.rst b/classes/class_audiostreamplayer.rst index 847e8b0b2..c93f3a0b8 100644 --- a/classes/class_audiostreamplayer.rst +++ b/classes/class_audiostreamplayer.rst @@ -18,37 +18,42 @@ Brief Description Member Functions ---------------- -+------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bus` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mix_target` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pos` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_stream` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_volume_db` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_autoplay_enabled` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`float` from_pos=0 **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`float` to_pos **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_autoplay` **(** :ref:`bool` enable **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus` **(** :ref:`String` bus **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mix_target` **(** :ref:`int` mix_target **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stream` **(** :ref:`AudioStream` stream **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_volume_db` **(** :ref:`float` volume_db **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_bus` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mix_target` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_pos` **(** **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`AudioStream` | :ref:`get_stream` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_volume_db` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_autoplay_enabled` **(** **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`float` from_pos=0.0 **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`float` to_pos **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_autoplay` **(** :ref:`bool` enable **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus` **(** :ref:`String` bus **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mix_target` **(** :ref:`int` mix_target **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stream` **(** :ref:`AudioStream` stream **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_volume_db` **(** :ref:`float` volume_db **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------+ + +Signals +------- + +- **finished** **(** **)** Member Variables ---------------- @@ -77,7 +82,7 @@ Member Function Description .. _class_AudioStreamPlayer_get_stream: -- :ref:`Object` **get_stream** **(** **)** const +- :ref:`AudioStream` **get_stream** **(** **)** const .. _class_AudioStreamPlayer_get_volume_db: @@ -93,7 +98,7 @@ Member Function Description .. _class_AudioStreamPlayer_play: -- void **play** **(** :ref:`float` from_pos=0 **)** +- void **play** **(** :ref:`float` from_pos=0.0 **)** .. _class_AudioStreamPlayer_seek: diff --git a/classes/class_audiostreamplayer2d.rst b/classes/class_audiostreamplayer2d.rst index b6f1fff0b..7cbbdf818 100644 --- a/classes/class_audiostreamplayer2d.rst +++ b/classes/class_audiostreamplayer2d.rst @@ -18,45 +18,50 @@ Brief Description Member Functions ---------------- -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_area_mask` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_attenuation` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bus` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_max_distance` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pos` **(** **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_stream` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_volume_db` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_autoplay_enabled` **(** **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`float` from_pos=0 **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`float` to_pos **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_area_mask` **(** :ref:`int` mask **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_attenuation` **(** :ref:`float` curve **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_autoplay` **(** :ref:`bool` enable **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus` **(** :ref:`String` bus **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_distance` **(** :ref:`float` pixels **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stream` **(** :ref:`AudioStream` stream **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_volume_db` **(** :ref:`float` volume_db **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_area_mask` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_attenuation` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_bus` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_max_distance` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_pos` **(** **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`AudioStream` | :ref:`get_stream` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_volume_db` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_autoplay_enabled` **(** **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`float` from_pos=0.0 **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`float` to_pos **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_area_mask` **(** :ref:`int` mask **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_attenuation` **(** :ref:`float` curve **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_autoplay` **(** :ref:`bool` enable **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus` **(** :ref:`String` bus **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_distance` **(** :ref:`float` pixels **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stream` **(** :ref:`AudioStream` stream **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_volume_db` **(** :ref:`float` volume_db **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + +Signals +------- + +- **finished** **(** **)** Member Variables ---------------- @@ -95,7 +100,7 @@ Member Function Description .. _class_AudioStreamPlayer2D_get_stream: -- :ref:`Object` **get_stream** **(** **)** const +- :ref:`AudioStream` **get_stream** **(** **)** const .. _class_AudioStreamPlayer2D_get_volume_db: @@ -111,7 +116,7 @@ Member Function Description .. _class_AudioStreamPlayer2D_play: -- void **play** **(** :ref:`float` from_pos=0 **)** +- void **play** **(** :ref:`float` from_pos=0.0 **)** .. _class_AudioStreamPlayer2D_seek: diff --git a/classes/class_audiostreamplayer3d.rst b/classes/class_audiostreamplayer3d.rst index b1f5ea708..310c8d319 100644 --- a/classes/class_audiostreamplayer3d.rst +++ b/classes/class_audiostreamplayer3d.rst @@ -18,81 +18,86 @@ Brief Description Member Functions ---------------- -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_area_mask` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_attenuation_filter_cutoff_hz` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_attenuation_filter_db` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_attenuation_model` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bus` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_doppler_tracking` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_emission_angle` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_emission_angle_filter_attenuation_db` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_max_db` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_max_distance` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_out_of_range_mode` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pos` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_stream` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_unit_db` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_unit_size` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_autoplay_enabled` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_emission_angle_enabled` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`float` from_pos=0 **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`float` to_pos **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_area_mask` **(** :ref:`int` mask **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_attenuation_filter_cutoff_hz` **(** :ref:`float` degrees **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_attenuation_filter_db` **(** :ref:`float` db **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_attenuation_model` **(** :ref:`int` model **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_autoplay` **(** :ref:`bool` enable **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus` **(** :ref:`String` bus **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_doppler_tracking` **(** :ref:`int` mode **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_angle` **(** :ref:`float` degrees **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_angle_enabled` **(** :ref:`bool` enabled **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_angle_filter_attenuation_db` **(** :ref:`float` db **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_db` **(** :ref:`float` max_db **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_distance` **(** :ref:`float` metres **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_out_of_range_mode` **(** :ref:`int` mode **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stream` **(** :ref:`AudioStream` stream **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_unit_db` **(** :ref:`float` unit_db **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_unit_size` **(** :ref:`float` unit_size **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_area_mask` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_attenuation_filter_cutoff_hz` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_attenuation_filter_db` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_attenuation_model` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_bus` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_doppler_tracking` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_emission_angle` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_emission_angle_filter_attenuation_db` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_max_db` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_max_distance` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_out_of_range_mode` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_pos` **(** **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AudioStream` | :ref:`get_stream` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_unit_db` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_unit_size` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_autoplay_enabled` **(** **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_emission_angle_enabled` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`float` from_pos=0.0 **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`float` to_pos **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_area_mask` **(** :ref:`int` mask **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_attenuation_filter_cutoff_hz` **(** :ref:`float` degrees **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_attenuation_filter_db` **(** :ref:`float` db **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_attenuation_model` **(** :ref:`int` model **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_autoplay` **(** :ref:`bool` enable **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus` **(** :ref:`String` bus **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_doppler_tracking` **(** :ref:`int` mode **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission_angle` **(** :ref:`float` degrees **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission_angle_enabled` **(** :ref:`bool` enabled **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission_angle_filter_attenuation_db` **(** :ref:`float` db **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_db` **(** :ref:`float` max_db **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_distance` **(** :ref:`float` metres **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_out_of_range_mode` **(** :ref:`int` mode **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stream` **(** :ref:`AudioStream` stream **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_unit_db` **(** :ref:`float` unit_db **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_unit_size` **(** :ref:`float` unit_size **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Signals +------- + +- **finished** **(** **)** Member Variables ---------------- @@ -180,7 +185,7 @@ Member Function Description .. _class_AudioStreamPlayer3D_get_stream: -- :ref:`Object` **get_stream** **(** **)** const +- :ref:`AudioStream` **get_stream** **(** **)** const .. _class_AudioStreamPlayer3D_get_unit_db: @@ -204,7 +209,7 @@ Member Function Description .. _class_AudioStreamPlayer3D_play: -- void **play** **(** :ref:`float` from_pos=0 **)** +- void **play** **(** :ref:`float` from_pos=0.0 **)** .. _class_AudioStreamPlayer3D_seek: diff --git a/classes/class_audiostreamrandompitch.rst b/classes/class_audiostreamrandompitch.rst index 67416ba4c..50cbc7a98 100644 --- a/classes/class_audiostreamrandompitch.rst +++ b/classes/class_audiostreamrandompitch.rst @@ -18,15 +18,15 @@ Brief Description Member Functions ---------------- -+------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_audio_stream` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_random_pitch` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_audio_stream` **(** :ref:`Object` stream **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_random_pitch` **(** :ref:`float` scale **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AudioStream` | :ref:`get_audio_stream` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_random_pitch` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_audio_stream` **(** :ref:`AudioStream` stream **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_random_pitch` **(** :ref:`float` scale **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -39,7 +39,7 @@ Member Function Description .. _class_AudioStreamRandomPitch_get_audio_stream: -- :ref:`Object` **get_audio_stream** **(** **)** const +- :ref:`AudioStream` **get_audio_stream** **(** **)** const .. _class_AudioStreamRandomPitch_get_random_pitch: @@ -47,7 +47,7 @@ Member Function Description .. _class_AudioStreamRandomPitch_set_audio_stream: -- void **set_audio_stream** **(** :ref:`Object` stream **)** +- void **set_audio_stream** **(** :ref:`AudioStream` stream **)** .. _class_AudioStreamRandomPitch_set_random_pitch: diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index 503fc8f0d..b4979ea62 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -20,43 +20,43 @@ Provides a base class for different kinds of buttons. Member Functions ---------------- -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_pressed` **(** **)** virtual | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_toggled` **(** :ref:`bool` pressed **)** virtual | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_action_mode` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_button_group` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_draw_mode` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_enabled_focus_mode` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_shortcut` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_disabled` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_hovered` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pressed` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_toggle_mode` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_action_mode` **(** :ref:`int` mode **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_button_group` **(** :ref:`Object` button_group **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disabled` **(** :ref:`bool` disabled **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enabled_focus_mode` **(** :ref:`int` mode **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shortcut` **(** :ref:`Object` shortcut **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_toggle_mode` **(** :ref:`bool` enabled **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_pressed` **(** **)** virtual | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_toggled` **(** :ref:`bool` pressed **)** virtual | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_action_mode` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ButtonGroup` | :ref:`get_button_group` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_draw_mode` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_enabled_focus_mode` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ShortCut` | :ref:`get_shortcut` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_disabled` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_hovered` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_pressed` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_toggle_mode` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_action_mode` **(** :ref:`int` mode **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_button_group` **(** :ref:`ButtonGroup` button_group **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disabled` **(** :ref:`bool` disabled **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_enabled_focus_mode` **(** :ref:`int` mode **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shortcut` **(** :ref:`ShortCut` shortcut **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_toggle_mode` **(** :ref:`bool` enabled **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -81,7 +81,7 @@ Member Variables - :ref:`bool` **disabled** - :ref:`int` **enabled_focus_mode** - :ref:`ButtonGroup` **group** -- :ref:`bool` **is_pressed** +- :ref:`bool` **pressed** - :ref:`ShortCut` **shortcut** - :ref:`bool` **toggle_mode** @@ -123,7 +123,7 @@ Return the current mode of action (see :ref:`set_action_mode` **get_button_group** **(** **)** const +- :ref:`ButtonGroup` **get_button_group** **(** **)** const .. _class_BaseButton_get_draw_mode: @@ -139,7 +139,7 @@ Returns focus access mode used when switching between enabled/disabled (see :ref .. _class_BaseButton_get_shortcut: -- :ref:`Object` **get_shortcut** **(** **)** const +- :ref:`ShortCut` **get_shortcut** **(** **)** const .. _class_BaseButton_is_disabled: @@ -173,7 +173,7 @@ Set the current mode of action, determining when the button is considered clicke .. _class_BaseButton_set_button_group: -- void **set_button_group** **(** :ref:`Object` button_group **)** +- void **set_button_group** **(** :ref:`ButtonGroup` button_group **)** .. _class_BaseButton_set_disabled: @@ -195,7 +195,7 @@ Set the button to pressed state (only if toggle_mode is active). .. _class_BaseButton_set_shortcut: -- void **set_shortcut** **(** :ref:`Object` shortcut **)** +- void **set_shortcut** **(** :ref:`ShortCut` shortcut **)** .. _class_BaseButton_set_toggle_mode: diff --git a/classes/class_basis.rst b/classes/class_basis.rst index eb9259012..28ac9ff47 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -41,12 +41,6 @@ Member Functions +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`scaled` **(** :ref:`Vector3` scale **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation_axis_angle` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation_euler` **(** :ref:`Vector3` euler **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scale` **(** :ref:`Vector3` scale **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`tdotx` **(** :ref:`Vector3` with **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`tdoty` **(** :ref:`Vector3` with **)** | @@ -87,7 +81,7 @@ Create a rotation matrix from the given quaternion. - :ref:`Basis` **Basis** **(** :ref:`Vector3` euler **)** -Create a rotation matrix (in the XYZ convention: first Z, then Y, and X last) from the specified Euler angles, given in the vector format as (third, second, first). +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: @@ -111,7 +105,7 @@ Return the determinant of the matrix. - :ref:`Vector3` **get_euler** **(** **)** -Assuming that the matrix is a proper rotation matrix (orthonormal matrix with determinant +1), return Euler angles (in the XYZ convention: first Z, then Y, and X last). Returned vector contains the rotation angles in the format (third,second,first). +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: @@ -149,24 +143,6 @@ Introduce an additional rotation around the given axis by phi (radians). Only re Introduce an additional scaling specified by the given 3D scaling factor. Only relevant when the matrix is being used as a part of :ref:`Transform`. -.. _class_Basis_set_rotation_axis_angle: - -- void **set_rotation_axis_angle** **(** :ref:`Vector3` axis, :ref:`float` angle **)** - -Changes only the rotation part of the :ref:`Basis` to a rotation around given axis by phi, while preserving the scaling part (as determined by get_scale). - -.. _class_Basis_set_rotation_euler: - -- void **set_rotation_euler** **(** :ref:`Vector3` euler **)** - -Changes only the rotation part of the :ref:`Basis` to a rotation corresponding to given Euler angles, while preserving the scaling part (as determined by get_scale). - -.. _class_Basis_set_scale: - -- void **set_scale** **(** :ref:`Vector3` scale **)** - -Changes only the scaling part of the Basis to the specified scaling, while preserving the rotation part (as determined by get_rotation). - .. _class_Basis_tdotx: - :ref:`float` **tdotx** **(** :ref:`Vector3` with **)** diff --git a/classes/class_bitmap.rst b/classes/class_bitmap.rst index 3b522be45..545cb51db 100644 --- a/classes/class_bitmap.rst +++ b/classes/class_bitmap.rst @@ -21,7 +21,7 @@ Member Functions +--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create` **(** :ref:`Vector2` size **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_from_image_alpha` **(** :ref:`Object` image **)** | +| void | :ref:`create_from_image_alpha` **(** :ref:`Image` image **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_bit` **(** :ref:`Vector2` pos **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ @@ -48,7 +48,7 @@ Member Function Description .. _class_BitMap_create_from_image_alpha: -- void **create_from_image_alpha** **(** :ref:`Object` image **)** +- void **create_from_image_alpha** **(** :ref:`Image` image **)** .. _class_BitMap_get_bit: diff --git a/classes/class_bitmapfont.rst b/classes/class_bitmapfont.rst index 66998ea12..13d74b421 100644 --- a/classes/class_bitmapfont.rst +++ b/classes/class_bitmapfont.rst @@ -18,35 +18,35 @@ Brief Description Member Functions ---------------- -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_char` **(** :ref:`int` character, :ref:`int` texture, :ref:`Rect2` rect, :ref:`Vector2` align=Vector2(0, 0), :ref:`float` advance=-1 **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b, :ref:`int` kerning **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`create_from_fnt` **(** :ref:`String` path **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_char_size` **(** :ref:`int` char, :ref:`int` next=0 **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_fallback` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** :ref:`int` idx **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_texture_count` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ascent` **(** :ref:`float` px **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_distance_field_hint` **(** :ref:`bool` enable **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fallback` **(** :ref:`Object` fallback **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_height` **(** :ref:`float` px **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_char` **(** :ref:`int` character, :ref:`int` texture, :ref:`Rect2` rect, :ref:`Vector2` align=null, :ref:`float` advance=null **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b, :ref:`int` kerning **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_texture` **(** :ref:`Texture` texture **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`create_from_fnt` **(** :ref:`String` path **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_char_size` **(** :ref:`int` char, :ref:`int` next=null **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`BitmapFont` | :ref:`get_fallback` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_texture` **(** :ref:`int` idx **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_texture_count` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ascent` **(** :ref:`float` px **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_distance_field_hint` **(** :ref:`bool` enable **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fallback` **(** :ref:`BitmapFont` fallback **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_height` **(** :ref:`float` px **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -64,7 +64,7 @@ Member Function Description .. _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 **)** +- void **add_char** **(** :ref:`int` character, :ref:`int` texture, :ref:`Rect2` rect, :ref:`Vector2` align=null, :ref:`float` advance=null **)** Add 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. @@ -92,13 +92,13 @@ Clear all the font data. .. _class_BitmapFont_get_char_size: -- :ref:`Vector2` **get_char_size** **(** :ref:`int` char, :ref:`int` next=0 **)** const +- :ref:`Vector2` **get_char_size** **(** :ref:`int` char, :ref:`int` next=null **)** const Return the size of a character, optionally taking kerning into account if the next character is provided. .. _class_BitmapFont_get_fallback: -- :ref:`Object` **get_fallback** **(** **)** const +- :ref:`BitmapFont` **get_fallback** **(** **)** const .. _class_BitmapFont_get_kerning_pair: @@ -126,7 +126,7 @@ Set the font ascent (number of pixels above the baseline). .. _class_BitmapFont_set_fallback: -- void **set_fallback** **(** :ref:`Object` fallback **)** +- void **set_fallback** **(** :ref:`BitmapFont` fallback **)** .. _class_BitmapFont_set_height: diff --git a/classes/class_camera.rst b/classes/class_camera.rst index d9f8589ed..ab43189dc 100644 --- a/classes/class_camera.rst +++ b/classes/class_camera.rst @@ -8,7 +8,7 @@ Camera **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`InterpolatedCamera` +**Inherited By:** :ref:`InterpolatedCamera`, :ref:`ARVRCamera` **Category:** Core diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index e8f99abc3..42bd2b7b3 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -18,91 +18,91 @@ Camera node for 2D scenes. Member Functions ---------------- -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`align` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_current` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`force_update_scroll` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_anchor_mode` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_camera_pos` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_camera_screen_center` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Viewport` | :ref:`get_custom_viewport` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_drag_margin` **(** :ref:`int` margin **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_follow_smoothing` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_h_offset` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_limit` **(** :ref:`int` margin **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_v_offset` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_zoom` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_current` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_follow_smoothing_enabled` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_h_drag_enabled` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_limit_drawing_enabled` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_limit_smoothing_enabled` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_margin_drawing_enabled` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_rotating` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_screen_drawing_enabled` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_v_drag_enabled` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`make_current` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reset_smoothing` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anchor_mode` **(** :ref:`int` anchor_mode **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_viewport` **(** :ref:`Viewport` viewport **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_drag_margin` **(** :ref:`int` margin, :ref:`float` drag_margin **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enable_follow_smoothing` **(** :ref:`bool` follow_smoothing **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_follow_smoothing` **(** :ref:`float` follow_smoothing **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_drag_enabled` **(** :ref:`bool` enabled **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_offset` **(** :ref:`float` ofs **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_limit` **(** :ref:`int` margin, :ref:`int` limit **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_limit_drawing_enabled` **(** :ref:`bool` limit_drawing_enabled **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_limit_smoothing_enabled` **(** :ref:`bool` limit_smoothing_enabled **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_margin_drawing_enabled` **(** :ref:`bool` margin_drawing_enabled **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotating` **(** :ref:`bool` rotating **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_screen_drawing_enabled` **(** :ref:`bool` screen_drawing_enabled **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_drag_enabled` **(** :ref:`bool` enabled **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_offset` **(** :ref:`float` ofs **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_zoom` **(** :ref:`Vector2` zoom **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`align` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_current` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_update_scroll` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_anchor_mode` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_camera_pos` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_camera_screen_center` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_custom_viewport` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_drag_margin` **(** :ref:`int` margin **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_follow_smoothing` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_h_offset` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_limit` **(** :ref:`int` margin **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_v_offset` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_zoom` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_current` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_follow_smoothing_enabled` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_h_drag_enabled` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_limit_drawing_enabled` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_limit_smoothing_enabled` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_margin_drawing_enabled` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_rotating` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_screen_drawing_enabled` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_v_drag_enabled` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`make_current` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reset_smoothing` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_anchor_mode` **(** :ref:`int` anchor_mode **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_viewport` **(** :ref:`Node` viewport **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_drag_margin` **(** :ref:`int` margin, :ref:`float` drag_margin **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_enable_follow_smoothing` **(** :ref:`bool` follow_smoothing **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_follow_smoothing` **(** :ref:`float` follow_smoothing **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_drag_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_offset` **(** :ref:`float` ofs **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_limit` **(** :ref:`int` margin, :ref:`int` limit **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_limit_drawing_enabled` **(** :ref:`bool` limit_drawing_enabled **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_limit_smoothing_enabled` **(** :ref:`bool` limit_smoothing_enabled **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_margin_drawing_enabled` **(** :ref:`bool` margin_drawing_enabled **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotating` **(** :ref:`bool` rotating **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_screen_drawing_enabled` **(** :ref:`bool` screen_drawing_enabled **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_drag_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_offset` **(** :ref:`float` ofs **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_zoom` **(** :ref:`Vector2` zoom **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -177,7 +177,7 @@ Return the camera position. .. _class_Camera2D_get_custom_viewport: -- :ref:`Viewport` **get_custom_viewport** **(** **)** const +- :ref:`Node` **get_custom_viewport** **(** **)** const .. _class_Camera2D_get_drag_margin: @@ -271,7 +271,7 @@ This has no effect if smoothing is disabled. .. _class_Camera2D_set_custom_viewport: -- void **set_custom_viewport** **(** :ref:`Viewport` viewport **)** +- void **set_custom_viewport** **(** :ref:`Node` viewport **)** .. _class_Camera2D_set_drag_margin: diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index 52b208a40..e3e2b6fcf 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -20,127 +20,127 @@ Base class of anything 2D. Member Functions ---------------- -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_draw` **(** **)** virtual | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`draw_char` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=Color(1,1,1,1) **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_circle` **(** :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_colored_polygon` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`PoolVector2Array` uvs=PoolVector2Array([]), :ref:`Texture` texture=NULL, :ref:`Texture` normal_map=NULL **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_line` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1, :ref:`bool` antialiased=false **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_polygon` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array([]), :ref:`Texture` texture=NULL, :ref:`Texture` normal_map=NULL **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_polyline` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1, :ref:`bool` antialiased=false **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_polyline_colors` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1, :ref:`bool` antialiased=false **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_primitive` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`Texture` texture=NULL, :ref:`float` width=1, :ref:`Texture` normal_map=NULL **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_rect` **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=true **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_set_transform` **(** :ref:`Vector2` pos, :ref:`float` rot, :ref:`Vector2` scale **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_set_transform_matrix` **(** :ref:`Transform2D` xform **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_string` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`Color` modulate=Color(1,1,1,1), :ref:`int` clip_w=-1 **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_style_box` **(** :ref:`StyleBox` style_box, :ref:`Rect2` rect **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_texture` **(** :ref:`Texture` texture, :ref:`Vector2` pos, :ref:`Color` modulate=Color(1,1,1,1), :ref:`Texture` normal_map=NULL **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_texture_rect` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false, :ref:`Texture` normal_map=NULL **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_texture_rect_region` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false, :ref:`Texture` normal_map=NULL, :ref:`bool` clip_uv=true **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`edit_get_state` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit_rotate` **(** :ref:`float` degrees **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit_set_rect` **(** :ref:`Rect2` rect **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit_set_state` **(** :ref:`Variant` state **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_canvas` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_canvas_item` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_canvas_transform` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_global_mouse_position` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_global_transform` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_global_transform_with_canvas` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_item_and_children_rect` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_item_rect` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_light_mask` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_local_mouse_pos` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`get_material` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_modulate` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_self_modulate` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_use_parent_material` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_viewport_rect` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_viewport_transform` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_world_2d` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`hide` **(** **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_draw_behind_parent_enabled` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_local_transform_notification_enabled` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_set_as_toplevel` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_visible` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`make_canvas_pos_local` **(** :ref:`Vector2` screen_point **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`make_input_local` **(** :ref:`Object` event **)** const | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_toplevel` **(** :ref:`bool` enable **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_draw_behind_parent` **(** :ref:`bool` enable **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_light_mask` **(** :ref:`int` light_mask **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_material` **(** :ref:`Material` material **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_modulate` **(** :ref:`Color` modulate **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_notify_local_transform` **(** :ref:`bool` enable **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_notify_transform` **(** :ref:`bool` enable **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_self_modulate` **(** :ref:`Color` self_modulate **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_parent_material` **(** :ref:`bool` enable **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_visible` **(** :ref:`bool` arg0 **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`show` **(** **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update` **(** **)** | -+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_draw` **(** **)** virtual | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`draw_char` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=null **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_circle` **(** :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_colored_polygon` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`PoolVector2Array` uvs=null, :ref:`Texture` texture=PoolVector2Array( ), :ref:`Texture` normal_map=null, :ref:`bool` antialiased=null **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_line` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=null, :ref:`bool` antialiased=null **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_polygon` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=null, :ref:`Texture` texture=PoolVector2Array( ), :ref:`Texture` normal_map=null, :ref:`bool` antialiased=null **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_polyline` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=null, :ref:`bool` antialiased=null **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_polyline_colors` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=null, :ref:`bool` antialiased=null **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_primitive` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`Texture` texture=null, :ref:`float` width=null, :ref:`Texture` normal_map=null **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_rect` **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=null **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_set_transform` **(** :ref:`Vector2` pos, :ref:`float` rot, :ref:`Vector2` scale **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_set_transform_matrix` **(** :ref:`Transform2D` xform **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_string` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`Color` modulate=null, :ref:`int` clip_w=null **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_style_box` **(** :ref:`StyleBox` style_box, :ref:`Rect2` rect **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_texture` **(** :ref:`Texture` texture, :ref:`Vector2` pos, :ref:`Color` modulate=null, :ref:`Texture` normal_map=null **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_texture_rect` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=null, :ref:`bool` transpose=null, :ref:`Texture` normal_map=null **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_texture_rect_region` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=null, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=null **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`edit_get_state` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`edit_rotate` **(** :ref:`float` degrees **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`edit_set_rect` **(** :ref:`Rect2` rect **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`edit_set_state` **(** :ref:`Variant` state **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_canvas` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_canvas_item` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_canvas_transform` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_global_mouse_position` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_global_transform` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_global_transform_with_canvas` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_item_and_children_rect` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_item_rect` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_light_mask` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_local_mouse_pos` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`get_material` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_modulate` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_self_modulate` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_use_parent_material` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_viewport_rect` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_viewport_transform` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`hide` **(** **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_draw_behind_parent_enabled` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_local_transform_notification_enabled` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_set_as_toplevel` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_visible` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`make_canvas_pos_local` **(** :ref:`Vector2` screen_point **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`InputEvent` | :ref:`make_input_local` **(** :ref:`InputEvent` event **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_as_toplevel` **(** :ref:`bool` enable **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_draw_behind_parent` **(** :ref:`bool` enable **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_light_mask` **(** :ref:`int` light_mask **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_material` **(** :ref:`Material` material **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_modulate` **(** :ref:`Color` modulate **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_notify_local_transform` **(** :ref:`bool` enable **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_notify_transform` **(** :ref:`bool` enable **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_self_modulate` **(** :ref:`Color` self_modulate **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_parent_material` **(** :ref:`bool` enable **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_visible` **(** :ref:`bool` visible **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`show` **(** **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update` **(** **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -162,7 +162,7 @@ Member Variables ---------------- - :ref:`int` **light_mask** -- ShaderMaterial,CanvasItemMaterial **material** +- :ref:`Material` **material** - :ref:`Color` **modulate** - :ref:`Color` **self_modulate** - :ref:`bool` **show_behind_parent** @@ -208,7 +208,7 @@ Called (if exists) to draw the canvas item. .. _class_CanvasItem_draw_char: -- :ref:`float` **draw_char** **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=Color(1,1,1,1) **)** +- :ref:`float` **draw_char** **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=null **)** Draw a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char. @@ -220,39 +220,39 @@ Draw a colored circle. .. _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 **)** +- void **draw_colored_polygon** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`PoolVector2Array` uvs=null, :ref:`Texture` texture=PoolVector2Array( ), :ref:`Texture` normal_map=null, :ref:`bool` antialiased=null **)** Draw a colored polygon of any amount of points, convex or concave. .. _class_CanvasItem_draw_line: -- void **draw_line** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1, :ref:`bool` antialiased=false **)** +- void **draw_line** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=null, :ref:`bool` antialiased=null **)** Draw a line from a 2D point to another, with a given color and width. It can be optionally antialiased. .. _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 **)** +- void **draw_polygon** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=null, :ref:`Texture` texture=PoolVector2Array( ), :ref:`Texture` normal_map=null, :ref:`bool` antialiased=null **)** Draw a polygon of any amount of points, convex or concave. .. _class_CanvasItem_draw_polyline: -- void **draw_polyline** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1, :ref:`bool` antialiased=false **)** +- void **draw_polyline** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=null, :ref:`bool` antialiased=null **)** .. _class_CanvasItem_draw_polyline_colors: -- void **draw_polyline_colors** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1, :ref:`bool` antialiased=false **)** +- void **draw_polyline_colors** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=null, :ref:`bool` antialiased=null **)** .. _class_CanvasItem_draw_primitive: -- void **draw_primitive** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`Texture` texture=NULL, :ref:`float` width=1, :ref:`Texture` normal_map=NULL **)** +- void **draw_primitive** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`Texture` texture=null, :ref:`float` width=null, :ref:`Texture` normal_map=null **)** Draw 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: -- void **draw_rect** **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=true **)** +- void **draw_rect** **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=null **)** Draw a colored rectangle. @@ -268,7 +268,7 @@ Set a custom transform for drawing. Anything drawn afterwards will be transforme .. _class_CanvasItem_draw_string: -- void **draw_string** **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`Color` modulate=Color(1,1,1,1), :ref:`int` clip_w=-1 **)** +- void **draw_string** **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`Color` modulate=null, :ref:`int` clip_w=null **)** Draw a string using a custom font. @@ -280,19 +280,19 @@ Draw a styled rectangle. .. _class_CanvasItem_draw_texture: -- void **draw_texture** **(** :ref:`Texture` texture, :ref:`Vector2` pos, :ref:`Color` modulate=Color(1,1,1,1), :ref:`Texture` normal_map=NULL **)** +- void **draw_texture** **(** :ref:`Texture` texture, :ref:`Vector2` pos, :ref:`Color` modulate=null, :ref:`Texture` normal_map=null **)** Draw a texture at a given position. .. _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 **)** +- void **draw_texture_rect** **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=null, :ref:`bool` transpose=null, :ref:`Texture` normal_map=null **)** Draw 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: -- 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 **)** +- 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=null, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=null **)** Draw a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture. @@ -422,7 +422,7 @@ Get this item's transform in relation to the viewport. .. _class_CanvasItem_get_world_2d: -- :ref:`Object` **get_world_2d** **(** **)** const +- :ref:`World2D` **get_world_2d** **(** **)** const Get the :ref:`World2D` where this item is in. @@ -468,7 +468,7 @@ Return true if this CanvasItem is visible. It may be invisible because itself or .. _class_CanvasItem_make_input_local: -- :ref:`Object` **make_input_local** **(** :ref:`Object` event **)** const +- :ref:`InputEvent` **make_input_local** **(** :ref:`InputEvent` event **)** const .. _class_CanvasItem_set_as_toplevel: @@ -522,7 +522,7 @@ Set whether or not this item should use its parent's material. .. _class_CanvasItem_set_visible: -- void **set_visible** **(** :ref:`bool` arg0 **)** +- void **set_visible** **(** :ref:`bool` visible **)** Set whether this item should be visible or not. diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index 9f6ddd408..ce483ecee 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -20,37 +20,37 @@ Canvas Item layer. Member Functions ---------------- -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Viewport` | :ref:`get_custom_viewport` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_layer` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotation` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotationd` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scale` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_viewport` **(** :ref:`Viewport` viewport **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer` **(** :ref:`int` layer **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation` **(** :ref:`float` radians **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotationd` **(** :ref:`float` degrees **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scale` **(** :ref:`Vector2` scale **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transform` **(** :ref:`Transform2D` transform **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_custom_viewport` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_layer` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rotation` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rotationd` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_scale` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_viewport` **(** :ref:`Node` viewport **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_layer` **(** :ref:`int` layer **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotation` **(** :ref:`float` radians **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotationd` **(** :ref:`float` degrees **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scale` **(** :ref:`Vector2` scale **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transform` **(** :ref:`Transform2D` transform **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -70,7 +70,7 @@ Member Function Description .. _class_CanvasLayer_get_custom_viewport: -- :ref:`Viewport` **get_custom_viewport** **(** **)** const +- :ref:`Node` **get_custom_viewport** **(** **)** const .. _class_CanvasLayer_get_layer: @@ -116,7 +116,7 @@ Return the :ref:`World2D` used by this layer. .. _class_CanvasLayer_set_custom_viewport: -- void **set_custom_viewport** **(** :ref:`Viewport` viewport **)** +- void **set_custom_viewport** **(** :ref:`Node` viewport **)** .. _class_CanvasLayer_set_layer: diff --git a/classes/class_classdb.rst b/classes/class_classdb.rst index 369e4d060..bdc1a8594 100644 --- a/classes/class_classdb.rst +++ b/classes/class_classdb.rst @@ -18,47 +18,47 @@ Brief Description Member Functions ---------------- -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_instance` **(** :ref:`String` class **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`class_exists` **(** :ref:`String` class **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`class_get_category` **(** :ref:`String` class **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`class_get_integer_constant` **(** :ref:`String` class, :ref:`String` name **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`class_get_integer_constant_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`class_get_method_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`class_get_property` **(** :ref:`Object` object, :ref:`String` property **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`class_get_property_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`class_get_signal` **(** :ref:`String` class, :ref:`String` signal **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`class_get_signal_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`class_has_integer_constant` **(** :ref:`String` class, :ref:`String` name **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`class_has_method` **(** :ref:`String` class, :ref:`String` method, :ref:`bool` no_inheritance=false **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`class_has_signal` **(** :ref:`String` class, :ref:`String` signal **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`class_set_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_class_list` **(** **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_inheriters_from_class` **(** :ref:`String` class **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_parent_class` **(** :ref:`String` class **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`instance` **(** :ref:`String` class **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_class_enabled` **(** :ref:`String` class **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_parent_class` **(** :ref:`String` class, :ref:`String` inherits **)** const | -+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_instance` **(** :ref:`String` class **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`class_exists` **(** :ref:`String` class **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`class_get_category` **(** :ref:`String` class **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`class_get_integer_constant` **(** :ref:`String` class, :ref:`String` name **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`class_get_integer_constant_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=null **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`class_get_method_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=null **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`class_get_property` **(** :ref:`Object` object, :ref:`String` property **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`class_get_property_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=null **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`class_get_signal` **(** :ref:`String` class, :ref:`String` signal **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`class_get_signal_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=null **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`class_has_integer_constant` **(** :ref:`String` class, :ref:`String` name **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`class_has_method` **(** :ref:`String` class, :ref:`String` method, :ref:`bool` no_inheritance=null **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`class_has_signal` **(** :ref:`String` class, :ref:`String` signal **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`class_set_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_class_list` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_inheriters_from_class` **(** :ref:`String` class **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_parent_class` **(** :ref:`String` class **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`instance` **(** :ref:`String` class **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_class_enabled` **(** :ref:`String` class **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_parent_class` **(** :ref:`String` class, :ref:`String` inherits **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- @@ -81,11 +81,11 @@ Member Function Description .. _class_ClassDB_class_get_integer_constant_list: -- :ref:`PoolStringArray` **class_get_integer_constant_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const +- :ref:`PoolStringArray` **class_get_integer_constant_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=null **)** const .. _class_ClassDB_class_get_method_list: -- :ref:`Array` **class_get_method_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const +- :ref:`Array` **class_get_method_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=null **)** const .. _class_ClassDB_class_get_property: @@ -93,7 +93,7 @@ Member Function Description .. _class_ClassDB_class_get_property_list: -- :ref:`Array` **class_get_property_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const +- :ref:`Array` **class_get_property_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=null **)** const .. _class_ClassDB_class_get_signal: @@ -101,7 +101,7 @@ Member Function Description .. _class_ClassDB_class_get_signal_list: -- :ref:`Array` **class_get_signal_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const +- :ref:`Array` **class_get_signal_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=null **)** const .. _class_ClassDB_class_has_integer_constant: @@ -109,7 +109,7 @@ Member Function Description .. _class_ClassDB_class_has_method: -- :ref:`bool` **class_has_method** **(** :ref:`String` class, :ref:`String` method, :ref:`bool` no_inheritance=false **)** const +- :ref:`bool` **class_has_method** **(** :ref:`String` class, :ref:`String` method, :ref:`bool` no_inheritance=null **)** const .. _class_ClassDB_class_has_signal: @@ -117,7 +117,7 @@ Member Function Description .. _class_ClassDB_class_set_property: -- Error **class_set_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** const +- :ref:`int` **class_set_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** const .. _class_ClassDB_get_class_list: diff --git a/classes/class_collisionobject.rst b/classes/class_collisionobject.rst index ec66abc8e..03b55a423 100644 --- a/classes/class_collisionobject.rst +++ b/classes/class_collisionobject.rst @@ -23,30 +23,46 @@ Member Functions +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_input_event` **(** :ref:`Object` camera, :ref:`InputEvent` event, :ref:`Vector3` click_pos, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** virtual | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_capture_input_on_drag` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`create_shape_owner` **(** :ref:`Object` owner **)** | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_capture_input_on_drag` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_rid` **(** **)** const | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_shape_owners` **(** **)** | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_clear_shapes` **(** :ref:`int` owner_id **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape` | :ref:`shape_owner_get_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shape_owner_get_shape_count` **(** :ref:`int` owner_id **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`shape_owner_get_transform` **(** :ref:`int` owner_id **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_remove_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_ray_pickable` **(** **)** const | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_shape_owner_disabled` **(** :ref:`int` owner_id **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_shape_owner` **(** :ref:`int` owner_id **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_capture_input_on_drag` **(** :ref:`bool` enable **)** | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ray_pickable` **(** :ref:`bool` ray_pickable **)** | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shape_find_owner` **(** :ref:`int` shape_index **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_add_shape` **(** :ref:`int` owner_id, :ref:`Shape` shape **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_clear_shapes` **(** :ref:`int` owner_id **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`shape_owner_get_owner` **(** :ref:`int` owner_id **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shape` | :ref:`shape_owner_get_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shape_owner_get_shape_count` **(** :ref:`int` owner_id **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shape_owner_get_shape_index` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`shape_owner_get_transform` **(** :ref:`int` owner_id **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_remove_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_set_disabled` **(** :ref:`int` owner_id, :ref:`bool` disabled **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_set_transform` **(** :ref:`int` owner_id, :ref:`Transform` transform **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -68,16 +84,16 @@ Member Function Description - void **_input_event** **(** :ref:`Object` camera, :ref:`InputEvent` event, :ref:`Vector3` click_pos, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** virtual -.. _class_CollisionObject_get_capture_input_on_drag: - -- :ref:`bool` **get_capture_input_on_drag** **(** **)** const - .. _class_CollisionObject_create_shape_owner: - :ref:`int` **create_shape_owner** **(** :ref:`Object` owner **)** Creates new holder for the shapes. Argument is a :ref:`CollisionShape` node. It will return owner_id which usually you will want to save for later use. +.. _class_CollisionObject_get_capture_input_on_drag: + +- :ref:`bool` **get_capture_input_on_drag** **(** **)** const + .. _class_CollisionObject_get_rid: - :ref:`RID` **get_rid** **(** **)** const @@ -88,40 +104,18 @@ Creates new holder for the shapes. Argument is a :ref:`CollisionShape` owner_id **)** - -Will remove all the shapes associated with given owner. - -.. _class_CollisionObject_shape_owner_get_shape: - -- :ref:`Shape` **shape_owner_get_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** - -Will return a :ref:`Shape`. First argument owner_id is an integer that can be obtained from :ref:`get_shape_owners`. Shape_id is a position of the shape inside owner; it's a value in range from 0 to :ref:`shape_owner_get_shape_count`. - -.. _class_CollisionObject_shape_owner_get_shape_count: - -- :ref:`int` **shape_owner_get_shape_count** **(** :ref:`int` owner_id **)** - -Returns number of shapes to which given owner is associated to. - -.. _class_CollisionObject_shape_owner_get_transform: - -- :ref:`Transform` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** - -Will return :ref:`Transform` of an owner node. - -.. _class_CollisionObject_shape_owner_remove_shape: - -- void **shape_owner_remove_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** - -Removes related shape from the owner. - .. _class_CollisionObject_is_ray_pickable: - :ref:`bool` **is_ray_pickable** **(** **)** const +.. _class_CollisionObject_is_shape_owner_disabled: + +- :ref:`bool` **is_shape_owner_disabled** **(** :ref:`int` owner_id **)** const + +.. _class_CollisionObject_remove_shape_owner: + +- void **remove_shape_owner** **(** :ref:`int` owner_id **)** + .. _class_CollisionObject_set_capture_input_on_drag: - void **set_capture_input_on_drag** **(** :ref:`bool` enable **)** @@ -130,4 +124,58 @@ Removes related shape from the owner. - void **set_ray_pickable** **(** :ref:`bool` ray_pickable **)** +.. _class_CollisionObject_shape_find_owner: + +- :ref:`int` **shape_find_owner** **(** :ref:`int` shape_index **)** const + +.. _class_CollisionObject_shape_owner_add_shape: + +- void **shape_owner_add_shape** **(** :ref:`int` owner_id, :ref:`Shape` shape **)** + +.. _class_CollisionObject_shape_owner_clear_shapes: + +- void **shape_owner_clear_shapes** **(** :ref:`int` owner_id **)** + +Will remove all the shapes associated with given owner. + +.. _class_CollisionObject_shape_owner_get_owner: + +- :ref:`Object` **shape_owner_get_owner** **(** :ref:`int` owner_id **)** const + +.. _class_CollisionObject_shape_owner_get_shape: + +- :ref:`Shape` **shape_owner_get_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const + +Will return a :ref:`Shape`. First argument owner_id is an integer that can be obtained from :ref:`get_shape_owners`. Shape_id is a position of the shape inside owner; it's a value in range from 0 to :ref:`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 number of shapes to which given owner is associated to. + +.. _class_CollisionObject_shape_owner_get_shape_index: + +- :ref:`int` **shape_owner_get_shape_index** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const + +.. _class_CollisionObject_shape_owner_get_transform: + +- :ref:`Transform` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** const + +Will return :ref:`Transform` of an owner node. + +.. _class_CollisionObject_shape_owner_remove_shape: + +- void **shape_owner_remove_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** + +Removes related shape from the owner. + +.. _class_CollisionObject_shape_owner_set_disabled: + +- void **shape_owner_set_disabled** **(** :ref:`int` owner_id, :ref:`bool` disabled **)** + +.. _class_CollisionObject_shape_owner_set_transform: + +- void **shape_owner_set_transform** **(** :ref:`int` owner_id, :ref:`Transform` transform **)** + diff --git a/classes/class_collisionobject2d.rst b/classes/class_collisionobject2d.rst index c3d2024a0..c587e46e7 100644 --- a/classes/class_collisionobject2d.rst +++ b/classes/class_collisionobject2d.rst @@ -29,19 +29,39 @@ Member Functions +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_shape_owners` **(** **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_pickable` **(** **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_shape_owner_disabled` **(** :ref:`int` owner_id **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_shape_owner_one_way_collision_enabled` **(** :ref:`int` owner_id **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_shape_owner` **(** :ref:`int` owner_id **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pickable` **(** :ref:`bool` enabled **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shape_find_owner` **(** :ref:`int` shape_index **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_add_shape` **(** :ref:`int` owner_id, :ref:`Shape2D` shape **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shape_owner_clear_shapes` **(** :ref:`int` owner_id **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape2D` | :ref:`shape_owner_get_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** | +| :ref:`Object` | :ref:`shape_owner_get_owner` **(** :ref:`int` owner_id **)** const | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shape_owner_get_shape_count` **(** :ref:`int` owner_id **)** | +| :ref:`Shape2D` | :ref:`shape_owner_get_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`shape_owner_get_transform` **(** :ref:`int` owner_id **)** | +| :ref:`int` | :ref:`shape_owner_get_shape_count` **(** :ref:`int` owner_id **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shape_owner_get_shape_index` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`shape_owner_get_transform` **(** :ref:`int` owner_id **)** const | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shape_owner_remove_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pickable` **(** **)** const | +| void | :ref:`shape_owner_set_disabled` **(** :ref:`int` owner_id, :ref:`bool` disabled **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pickable` **(** :ref:`bool` enabled **)** | +| void | :ref:`shape_owner_set_one_way_collision` **(** :ref:`int` owner_id, :ref:`bool` enable **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_set_transform` **(** :ref:`int` owner_id, :ref:`Transform2D` transform **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -90,27 +110,67 @@ Return the RID of this object. Shape owner is a node which is holding concrete shape resources. This method will return an array which is holding an integer numbers that are representing unique ID of each owner. You can use those ids when you are using others shape_owner methods. +.. _class_CollisionObject2D_is_pickable: + +- :ref:`bool` **is_pickable** **(** **)** const + +Return whether this object is pickable. + +.. _class_CollisionObject2D_is_shape_owner_disabled: + +- :ref:`bool` **is_shape_owner_disabled** **(** :ref:`int` owner_id **)** const + +.. _class_CollisionObject2D_is_shape_owner_one_way_collision_enabled: + +- :ref:`bool` **is_shape_owner_one_way_collision_enabled** **(** :ref:`int` owner_id **)** const + +.. _class_CollisionObject2D_remove_shape_owner: + +- void **remove_shape_owner** **(** :ref:`int` owner_id **)** + +.. _class_CollisionObject2D_set_pickable: + +- void **set_pickable** **(** :ref:`bool` enabled **)** + +Set whether this object is pickable. A pickable object can detect the mouse pointer enter/leave it and, if the mouse is inside it, report input events. + +.. _class_CollisionObject2D_shape_find_owner: + +- :ref:`int` **shape_find_owner** **(** :ref:`int` shape_index **)** const + +.. _class_CollisionObject2D_shape_owner_add_shape: + +- void **shape_owner_add_shape** **(** :ref:`int` owner_id, :ref:`Shape2D` shape **)** + .. _class_CollisionObject2D_shape_owner_clear_shapes: - void **shape_owner_clear_shapes** **(** :ref:`int` owner_id **)** Will remove all the shapes associated with given owner. +.. _class_CollisionObject2D_shape_owner_get_owner: + +- :ref:`Object` **shape_owner_get_owner** **(** :ref:`int` owner_id **)** const + .. _class_CollisionObject2D_shape_owner_get_shape: -- :ref:`Shape2D` **shape_owner_get_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** +- :ref:`Shape2D` **shape_owner_get_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const Will return a :ref:`Shape2D`. First argument owner_id is an integer that can be obtained from :ref:`get_shape_owners`. Shape_id is a position of the shape inside owner; it's a value in range from 0 to :ref:`shape_owner_get_shape_count`. .. _class_CollisionObject2D_shape_owner_get_shape_count: -- :ref:`int` **shape_owner_get_shape_count** **(** :ref:`int` owner_id **)** +- :ref:`int` **shape_owner_get_shape_count** **(** :ref:`int` owner_id **)** const Returns number of shapes to which given owner is associated to. +.. _class_CollisionObject2D_shape_owner_get_shape_index: + +- :ref:`int` **shape_owner_get_shape_index** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const + .. _class_CollisionObject2D_shape_owner_get_transform: -- :ref:`Transform2D` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** +- :ref:`Transform2D` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** const Will return :ref:`Transform2D` of an owner node. @@ -120,16 +180,16 @@ Will return :ref:`Transform2D` of an owner node. Removes related shape from the owner. -.. _class_CollisionObject2D_is_pickable: +.. _class_CollisionObject2D_shape_owner_set_disabled: -- :ref:`bool` **is_pickable** **(** **)** const +- void **shape_owner_set_disabled** **(** :ref:`int` owner_id, :ref:`bool` disabled **)** -Return whether this object is pickable. +.. _class_CollisionObject2D_shape_owner_set_one_way_collision: -.. _class_CollisionObject2D_set_pickable: +- void **shape_owner_set_one_way_collision** **(** :ref:`int` owner_id, :ref:`bool` enable **)** -- void **set_pickable** **(** :ref:`bool` enabled **)** +.. _class_CollisionObject2D_shape_owner_set_transform: -Set whether this object is pickable. A pickable object can detect the mouse pointer enter/leave it and, if the mouse is inside it, report input events. +- void **shape_owner_set_transform** **(** :ref:`int` owner_id, :ref:`Transform2D` transform **)** diff --git a/classes/class_collisionshape.rst b/classes/class_collisionshape.rst index 068f0c53e..377e0eb1a 100644 --- a/classes/class_collisionshape.rst +++ b/classes/class_collisionshape.rst @@ -18,19 +18,19 @@ Brief Description Member Functions ---------------- -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_shape` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_disabled` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`make_convex_from_brothers` **(** **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resource_changed` **(** :ref:`Object` resource **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disabled` **(** :ref:`bool` enable **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape` **(** :ref:`Object` shape **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shape` | :ref:`get_shape` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_disabled` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`make_convex_from_brothers` **(** **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resource_changed` **(** :ref:`Resource` resource **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disabled` **(** :ref:`bool` enable **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape` **(** :ref:`Shape` shape **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -43,7 +43,7 @@ Member Function Description .. _class_CollisionShape_get_shape: -- :ref:`Object` **get_shape** **(** **)** const +- :ref:`Shape` **get_shape** **(** **)** const .. _class_CollisionShape_is_disabled: @@ -55,7 +55,7 @@ Member Function Description .. _class_CollisionShape_resource_changed: -- void **resource_changed** **(** :ref:`Object` resource **)** +- void **resource_changed** **(** :ref:`Resource` resource **)** .. _class_CollisionShape_set_disabled: @@ -63,6 +63,6 @@ Member Function Description .. _class_CollisionShape_set_shape: -- void **set_shape** **(** :ref:`Object` shape **)** +- void **set_shape** **(** :ref:`Shape` shape **)** diff --git a/classes/class_collisionshape2d.rst b/classes/class_collisionshape2d.rst index 189b34435..088139567 100644 --- a/classes/class_collisionshape2d.rst +++ b/classes/class_collisionshape2d.rst @@ -18,19 +18,19 @@ Editor-only class for easy editing of shapes. Member Functions ---------------- -+------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_shape` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_disabled` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_one_way_collision_enabled` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disabled` **(** :ref:`bool` disabled **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_one_way_collision` **(** :ref:`bool` enabled **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape` **(** :ref:`Object` shape **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shape2D` | :ref:`get_shape` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_disabled` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_one_way_collision_enabled` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disabled` **(** :ref:`bool` disabled **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_one_way_collision` **(** :ref:`bool` enabled **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape` **(** :ref:`Shape2D` shape **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -49,7 +49,7 @@ Member Function Description .. _class_CollisionShape2D_get_shape: -- :ref:`Object` **get_shape** **(** **)** const +- :ref:`Shape2D` **get_shape** **(** **)** const Return this shape's :ref:`Shape2D`. @@ -71,7 +71,7 @@ Return this shape's :ref:`Shape2D`. .. _class_CollisionShape2D_set_shape: -- void **set_shape** **(** :ref:`Object` shape **)** +- void **set_shape** **(** :ref:`Shape2D` shape **)** Set this shape's :ref:`Shape2D`. This will not appear as a node, but can be directly edited as a property. diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index 410550f92..f2641ba15 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -19,7 +19,7 @@ Member Functions ---------------- +----------------------------+-------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_preset` **(** :ref:`Color` arg0 **)** | +| void | :ref:`add_preset` **(** :ref:`Color` color **)** | +----------------------------+-------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_pick_color` **(** **)** const | +----------------------------+-------------------------------------------------------------------------------------------------------+ @@ -51,7 +51,7 @@ Member Function Description .. _class_ColorPicker_add_preset: -- void **add_preset** **(** :ref:`Color` arg0 **)** +- void **add_preset** **(** :ref:`Color` color **)** Adds the current selected to color to a list of colors (presets), the presets will be displayed in the color picker and the user will be able to select them, notice that the presets list is only for this color picker. diff --git a/classes/class_configfile.rst b/classes/class_configfile.rst index ac455d201..77c00a569 100644 --- a/classes/class_configfile.rst +++ b/classes/class_configfile.rst @@ -25,15 +25,15 @@ Member Functions +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolStringArray` | :ref:`get_sections` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_value` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=NULL **)** const | +| :ref:`Variant` | :ref:`get_value` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_section` **(** :ref:`String` section **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_section_key` **(** :ref:`String` section, :ref:`String` key **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`load` **(** :ref:`String` path **)** | +| :ref:`int` | :ref:`load` **(** :ref:`String` path **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`save` **(** :ref:`String` path **)** | +| :ref:`int` | :ref:`save` **(** :ref:`String` path **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_value` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` value **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -79,7 +79,7 @@ Return an array of all defined section identifiers. .. _class_ConfigFile_get_value: -- :ref:`Variant` **get_value** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=NULL **)** const +- :ref:`Variant` **get_value** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** const Return 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 (and thus ``NULL`` if not specified). @@ -97,13 +97,13 @@ Check if the specified section-key pair exists. .. _class_ConfigFile_load: -- Error **load** **(** :ref:`String` path **)** +- :ref:`int` **load** **(** :ref:`String` path **)** Load the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object from which the method was called. The return value is one of the OK, FAILED or ERR\_\* constants listed in :ref:`@Global Scope` (if the load was successful, it returns OK). .. _class_ConfigFile_save: -- Error **save** **(** :ref:`String` path **)** +- :ref:`int` **save** **(** :ref:`String` path **)** Save the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. diff --git a/classes/class_container.rst b/classes/class_container.rst index 9ed540849..0ddd32af4 100644 --- a/classes/class_container.rst +++ b/classes/class_container.rst @@ -8,7 +8,7 @@ Container **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`PanelContainer`, :ref:`GridContainer`, :ref:`ScrollContainer`, :ref:`ViewportContainer`, :ref:`CenterContainer`, :ref:`MarginContainer`, :ref:`GraphNode`, :ref:`SplitContainer`, :ref:`BoxContainer` +**Inherited By:** :ref:`PanelContainer`, :ref:`GridContainer`, :ref:`ScrollContainer`, :ref:`ViewportContainer`, :ref:`MarginContainer`, :ref:`CenterContainer`, :ref:`GraphNode`, :ref:`SplitContainer`, :ref:`BoxContainer` **Category:** Core diff --git a/classes/class_control.rst b/classes/class_control.rst index a0b26447f..91c05dcd9 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -20,199 +20,201 @@ Control is the base node for all the GUI components. Member Functions ---------------- -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`_get_minimum_size` **(** **)** virtual | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_gui_input` **(** :ref:`InputEvent` event **)** virtual | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`accept_event` **(** **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_color_override` **(** :ref:`String` name, :ref:`Color` color **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_constant_override` **(** :ref:`String` name, :ref:`int` constant **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_font_override` **(** :ref:`String` name, :ref:`Font` font **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_override` **(** :ref:`String` name, :ref:`Texture` texture **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_shader_override` **(** :ref:`String` name, :ref:`Shader` shader **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_style_override` **(** :ref:`String` name, :ref:`StyleBox` stylebox **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_drop_data` **(** :ref:`Vector2` pos, :ref:`Variant` data **)** virtual | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`drop_data` **(** :ref:`Vector2` pos, :ref:`Variant` data **)** virtual | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`force_drag` **(** :ref:`Variant` data, :ref:`Object` preview **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_anchor` **(** :ref:`int` margin **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_begin` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** :ref:`String` name, :ref:`String` type="" **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_combined_minimum_size` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_constant` **(** :ref:`String` name, :ref:`String` type="" **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cursor_shape` **(** :ref:`Vector2` pos=Vector2(0, 0) **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_custom_minimum_size` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_default_cursor_shape` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_drag_data` **(** :ref:`Vector2` pos **)** virtual | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_end` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_focus_mode` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_focus_neighbour` **(** :ref:`int` margin **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_focus_owner` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Font` | :ref:`get_font` **(** :ref:`String` name, :ref:`String` type="" **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_global_position` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_global_rect` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_h_grow_direction` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_h_size_flags` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_icon` **(** :ref:`String` name, :ref:`String` type="" **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_margin` **(** :ref:`int` margin **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_minimum_size` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mouse_filter` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_parent_area_size` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_parent_control` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_pivot_offset` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_position` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_rect` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotation` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotation_deg` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scale` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_stretch_ratio` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`get_stylebox` **(** :ref:`String` name, :ref:`String` type="" **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Theme` | :ref:`get_theme` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tooltip` **(** :ref:`Vector2` atpos=Vector2(0, 0) **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_v_grow_direction` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_v_size_flags` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`grab_click_focus` **(** **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`grab_focus` **(** **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_color` **(** :ref:`String` name, :ref:`String` type="" **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_color_override` **(** :ref:`String` name **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_constant` **(** :ref:`String` name, :ref:`String` type="" **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_constant_override` **(** :ref:`String` name **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_focus` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_font` **(** :ref:`String` name, :ref:`String` type="" **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_font_override` **(** :ref:`String` name **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_icon` **(** :ref:`String` name, :ref:`String` type="" **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_icon_override` **(** :ref:`String` name **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`has_point` **(** :ref:`Vector2` point **)** virtual | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_stylebox` **(** :ref:`String` name, :ref:`String` type="" **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_stylebox_override` **(** :ref:`String` name **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_clipping_contents` **(** **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`minimum_size_changed` **(** **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`release_focus` **(** **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anchor` **(** :ref:`int` margin, :ref:`int` anchor_mode, :ref:`bool` keep_margin=false **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anchor_and_margin` **(** :ref:`int` margin, :ref:`int` anchor_mode, :ref:`float` offset **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_area_as_parent_rect` **(** :ref:`int` margin=0 **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_begin` **(** :ref:`Vector2` pos **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_clip_contents` **(** :ref:`bool` enable **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_minimum_size` **(** :ref:`Vector2` size **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_cursor_shape` **(** :ref:`int` shape **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_drag_forwarding` **(** :ref:`Control` target **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_drag_preview` **(** :ref:`Control` control **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_end` **(** :ref:`Vector2` pos **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_focus_mode` **(** :ref:`int` mode **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_focus_neighbour` **(** :ref:`int` margin, :ref:`NodePath` neighbour **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_position` **(** :ref:`Vector2` pos **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_grow_direction` **(** :ref:`int` direction **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_size_flags` **(** :ref:`int` flags **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_margin` **(** :ref:`int` margin, :ref:`float` offset **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mouse_filter` **(** :ref:`int` filter **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pivot_offset` **(** :ref:`Vector2` pivot_offset **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_position` **(** :ref:`Vector2` pos **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation` **(** :ref:`float` radians **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation_deg` **(** :ref:`float` degrees **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scale` **(** :ref:`Vector2` scale **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stretch_ratio` **(** :ref:`float` ratio **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_theme` **(** :ref:`Theme` theme **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tooltip` **(** :ref:`String` tooltip **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_grow_direction` **(** :ref:`int` direction **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_size_flags` **(** :ref:`int` flags **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`show_modal` **(** :ref:`bool` exclusive=false **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`warp_mouse` **(** :ref:`Vector2` to_pos **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`_get_minimum_size` **(** **)** virtual | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_gui_input` **(** :ref:`InputEvent` event **)** virtual | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`accept_event` **(** **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_color_override` **(** :ref:`String` name, :ref:`Color` color **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_constant_override` **(** :ref:`String` name, :ref:`int` constant **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_font_override` **(** :ref:`String` name, :ref:`Font` font **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_override` **(** :ref:`String` name, :ref:`Texture` texture **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_shader_override` **(** :ref:`String` name, :ref:`Shader` shader **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_style_override` **(** :ref:`String` name, :ref:`StyleBox` stylebox **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_drop_data` **(** :ref:`Vector2` pos, :ref:`Variant` data **)** virtual | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`drop_data` **(** :ref:`Vector2` pos, :ref:`Variant` data **)** virtual | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_drag` **(** :ref:`Variant` data, :ref:`Control` preview **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_anchor` **(** :ref:`int` margin **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_begin` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_color` **(** :ref:`String` name, :ref:`String` type=null **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_combined_minimum_size` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_constant` **(** :ref:`String` name, :ref:`String` type=null **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cursor_shape` **(** :ref:`Vector2` pos=Vector2( 0, 0 ) **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_custom_minimum_size` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_default_cursor_shape` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_drag_data` **(** :ref:`Vector2` pos **)** virtual | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_end` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_focus_mode` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_focus_neighbour` **(** :ref:`int` margin **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Control` | :ref:`get_focus_owner` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Font` | :ref:`get_font` **(** :ref:`String` name, :ref:`String` type=null **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_global_position` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_global_rect` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_h_grow_direction` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_h_size_flags` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_icon` **(** :ref:`String` name, :ref:`String` type=null **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_margin` **(** :ref:`int` margin **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_minimum_size` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mouse_filter` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_parent_area_size` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Control` | :ref:`get_parent_control` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_pivot_offset` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_position` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_rect` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rotation` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rotation_deg` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_scale` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_stretch_ratio` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StyleBox` | :ref:`get_stylebox` **(** :ref:`String` name, :ref:`String` type=null **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Theme` | :ref:`get_theme` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_tooltip` **(** :ref:`Vector2` atpos=Vector2( 0, 0 ) **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_v_grow_direction` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_v_size_flags` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`grab_click_focus` **(** **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`grab_focus` **(** **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_color` **(** :ref:`String` name, :ref:`String` type=null **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_color_override` **(** :ref:`String` name **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_constant` **(** :ref:`String` name, :ref:`String` type=null **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_constant_override` **(** :ref:`String` name **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_focus` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_font` **(** :ref:`String` name, :ref:`String` type=null **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_font_override` **(** :ref:`String` name **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_icon` **(** :ref:`String` name, :ref:`String` type=null **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_icon_override` **(** :ref:`String` name **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector2` point **)** virtual | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_stylebox` **(** :ref:`String` name, :ref:`String` type=null **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_stylebox_override` **(** :ref:`String` name **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_clipping_contents` **(** **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`minimum_size_changed` **(** **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`release_focus` **(** **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_anchor` **(** :ref:`int` margin, :ref:`float` anchor, :ref:`bool` keep_margin=null, :ref:`bool` push_opposite_anchor=null **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_anchor_and_margin` **(** :ref:`int` margin, :ref:`float` anchor, :ref:`float` offset, :ref:`bool` push_opposite_anchor=null **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_anchors_preset` **(** :ref:`int` preset, :ref:`bool` keep_margin=null **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_area_as_parent_rect` **(** :ref:`int` margin=0 **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_begin` **(** :ref:`Vector2` pos **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_clip_contents` **(** :ref:`bool` enable **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_minimum_size` **(** :ref:`Vector2` size **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_cursor_shape` **(** :ref:`int` shape **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_drag_forwarding` **(** :ref:`Control` target **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_drag_preview` **(** :ref:`Control` control **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_end` **(** :ref:`Vector2` pos **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_focus_mode` **(** :ref:`int` mode **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_focus_neighbour` **(** :ref:`int` margin, :ref:`NodePath` neighbour **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_position` **(** :ref:`Vector2` pos **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_grow_direction` **(** :ref:`int` direction **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_size_flags` **(** :ref:`int` flags **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_margin` **(** :ref:`int` margin, :ref:`float` offset **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mouse_filter` **(** :ref:`int` filter **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pivot_offset` **(** :ref:`Vector2` pivot_offset **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_position` **(** :ref:`Vector2` pos **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotation` **(** :ref:`float` radians **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotation_deg` **(** :ref:`float` degrees **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scale` **(** :ref:`Vector2` scale **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stretch_ratio` **(** :ref:`float` ratio **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_theme` **(** :ref:`Theme` theme **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tooltip` **(** :ref:`String` tooltip **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_grow_direction` **(** :ref:`int` direction **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_size_flags` **(** :ref:`int` flags **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`show_modal` **(** :ref:`bool` exclusive=false **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`warp_mouse` **(** :ref:`Vector2` to_pos **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -244,10 +246,10 @@ Emitted when the size flags changed. Member Variables ---------------- -- :ref:`int` **anchor_bottom** -- :ref:`int` **anchor_left** -- :ref:`int` **anchor_right** -- :ref:`int` **anchor_top** +- :ref:`float` **anchor_bottom** +- :ref:`float` **anchor_left** +- :ref:`float` **anchor_right** +- :ref:`float` **anchor_top** - :ref:`NodePath` **focus_neighbour_bottom** - :ref:`NodePath` **focus_neighbour_left** - :ref:`NodePath` **focus_neighbour_right** @@ -255,10 +257,10 @@ Member Variables - :ref:`int` **grow_horizontal** - :ref:`int` **grow_vertical** - :ref:`String` **hint_tooltip** -- :ref:`int` **margin_bottom** -- :ref:`int` **margin_left** -- :ref:`int` **margin_right** -- :ref:`int` **margin_top** +- :ref:`float` **margin_bottom** +- :ref:`float` **margin_left** +- :ref:`float` **margin_right** +- :ref:`float` **margin_top** - :ref:`int` **mouse_filter** - :ref:`bool` **rect_clip_content** - :ref:`Vector2` **rect_min_size** @@ -268,16 +270,13 @@ Member Variables - :ref:`Vector2` **rect_scale** - :ref:`Vector2` **rect_size** - :ref:`int` **size_flags_horizontal** -- :ref:`int` **size_flags_stretch_ratio** +- :ref:`float` **size_flags_stretch_ratio** - :ref:`int` **size_flags_vertical** - :ref:`Theme` **theme** Numeric Constants ----------------- -- **ANCHOR_BEGIN** = **0** --- X is relative to MARGIN_LEFT, Y is relative to MARGIN_TOP. -- **ANCHOR_END** = **1** --- X is relative to -MARGIN_RIGHT, Y is relative to -MARGIN_BOTTOM. -- **ANCHOR_CENTER** = **2** - **FOCUS_NONE** = **0** --- Control can't acquire focus. - **FOCUS_CLICK** = **1** --- Control can acquire focus only if clicked. - **FOCUS_ALL** = **2** --- Control can acquire focus if clicked, or by pressing TAB/Directionals in the keyboard from another Control. @@ -305,6 +304,22 @@ Numeric Constants - **CURSOR_VSPLIT** = **14** - **CURSOR_HSPLIT** = **15** - **CURSOR_HELP** = **16** +- **PRESET_TOP_LEFT** = **0** +- **PRESET_TOP_RIGHT** = **1** +- **PRESET_BOTTOM_LEFT** = **2** +- **PRESET_BOTTOM_RIGHT** = **3** +- **PRESET_CENTER_LEFT** = **4** +- **PRESET_CENTER_TOP** = **5** +- **PRESET_CENTER_RIGHT** = **6** +- **PRESET_CENTER_BOTTOM** = **7** +- **PRESET_CENTER** = **8** +- **PRESET_LEFT_WIDE** = **9** +- **PRESET_TOP_WIDE** = **10** +- **PRESET_RIGHT_WIDE** = **11** +- **PRESET_BOTTOM_WIDE** = **12** +- **PRESET_VCENTER_WIDE** = **13** +- **PRESET_HCENTER_WIDE** = **14** +- **PRESET_WIDE** = **15** - **SIZE_EXPAND** = **2** - **SIZE_FILL** = **1** - **SIZE_EXPAND_FILL** = **3** @@ -315,6 +330,8 @@ Numeric Constants - **MOUSE_FILTER_IGNORE** = **2** - **GROW_DIRECTION_BEGIN** = **0** - **GROW_DIRECTION_END** = **1** +- **ANCHOR_BEGIN** = **0** --- X is relative to MARGIN_LEFT, Y is relative to MARGIN_TOP. +- **ANCHOR_END** = **1** --- X is relative to -MARGIN_RIGHT, Y is relative to -MARGIN_BOTTOM. Description ----------- @@ -394,11 +411,11 @@ Override a single stylebox (Stylebox) in the theme of this Control. If stylebox .. _class_Control_force_drag: -- void **force_drag** **(** :ref:`Variant` data, :ref:`Object` preview **)** +- void **force_drag** **(** :ref:`Variant` data, :ref:`Control` preview **)** .. _class_Control_get_anchor: -- :ref:`int` **get_anchor** **(** :ref:`int` margin **)** const +- :ref:`float` **get_anchor** **(** :ref:`int` margin **)** const Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). @@ -408,7 +425,7 @@ Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given marg .. _class_Control_get_color: -- :ref:`Color` **get_color** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`Color` **get_color** **(** :ref:`String` name, :ref:`String` type=null **)** const .. _class_Control_get_combined_minimum_size: @@ -416,11 +433,11 @@ Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given marg .. _class_Control_get_constant: -- :ref:`int` **get_constant** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`int` **get_constant** **(** :ref:`String` name, :ref:`String` type=null **)** const .. _class_Control_get_cursor_shape: -- :ref:`int` **get_cursor_shape** **(** :ref:`Vector2` pos=Vector2(0, 0) **)** const +- :ref:`int` **get_cursor_shape** **(** :ref:`Vector2` pos=Vector2( 0, 0 ) **)** const Return the cursor shape at a certain position in the control. @@ -464,7 +481,7 @@ Return which control is owning the keyboard focus, or null if no one. .. _class_Control_get_font: -- :ref:`Font` **get_font** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`Font` **get_font** **(** :ref:`String` name, :ref:`String` type=null **)** const .. _class_Control_get_global_position: @@ -490,7 +507,7 @@ Hint for containers, return horizontal positioning flags. .. _class_Control_get_icon: -- :ref:`Texture` **get_icon** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`Texture` **get_icon** **(** :ref:`String` name, :ref:`String` type=null **)** const .. _class_Control_get_margin: @@ -564,7 +581,7 @@ Hint for containers, return the stretch ratio. This value is relative to other s .. _class_Control_get_stylebox: -- :ref:`StyleBox` **get_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`StyleBox` **get_stylebox** **(** :ref:`String` name, :ref:`String` type=null **)** const .. _class_Control_get_theme: @@ -574,7 +591,7 @@ Return a :ref:`Theme` override, if one exists (see :ref:`set_theme< .. _class_Control_get_tooltip: -- :ref:`String` **get_tooltip** **(** :ref:`Vector2` atpos=Vector2(0, 0) **)** const +- :ref:`String` **get_tooltip** **(** :ref:`Vector2` atpos=Vector2( 0, 0 ) **)** const Return the tooltip, which will appear when the cursor is resting over this control. @@ -600,7 +617,7 @@ Steal the focus from another control and become the focused control (see :ref:`s .. _class_Control_has_color: -- :ref:`bool` **has_color** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`bool` **has_color** **(** :ref:`String` name, :ref:`String` type=null **)** const .. _class_Control_has_color_override: @@ -608,7 +625,7 @@ Steal the focus from another control and become the focused control (see :ref:`s .. _class_Control_has_constant: -- :ref:`bool` **has_constant** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`bool` **has_constant** **(** :ref:`String` name, :ref:`String` type=null **)** const .. _class_Control_has_constant_override: @@ -622,7 +639,7 @@ Return whether the Control is the current focused control (see :ref:`set_focus_m .. _class_Control_has_font: -- :ref:`bool` **has_font** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`bool` **has_font** **(** :ref:`String` name, :ref:`String` type=null **)** const .. _class_Control_has_font_override: @@ -630,7 +647,7 @@ Return whether the Control is the current focused control (see :ref:`set_focus_m .. _class_Control_has_icon: -- :ref:`bool` **has_icon** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`bool` **has_icon** **(** :ref:`String` name, :ref:`String` type=null **)** const .. _class_Control_has_icon_override: @@ -638,11 +655,11 @@ Return whether the Control is the current focused control (see :ref:`set_focus_m .. _class_Control_has_point: -- void **has_point** **(** :ref:`Vector2` point **)** virtual +- :ref:`bool` **has_point** **(** :ref:`Vector2` point **)** virtual .. _class_Control_has_stylebox: -- :ref:`bool` **has_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`bool` **has_stylebox** **(** :ref:`String` name, :ref:`String` type=null **)** const .. _class_Control_has_stylebox_override: @@ -664,17 +681,15 @@ Give up the focus, no other control will be able to receive keyboard input. .. _class_Control_set_anchor: -- void **set_anchor** **(** :ref:`int` margin, :ref:`int` anchor_mode, :ref:`bool` keep_margin=false **)** - -Change the anchor (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) type for a margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Changing the anchor mode converts the current margin offset from the previous anchor mode to the new one, so margin offsets (:ref:`set_margin`) must be done after setting anchors, or at the same time (:ref:`set_anchor_and_margin`) - -Additionally, ``keep_margin`` controls whether margins should be left the same, or changed to keep the same position and size on-screen. +- void **set_anchor** **(** :ref:`int` margin, :ref:`float` anchor, :ref:`bool` keep_margin=null, :ref:`bool` push_opposite_anchor=null **)** .. _class_Control_set_anchor_and_margin: -- void **set_anchor_and_margin** **(** :ref:`int` margin, :ref:`int` anchor_mode, :ref:`float` offset **)** +- void **set_anchor_and_margin** **(** :ref:`int` margin, :ref:`float` anchor, :ref:`float` offset, :ref:`bool` push_opposite_anchor=null **)** -Change the anchor (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) type for a margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM), and also set its offset. This is a helper (see :ref:`set_anchor` and :ref:`set_margin`). +.. _class_Control_set_anchors_preset: + +- void **set_anchors_preset** **(** :ref:`int` preset, :ref:`bool` keep_margin=null **)** .. _class_Control_set_area_as_parent_rect: diff --git a/classes/class_convexpolygonshape.rst b/classes/class_convexpolygonshape.rst index 52aaa07a5..532559d2c 100644 --- a/classes/class_convexpolygonshape.rst +++ b/classes/class_convexpolygonshape.rst @@ -27,7 +27,7 @@ Member Functions Member Variables ---------------- -- :ref:`Array` **points** +- :ref:`PoolVector3Array` **points** Description ----------- diff --git a/classes/class_cubemap.rst b/classes/class_cubemap.rst index f199032ce..de1dfb955 100644 --- a/classes/class_cubemap.rst +++ b/classes/class_cubemap.rst @@ -18,27 +18,27 @@ Brief Description Member Functions ---------------- -+------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_flags` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_height` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_lossy_storage_quality` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_side` **(** :ref:`int` side **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_storage` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_width` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flags` **(** :ref:`int` flags **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_lossy_storage_quality` **(** :ref:`float` quality **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_side` **(** :ref:`int` side, :ref:`Object` image **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_storage` **(** :ref:`int` mode **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_flags` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_height` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_lossy_storage_quality` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`get_side` **(** :ref:`int` side **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_storage` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_width` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flags` **(** :ref:`int` flags **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_lossy_storage_quality` **(** :ref:`float` quality **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_side` **(** :ref:`int` side, :ref:`Image` image **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_storage` **(** :ref:`int` mode **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -74,7 +74,7 @@ Member Function Description .. _class_CubeMap_get_side: -- :ref:`Object` **get_side** **(** :ref:`int` side **)** const +- :ref:`Image` **get_side** **(** :ref:`int` side **)** const .. _class_CubeMap_get_storage: @@ -94,7 +94,7 @@ Member Function Description .. _class_CubeMap_set_side: -- void **set_side** **(** :ref:`int` side, :ref:`Object` image **)** +- void **set_side** **(** :ref:`int` side, :ref:`Image` image **)** .. _class_CubeMap_set_storage: diff --git a/classes/class_cubemesh.rst b/classes/class_cubemesh.rst index 6da3d40f8..e0f3c1a73 100644 --- a/classes/class_cubemesh.rst +++ b/classes/class_cubemesh.rst @@ -39,7 +39,7 @@ Member Functions Member Variables ---------------- -- :ref:`Vector2` **size** +- :ref:`Vector3` **size** - :ref:`int` **subdivide_depth** - :ref:`int` **subdivide_height** - :ref:`int` **subdivide_width** diff --git a/classes/class_curve.rst b/classes/class_curve.rst index 926d91039..064c4b9f8 100644 --- a/classes/class_curve.rst +++ b/classes/class_curve.rst @@ -18,55 +18,55 @@ Brief Description Member Functions ---------------- -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`add_point` **(** :ref:`Vector2` pos, :ref:`float` left_tangent=0, :ref:`float` right_tangent=0, :ref:`int` left_mode=0, :ref:`int` right_mode=0 **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`bake` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clean_dupes` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_points` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bake_resolution` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_max_value` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_min_value` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_left_mode` **(** :ref:`int` index **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_left_tangent` **(** :ref:`int` index **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_pos` **(** :ref:`int` index **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_right_mode` **(** :ref:`int` index **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_right_tangent` **(** :ref:`int` index **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`interpolate` **(** :ref:`float` offset **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`interpolate_baked` **(** :ref:`float` offset **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` index **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bake_resolution` **(** :ref:`int` resolution **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_value` **(** :ref:`float` max **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_min_value` **(** :ref:`float` min **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_left_mode` **(** :ref:`int` index, :ref:`int` mode **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_left_tangent` **(** :ref:`int` index, :ref:`float` tangent **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_offset` **(** :ref:`int` index, :ref:`float` offset **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_right_mode` **(** :ref:`int` index, :ref:`int` mode **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_right_tangent` **(** :ref:`int` index, :ref:`float` tangent **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_value` **(** :ref:`int` index, :ref:`float` y **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`add_point` **(** :ref:`Vector2` pos, :ref:`float` left_tangent=0, :ref:`float` right_tangent=0, :ref:`int` left_mode=0, :ref:`int` right_mode=null **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`bake` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clean_dupes` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_points` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bake_resolution` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_max_value` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_min_value` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_left_mode` **(** :ref:`int` index **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_left_tangent` **(** :ref:`int` index **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_pos` **(** :ref:`int` index **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_right_mode` **(** :ref:`int` index **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_right_tangent` **(** :ref:`int` index **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`interpolate` **(** :ref:`float` offset **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`interpolate_baked` **(** :ref:`float` offset **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` index **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bake_resolution` **(** :ref:`int` resolution **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_value` **(** :ref:`float` max **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_min_value` **(** :ref:`float` min **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_left_mode` **(** :ref:`int` index, :ref:`int` mode **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_left_tangent` **(** :ref:`int` index, :ref:`float` tangent **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_offset` **(** :ref:`int` index, :ref:`float` offset **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_right_mode` **(** :ref:`int` index, :ref:`int` mode **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_right_tangent` **(** :ref:`int` index, :ref:`float` tangent **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_value` **(** :ref:`int` index, :ref:`float` y **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -76,7 +76,7 @@ Signals Member Variables ---------------- -- :ref:`int` **_data** +- :ref:`Array` **_data** - :ref:`int` **bake_resolution** - :ref:`float` **max_value** - :ref:`float` **min_value** @@ -86,7 +86,7 @@ Member Function Description .. _class_Curve_add_point: -- :ref:`int` **add_point** **(** :ref:`Vector2` pos, :ref:`float` left_tangent=0, :ref:`float` right_tangent=0, :ref:`int` left_mode=0, :ref:`int` right_mode=0 **)** +- :ref:`int` **add_point** **(** :ref:`Vector2` pos, :ref:`float` left_tangent=0, :ref:`float` right_tangent=0, :ref:`int` left_mode=0, :ref:`int` right_mode=null **)** .. _class_Curve_bake: diff --git a/classes/class_curve2d.rst b/classes/class_curve2d.rst index ade4c810f..43f5c3947 100644 --- a/classes/class_curve2d.rst +++ b/classes/class_curve2d.rst @@ -18,48 +18,48 @@ Describes a Bezier curve in 2D space. Member Functions ---------------- -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`Vector2` pos, :ref:`Vector2` in=Vector2(0, 0), :ref:`Vector2` out=Vector2(0, 0), :ref:`int` atpos=-1 **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_points` **(** **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bake_interval` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_baked_length` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_baked_points` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_pos` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` idx **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bake_interval` **(** :ref:`float` distance **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector2` pos **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector2` pos **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_pos` **(** :ref:`int` idx, :ref:`Vector2` pos **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`tesselate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`Vector2` pos, :ref:`Vector2` in=Vector2( 0, 0 ), :ref:`Vector2` out=Vector2( 0, 0 ), :ref:`int` atpos=null **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_points` **(** **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bake_interval` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_baked_length` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_baked_points` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_pos` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=null **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` idx **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bake_interval` **(** :ref:`float` distance **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector2` pos **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector2` pos **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_pos` **(** :ref:`int` idx, :ref:`Vector2` pos **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`tessellate` **(** :ref:`int` max_stages=4, :ref:`float` tolerance_degrees=5 **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- -- :ref:`int` **_data** +- :ref:`Dictionary` **_data** - :ref:`float` **bake_interval** Description @@ -74,7 +74,7 @@ Member Function Description .. _class_Curve2D_add_point: -- void **add_point** **(** :ref:`Vector2` pos, :ref:`Vector2` in=Vector2(0, 0), :ref:`Vector2` out=Vector2(0, 0), :ref:`int` atpos=-1 **)** +- void **add_point** **(** :ref:`Vector2` pos, :ref:`Vector2` in=Vector2( 0, 0 ), :ref:`Vector2` out=Vector2( 0, 0 ), :ref:`int` atpos=null **)** Adds a point to a curve, at position "pos", with control points "in" and "out". @@ -136,7 +136,7 @@ If "idx" is out of bounds it is truncated to the first or last vertex, and "t" i .. _class_Curve2D_interpolate_baked: -- :ref:`Vector2` **interpolate_baked** **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const +- :ref:`Vector2` **interpolate_baked** **(** :ref:`float` offset, :ref:`bool` cubic=null **)** const Returns a point within the curve at position "offset", where "offset" is measured as a pixel distance along the curve. @@ -180,9 +180,9 @@ Sets the position of the control point leading out of the vertex "idx". If the i Sets the position for the vertex "idx". If the index is out of bounds, the function sends an error to the console. -.. _class_Curve2D_tesselate: +.. _class_Curve2D_tessellate: -- :ref:`PoolVector2Array` **tesselate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const +- :ref:`PoolVector2Array` **tessellate** **(** :ref:`int` max_stages=4, :ref:`float` tolerance_degrees=5 **)** const Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. diff --git a/classes/class_curve3d.rst b/classes/class_curve3d.rst index dfbd0f4df..24b0c959c 100644 --- a/classes/class_curve3d.rst +++ b/classes/class_curve3d.rst @@ -18,54 +18,54 @@ Describes a Bezier curve in 3D space. Member Functions ---------------- -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`Vector3` pos, :ref:`Vector3` in=Vector3(0, 0, 0), :ref:`Vector3` out=Vector3(0, 0, 0), :ref:`int` atpos=-1 **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_points` **(** **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bake_interval` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_baked_length` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_baked_points` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`get_baked_tilts` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_pos` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_tilt` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` idx **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bake_interval` **(** :ref:`float` distance **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector3` pos **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector3` pos **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_pos` **(** :ref:`int` idx, :ref:`Vector3` pos **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_tilt` **(** :ref:`int` idx, :ref:`float` tilt **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`tesselate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`Vector3` pos, :ref:`Vector3` in=Vector3( 0, 0, 0 ), :ref:`Vector3` out=Vector3( 0, 0, 0 ), :ref:`int` atpos=null **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_points` **(** **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bake_interval` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_baked_length` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_baked_points` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolRealArray` | :ref:`get_baked_tilts` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_pos` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_tilt` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=null **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` idx **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bake_interval` **(** :ref:`float` distance **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector3` pos **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector3` pos **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_pos` **(** :ref:`int` idx, :ref:`Vector3` pos **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_tilt` **(** :ref:`int` idx, :ref:`float` tilt **)** | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`tessellate` **(** :ref:`int` max_stages=4, :ref:`float` tolerance_degrees=5 **)** const | ++--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- -- :ref:`int` **_data** +- :ref:`Dictionary` **_data** - :ref:`float` **bake_interval** Description @@ -80,7 +80,7 @@ Member Function Description .. _class_Curve3D_add_point: -- void **add_point** **(** :ref:`Vector3` pos, :ref:`Vector3` in=Vector3(0, 0, 0), :ref:`Vector3` out=Vector3(0, 0, 0), :ref:`int` atpos=-1 **)** +- void **add_point** **(** :ref:`Vector3` pos, :ref:`Vector3` in=Vector3( 0, 0, 0 ), :ref:`Vector3` out=Vector3( 0, 0, 0 ), :ref:`int` atpos=null **)** Adds a point to a curve, at position "pos", with control points "in" and "out". @@ -154,7 +154,7 @@ If "idx" is out of bounds it is truncated to the first or last vertex, and "t" i .. _class_Curve3D_interpolate_baked: -- :ref:`Vector3` **interpolate_baked** **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const +- :ref:`Vector3` **interpolate_baked** **(** :ref:`float` offset, :ref:`bool` cubic=null **)** const Returns a point within the curve at position "offset", where "offset" is measured as a distance in 3D units along the curve. @@ -206,9 +206,9 @@ 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`, this tilt is an offset over the natural tilt the PathFollow calculates. -.. _class_Curve3D_tesselate: +.. _class_Curve3D_tessellate: -- :ref:`PoolVector3Array` **tesselate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const +- :ref:`PoolVector3Array` **tessellate** **(** :ref:`int` max_stages=4, :ref:`float` tolerance_degrees=5 **)** const Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. diff --git a/classes/class_directionallight.rst b/classes/class_directionallight.rst index dedeb22b8..91b585790 100644 --- a/classes/class_directionallight.rst +++ b/classes/class_directionallight.rst @@ -31,6 +31,7 @@ Member Functions Member Variables ---------------- +- :ref:`float` **directional_shadow_bias_split_scale** - :ref:`bool` **directional_shadow_blend_splits** - :ref:`int` **directional_shadow_mode** - :ref:`float` **directional_shadow_normal_bias** diff --git a/classes/class_directory.rst b/classes/class_directory.rst index ac18f7e43..28d6835a5 100644 --- a/classes/class_directory.rst +++ b/classes/class_directory.rst @@ -19,9 +19,9 @@ Member Functions ---------------- +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`change_dir` **(** :ref:`String` todir **)** | +| :ref:`int` | :ref:`change_dir` **(** :ref:`String` todir **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`copy` **(** :ref:`String` from, :ref:`String` to **)** | +| :ref:`int` | :ref:`copy` **(** :ref:`String` from, :ref:`String` to **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`current_is_dir` **(** **)** const | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -45,15 +45,15 @@ Member Functions +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`list_dir_end` **(** **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`make_dir` **(** :ref:`String` path **)** | +| :ref:`int` | :ref:`make_dir` **(** :ref:`String` path **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`make_dir_recursive` **(** :ref:`String` path **)** | +| :ref:`int` | :ref:`make_dir_recursive` **(** :ref:`String` path **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`open` **(** :ref:`String` path **)** | +| :ref:`int` | :ref:`open` **(** :ref:`String` path **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`remove` **(** :ref:`String` path **)** | +| :ref:`int` | :ref:`remove` **(** :ref:`String` path **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`rename` **(** :ref:`String` from, :ref:`String` to **)** | +| :ref:`int` | :ref:`rename` **(** :ref:`String` from, :ref:`String` to **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description @@ -84,7 +84,7 @@ Member Function Description .. _class_Directory_change_dir: -- Error **change_dir** **(** :ref:`String` todir **)** +- :ref:`int` **change_dir** **(** :ref:`String` todir **)** Change the currently opened directory to the one passed as an argument. The argument can be relative to the current directory (e.g. ``newdir`` or ``../newdir``), or an absolute path (e.g. ``/tmp/newdir`` or ``res://somedir/newdir``). @@ -92,7 +92,7 @@ The method returns one of the error code constants defined in :ref:`@Global Scop .. _class_Directory_copy: -- Error **copy** **(** :ref:`String` from, :ref:`String` to **)** +- :ref:`int` **copy** **(** :ref:`String` from, :ref:`String` to **)** Copy the *from* file to the *to* destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten. @@ -170,7 +170,7 @@ Close the current stream opened with :ref:`list_dir_begin` path **)** +- :ref:`int` **make_dir** **(** :ref:`String` path **)** Create a directory. The argument can be relative to the current directory, or an absolute path. The target directory should be placed in an already existing directory (to create the full path recursively, see :ref:`make_dir_recursive`). @@ -178,7 +178,7 @@ The method returns one of the error code constants defined in :ref:`@Global Scop .. _class_Directory_make_dir_recursive: -- Error **make_dir_recursive** **(** :ref:`String` path **)** +- :ref:`int` **make_dir_recursive** **(** :ref:`String` path **)** Create a target directory and all necessary intermediate directories in its path, by calling :ref:`make_dir` recursively. The argument can be relative to the current directory, or an absolute path. @@ -186,7 +186,7 @@ Return one of the error code constants defined in :ref:`@Global Scope` path **)** +- :ref:`int` **open** **(** :ref:`String` path **)** Open an existing directory of the filesystem. The *path* argument can be within the project tree (``res://folder``), the user directory (``user://folder``) or an absolute path of the user filesystem (e.g. ``/tmp/folder`` or ``C:\tmp\folder``). @@ -194,7 +194,7 @@ The method returns one of the error code constants defined in :ref:`@Global Scop .. _class_Directory_remove: -- Error **remove** **(** :ref:`String` path **)** +- :ref:`int` **remove** **(** :ref:`String` path **)** Delete the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail. @@ -202,7 +202,7 @@ Return one of the error code constants defined in :ref:`@Global Scope` from, :ref:`String` to **)** +- :ref:`int` **rename** **(** :ref:`String` from, :ref:`String` to **)** Rename (move) the *from* file to the *to* destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten. diff --git a/classes/class_editorfilesystem.rst b/classes/class_editorfilesystem.rst index 829fbcbc2..595ac0590 100644 --- a/classes/class_editorfilesystem.rst +++ b/classes/class_editorfilesystem.rst @@ -42,6 +42,7 @@ Signals - **filesystem_changed** **(** **)** Emitted if the filesystem changed. +- **resources_reimported** **(** :ref:`PoolStringArray` resources **)** - **sources_changed** **(** :ref:`bool` exist **)** Emitted if the source of any imported file changed. diff --git a/classes/class_editorfilesystemdirectory.rst b/classes/class_editorfilesystemdirectory.rst index 482289cd2..1b6410783 100644 --- a/classes/class_editorfilesystemdirectory.rst +++ b/classes/class_editorfilesystemdirectory.rst @@ -18,29 +18,31 @@ A diretory for the resource filesystem. Member Functions ---------------- -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_dir_index` **(** :ref:`String` name **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_file_index` **(** :ref:`String` name **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file` **(** :ref:`int` idx **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_file_count` **(** **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file_path` **(** :ref:`int` idx **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file_type` **(** :ref:`int` idx **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorFileSystemDirectory` | :ref:`get_parent` **(** **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_path` **(** **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_subdir` **(** :ref:`int` idx **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_subdir_count` **(** **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_dir_index` **(** :ref:`String` name **)** const | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_file_index` **(** :ref:`String` name **)** const | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file` **(** :ref:`int` idx **)** const | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_file_count` **(** **)** const | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_file_import_is_valid` **(** :ref:`int` idx **)** const | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file_path` **(** :ref:`int` idx **)** const | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file_type` **(** :ref:`int` idx **)** const | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorFileSystemDirectory` | :ref:`get_parent` **(** **)** | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_path` **(** **)** const | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorFileSystemDirectory` | :ref:`get_subdir` **(** :ref:`int` idx **)** | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_subdir_count` **(** **)** const | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- @@ -61,6 +63,10 @@ Member Function Description - :ref:`int` **get_file_count** **(** **)** const +.. _class_EditorFileSystemDirectory_get_file_import_is_valid: + +- :ref:`bool` **get_file_import_is_valid** **(** :ref:`int` idx **)** const + .. _class_EditorFileSystemDirectory_get_file_path: - :ref:`String` **get_file_path** **(** :ref:`int` idx **)** const @@ -83,7 +89,7 @@ Member Function Description .. _class_EditorFileSystemDirectory_get_subdir: -- :ref:`Object` **get_subdir** **(** :ref:`int` idx **)** +- :ref:`EditorFileSystemDirectory` **get_subdir** **(** :ref:`int` idx **)** .. _class_EditorFileSystemDirectory_get_subdir_count: diff --git a/classes/class_editorinterface.rst b/classes/class_editorinterface.rst new file mode 100644 index 000000000..a9d1658c9 --- /dev/null +++ b/classes/class_editorinterface.rst @@ -0,0 +1,122 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. + +.. _class_EditorInterface: + +EditorInterface +=============== + +**Inherits:** :ref:`Node` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`edit_resource` **(** :ref:`Resource` resource **)** | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Control` | :ref:`get_base_control` **(** **)** | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_edited_scene_root` **(** **)** | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorSettings` | :ref:`get_editor_settings` **(** **)** | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Control` | :ref:`get_editor_viewport` **(** **)** | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_open_scenes` **(** **)** const | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorFileSystem` | :ref:`get_resource_filesystem` **(** **)** | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorResourcePreview` | :ref:`get_resource_previewer` **(** **)** | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ScriptEditor` | :ref:`get_script_editor` **(** **)** | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorSelection` | :ref:`get_selection` **(** **)** | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`inspect_object` **(** :ref:`Object` object, :ref:`String` for_property=null **)** | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`make_mesh_previews` **(** :ref:`Array` arg0, :ref:`int` arg1 **)** | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`open_scene_from_path` **(** :ref:`String` scene_filepath **)** | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reload_scene_from_path` **(** :ref:`String` scene_filepath **)** | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`save_scene` **(** **)** | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`save_scene_as` **(** :ref:`String` path, :ref:`bool` with_preview=null **)** | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_EditorInterface_edit_resource: + +- void **edit_resource** **(** :ref:`Resource` resource **)** + +.. _class_EditorInterface_get_base_control: + +- :ref:`Control` **get_base_control** **(** **)** + +.. _class_EditorInterface_get_edited_scene_root: + +- :ref:`Node` **get_edited_scene_root** **(** **)** + +.. _class_EditorInterface_get_editor_settings: + +- :ref:`EditorSettings` **get_editor_settings** **(** **)** + +.. _class_EditorInterface_get_editor_viewport: + +- :ref:`Control` **get_editor_viewport** **(** **)** + +.. _class_EditorInterface_get_open_scenes: + +- :ref:`Array` **get_open_scenes** **(** **)** const + +.. _class_EditorInterface_get_resource_filesystem: + +- :ref:`EditorFileSystem` **get_resource_filesystem** **(** **)** + +.. _class_EditorInterface_get_resource_previewer: + +- :ref:`EditorResourcePreview` **get_resource_previewer** **(** **)** + +.. _class_EditorInterface_get_script_editor: + +- :ref:`ScriptEditor` **get_script_editor** **(** **)** + +.. _class_EditorInterface_get_selection: + +- :ref:`EditorSelection` **get_selection** **(** **)** + +.. _class_EditorInterface_inspect_object: + +- void **inspect_object** **(** :ref:`Object` object, :ref:`String` for_property=null **)** + +.. _class_EditorInterface_make_mesh_previews: + +- :ref:`Array` **make_mesh_previews** **(** :ref:`Array` arg0, :ref:`int` arg1 **)** + +.. _class_EditorInterface_open_scene_from_path: + +- void **open_scene_from_path** **(** :ref:`String` scene_filepath **)** + +.. _class_EditorInterface_reload_scene_from_path: + +- void **reload_scene_from_path** **(** :ref:`String` scene_filepath **)** + +.. _class_EditorInterface_save_scene: + +- :ref:`int` **save_scene** **(** **)** + +.. _class_EditorInterface_save_scene_as: + +- void **save_scene_as** **(** :ref:`String` path, :ref:`bool` with_preview=null **)** + + diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index 6c2193302..5d477d0d3 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -18,99 +18,75 @@ Used by the editor to extend its functionality. Member Functions ---------------- -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ToolButton` | :ref:`add_control_to_bottom_panel` **(** :ref:`Control` control, :ref:`String` title **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_control_to_container` **(** :ref:`int` container, :ref:`Control` control **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_control_to_dock` **(** :ref:`int` slot, :ref:`Control` control **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_custom_type` **(** :ref:`String` type, :ref:`String` base, :ref:`Script` script, :ref:`Texture` icon **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_import_plugin` **(** :ref:`Object` arg0 **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_tool_submenu_item` **(** :ref:`String` name, :ref:`PopupMenu` submenu **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_changes` **(** **)** virtual | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** virtual | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorSpatialGizmo` | :ref:`create_spatial_gizmo` **(** :ref:`Spatial` for_spatial **)** virtual | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit` **(** :ref:`Object` object **)** virtual | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit_resource` **(** :ref:`Object` arg0 **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`forward_canvas_gui_input` **(** :ref:`Transform2D` canvas_xform, :ref:`InputEvent` event **)** virtual | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`forward_draw_over_canvas` **(** :ref:`Transform2D` canvas_xform, :ref:`Control` canvas **)** virtual | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`forward_spatial_gui_input` **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** virtual | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_base_control` **(** **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_breakpoints` **(** **)** virtual | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorSettings` | :ref:`get_editor_settings` **(** **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_edited_scene_root` **(** **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_editor_viewport` **(** **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** virtual | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_open_scenes` **(** **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorFileSystem` | :ref:`get_resource_filesystem` **(** **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorResourcePreview` | :ref:`get_resource_previewer` **(** **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ScriptEditor` | :ref:`get_script_editor` **(** **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorSelection` | :ref:`get_selection` **(** **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_state` **(** **)** virtual | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`UndoRedo` | :ref:`get_undo_redo` **(** **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_window_layout` **(** :ref:`ConfigFile` layout **)** virtual | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`handles` **(** :ref:`Object` object **)** virtual | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_main_screen` **(** **)** virtual | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`hide_bottom_panel` **(** **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`inspect_object` **(** :ref:`Object` object, :ref:`String` for_property="" **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`make_bottom_panel_item_visible` **(** :ref:`Control` item **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`make_visible` **(** :ref:`bool` visible **)** virtual | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`open_scene_from_path` **(** :ref:`String` scene_filepath **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_save_layout` **(** **)** const | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reload_scene_from_path` **(** :ref:`String` scene_filepath **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_control_from_bottom_panel` **(** :ref:`Control` control **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_control_from_docks` **(** :ref:`Control` control **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_custom_type` **(** :ref:`String` type **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_import_plugin` **(** :ref:`Object` arg0 **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`save_external_data` **(** **)** virtual | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_input_event_forwarding_always_enabled` **(** **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_state` **(** :ref:`Dictionary` state **)** virtual | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_window_layout` **(** :ref:`ConfigFile` layout **)** virtual | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_canvas` **(** **)** | -+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ToolButton` | :ref:`add_control_to_bottom_panel` **(** :ref:`Control` control, :ref:`String` title **)** | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_control_to_container` **(** :ref:`int` container, :ref:`Control` control **)** | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_control_to_dock` **(** :ref:`int` slot, :ref:`Control` control **)** | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_custom_type` **(** :ref:`String` type, :ref:`String` base, :ref:`Script` script, :ref:`Texture` icon **)** | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_import_plugin` **(** :ref:`EditorImportPlugin` importer **)** | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_tool_submenu_item` **(** :ref:`String` name, :ref:`Object` submenu **)** | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_changes` **(** **)** virtual | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** virtual | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorSpatialGizmo` | :ref:`create_spatial_gizmo` **(** :ref:`Spatial` for_spatial **)** virtual | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`edit` **(** :ref:`Object` object **)** virtual | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`forward_canvas_gui_input` **(** :ref:`Transform2D` canvas_xform, :ref:`InputEvent` event **)** virtual | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`forward_draw_over_canvas` **(** :ref:`Transform2D` canvas_xform, :ref:`Control` canvas **)** virtual | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`forward_spatial_gui_input` **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** virtual | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_breakpoints` **(** **)** virtual | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorInterface` | :ref:`get_editor_interface` **(** **)** | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_plugin_name` **(** **)** virtual | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_state` **(** **)** virtual | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`UndoRedo` | :ref:`get_undo_redo` **(** **)** | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`get_window_layout` **(** :ref:`ConfigFile` layout **)** virtual | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`handles` **(** :ref:`Object` object **)** virtual | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_main_screen` **(** **)** virtual | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`hide_bottom_panel` **(** **)** | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`make_bottom_panel_item_visible` **(** :ref:`Control` item **)** | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`make_visible` **(** :ref:`bool` visible **)** virtual | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_save_layout` **(** **)** const | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_control_from_bottom_panel` **(** :ref:`Control` control **)** | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_control_from_docks` **(** :ref:`Control` control **)** | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_custom_type` **(** :ref:`String` type **)** | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_import_plugin` **(** :ref:`EditorImportPlugin` importer **)** | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`save_external_data` **(** **)** virtual | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_input_event_forwarding_always_enabled` **(** **)** | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_state` **(** :ref:`Dictionary` state **)** virtual | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_window_layout` **(** :ref:`ConfigFile` layout **)** virtual | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_canvas` **(** **)** | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -118,7 +94,7 @@ Signals - **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. -- **scene_changed** **(** :ref:`Node` scene_root **)** +- **scene_changed** **(** :ref:`Object` scene_root **)** Emitted when user change scene. The argument is a root node of freshly opened scene. - **scene_closed** **(** :ref:`String` filepath **)** @@ -193,11 +169,11 @@ During run-time, this will be a simple object with a script so this function doe .. _class_EditorPlugin_add_import_plugin: -- void **add_import_plugin** **(** :ref:`Object` arg0 **)** +- void **add_import_plugin** **(** :ref:`EditorImportPlugin` importer **)** .. _class_EditorPlugin_add_tool_submenu_item: -- void **add_tool_submenu_item** **(** :ref:`String` name, :ref:`PopupMenu` submenu **)** +- void **add_tool_submenu_item** **(** :ref:`String` name, :ref:`Object` submenu **)** .. _class_EditorPlugin_apply_changes: @@ -225,10 +201,6 @@ This is used for plugins that create gizmos used by the spatial editor. Just che 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_edit_resource: - -- void **edit_resource** **(** :ref:`Object` arg0 **)** - .. _class_EditorPlugin_forward_canvas_gui_input: - :ref:`bool` **forward_canvas_gui_input** **(** :ref:`Transform2D` canvas_xform, :ref:`InputEvent` event **)** virtual @@ -247,71 +219,19 @@ 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_base_control: - -- :ref:`Control` **get_base_control** **(** **)** - -Get a base control where it's safe to place dialogs. Many plugins open dialogs and they need a control as a base to make sure they use the editor icons and theme. - .. _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_settings: +.. _class_EditorPlugin_get_editor_interface: -- :ref:`EditorSettings` **get_editor_settings** **(** **)** +- :ref:`EditorInterface` **get_editor_interface** **(** **)** -Get the general settings for the editor (the same window that appears in the Settings menu). +.. _class_EditorPlugin_get_plugin_name: -.. _class_EditorPlugin_get_edited_scene_root: - -- :ref:`Node` **get_edited_scene_root** **(** **)** - -Returns root node of currently edited scene. - -.. _class_EditorPlugin_get_editor_viewport: - -- :ref:`Control` **get_editor_viewport** **(** **)** - -Get the main editor control. Use this as a parent for main screens. - -.. _class_EditorPlugin_get_name: - -- :ref:`String` **get_name** **(** **)** virtual - -Get the name of the editor plugin. For main scren plugins this is what will appear in the selector (which by default is 2D, 3D, Script). - -.. _class_EditorPlugin_get_open_scenes: - -- :ref:`Array` **get_open_scenes** **(** **)** - -Will return an Array of Strings which represent file paths to currently open scenes. - -.. _class_EditorPlugin_get_resource_filesystem: - -- :ref:`EditorFileSystem` **get_resource_filesystem** **(** **)** - -Get the filesystem cache for all resources in the project. - -.. _class_EditorPlugin_get_resource_previewer: - -- :ref:`EditorResourcePreview` **get_resource_previewer** **(** **)** - -Get tool for generating resource previews. - -.. _class_EditorPlugin_get_script_editor: - -- :ref:`ScriptEditor` **get_script_editor** **(** **)** - -Will return ScriptEditor object which contains informations about state of the scripts which are currently open by the editor. - -.. _class_EditorPlugin_get_selection: - -- :ref:`EditorSelection` **get_selection** **(** **)** - -Get the object that handles the selection of nodes in the Scene Tree editor. +- :ref:`String` **get_plugin_name** **(** **)** virtual .. _class_EditorPlugin_get_state: @@ -347,12 +267,6 @@ Return true if this is a main screen editor plugin (it goes in the main screen s - void **hide_bottom_panel** **(** **)** -.. _class_EditorPlugin_inspect_object: - -- void **inspect_object** **(** :ref:`Object` object, :ref:`String` for_property="" **)** - -Inspect an object in the inspector. - .. _class_EditorPlugin_make_bottom_panel_item_visible: - void **make_bottom_panel_item_visible** **(** :ref:`Control` item **)** @@ -365,24 +279,12 @@ 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_open_scene_from_path: - -- void **open_scene_from_path** **(** :ref:`String` scene_filepath **)** - -Opens scene in editor. Do not use during plugin initialization. If you need, then use it together with :ref:`Object.call_deferred`. - .. _class_EditorPlugin_queue_save_layout: - void **queue_save_layout** **(** **)** const Queue save the project's editor layout. -.. _class_EditorPlugin_reload_scene_from_path: - -- void **reload_scene_from_path** **(** :ref:`String` scene_filepath **)** - -Reloads already loaded editor scene. - .. _class_EditorPlugin_remove_control_from_bottom_panel: - void **remove_control_from_bottom_panel** **(** :ref:`Control` control **)** @@ -403,7 +305,7 @@ Remove a custom type added by :ref:`EditorPlugin.add_custom_type` arg0 **)** +- void **remove_import_plugin** **(** :ref:`EditorImportPlugin` importer **)** .. _class_EditorPlugin_save_external_data: diff --git a/classes/class_editorscript.rst b/classes/class_editorscript.rst index 8b3d83792..c006e3545 100644 --- a/classes/class_editorscript.rst +++ b/classes/class_editorscript.rst @@ -18,13 +18,15 @@ Simple script to perform changes in the currently edited scene. Member Functions ---------------- -+------------------------------+-------------------------------------------------------------------------------------------------------+ -| void | :ref:`_run` **(** **)** virtual | -+------------------------------+-------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_root_node` **(** :ref:`Object` node **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_scene` **(** **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`_run` **(** **)** virtual | ++------------------------------------------------+---------------------------------------------------------------------------------------------------+ +| void | :ref:`add_root_node` **(** :ref:`Node` node **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------+ +| :ref:`EditorInterface` | :ref:`get_editor_interface` **(** **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_scene` **(** **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------+ Description ----------- @@ -40,10 +42,14 @@ Member Function Description .. _class_EditorScript_add_root_node: -- void **add_root_node** **(** :ref:`Object` node **)** +- void **add_root_node** **(** :ref:`Node` node **)** + +.. _class_EditorScript_get_editor_interface: + +- :ref:`EditorInterface` **get_editor_interface** **(** **)** .. _class_EditorScript_get_scene: -- :ref:`Object` **get_scene** **(** **)** +- :ref:`Node` **get_scene** **(** **)** diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index ff385b788..26714576c 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -94,7 +94,7 @@ Get the list of favorite directories for this project. - :ref:`String` **get_project_settings_path** **(** **)** const -Get the specific project settings path. Projects all have an unique sub-directory inside the settings path where project specific settings are saved. +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: diff --git a/classes/class_editorspatialgizmo.rst b/classes/class_editorspatialgizmo.rst index 1140a51ec..caafb91a9 100644 --- a/classes/class_editorspatialgizmo.rst +++ b/classes/class_editorspatialgizmo.rst @@ -18,33 +18,33 @@ Custom gizmo for editing Spatial objects. Member Functions ---------------- -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_segments` **(** :ref:`PoolVector3Array` segments **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_triangles` **(** :ref:`TriangleMesh` triangles **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_handles` **(** :ref:`PoolVector3Array` handles, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_lines` **(** :ref:`PoolVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=false **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_mesh` **(** :ref:`Mesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton=[RID] **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_unscaled_billboard` **(** :ref:`Material` material, :ref:`float` default_scale=1 **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`commit_handle` **(** :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel **)** virtual | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_handle_name` **(** :ref:`int` index **)** virtual | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_handle_value` **(** :ref:`int` index **)** virtual | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`redraw` **(** **)** virtual | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_handle` **(** :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_spatial_node` **(** :ref:`Spatial` node **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_collision_segments` **(** :ref:`PoolVector3Array` segments **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_collision_triangles` **(** :ref:`TriangleMesh` triangles **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_handles` **(** :ref:`PoolVector3Array` handles, :ref:`bool` billboard=false, :ref:`bool` secondary=null **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_lines` **(** :ref:`PoolVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=null **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_mesh` **(** :ref:`ArrayMesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton=null **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_unscaled_billboard` **(** :ref:`Material` material, :ref:`float` default_scale=null **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`commit_handle` **(** :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** virtual | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_handle_name` **(** :ref:`int` index **)** virtual | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_handle_value` **(** :ref:`int` index **)** virtual | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`redraw` **(** **)** virtual | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_handle` **(** :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_spatial_node` **(** :ref:`Node` node **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -66,7 +66,7 @@ Add collision triangles to the gizmo for picking. A :ref:`TriangleMesh` handles, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** +- void **add_handles** **(** :ref:`PoolVector3Array` handles, :ref:`bool` billboard=false, :ref:`bool` secondary=null **)** Add a list of handles (points) which can be used to deform the object being edited. @@ -74,19 +74,17 @@ There are virtual functions which will be called upon editing of these handles. .. _class_EditorSpatialGizmo_add_lines: -- void **add_lines** **(** :ref:`PoolVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=false **)** +- void **add_lines** **(** :ref:`PoolVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=null **)** 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: -- void **add_mesh** **(** :ref:`Mesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton=[RID] **)** - -Add a mesh to the gizmo, this is used for visualization. Call this function during :ref:`redraw`. +- void **add_mesh** **(** :ref:`ArrayMesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton=null **)** .. _class_EditorSpatialGizmo_add_unscaled_billboard: -- void **add_unscaled_billboard** **(** :ref:`Material` material, :ref:`float` default_scale=1 **)** +- void **add_unscaled_billboard** **(** :ref:`Material` material, :ref:`float` default_scale=null **)** Add an unscaled billboard for visualization. Call this function during :ref:`redraw`. @@ -96,7 +94,7 @@ Add an unscaled billboard for visualization. Call this function during :ref:`red .. _class_EditorSpatialGizmo_commit_handle: -- void **commit_handle** **(** :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel **)** virtual +- void **commit_handle** **(** :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** virtual Commit a handle being edited (handles must have been prevously added by :ref:`add_handles`). @@ -132,8 +130,6 @@ The :ref:`Camera` is also provided so screen coordinates can be co .. _class_EditorSpatialGizmo_set_spatial_node: -- void **set_spatial_node** **(** :ref:`Spatial` node **)** - -Call this function once and upon creation of the gizmo, otherwise no other function will work. The argument is the node being edited by the gizmo. +- void **set_spatial_node** **(** :ref:`Node` node **)** diff --git a/classes/class_encodedobjectasid.rst b/classes/class_encodedobjectasid.rst new file mode 100644 index 000000000..b042d0829 --- /dev/null +++ b/classes/class_encodedobjectasid.rst @@ -0,0 +1,38 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. + +.. _class_EncodedObjectAsID: + +EncodedObjectAsID +================= + +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_object_id` **(** **)** const | ++------------------------+----------------------------------------------------------------------------------------------------+ +| void | :ref:`set_object_id` **(** :ref:`int` id **)** | ++------------------------+----------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_EncodedObjectAsID_get_object_id: + +- :ref:`int` **get_object_id** **(** **)** const + +.. _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 d37769d60..4343550fb 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -18,8 +18,6 @@ Brief Description Member Functions ---------------- -+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_custom_level` **(** **)** const | +--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_frames_drawn` **(** **)** | +--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ @@ -35,8 +33,12 @@ Member Functions +--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_version_info` **(** **)** const | +--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_editor_hint` **(** **)** const | ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_in_fixed_frame` **(** **)** const | +--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_editor_hint` **(** :ref:`bool` enabled **)** | ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_iterations_per_second` **(** :ref:`int` iterations_per_second **)** | +--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_target_fps` **(** :ref:`int` target_fps **)** | @@ -47,12 +49,6 @@ Member Functions Member Function Description --------------------------- -.. _class_Engine_get_custom_level: - -- :ref:`String` **get_custom_level** **(** **)** const - -Returns the value of the commandline argument "-level". - .. _class_Engine_get_frames_drawn: - :ref:`int` **get_frames_drawn** **(** **)** @@ -105,10 +101,18 @@ Returns the current engine version information in a Dictionary. "string" - major + minor + patch + status + revision in a single String +.. _class_Engine_is_editor_hint: + +- :ref:`bool` **is_editor_hint** **(** **)** const + .. _class_Engine_is_in_fixed_frame: - :ref:`bool` **is_in_fixed_frame** **(** **)** const +.. _class_Engine_set_editor_hint: + +- void **set_editor_hint** **(** :ref:`bool` enabled **)** + .. _class_Engine_set_iterations_per_second: - void **set_iterations_per_second** **(** :ref:`int` iterations_per_second **)** diff --git a/classes/class_environment.rst b/classes/class_environment.rst index b0996655b..136b5d0aa 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -18,283 +18,283 @@ Brief Description Member Functions ---------------- -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_adjustment_brightness` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_adjustment_color_correction` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_adjustment_contrast` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_adjustment_saturation` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_ambient_light_color` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ambient_light_energy` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ambient_light_sky_contribution` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_background` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_bg_color` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bg_energy` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_canvas_max_layer` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_dof_blur_far_amount` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_dof_blur_far_distance` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_dof_blur_far_quality` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_dof_blur_far_transition` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_dof_blur_near_amount` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_dof_blur_near_distance` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_dof_blur_near_quality` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_dof_blur_near_transition` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_fog_color` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fog_depth_begin` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fog_depth_curve` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fog_height_curve` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fog_height_max` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fog_height_min` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fog_sun_amount` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_fog_sun_color` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fog_transmit_curve` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_glow_blend_mode` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_glow_bloom` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_glow_hdr_bleed_scale` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_glow_hdr_bleed_threshold` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_glow_intensity` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_glow_strength` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`CubeMap` | :ref:`get_sky` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_sky_scale` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssao_bias` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_ssao_color` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssao_direct_light_affect` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssao_intensity` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssao_intensity2` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssao_radius` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssao_radius2` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssr_depth_tolerance` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssr_fade_in` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssr_fade_out` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_ssr_max_steps` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_tonemap_auto_exposure` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tonemap_auto_exposure_grey` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tonemap_auto_exposure_max` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tonemap_auto_exposure_min` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tonemap_auto_exposure_speed` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tonemap_exposure` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_tonemap_white` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tonemapper` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_adjustment_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_dof_blur_far_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_dof_blur_near_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_fog_depth_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_fog_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_fog_height_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_fog_transmit_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_glow_bicubic_upscale_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_glow_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_glow_level_enabled` **(** :ref:`int` idx **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_ssao_blur_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_ssao_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_ssr_enabled` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_ssr_rough` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_adjustment_brightness` **(** :ref:`float` brightness **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_adjustment_color_correction` **(** :ref:`Object` color_correction **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_adjustment_contrast` **(** :ref:`float` contrast **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_adjustment_enable` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_adjustment_saturation` **(** :ref:`float` saturation **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ambient_light_color` **(** :ref:`Color` color **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ambient_light_energy` **(** :ref:`float` energy **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ambient_light_sky_contribution` **(** :ref:`float` energy **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_background` **(** :ref:`int` mode **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bg_color` **(** :ref:`Color` color **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bg_energy` **(** :ref:`float` energy **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_canvas_max_layer` **(** :ref:`int` layer **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_far_amount` **(** :ref:`float` intensity **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_far_distance` **(** :ref:`float` intensity **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_far_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_far_quality` **(** :ref:`int` intensity **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_far_transition` **(** :ref:`float` intensity **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_near_amount` **(** :ref:`float` intensity **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_near_distance` **(** :ref:`float` intensity **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_near_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_near_quality` **(** :ref:`int` level **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dof_blur_near_transition` **(** :ref:`float` intensity **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_color` **(** :ref:`Color` color **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_depth_begin` **(** :ref:`float` distance **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_depth_curve` **(** :ref:`float` curve **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_depth_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_height_curve` **(** :ref:`float` curve **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_height_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_height_max` **(** :ref:`float` height **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_height_min` **(** :ref:`float` height **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_sun_amount` **(** :ref:`float` amount **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_sun_color` **(** :ref:`Color` color **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_transmit_curve` **(** :ref:`float` curve **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fog_transmit_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_glow_bicubic_upscale` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_glow_blend_mode` **(** :ref:`int` mode **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_glow_bloom` **(** :ref:`float` amount **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_glow_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_glow_hdr_bleed_scale` **(** :ref:`float` scale **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_glow_hdr_bleed_threshold` **(** :ref:`float` threshold **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_glow_intensity` **(** :ref:`float` intensity **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_glow_level` **(** :ref:`int` idx, :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_glow_strength` **(** :ref:`float` strength **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sky` **(** :ref:`Sky` sky **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sky_scale` **(** :ref:`float` scale **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_bias` **(** :ref:`float` bias **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_blur` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_color` **(** :ref:`Color` color **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_direct_light_affect` **(** :ref:`float` amount **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_intensity` **(** :ref:`float` intensity **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_intensity2` **(** :ref:`float` intensity **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_radius` **(** :ref:`float` radius **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssao_radius2` **(** :ref:`float` radius **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssr_depth_tolerance` **(** :ref:`float` depth_tolerance **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssr_enabled` **(** :ref:`bool` enabled **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssr_fade_in` **(** :ref:`float` fade_in **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssr_fade_out` **(** :ref:`float` fade_out **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssr_max_steps` **(** :ref:`int` max_steps **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssr_rough` **(** :ref:`bool` rough **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tonemap_auto_exposure` **(** :ref:`bool` auto_exposure **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tonemap_auto_exposure_grey` **(** :ref:`float` exposure_grey **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tonemap_auto_exposure_max` **(** :ref:`float` exposure_max **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tonemap_auto_exposure_min` **(** :ref:`float` exposure_min **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tonemap_auto_exposure_speed` **(** :ref:`float` exposure_speed **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tonemap_exposure` **(** :ref:`float` exposure **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tonemap_white` **(** :ref:`float` white **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tonemapper` **(** :ref:`int` mode **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_adjustment_brightness` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_adjustment_color_correction` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_adjustment_contrast` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_adjustment_saturation` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_ambient_light_color` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ambient_light_energy` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ambient_light_sky_contribution` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_background` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_bg_color` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bg_energy` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_canvas_max_layer` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_dof_blur_far_amount` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_dof_blur_far_distance` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_dof_blur_far_quality` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_dof_blur_far_transition` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_dof_blur_near_amount` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_dof_blur_near_distance` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_dof_blur_near_quality` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_dof_blur_near_transition` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_fog_color` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fog_depth_begin` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fog_depth_curve` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fog_height_curve` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fog_height_max` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fog_height_min` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fog_sun_amount` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_fog_sun_color` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fog_transmit_curve` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_glow_blend_mode` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_glow_bloom` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_glow_hdr_bleed_scale` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_glow_hdr_bleed_threshold` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_glow_intensity` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_glow_strength` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Sky` | :ref:`get_sky` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_sky_scale` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ssao_bias` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_ssao_color` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ssao_direct_light_affect` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ssao_intensity` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ssao_intensity2` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ssao_radius` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ssao_radius2` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ssr_depth_tolerance` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ssr_fade_in` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ssr_fade_out` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_ssr_max_steps` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_tonemap_auto_exposure` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tonemap_auto_exposure_grey` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tonemap_auto_exposure_max` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tonemap_auto_exposure_min` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tonemap_auto_exposure_speed` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tonemap_exposure` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_tonemap_white` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tonemapper` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_adjustment_enabled` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_dof_blur_far_enabled` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_dof_blur_near_enabled` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_fog_depth_enabled` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_fog_enabled` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_fog_height_enabled` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_fog_transmit_enabled` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_glow_bicubic_upscale_enabled` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_glow_enabled` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_glow_level_enabled` **(** :ref:`int` idx **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_ssao_blur_enabled` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_ssao_enabled` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_ssr_enabled` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_ssr_rough` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_adjustment_brightness` **(** :ref:`float` brightness **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_adjustment_color_correction` **(** :ref:`Texture` color_correction **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_adjustment_contrast` **(** :ref:`float` contrast **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_adjustment_enable` **(** :ref:`bool` enabled **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_adjustment_saturation` **(** :ref:`float` saturation **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ambient_light_color` **(** :ref:`Color` color **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ambient_light_energy` **(** :ref:`float` energy **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ambient_light_sky_contribution` **(** :ref:`float` energy **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_background` **(** :ref:`int` mode **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bg_color` **(** :ref:`Color` color **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bg_energy` **(** :ref:`float` energy **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_canvas_max_layer` **(** :ref:`int` layer **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_far_amount` **(** :ref:`float` intensity **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_far_distance` **(** :ref:`float` intensity **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_far_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_far_quality` **(** :ref:`int` intensity **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_far_transition` **(** :ref:`float` intensity **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_near_amount` **(** :ref:`float` intensity **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_near_distance` **(** :ref:`float` intensity **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_near_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_near_quality` **(** :ref:`int` level **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dof_blur_near_transition` **(** :ref:`float` intensity **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_color` **(** :ref:`Color` color **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_depth_begin` **(** :ref:`float` distance **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_depth_curve` **(** :ref:`float` curve **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_depth_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_height_curve` **(** :ref:`float` curve **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_height_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_height_max` **(** :ref:`float` height **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_height_min` **(** :ref:`float` height **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_sun_amount` **(** :ref:`float` amount **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_sun_color` **(** :ref:`Color` color **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_transmit_curve` **(** :ref:`float` curve **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_transmit_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_glow_bicubic_upscale` **(** :ref:`bool` enabled **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_glow_blend_mode` **(** :ref:`int` mode **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_glow_bloom` **(** :ref:`float` amount **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_glow_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_glow_hdr_bleed_scale` **(** :ref:`float` scale **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_glow_hdr_bleed_threshold` **(** :ref:`float` threshold **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_glow_intensity` **(** :ref:`float` intensity **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_glow_level` **(** :ref:`int` idx, :ref:`bool` enabled **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_glow_strength` **(** :ref:`float` strength **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sky` **(** :ref:`Sky` sky **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sky_scale` **(** :ref:`float` scale **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssao_bias` **(** :ref:`float` bias **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssao_blur` **(** :ref:`bool` enabled **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssao_color` **(** :ref:`Color` color **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssao_direct_light_affect` **(** :ref:`float` amount **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssao_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssao_intensity` **(** :ref:`float` intensity **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssao_intensity2` **(** :ref:`float` intensity **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssao_radius` **(** :ref:`float` radius **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssao_radius2` **(** :ref:`float` radius **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssr_depth_tolerance` **(** :ref:`float` depth_tolerance **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssr_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssr_fade_in` **(** :ref:`float` fade_in **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssr_fade_out` **(** :ref:`float` fade_out **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssr_max_steps` **(** :ref:`int` max_steps **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssr_rough` **(** :ref:`bool` rough **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tonemap_auto_exposure` **(** :ref:`bool` auto_exposure **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tonemap_auto_exposure_grey` **(** :ref:`float` exposure_grey **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tonemap_auto_exposure_max` **(** :ref:`float` exposure_max **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tonemap_auto_exposure_min` **(** :ref:`float` exposure_min **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tonemap_auto_exposure_speed` **(** :ref:`float` exposure_speed **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tonemap_exposure` **(** :ref:`float` exposure **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tonemap_white` **(** :ref:`float` white **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tonemapper` **(** :ref:`int` mode **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -405,7 +405,7 @@ Member Function Description .. _class_Environment_get_adjustment_color_correction: -- :ref:`Object` **get_adjustment_color_correction** **(** **)** const +- :ref:`Texture` **get_adjustment_color_correction** **(** **)** const .. _class_Environment_get_adjustment_contrast: @@ -537,7 +537,7 @@ Member Function Description .. _class_Environment_get_sky: -- :ref:`CubeMap` **get_sky** **(** **)** const +- :ref:`Sky` **get_sky** **(** **)** const .. _class_Environment_get_sky_scale: @@ -681,7 +681,7 @@ Member Function Description .. _class_Environment_set_adjustment_color_correction: -- void **set_adjustment_color_correction** **(** :ref:`Object` color_correction **)** +- void **set_adjustment_color_correction** **(** :ref:`Texture` color_correction **)** .. _class_Environment_set_adjustment_contrast: diff --git a/classes/class_file.rst b/classes/class_file.rst index 5ad682e4f..00de21426 100644 --- a/classes/class_file.rst +++ b/classes/class_file.rst @@ -43,7 +43,7 @@ Member Functions +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_endian_swap` **(** **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`get_error` **(** **)** const | +| :ref:`int` | :ref:`get_error` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_float` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -63,13 +63,13 @@ Member Functions +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_sha256` **(** :ref:`String` path **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_var` **(** **)** const | +| :ref:`Variant` | :ref:`get_var` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_open` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`open` **(** :ref:`String` path, :ref:`int` flags **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`open_compressed` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`int` compression_mode=0 **)** | +| :ref:`int` | :ref:`open_compressed` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`int` compression_mode=null **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`open_encrypted` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`PoolByteArray` key **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -217,7 +217,7 @@ Get whether endian swap is enabled for this file. .. _class_File_get_error: -- Error **get_error** **(** **)** const +- :ref:`int` **get_error** **(** **)** const Get the last error that happened when trying to perform operations. Compare with the ``ERR_FILE\_\*`` constants from :ref:`@Global Scope`. @@ -275,7 +275,7 @@ Return a sha256 String representing the file at the given path or an empty :ref: .. _class_File_get_var: -- void **get_var** **(** **)** const +- :ref:`Variant` **get_var** **(** **)** const Get the next Variant value from the file. @@ -293,7 +293,7 @@ Open the file for writing or reading, depending on the flags. .. _class_File_open_compressed: -- :ref:`int` **open_compressed** **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`int` compression_mode=0 **)** +- :ref:`int` **open_compressed** **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`int` compression_mode=null **)** Open a compressed file for reading or writing. The compression_mode can be set as one of the COMPRESSION\_\* constants. diff --git a/classes/class_font.rst b/classes/class_font.rst index c4127dd40..a8e08fa60 100644 --- a/classes/class_font.rst +++ b/classes/class_font.rst @@ -20,41 +20,41 @@ Internationalized font and text drawing support. Member Functions ---------------- -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`String` string, :ref:`Color` modulate=Color(1,1,1,1), :ref:`int` clip_w=-1 **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`draw_char` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`int` char, :ref:`int` next=-1, :ref:`Color` modulate=Color(1,1,1,1) **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ascent` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_descent` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_height` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_string_size` **(** :ref:`String` string **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_distance_field_hint` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_changes` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`String` string, :ref:`Color` modulate=null, :ref:`int` clip_w=null **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`draw_char` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`int` char, :ref:`int` next=null, :ref:`Color` modulate=null **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ascent` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_descent` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_height` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_string_size` **(** :ref:`String` string **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_distance_field_hint` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_changes` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- -Font contains an unicode compatible character set, as well as the ability to draw it with variable width, ascent, descent and kerning. For creating fonts from TTF files (or other font formats), see the editor support for fonts. TODO check wikipedia for graph of ascent/baseline/descent/height/etc. +Font contains a unicode compatible character set, as well as the ability to draw it with variable width, ascent, descent and kerning. For creating fonts from TTF files (or other font formats), see the editor support for fonts. TODO check wikipedia for graph of ascent/baseline/descent/height/etc. Member Function Description --------------------------- .. _class_Font_draw: -- void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`String` string, :ref:`Color` modulate=Color(1,1,1,1), :ref:`int` clip_w=-1 **)** const +- void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`String` string, :ref:`Color` modulate=null, :ref:`int` clip_w=null **)** const Draw "string" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally clipping the width. "pos" specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis. .. _class_Font_draw_char: -- :ref:`float` **draw_char** **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`int` char, :ref:`int` next=-1, :ref:`Color` modulate=Color(1,1,1,1) **)** const +- :ref:`float` **draw_char** **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`int` char, :ref:`int` next=null, :ref:`Color` modulate=null **)** const Draw character "char" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally kerning if "next" is passed. clipping the width. "pos" 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. diff --git a/classes/class_gdfunctionstate.rst b/classes/class_gdfunctionstate.rst index fcfb77273..09ca36149 100644 --- a/classes/class_gdfunctionstate.rst +++ b/classes/class_gdfunctionstate.rst @@ -21,7 +21,7 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid` **(** :ref:`bool` extended_check=false **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`resume` **(** :ref:`Variant` arg=NULL **)** | +| :ref:`Variant` | :ref:`resume` **(** :ref:`Variant` arg=null **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------+ Signals @@ -47,7 +47,7 @@ If ``extended_check`` is enabled, it also checks if the associated script and ob .. _class_GDFunctionState_resume: -- :ref:`Variant` **resume** **(** :ref:`Variant` arg=NULL **)** +- :ref:`Variant` **resume** **(** :ref:`Variant` arg=null **)** Resume execution of the yielded function call. diff --git a/classes/class_gdnative.rst b/classes/class_gdnative.rst new file mode 100644 index 000000000..598b4a7a7 --- /dev/null +++ b/classes/class_gdnative.rst @@ -0,0 +1,61 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. + +.. _class_GDNative: + +GDNative +======== + +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`call_native` **(** :ref:`String` procedure_name, :ref:`String` arguments, :ref:`Array` arg2 **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`GDNativeLibrary` | :ref:`get_library` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`initialize` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_library` **(** :ref:`GDNativeLibrary` library **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`terminate` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`GDNativeLibrary` **library** + +Member Function Description +--------------------------- + +.. _class_GDNative_call_native: + +- :ref:`Variant` **call_native** **(** :ref:`String` procedure_name, :ref:`String` arguments, :ref:`Array` arg2 **)** + +.. _class_GDNative_get_library: + +- :ref:`GDNativeLibrary` **get_library** **(** **)** + +.. _class_GDNative_initialize: + +- :ref:`bool` **initialize** **(** **)** + +.. _class_GDNative_set_library: + +- void **set_library** **(** :ref:`GDNativeLibrary` library **)** + +.. _class_GDNative_terminate: + +- :ref:`bool` **terminate** **(** **)** + + diff --git a/classes/class_gdnativeclass.rst b/classes/class_gdnativeclass.rst index 341141ce8..40582be35 100644 --- a/classes/class_gdnativeclass.rst +++ b/classes/class_gdnativeclass.rst @@ -18,15 +18,15 @@ Brief Description Member Functions ---------------- -+-------+--------------------------------------------------+ -| void | :ref:`new` **(** **)** | -+-------+--------------------------------------------------+ ++--------------------------------+--------------------------------------------------+ +| :ref:`Variant` | :ref:`new` **(** **)** | ++--------------------------------+--------------------------------------------------+ Member Function Description --------------------------- .. _class_GDNativeClass_new: -- void **new** **(** **)** +- :ref:`Variant` **new** **(** **)** diff --git a/classes/class_gdnativelibrary.rst b/classes/class_gdnativelibrary.rst index 65abfb562..6c4b2b7e1 100644 --- a/classes/class_gdnativelibrary.rst +++ b/classes/class_gdnativelibrary.rst @@ -18,21 +18,21 @@ Brief Description Member Functions ---------------- -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_platform_file` **(** :ref:`String` platform **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_platform_file` **(** :ref:`String` platform, :ref:`String` file **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_library_path` **(** :ref:`String` platform **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_library_path` **(** :ref:`String` platform, :ref:`String` path **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- -.. _class_GDNativeLibrary_get_platform_file: +.. _class_GDNativeLibrary_get_library_path: -- :ref:`String` **get_platform_file** **(** :ref:`String` platform **)** const +- :ref:`String` **get_library_path** **(** :ref:`String` platform **)** const -.. _class_GDNativeLibrary_set_platform_file: +.. _class_GDNativeLibrary_set_library_path: -- void **set_platform_file** **(** :ref:`String` platform, :ref:`String` file **)** +- void **set_library_path** **(** :ref:`String` platform, :ref:`String` path **)** diff --git a/classes/class_gdnativescript.rst b/classes/class_gdnativescript.rst deleted file mode 100644 index 71dd42eca..000000000 --- a/classes/class_gdnativescript.rst +++ /dev/null @@ -1,62 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. - -.. _class_GDNativeScript: - -GDNativeScript -============== - -**Inherits:** :ref:`Script` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - -Member Functions ----------------- - -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_library` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_script_name` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`new` **(** **)** vararg | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_library` **(** :ref:`Object` library **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_script_name` **(** :ref:`String` script_name **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------+ - -Member Variables ----------------- - -- :ref:`GDNativeLibrary` **library** -- :ref:`String` **script_name** - -Member Function Description ---------------------------- - -.. _class_GDNativeScript_get_library: - -- :ref:`Object` **get_library** **(** **)** const - -.. _class_GDNativeScript_get_script_name: - -- :ref:`String` **get_script_name** **(** **)** const - -.. _class_GDNativeScript_new: - -- :ref:`Object` **new** **(** **)** vararg - -.. _class_GDNativeScript_set_library: - -- void **set_library** **(** :ref:`Object` library **)** - -.. _class_GDNativeScript_set_script_name: - -- void **set_script_name** **(** :ref:`String` script_name **)** - - diff --git a/classes/class_geometry.rst b/classes/class_geometry.rst index 876911511..77f5c3d48 100644 --- a/classes/class_geometry.rst +++ b/classes/class_geometry.rst @@ -21,9 +21,9 @@ Member Functions +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`build_box_planes` **(** :ref:`Vector3` extents **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`build_capsule_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, :ref:`int` axis=2 **)** | +| :ref:`Array` | :ref:`build_capsule_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, :ref:`int` axis=null **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`build_cylinder_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` axis=2 **)** | +| :ref:`Array` | :ref:`build_cylinder_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` axis=null **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -43,7 +43,7 @@ Member Functions +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`point_is_inside_triangle` **(** :ref:`Vector2` point, :ref:`Vector2` a, :ref:`Vector2` b, :ref:`Vector2` c **)** const | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`ray_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` dir, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | +| :ref:`Variant` | :ref:`ray_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` dir, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`segment_intersects_circle` **(** :ref:`Vector2` segment_from, :ref:`Vector2` segment_to, :ref:`Vector2` circle_pos, :ref:`float` circle_radius **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -51,11 +51,11 @@ Member Functions +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolVector3Array` | :ref:`segment_intersects_cylinder` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`float` height, :ref:`float` radius **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`segment_intersects_segment_2d` **(** :ref:`Vector2` from_a, :ref:`Vector2` to_a, :ref:`Vector2` from_b, :ref:`Vector2` to_b **)** | +| :ref:`Variant` | :ref:`segment_intersects_segment_2d` **(** :ref:`Vector2` from_a, :ref:`Vector2` to_a, :ref:`Vector2` from_b, :ref:`Vector2` to_b **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolVector3Array` | :ref:`segment_intersects_sphere` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` spos, :ref:`float` sradius **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`segment_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | +| :ref:`Variant` | :ref:`segment_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolIntArray` | :ref:`triangulate_polygon` **(** :ref:`PoolVector2Array` polygon **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -69,11 +69,11 @@ Member Function Description .. _class_Geometry_build_capsule_planes: -- :ref:`Array` **build_capsule_planes** **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, :ref:`int` axis=2 **)** +- :ref:`Array` **build_capsule_planes** **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, :ref:`int` axis=null **)** .. _class_Geometry_build_cylinder_planes: -- :ref:`Array` **build_cylinder_planes** **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` axis=2 **)** +- :ref:`Array` **build_cylinder_planes** **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` axis=null **)** .. _class_Geometry_get_closest_point_to_segment: @@ -113,7 +113,7 @@ Member Function Description .. _class_Geometry_ray_intersects_triangle: -- void **ray_intersects_triangle** **(** :ref:`Vector3` from, :ref:`Vector3` dir, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** +- :ref:`Variant` **ray_intersects_triangle** **(** :ref:`Vector3` from, :ref:`Vector3` dir, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** .. _class_Geometry_segment_intersects_circle: @@ -129,7 +129,7 @@ Member Function Description .. _class_Geometry_segment_intersects_segment_2d: -- void **segment_intersects_segment_2d** **(** :ref:`Vector2` from_a, :ref:`Vector2` to_a, :ref:`Vector2` from_b, :ref:`Vector2` to_b **)** +- :ref:`Variant` **segment_intersects_segment_2d** **(** :ref:`Vector2` from_a, :ref:`Vector2` to_a, :ref:`Vector2` from_b, :ref:`Vector2` to_b **)** .. _class_Geometry_segment_intersects_sphere: @@ -137,7 +137,7 @@ Member Function Description .. _class_Geometry_segment_intersects_triangle: -- void **segment_intersects_triangle** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** +- :ref:`Variant` **segment_intersects_triangle** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** .. _class_Geometry_triangulate_polygon: diff --git a/classes/class_geometryinstance.rst b/classes/class_geometryinstance.rst index ef4e218e4..dc381384d 100644 --- a/classes/class_geometryinstance.rst +++ b/classes/class_geometryinstance.rst @@ -8,7 +8,7 @@ GeometryInstance **Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`MultiMeshInstance`, :ref:`SpriteBase3D`, :ref:`MeshInstance`, :ref:`Particles`, :ref:`ImmediateGeometry` +**Inherited By:** :ref:`MultiMeshInstance`, :ref:`MeshInstance`, :ref:`Particles`, :ref:`SpriteBase3D`, :ref:`ImmediateGeometry` **Category:** Core @@ -20,59 +20,56 @@ Base node for geometry based visual instances. Member Functions ---------------- -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cast_shadows_setting` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_extra_cull_margin` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_flag` **(** :ref:`int` flag **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_lod_max_distance` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_lod_max_hysteresis` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_lod_min_distance` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_lod_min_hysteresis` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_material_override` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cast_shadows_setting` **(** :ref:`int` shadow_casting_setting **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_extra_cull_margin` **(** :ref:`float` margin **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flag` **(** :ref:`int` flag, :ref:`bool` value **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_lod_max_distance` **(** :ref:`float` mode **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_lod_max_hysteresis` **(** :ref:`float` mode **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_lod_min_distance` **(** :ref:`float` mode **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_lod_min_hysteresis` **(** :ref:`float` mode **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_material_override` **(** :ref:`Object` material **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cast_shadows_setting` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_extra_cull_margin` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_flag` **(** :ref:`int` flag **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_lod_max_distance` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_lod_max_hysteresis` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_lod_min_distance` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_lod_min_hysteresis` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`get_material_override` **(** **)** const | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cast_shadows_setting` **(** :ref:`int` shadow_casting_setting **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_extra_cull_margin` **(** :ref:`float` margin **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flag` **(** :ref:`int` flag, :ref:`bool` value **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_lod_max_distance` **(** :ref:`float` mode **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_lod_max_hysteresis` **(** :ref:`float` mode **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_lod_min_distance` **(** :ref:`float` mode **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_lod_min_hysteresis` **(** :ref:`float` mode **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_material_override` **(** :ref:`Material` material **)** | ++----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- - :ref:`int` **cast_shadow** - :ref:`float` **extra_cull_margin** -- :ref:`int` **lod_max_distance** -- :ref:`int` **lod_max_hysteresis** -- :ref:`int` **lod_min_distance** -- :ref:`int` **lod_min_hysteresis** -- ShaderMaterial,SpatialMaterial **material_override** +- :ref:`float` **lod_max_distance** +- :ref:`float` **lod_max_hysteresis** +- :ref:`float` **lod_min_distance** +- :ref:`float` **lod_min_hysteresis** +- :ref:`Material` **material_override** - :ref:`bool` **use_in_baked_light** -- :ref:`bool` **visible_in_all_rooms** Numeric Constants ----------------- -- **FLAG_CAST_SHADOW** = **0** -- **FLAG_VISIBLE_IN_ALL_ROOMS** = **1** -- **FLAG_MAX** = **3** +- **FLAG_MAX** = **1** - **SHADOW_CASTING_SETTING_OFF** = **0** - **SHADOW_CASTING_SETTING_ON** = **1** - **SHADOW_CASTING_SETTING_DOUBLE_SIDED** = **2** @@ -116,7 +113,7 @@ Member Function Description .. _class_GeometryInstance_get_material_override: -- :ref:`Object` **get_material_override** **(** **)** const +- :ref:`Material` **get_material_override** **(** **)** const Return the material override for the whole geometry. @@ -150,7 +147,7 @@ Return the material override for the whole geometry. .. _class_GeometryInstance_set_material_override: -- void **set_material_override** **(** :ref:`Object` material **)** +- void **set_material_override** **(** :ref:`Material` material **)** Set the material override for the whole geometry. diff --git a/classes/class_giprobe.rst b/classes/class_giprobe.rst index 12d252cc1..7f086f4e6 100644 --- a/classes/class_giprobe.rst +++ b/classes/class_giprobe.rst @@ -18,51 +18,51 @@ Brief Description Member Functions ---------------- -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`bake` **(** :ref:`Object` from_node=NULL, :ref:`bool` create_visual_debug=false **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`debug_bake` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bias` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_dynamic_range` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_energy` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_extents` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_normal_bias` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_probe_data` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_propagation` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_subdiv` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_compressed` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_interior` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bias` **(** :ref:`float` max **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_compress` **(** :ref:`bool` enable **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dynamic_range` **(** :ref:`int` max **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_energy` **(** :ref:`float` max **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_extents` **(** :ref:`Vector3` extents **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_interior` **(** :ref:`bool` enable **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_normal_bias` **(** :ref:`float` max **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_probe_data` **(** :ref:`Object` data **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_propagation` **(** :ref:`float` max **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_subdiv` **(** :ref:`int` subdiv **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`bake` **(** :ref:`Node` from_node=false, :ref:`bool` create_visual_debug=null **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`debug_bake` **(** **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bias` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_dynamic_range` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_energy` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_extents` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_normal_bias` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`GIProbeData` | :ref:`get_probe_data` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_propagation` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_subdiv` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_compressed` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_interior` **(** **)** const | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bias` **(** :ref:`float` max **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_compress` **(** :ref:`bool` enable **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dynamic_range` **(** :ref:`int` max **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_energy` **(** :ref:`float` max **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_extents` **(** :ref:`Vector3` extents **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_interior` **(** :ref:`bool` enable **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_normal_bias` **(** :ref:`float` max **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_probe_data` **(** :ref:`GIProbeData` data **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_propagation` **(** :ref:`float` max **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_subdiv` **(** :ref:`int` subdiv **)** | ++----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -91,7 +91,7 @@ Member Function Description .. _class_GIProbe_bake: -- void **bake** **(** :ref:`Object` from_node=NULL, :ref:`bool` create_visual_debug=false **)** +- void **bake** **(** :ref:`Node` from_node=false, :ref:`bool` create_visual_debug=null **)** .. _class_GIProbe_debug_bake: @@ -119,7 +119,7 @@ Member Function Description .. _class_GIProbe_get_probe_data: -- :ref:`Object` **get_probe_data** **(** **)** const +- :ref:`GIProbeData` **get_probe_data** **(** **)** const .. _class_GIProbe_get_propagation: @@ -167,7 +167,7 @@ Member Function Description .. _class_GIProbe_set_probe_data: -- void **set_probe_data** **(** :ref:`Object` data **)** +- void **set_probe_data** **(** :ref:`GIProbeData` data **)** .. _class_GIProbe_set_propagation: diff --git a/classes/class_gradient.rst b/classes/class_gradient.rst index 79cc02612..f611cb127 100644 --- a/classes/class_gradient.rst +++ b/classes/class_gradient.rst @@ -47,8 +47,8 @@ Member Functions Member Variables ---------------- -- :ref:`float` **colors** -- :ref:`float` **offsets** +- :ref:`PoolColorArray` **colors** +- :ref:`PoolRealArray` **offsets** Description ----------- diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index e83ef4866..df286cb93 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -19,7 +19,7 @@ Member Functions ---------------- +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`connect_node` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | +| :ref:`int` | :ref:`connect_node` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`disconnect_node` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -41,7 +41,7 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_scroll_ofs` **(** :ref:`Vector2` ofs **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_selected` **(** :ref:`Object` node **)** | +| void | :ref:`set_selected` **(** :ref:`Node` node **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_snap` **(** :ref:`int` pixels **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -81,7 +81,7 @@ Signal sent when a popup is requested. Happens on right-clicking in the GraphEdi Description ----------- -GraphEdit manages the showing of GraphNodes it contains, as well as connections an disconnections between them. Signals are sent for each of these two events. Disconnection between GraphNodes slots is disabled by default. +GraphEdit manages the showing of GraphNodes it contains, as well as connections and disconnections between them. Signals are sent for each of these two events. Disconnection between GraphNodes slots is disabled by default. It is greatly advised to enable low processor usage mode (see :ref:`OS.set_low_processor_usage_mode`) when using GraphEdits. @@ -90,7 +90,7 @@ Member Function Description .. _class_GraphEdit_connect_node: -- Error **connect_node** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** +- :ref:`int` **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. @@ -150,7 +150,7 @@ Enable the disconnection of existing connections in the visual GraphEdit by left .. _class_GraphEdit_set_selected: -- void **set_selected** **(** :ref:`Object` node **)** +- void **set_selected** **(** :ref:`Node` node **)** .. _class_GraphEdit_set_snap: diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index 800bad917..b30e9cf6b 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -18,69 +18,69 @@ A GraphNode is a container with several input and output slots allowing connecti Member Functions ---------------- -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_all_slots` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_slot` **(** :ref:`int` idx **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_connection_input_color` **(** :ref:`int` idx **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connection_input_count` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_connection_input_pos` **(** :ref:`int` idx **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connection_input_type` **(** :ref:`int` idx **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_connection_output_color` **(** :ref:`int` idx **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connection_output_count` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_connection_output_pos` **(** :ref:`int` idx **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connection_output_type` **(** :ref:`int` idx **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_overlay` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_slot_color_left` **(** :ref:`int` idx **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_slot_color_right` **(** :ref:`int` idx **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_slot_type_left` **(** :ref:`int` idx **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_slot_type_right` **(** :ref:`int` idx **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_title` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_close_button_visible` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_comment` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_resizeable` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selected` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_slot_enabled_left` **(** :ref:`int` idx **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_slot_enabled_right` **(** :ref:`int` idx **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_comment` **(** :ref:`bool` comment **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_overlay` **(** :ref:`int` overlay **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_resizeable` **(** :ref:`bool` resizeable **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_selected` **(** :ref:`bool` selected **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_show_close_button` **(** :ref:`bool` show **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_slot` **(** :ref:`int` idx, :ref:`bool` enable_left, :ref:`int` type_left, :ref:`Color` color_left, :ref:`bool` enable_right, :ref:`int` type_right, :ref:`Color` color_right, :ref:`Object` custom_left=NULL, :ref:`Object` custom_right=NULL **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_title` **(** :ref:`String` title **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_all_slots` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_slot` **(** :ref:`int` idx **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_connection_input_color` **(** :ref:`int` idx **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_input_count` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_connection_input_pos` **(** :ref:`int` idx **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_input_type` **(** :ref:`int` idx **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_connection_output_color` **(** :ref:`int` idx **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_output_count` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_connection_output_pos` **(** :ref:`int` idx **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_output_type` **(** :ref:`int` idx **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_overlay` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_slot_color_left` **(** :ref:`int` idx **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_slot_color_right` **(** :ref:`int` idx **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_slot_type_left` **(** :ref:`int` idx **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_slot_type_right` **(** :ref:`int` idx **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_title` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_close_button_visible` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_comment` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_resizeable` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_selected` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_slot_enabled_left` **(** :ref:`int` idx **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_slot_enabled_right` **(** :ref:`int` idx **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_comment` **(** :ref:`bool` comment **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_overlay` **(** :ref:`int` overlay **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_resizeable` **(** :ref:`bool` resizeable **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_selected` **(** :ref:`bool` selected **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_show_close_button` **(** :ref:`bool` show **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_slot` **(** :ref:`int` idx, :ref:`bool` enable_left, :ref:`int` type_left, :ref:`Color` color_left, :ref:`bool` enable_right, :ref:`int` type_right, :ref:`Color` color_right, :ref:`Texture` custom_left=null, :ref:`Texture` custom_right=null **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_title` **(** :ref:`String` title **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -281,7 +281,7 @@ Show the close button on the GraphNode if 'show' is true (disabled by default). .. _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:`Object` custom_left=NULL, :ref:`Object` custom_right=NULL **)** +- void **set_slot** **(** :ref:`int` idx, :ref:`bool` enable_left, :ref:`int` type_left, :ref:`Color` color_left, :ref:`bool` enable_right, :ref:`int` type_right, :ref:`Color` color_right, :ref:`Texture` custom_left=null, :ref:`Texture` custom_right=null **)** .. _class_GraphNode_set_title: diff --git a/classes/class_gridmap.rst b/classes/class_gridmap.rst index 1ac1c822c..8c87aebe9 100644 --- a/classes/class_gridmap.rst +++ b/classes/class_gridmap.rst @@ -18,69 +18,45 @@ Brief Description Member Functions ---------------- -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`area_get_bounds` **(** :ref:`int` area **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`area_get_name` **(** :ref:`int` area **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`area_get_portal_disable_color` **(** :ref:`int` area **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`area_get_portal_disable_distance` **(** :ref:`int` area **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`area_is_exterior_portal` **(** :ref:`int` area **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_exterior_portal` **(** :ref:`int` area, :ref:`bool` enable **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_name` **(** :ref:`int` area, :ref:`String` name **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_portal_disable_color` **(** :ref:`int` area, :ref:`Color` color **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_portal_disable_distance` **(** :ref:`int` area, :ref:`float` distance **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`create_area` **(** :ref:`int` id, :ref:`Rect3` area **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_area` **(** :ref:`int` area **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cell_item` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cell_item_orientation` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_cell_size` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_center_x` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_center_y` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_center_z` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_meshes` **(** **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_octant_size` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`MeshLibrary` | :ref:`get_theme` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_unused_area_id` **(** **)** const | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resource_changed` **(** :ref:`Object` resource **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_item` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` item, :ref:`int` orientation=0 **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_size` **(** :ref:`float` size **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_center_x` **(** :ref:`bool` enable **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_center_y` **(** :ref:`bool` enable **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_center_z` **(** :ref:`bool` enable **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_clip` **(** :ref:`bool` enabled, :ref:`bool` clipabove=true, :ref:`int` floor=0, :ref:`int` axis=0 **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_octant_size` **(** :ref:`int` size **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_theme` **(** :ref:`MeshLibrary` theme **)** | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cell_item` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cell_item_orientation` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_cell_size` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_center_x` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_center_y` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_center_z` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_meshes` **(** **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_octant_size` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`MeshLibrary` | :ref:`get_theme` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resource_changed` **(** :ref:`Resource` resource **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell_item` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` item, :ref:`int` orientation=null **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell_size` **(** :ref:`Vector3` size **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_center_x` **(** :ref:`bool` enable **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_center_y` **(** :ref:`bool` enable **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_center_z` **(** :ref:`bool` enable **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_clip` **(** :ref:`bool` enabled, :ref:`bool` clipabove=0, :ref:`int` floor=true, :ref:`int` axis=null **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_octant_size` **(** :ref:`int` size **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_theme` **(** :ref:`MeshLibrary` theme **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -90,54 +66,10 @@ Numeric Constants Member Function Description --------------------------- -.. _class_GridMap_area_get_bounds: - -- :ref:`Rect3` **area_get_bounds** **(** :ref:`int` area **)** const - -.. _class_GridMap_area_get_name: - -- :ref:`String` **area_get_name** **(** :ref:`int` area **)** const - -.. _class_GridMap_area_get_portal_disable_color: - -- :ref:`Color` **area_get_portal_disable_color** **(** :ref:`int` area **)** const - -.. _class_GridMap_area_get_portal_disable_distance: - -- :ref:`float` **area_get_portal_disable_distance** **(** :ref:`int` area **)** const - -.. _class_GridMap_area_is_exterior_portal: - -- :ref:`bool` **area_is_exterior_portal** **(** :ref:`int` area **)** const - -.. _class_GridMap_area_set_exterior_portal: - -- void **area_set_exterior_portal** **(** :ref:`int` area, :ref:`bool` enable **)** - -.. _class_GridMap_area_set_name: - -- void **area_set_name** **(** :ref:`int` area, :ref:`String` name **)** - -.. _class_GridMap_area_set_portal_disable_color: - -- void **area_set_portal_disable_color** **(** :ref:`int` area, :ref:`Color` color **)** - -.. _class_GridMap_area_set_portal_disable_distance: - -- void **area_set_portal_disable_distance** **(** :ref:`int` area, :ref:`float` distance **)** - .. _class_GridMap_clear: - void **clear** **(** **)** -.. _class_GridMap_create_area: - -- :ref:`int` **create_area** **(** :ref:`int` id, :ref:`Rect3` area **)** - -.. _class_GridMap_erase_area: - -- void **erase_area** **(** :ref:`int` area **)** - .. _class_GridMap_get_cell_item: - :ref:`int` **get_cell_item** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const @@ -148,7 +80,7 @@ Member Function Description .. _class_GridMap_get_cell_size: -- :ref:`float` **get_cell_size** **(** **)** const +- :ref:`Vector3` **get_cell_size** **(** **)** const .. _class_GridMap_get_center_x: @@ -174,21 +106,17 @@ Member Function Description - :ref:`MeshLibrary` **get_theme** **(** **)** const -.. _class_GridMap_get_unused_area_id: - -- :ref:`int` **get_unused_area_id** **(** **)** const - .. _class_GridMap_resource_changed: -- void **resource_changed** **(** :ref:`Object` resource **)** +- void **resource_changed** **(** :ref:`Resource` resource **)** .. _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 **)** +- void **set_cell_item** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` item, :ref:`int` orientation=null **)** .. _class_GridMap_set_cell_size: -- void **set_cell_size** **(** :ref:`float` size **)** +- void **set_cell_size** **(** :ref:`Vector3` size **)** .. _class_GridMap_set_center_x: @@ -204,7 +132,7 @@ Member Function Description .. _class_GridMap_set_clip: -- void **set_clip** **(** :ref:`bool` enabled, :ref:`bool` clipabove=true, :ref:`int` floor=0, :ref:`int` axis=0 **)** +- void **set_clip** **(** :ref:`bool` enabled, :ref:`bool` clipabove=0, :ref:`int` floor=true, :ref:`int` axis=null **)** .. _class_GridMap_set_octant_size: diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index 3eb246775..d4a1e7fea 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -21,7 +21,7 @@ Member Functions +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`close` **(** **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`connect_to_host` **(** :ref:`String` host, :ref:`int` port, :ref:`bool` use_ssl=false, :ref:`bool` verify_host=true **)** | +| :ref:`int` | :ref:`connect_to_host` **(** :ref:`String` host, :ref:`int` port, :ref:`bool` use_ssl=null, :ref:`bool` verify_host=null **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StreamPeer` | :ref:`get_connection` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -41,13 +41,13 @@ Member Functions +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_response_chunked` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`poll` **(** **)** | +| :ref:`int` | :ref:`poll` **(** **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`query_string_from_dict` **(** :ref:`Dictionary` fields **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolByteArray` | :ref:`read_response_body_chunk` **(** **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`request` **(** :ref:`int` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`String` body="" **)** | +| :ref:`int` | :ref:`request` **(** :ref:`int` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`String` body=null **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`request_raw` **(** :ref:`int` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -152,7 +152,7 @@ Cloces the current connection, allows for reusal of :ref:`HTTPClient` host, :ref:`int` port, :ref:`bool` use_ssl=false, :ref:`bool` verify_host=true **)** +- :ref:`int` **connect_to_host** **(** :ref:`String` host, :ref:`int` port, :ref:`bool` use_ssl=null, :ref:`bool` verify_host=null **)** Connect to a host. This needs to be done before any requests are sent. @@ -220,7 +220,7 @@ Return whether this :ref:`HTTPClient` has a response that is c .. _class_HTTPClient_poll: -- Error **poll** **(** **)** +- :ref:`int` **poll** **(** **)** This needs to be called in order to have any request processed. Check results with :ref:`get_status` @@ -244,7 +244,7 @@ Reads one chunk from the response. .. _class_HTTPClient_request: -- :ref:`int` **request** **(** :ref:`int` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`String` body="" **)** +- :ref:`int` **request** **(** :ref:`int` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`String` body=null **)** Sends a request to the connected host. The url is what is normally behind the hostname, i.e. in ``http://somehost.com/index.php``, url would be "index.php". diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index 57d6a073a..e662fcc01 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -18,33 +18,33 @@ A Node with the ability to send HTTP requests. Member Functions ---------------- -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cancel_request` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_body_size` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_body_size_limit` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_download_file` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_downloaded_bytes` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_http_client_status` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_max_redirects` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_threads` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`request` **(** :ref:`String` url, :ref:`PoolStringArray` custom_headers=PoolStringArray([]), :ref:`bool` ssl_validate_domain=true, :ref:`int` method=0, :ref:`String` request_data="" **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_body_size_limit` **(** :ref:`int` bytes **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_download_file` **(** :ref:`String` path **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_redirects` **(** :ref:`int` amount **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_threads` **(** :ref:`bool` enable **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cancel_request` **(** **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_body_size` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_body_size_limit` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_download_file` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_downloaded_bytes` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_http_client_status` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_max_redirects` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_using_threads` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`request` **(** :ref:`String` url, :ref:`PoolStringArray` custom_headers=0, :ref:`bool` ssl_validate_domain=true, :ref:`int` method=PoolStringArray( ), :ref:`String` request_data=null **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_body_size_limit` **(** :ref:`int` bytes **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_download_file` **(** :ref:`String` path **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_redirects` **(** :ref:`int` amount **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_threads` **(** :ref:`bool` enable **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -136,7 +136,7 @@ Whether this request is using threads. .. _class_HTTPRequest_request: -- :ref:`int` **request** **(** :ref:`String` url, :ref:`PoolStringArray` custom_headers=PoolStringArray([]), :ref:`bool` ssl_validate_domain=true, :ref:`int` method=0, :ref:`String` request_data="" **)** +- :ref:`int` **request** **(** :ref:`String` url, :ref:`PoolStringArray` custom_headers=0, :ref:`bool` ssl_validate_domain=true, :ref:`int` method=PoolStringArray( ), :ref:`String` request_data=null **)** .. _class_HTTPRequest_set_body_size_limit: diff --git a/classes/class_image.rst b/classes/class_image.rst index c60a1fefb..bbdf8ad62 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -29,7 +29,7 @@ Member Functions +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_mipmaps` **(** **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`compress` **(** :ref:`int` mode, :ref:`int` arg1, :ref:`float` arg2 **)** | +| :ref:`int` | :ref:`compress` **(** :ref:`int` mode, :ref:`int` source, :ref:`float` lossy_quality **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`convert` **(** :ref:`int` format **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -69,6 +69,8 @@ Member Functions +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Image` | :ref:`get_rect` **(** :ref:`Rect2` rect **)** const | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size` **(** **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`get_used_rect` **(** **)** const | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_width` **(** **)** const | @@ -89,7 +91,7 @@ Member Functions +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`premultiply_alpha` **(** **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` width, :ref:`int` height, :ref:`int` interpolation=1 **)** | +| void | :ref:`resize` **(** :ref:`int` width, :ref:`int` height, :ref:`int` interpolation=null **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`resize_to_po2` **(** :ref:`bool` square=false **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -203,7 +205,7 @@ Blits a "src_rect" :ref:`Rect2` from "src" :ref:`Image .. _class_Image_compress: -- :ref:`int` **compress** **(** :ref:`int` mode, :ref:`int` arg1, :ref:`float` arg2 **)** +- :ref:`int` **compress** **(** :ref:`int` mode, :ref:`int` source, :ref:`float` lossy_quality **)** .. _class_Image_convert: @@ -293,6 +295,10 @@ Return the height of the :ref:`Image`. Return a new :ref:`Image` that is a copy of "area" in this :ref:`Image`. +.. _class_Image_get_size: + +- :ref:`Vector2` **get_size** **(** **)** const + .. _class_Image_get_used_rect: - :ref:`Rect2` **get_used_rect** **(** **)** const @@ -341,7 +347,7 @@ Load an :ref:`Image`. .. _class_Image_resize: -- void **resize** **(** :ref:`int` width, :ref:`int` height, :ref:`int` interpolation=1 **)** +- void **resize** **(** :ref:`int` width, :ref:`int` height, :ref:`int` interpolation=null **)** .. _class_Image_resize_to_po2: diff --git a/classes/class_imagetexture.rst b/classes/class_imagetexture.rst index 77cd55d65..81dab75d4 100644 --- a/classes/class_imagetexture.rst +++ b/classes/class_imagetexture.rst @@ -18,29 +18,27 @@ A :ref:`Texture` based on an :ref:`Image`. Member Functions ---------------- -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create` **(** :ref:`int` width, :ref:`int` height, :ref:`int` format, :ref:`int` flags=7 **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_from_image` **(** :ref:`Image` image, :ref:`int` flags=7 **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_data` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_format` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_lossy_storage_quality` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_storage` **(** **)** const | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`load` **(** :ref:`String` path **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_data` **(** :ref:`Image` image **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_lossy_storage_quality` **(** :ref:`float` quality **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size_override` **(** :ref:`Vector2` size **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_storage` **(** :ref:`int` mode **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create` **(** :ref:`int` width, :ref:`int` height, :ref:`int` format, :ref:`int` flags=null **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_from_image` **(** :ref:`Image` image, :ref:`int` flags=null **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_format` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_lossy_storage_quality` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_storage` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`load` **(** :ref:`String` path **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_data` **(** :ref:`Image` image **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_lossy_storage_quality` **(** :ref:`float` quality **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size_override` **(** :ref:`Vector2` size **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_storage` **(** :ref:`int` mode **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -59,7 +57,7 @@ Member Function Description .. _class_ImageTexture_create: -- void **create** **(** :ref:`int` width, :ref:`int` height, :ref:`int` format, :ref:`int` flags=7 **)** +- void **create** **(** :ref:`int` width, :ref:`int` height, :ref:`int` format, :ref:`int` flags=null **)** Create a new :ref:`ImageTexture` with "width" and "height". @@ -69,16 +67,10 @@ Create a new :ref:`ImageTexture` with "width" and "height". .. _class_ImageTexture_create_from_image: -- void **create_from_image** **(** :ref:`Image` image, :ref:`int` flags=7 **)** +- void **create_from_image** **(** :ref:`Image` image, :ref:`int` flags=null **)** Create a new :ref:`ImageTexture` from an :ref:`Image` with "flags" from :ref:`Texture`.FLAG\_\*. -.. _class_ImageTexture_get_data: - -- :ref:`Image` **get_data** **(** **)** const - -Return the :ref:`Image` of this :ref:`ImageTexture`. - .. _class_ImageTexture_get_format: - :ref:`int` **get_format** **(** **)** const diff --git a/classes/class_immediategeometry.rst b/classes/class_immediategeometry.rst index 5f5c7f414..08d94d36a 100644 --- a/classes/class_immediategeometry.rst +++ b/classes/class_immediategeometry.rst @@ -19,11 +19,11 @@ Member Functions ---------------- +-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_sphere` **(** :ref:`int` lats, :ref:`int` lons, :ref:`float` radius, :ref:`bool` add_uv=true **)** | +| void | :ref:`add_sphere` **(** :ref:`int` lats, :ref:`int` lons, :ref:`float` radius, :ref:`bool` add_uv=null **)** | +-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_vertex` **(** :ref:`Vector3` pos **)** | +-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`begin` **(** :ref:`int` primitive, :ref:`Texture` texture=NULL **)** | +| void | :ref:`begin` **(** :ref:`int` primitive, :ref:`Texture` texture=null **)** | +-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -45,9 +45,9 @@ Member Function Description .. _class_ImmediateGeometry_add_sphere: -- void **add_sphere** **(** :ref:`int` lats, :ref:`int` lons, :ref:`float` radius, :ref:`bool` add_uv=true **)** +- void **add_sphere** **(** :ref:`int` lats, :ref:`int` lons, :ref:`float` radius, :ref:`bool` add_uv=null **)** -Simple helper to draw an uvsphere, with given latitudes, longitude and radius. +Simple helper to draw a uvsphere, with given latitudes, longitude and radius. .. _class_ImmediateGeometry_add_vertex: @@ -57,7 +57,7 @@ Add a vertex with the currently set color/uv/etc. .. _class_ImmediateGeometry_begin: -- void **begin** **(** :ref:`int` primitive, :ref:`Texture` texture=NULL **)** +- void **begin** **(** :ref:`int` primitive, :ref:`Texture` texture=null **)** Begin drawing (And optionally pass a texture override). When done call end(). For more information on how this works, search for glBegin() glEnd() references. diff --git a/classes/class_input.rst b/classes/class_input.rst index c60286ad2..2fd982270 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -20,75 +20,75 @@ A Singleton that deals with inputs. Member Functions ---------------- -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_press` **(** :ref:`String` action **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_release` **(** :ref:`String` action **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_joy_mapping` **(** :ref:`String` mapping, :ref:`bool` update_existing=false **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_accelerometer` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_connected_joypads` **(** **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_gravity` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_gyroscope` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_joy_axis` **(** :ref:`int` device, :ref:`int` axis **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_joy_axis_index_from_string` **(** :ref:`String` axis **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_joy_axis_string` **(** :ref:`int` axis_index **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_joy_button_index_from_string` **(** :ref:`String` button **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_joy_button_string` **(** :ref:`int` button_index **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_joy_guid` **(** :ref:`int` device **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_joy_name` **(** :ref:`int` device **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_joy_vibration_duration` **(** :ref:`int` device **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_joy_vibration_strength` **(** :ref:`int` device **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_last_mouse_speed` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_magnetometer` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mouse_button_mask` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mouse_mode` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_just_pressed` **(** :ref:`String` action **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_just_released` **(** :ref:`String` action **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_joy_button_pressed` **(** :ref:`int` device, :ref:`int` button **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_joy_known` **(** :ref:`int` device **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_key_pressed` **(** :ref:`int` scancode **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_mouse_button_pressed` **(** :ref:`int` button **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`parse_input_event` **(** :ref:`Object` event **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_joy_mapping` **(** :ref:`String` guid **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_mouse_cursor` **(** :ref:`Texture` image, :ref:`Vector2` hotspot=Vector2(0, 0) **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mouse_mode` **(** :ref:`int` mode **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`start_joy_vibration` **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=0 **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop_joy_vibration` **(** :ref:`int` device **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`warp_mouse_pos` **(** :ref:`Vector2` to **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`action_press` **(** :ref:`String` action **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`action_release` **(** :ref:`String` action **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_joy_mapping` **(** :ref:`String` mapping, :ref:`bool` update_existing=null **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_accelerometer` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_connected_joypads` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_gravity` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_gyroscope` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_joy_axis` **(** :ref:`int` device, :ref:`int` axis **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_joy_axis_index_from_string` **(** :ref:`String` axis **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_joy_axis_string` **(** :ref:`int` axis_index **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_joy_button_index_from_string` **(** :ref:`String` button **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_joy_button_string` **(** :ref:`int` button_index **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_joy_guid` **(** :ref:`int` device **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_joy_name` **(** :ref:`int` device **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_joy_vibration_duration` **(** :ref:`int` device **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_joy_vibration_strength` **(** :ref:`int` device **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_last_mouse_speed` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_magnetometer` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mouse_button_mask` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mouse_mode` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_just_pressed` **(** :ref:`String` action **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_just_released` **(** :ref:`String` action **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_joy_button_pressed` **(** :ref:`int` device, :ref:`int` button **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_joy_known` **(** :ref:`int` device **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_key_pressed` **(** :ref:`int` scancode **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_mouse_button_pressed` **(** :ref:`int` button **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`parse_input_event` **(** :ref:`InputEvent` event **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_joy_mapping` **(** :ref:`String` guid **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_mouse_cursor` **(** :ref:`Resource` image, :ref:`Vector2` hotspot=null **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mouse_mode` **(** :ref:`int` mode **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`start_joy_vibration` **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=null **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop_joy_vibration` **(** :ref:`int` device **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`warp_mouse_pos` **(** :ref:`Vector2` to **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -127,7 +127,7 @@ If the specified action is already pressed, this will release it. .. _class_Input_add_joy_mapping: -- void **add_joy_mapping** **(** :ref:`String` mapping, :ref:`bool` update_existing=false **)** +- void **add_joy_mapping** **(** :ref:`String` mapping, :ref:`bool` update_existing=null **)** Add a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices. @@ -263,7 +263,7 @@ Returns true or false depending on whether mouse button is pressed or not. You c .. _class_Input_parse_input_event: -- void **parse_input_event** **(** :ref:`Object` event **)** +- void **parse_input_event** **(** :ref:`InputEvent` event **)** .. _class_Input_remove_joy_mapping: @@ -273,9 +273,7 @@ Removes all mappings from the internal db that match the given uid. .. _class_Input_set_custom_mouse_cursor: -- void **set_custom_mouse_cursor** **(** :ref:`Texture` image, :ref:`Vector2` hotspot=Vector2(0, 0) **)** - -Set a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified. +- void **set_custom_mouse_cursor** **(** :ref:`Resource` image, :ref:`Vector2` hotspot=null **)** .. _class_Input_set_mouse_mode: @@ -285,7 +283,7 @@ Set the mouse mode. See the constants for more information. .. _class_Input_start_joy_vibration: -- void **start_joy_vibration** **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=0 **)** +- void **start_joy_vibration** **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=null **)** Starts to vibrate the joypad. Joypads usually come with two rumble motors, a strong and a weak one. weak_magnitude is the strength of the weak motor (between 0 and 1) and strong_magnitude is the strength of the strong motor (between 0 and 1). duration is the duration of the effect in seconds (a duration of 0 will try to play the vibration indefinitely). diff --git a/classes/class_inputevent.rst b/classes/class_inputevent.rst index 83be8ad0e..c3be33399 100644 --- a/classes/class_inputevent.rst +++ b/classes/class_inputevent.rst @@ -20,35 +20,35 @@ Brief Description Member Functions ---------------- -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`action_match` **(** :ref:`InputEvent` event **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`as_text` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_device` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_id` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action` **(** :ref:`String` action **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_released` **(** :ref:`String` action **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_type` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_echo` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pressed` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_device` **(** :ref:`int` device **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_id` **(** :ref:`int` id **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`shortcut_match` **(** :ref:`InputEvent` event **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`InputEvent` | :ref:`xformed_by` **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=Vector2(0, 0) **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`action_match` **(** :ref:`InputEvent` event **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`as_text` **(** **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_device` **(** **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_id` **(** **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action` **(** :ref:`String` action **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_released` **(** :ref:`String` action **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_type` **(** **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_echo` **(** **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_pressed` **(** **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_device` **(** :ref:`int` device **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_id` **(** :ref:`int` id **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`shortcut_match` **(** :ref:`InputEvent` event **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`InputEvent` | :ref:`xformed_by` **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=null **)** const | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -122,6 +122,6 @@ Return if this input event is pressed. Not relevant for the event types MOUSE_MO .. _class_InputEvent_xformed_by: -- :ref:`InputEvent` **xformed_by** **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=Vector2(0, 0) **)** const +- :ref:`InputEvent` **xformed_by** **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=null **)** const diff --git a/classes/class_inputeventkey.rst b/classes/class_inputeventkey.rst index 0ea341a3b..243dfa4a8 100644 --- a/classes/class_inputeventkey.rst +++ b/classes/class_inputeventkey.rst @@ -37,7 +37,7 @@ Member Functions Member Variables ---------------- -- :ref:`int` **echo** - Echo state of the key, i.e. whether it's a repeat event or not. +- :ref:`bool` **echo** - Echo state of the key, i.e. whether it's a repeat event or not. - :ref:`bool` **pressed** - Pressed state of the key. - :ref:`int` **scancode** - Scancode of the key, one of the KEY_* constants in [@Global Scope]. - :ref:`int` **unicode** - Unicode identifier of the key (when relevant). diff --git a/classes/class_inputmap.rst b/classes/class_inputmap.rst index 122504f84..c166518a3 100644 --- a/classes/class_inputmap.rst +++ b/classes/class_inputmap.rst @@ -18,46 +18,46 @@ Singleton that manages actions. Member Functions ---------------- -+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_add_event` **(** :ref:`String` action, :ref:`Object` event **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_erase_event` **(** :ref:`String` action, :ref:`Object` event **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`action_has_event` **(** :ref:`String` action, :ref:`Object` event **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_action` **(** :ref:`String` action **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_action` **(** :ref:`String` action **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`event_is_action` **(** :ref:`Object` event, :ref:`String` action **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_action_list` **(** :ref:`String` action **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_actions` **(** **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_action` **(** :ref:`String` action **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`load_from_globals` **(** **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`action_add_event` **(** :ref:`String` action, :ref:`InputEvent` event **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`action_erase_event` **(** :ref:`String` action, :ref:`InputEvent` event **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`action_has_event` **(** :ref:`String` action, :ref:`InputEvent` event **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_action` **(** :ref:`String` action **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_action` **(** :ref:`String` action **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`event_is_action` **(** :ref:`InputEvent` event, :ref:`String` action **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_action_list` **(** :ref:`String` action **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_actions` **(** **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_action` **(** :ref:`String` action **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`load_from_globals` **(** **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_InputMap_action_add_event: -- void **action_add_event** **(** :ref:`String` action, :ref:`Object` event **)** +- void **action_add_event** **(** :ref:`String` action, :ref:`InputEvent` event **)** Add an :ref:`InputEvent` to an action. This :ref:`InputEvent` will trigger the action. .. _class_InputMap_action_erase_event: -- void **action_erase_event** **(** :ref:`String` action, :ref:`Object` event **)** +- void **action_erase_event** **(** :ref:`String` action, :ref:`InputEvent` event **)** Remove an :ref:`InputEvent` from an action. .. _class_InputMap_action_has_event: -- :ref:`bool` **action_has_event** **(** :ref:`String` action, :ref:`Object` event **)** +- :ref:`bool` **action_has_event** **(** :ref:`String` action, :ref:`InputEvent` event **)** Whether an action has an :ref:`InputEvent` associated with it. @@ -75,7 +75,7 @@ Remove an action from the :ref:`InputMap`. .. _class_InputMap_event_is_action: -- :ref:`bool` **event_is_action** **(** :ref:`Object` event, :ref:`String` action **)** const +- :ref:`bool` **event_is_action** **(** :ref:`InputEvent` event, :ref:`String` action **)** const Return whether 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. diff --git a/classes/class_instanceplaceholder.rst b/classes/class_instanceplaceholder.rst index 035ebed46..753759d52 100644 --- a/classes/class_instanceplaceholder.rst +++ b/classes/class_instanceplaceholder.rst @@ -23,7 +23,7 @@ Member Functions +--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_stored_values` **(** :ref:`bool` with_order=false **)** | +--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`replace_by_instance` **(** :ref:`PackedScene` custom_scene=NULL **)** | +| void | :ref:`replace_by_instance` **(** :ref:`PackedScene` custom_scene=null **)** | +--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ Description @@ -48,7 +48,7 @@ Retrieve the path to the :ref:`PackedScene` resource file tha .. _class_InstancePlaceholder_replace_by_instance: -- void **replace_by_instance** **(** :ref:`PackedScene` custom_scene=NULL **)** +- 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_interpolatedcamera.rst b/classes/class_interpolatedcamera.rst index 908477c0d..bf6d4cb8d 100644 --- a/classes/class_interpolatedcamera.rst +++ b/classes/class_interpolatedcamera.rst @@ -29,7 +29,7 @@ Member Functions +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_speed` **(** :ref:`float` speed **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_target` **(** :ref:`Camera` target **)** | +| void | :ref:`set_target` **(** :ref:`Object` target **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_target_path` **(** :ref:`NodePath` target_path **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ @@ -66,7 +66,7 @@ Member Function Description .. _class_InterpolatedCamera_set_target: -- void **set_target** **(** :ref:`Camera` target **)** +- void **set_target** **(** :ref:`Object` target **)** .. _class_InterpolatedCamera_set_target_path: diff --git a/classes/class_ip.rst b/classes/class_ip.rst index 579657851..7e09e7e88 100644 --- a/classes/class_ip.rst +++ b/classes/class_ip.rst @@ -20,21 +20,21 @@ IP Protocol support functions. Member Functions ---------------- -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_cache` **(** :ref:`String` arg0="" **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_resolve_item` **(** :ref:`int` id **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_local_addresses` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_resolve_item_address` **(** :ref:`int` id **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_resolve_item_status` **(** :ref:`int` id **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`resolve_hostname` **(** :ref:`String` host, :ref:`int` ip_type=3 **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`resolve_hostname_queue_item` **(** :ref:`String` host, :ref:`int` ip_type=3 **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_cache` **(** :ref:`String` hostname="" **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_resolve_item` **(** :ref:`int` id **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_local_addresses` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_resolve_item_address` **(** :ref:`int` id **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_resolve_item_status` **(** :ref:`int` id **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`resolve_hostname` **(** :ref:`String` host, :ref:`int` ip_type=null **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`resolve_hostname_queue_item` **(** :ref:`String` host, :ref:`int` ip_type=null **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -60,7 +60,7 @@ Member Function Description .. _class_IP_clear_cache: -- void **clear_cache** **(** :ref:`String` arg0="" **)** +- void **clear_cache** **(** :ref:`String` hostname="" **)** .. _class_IP_erase_resolve_item: @@ -86,13 +86,13 @@ Return the status of hostname queued for resolving, given its queue ID. Returned .. _class_IP_resolve_hostname: -- :ref:`String` **resolve_hostname** **(** :ref:`String` host, :ref:`int` ip_type=3 **)** +- :ref:`String` **resolve_hostname** **(** :ref:`String` host, :ref:`int` ip_type=null **)** Resolve a given hostname, blocking. Resolved hostname is returned as an IPv4 or IPv6 depending on "ip_type". .. _class_IP_resolve_hostname_queue_item: -- :ref:`int` **resolve_hostname_queue_item** **(** :ref:`String` host, :ref:`int` ip_type=3 **)** +- :ref:`int` **resolve_hostname_queue_item** **(** :ref:`String` host, :ref:`int` ip_type=null **)** Create a queue item for resolving a given hostname to an IPv4 or IPv6 depending on "ip_type". The queue ID is returned, or RESOLVER_INVALID_ID on error. diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index 7994527e5..87ed17129 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -19,9 +19,9 @@ Member Functions ---------------- +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_item` **(** :ref:`Texture` icon, :ref:`bool` selectable=true **)** | +| void | :ref:`add_icon_item` **(** :ref:`Texture` icon, :ref:`bool` selectable=null **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_item` **(** :ref:`String` text, :ref:`Texture` icon=NULL, :ref:`bool` selectable=true **)** | +| void | :ref:`add_item` **(** :ref:`String` text, :ref:`Texture` icon=null, :ref:`bool` selectable=null **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -37,7 +37,7 @@ Member Functions +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_icon_scale` **(** **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_at_pos` **(** :ref:`Vector2` pos, :ref:`bool` exact=false **)** const | +| :ref:`int` | :ref:`get_item_at_pos` **(** :ref:`Vector2` pos, :ref:`bool` exact=null **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_item_count` **(** **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -61,7 +61,9 @@ Member Functions +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolIntArray` | :ref:`get_selected_items` **(** **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_v_scroll` **(** **)** | +| :ref:`VScrollBar` | :ref:`get_v_scroll` **(** **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_auto_height` **(** **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -69,16 +71,18 @@ Member Functions +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_item_tooltip_enabled` **(** :ref:`int` idx **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`is_same_column_width` **(** **)** const | +| :ref:`bool` | :ref:`is_same_column_width` **(** **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_selected` **(** :ref:`int` idx **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_item` **(** :ref:`int` idx **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select` **(** :ref:`int` idx, :ref:`bool` single=true **)** | +| void | :ref:`select` **(** :ref:`int` idx, :ref:`bool` single=null **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_allow_rmb_select` **(** :ref:`bool` allow **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_auto_height` **(** :ref:`bool` enable **)** | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_fixed_column_width` **(** :ref:`int` width **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_fixed_icon_size` **(** :ref:`Vector2` size **)** | @@ -142,6 +146,7 @@ Member Variables ---------------- - :ref:`bool` **allow_rmb_select** +- :ref:`bool` **auto_height** - :ref:`int` **fixed_column_width** - :ref:`int` **icon_mode** - :ref:`float` **icon_scale** @@ -175,13 +180,13 @@ Member Function Description .. _class_ItemList_add_icon_item: -- void **add_icon_item** **(** :ref:`Texture` icon, :ref:`bool` selectable=true **)** +- void **add_icon_item** **(** :ref:`Texture` icon, :ref:`bool` selectable=null **)** Adds an item to the item list with no text, only an icon. .. _class_ItemList_add_item: -- void **add_item** **(** :ref:`String` text, :ref:`Texture` icon=NULL, :ref:`bool` selectable=true **)** +- void **add_item** **(** :ref:`String` text, :ref:`Texture` icon=null, :ref:`bool` selectable=null **)** Adds an item to the item list with specified text. Specify an icon of null for a list item with no icon. @@ -225,7 +230,7 @@ If column size has been fixed to a value, return that value. .. _class_ItemList_get_item_at_pos: -- :ref:`int` **get_item_at_pos** **(** :ref:`Vector2` pos, :ref:`bool` exact=false **)** const +- :ref:`int` **get_item_at_pos** **(** :ref:`Vector2` pos, :ref:`bool` exact=null **)** const Given a position within the control return the item (if any) at that point. @@ -287,10 +292,14 @@ Returns the list of selected indexes. .. _class_ItemList_get_v_scroll: -- :ref:`Object` **get_v_scroll** **(** **)** +- :ref:`VScrollBar` **get_v_scroll** **(** **)** Returns the current vertical scroll bar for the List. +.. _class_ItemList_has_auto_height: + +- :ref:`bool` **has_auto_height** **(** **)** const + .. _class_ItemList_is_item_disabled: - :ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** const @@ -311,7 +320,7 @@ Returns whether the tooptip is enabled for specified item index. .. _class_ItemList_is_same_column_width: -- :ref:`int` **is_same_column_width** **(** **)** const +- :ref:`bool` **is_same_column_width** **(** **)** const Returns whether or not all columns of the list are of the same size. @@ -329,7 +338,7 @@ Remove item at specified index from the list. .. _class_ItemList_select: -- void **select** **(** :ref:`int` idx, :ref:`bool` single=true **)** +- void **select** **(** :ref:`int` idx, :ref:`bool` single=null **)** Select the item at the specified index. @@ -341,6 +350,10 @@ Note: This method does not trigger the item selection signal. Allow (or disallow) selection of (selectable) items in the list using right mouse button. +.. _class_ItemList_set_auto_height: + +- void **set_auto_height** **(** :ref:`bool` enable **)** + .. _class_ItemList_set_fixed_column_width: - void **set_fixed_column_width** **(** :ref:`int` width **)** diff --git a/classes/class_kinematicbody.rst b/classes/class_kinematicbody.rst index 36f2b8685..01eb4f07a 100644 --- a/classes/class_kinematicbody.rst +++ b/classes/class_kinematicbody.rst @@ -18,49 +18,49 @@ Kinematic body 3D node. Member Functions ---------------- -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collision_collider` **(** :ref:`int` collision **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_collider_id` **(** :ref:`int` collision **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_collision_collider_metadata` **(** :ref:`int` collision **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collision_collider_shape` **(** :ref:`int` collision **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_collider_shape_index` **(** :ref:`int` collision **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_collision_collider_velocity` **(** :ref:`int` collision **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_count` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collision_local_shape` **(** :ref:`int` collision **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_collision_normal` **(** :ref:`int` collision **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_collision_position` **(** :ref:`int` collision **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_collision_remainder` **(** :ref:`int` collision **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_collision_travel` **(** :ref:`int` collision **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_floor_velocity` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_safe_margin` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_ceiling` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_floor` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_wall` **(** **)** const | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`move` **(** :ref:`Vector3` rel_vec **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`move_and_slide` **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=Vector3(0, 0, 0), :ref:`float` slope_stop_min_velocity=0.05, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_safe_margin` **(** :ref:`float` pixels **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform` from, :ref:`Vector3` rel_vec **)** | -+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collision_collider` **(** :ref:`int` collision **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_collider_id` **(** :ref:`int` collision **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_collision_collider_metadata` **(** :ref:`int` collision **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collision_collider_shape` **(** :ref:`int` collision **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_collider_shape_index` **(** :ref:`int` collision **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_collision_collider_velocity` **(** :ref:`int` collision **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_count` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collision_local_shape` **(** :ref:`int` collision **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_collision_normal` **(** :ref:`int` collision **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_collision_position` **(** :ref:`int` collision **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_collision_remainder` **(** :ref:`int` collision **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_collision_travel` **(** :ref:`int` collision **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_floor_velocity` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_safe_margin` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_ceiling` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_floor` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_wall` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`move` **(** :ref:`Vector3` rel_vec **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`move_and_slide` **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=4, :ref:`float` slope_stop_min_velocity=0.05, :ref:`int` max_bounces=Vector3( 0, 0, 0 ), :ref:`float` floor_max_angle=null **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_safe_margin` **(** :ref:`float` pixels **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform` from, :ref:`Vector3` rel_vec **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -89,7 +89,7 @@ Member Function Description .. _class_KinematicBody_get_collision_collider_metadata: -- void **get_collision_collider_metadata** **(** :ref:`int` collision **)** const +- :ref:`Variant` **get_collision_collider_metadata** **(** :ref:`int` collision **)** const .. _class_KinematicBody_get_collision_collider_shape: @@ -173,7 +173,7 @@ If the body did not intersect anything, then an empty dictionary (dir.empty()==t .. _class_KinematicBody_move_and_slide: -- :ref:`Vector3` **move_and_slide** **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=Vector3(0, 0, 0), :ref:`float` slope_stop_min_velocity=0.05, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** +- :ref:`Vector3` **move_and_slide** **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=4, :ref:`float` slope_stop_min_velocity=0.05, :ref:`int` max_bounces=Vector3( 0, 0, 0 ), :ref:`float` floor_max_angle=null **)** .. _class_KinematicBody_set_safe_margin: diff --git a/classes/class_kinematicbody2d.rst b/classes/class_kinematicbody2d.rst index 2f5ebbe98..8ec1999f2 100644 --- a/classes/class_kinematicbody2d.rst +++ b/classes/class_kinematicbody2d.rst @@ -18,49 +18,49 @@ Kinematic body 2D node. Member Functions ---------------- -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collision_collider` **(** :ref:`int` collision **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_collider_id` **(** :ref:`int` collision **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_collision_collider_metadata` **(** :ref:`int` collision **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collision_collider_shape` **(** :ref:`int` collision **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_collider_shape_index` **(** :ref:`int` collision **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_collider_velocity` **(** :ref:`int` collision **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_count` **(** **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collision_local_shape` **(** :ref:`int` collision **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_normal` **(** :ref:`int` collision **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_position` **(** :ref:`int` collision **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_remainder` **(** :ref:`int` collision **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_travel` **(** :ref:`int` collision **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_floor_velocity` **(** **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_safe_margin` **(** **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_ceiling` **(** **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_floor` **(** **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_wall` **(** **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`move` **(** :ref:`Vector2` rel_vec **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`move_and_slide` **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2(0, 0), :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_safe_margin` **(** :ref:`float` pixels **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collision_collider` **(** :ref:`int` collision **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_collider_id` **(** :ref:`int` collision **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_collision_collider_metadata` **(** :ref:`int` collision **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collision_collider_shape` **(** :ref:`int` collision **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_collider_shape_index` **(** :ref:`int` collision **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_collider_velocity` **(** :ref:`int` collision **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_count` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collision_local_shape` **(** :ref:`int` collision **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_normal` **(** :ref:`int` collision **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_position` **(** :ref:`int` collision **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_remainder` **(** :ref:`int` collision **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_travel` **(** :ref:`int` collision **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_floor_velocity` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_safe_margin` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_ceiling` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_floor` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_wall` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`move` **(** :ref:`Vector2` rel_vec **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`move_and_slide` **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=4, :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=Vector2( 0, 0 ), :ref:`float` floor_max_angle=null **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_safe_margin` **(** :ref:`float` pixels **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -89,7 +89,7 @@ Member Function Description .. _class_KinematicBody2D_get_collision_collider_metadata: -- void **get_collision_collider_metadata** **(** :ref:`int` collision **)** const +- :ref:`Variant` **get_collision_collider_metadata** **(** :ref:`int` collision **)** const .. _class_KinematicBody2D_get_collision_collider_shape: @@ -175,7 +175,7 @@ If the body did not intersect anything, then an empty dictionary (dir.empty()==t .. _class_KinematicBody2D_move_and_slide: -- :ref:`Vector2` **move_and_slide** **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2(0, 0), :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** +- :ref:`Vector2` **move_and_slide** **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=4, :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=Vector2( 0, 0 ), :ref:`float` floor_max_angle=null **)** .. _class_KinematicBody2D_set_safe_margin: diff --git a/classes/class_light.rst b/classes/class_light.rst index 88d789a86..0e480ea21 100644 --- a/classes/class_light.rst +++ b/classes/class_light.rst @@ -20,35 +20,39 @@ Provides a base class for different kinds of light nodes. Member Functions ---------------- -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cull_mask` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_shadow_color` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_shadow` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_editor_only` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_negative` **(** **)** const | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`Color` color **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cull_mask` **(** :ref:`int` cull_mask **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_editor_only` **(** :ref:`bool` editor_only **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_negative` **(** :ref:`bool` enabled **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow` **(** :ref:`bool` enabled **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_color` **(** :ref:`Color` shadow_color **)** | -+----------------------------+--------------------------------------------------------------------------------------------------------------------+ ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_color` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cull_mask` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_shadow_color` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_shadow_reverse_cull_face` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_shadow` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_editor_only` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_negative` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color` **(** :ref:`Color` color **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cull_mask` **(** :ref:`int` cull_mask **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_editor_only` **(** :ref:`bool` editor_only **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_negative` **(** :ref:`bool` enabled **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow` **(** :ref:`bool` enabled **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_color` **(** :ref:`Color` shadow_color **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_reverse_cull_face` **(** :ref:`bool` enable **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -64,6 +68,7 @@ Member Variables - :ref:`float` **shadow_contact** - :ref:`bool` **shadow_enabled** - :ref:`float` **shadow_max_distance** +- :ref:`bool` **shadow_reverse_cull_face** Numeric Constants ----------------- @@ -81,7 +86,7 @@ Numeric Constants - **PARAM_SHADOW_SPLIT_3_OFFSET** = **10** - **PARAM_SHADOW_NORMAL_BIAS** = **11** - **PARAM_SHADOW_BIAS** = **12** -- **PARAM_MAX** = **13** +- **PARAM_MAX** = **14** Description ----------- @@ -107,6 +112,10 @@ Member Function Description - :ref:`Color` **get_shadow_color** **(** **)** const +.. _class_Light_get_shadow_reverse_cull_face: + +- :ref:`bool` **get_shadow_reverse_cull_face** **(** **)** const + .. _class_Light_has_shadow: - :ref:`bool` **has_shadow** **(** **)** const @@ -147,4 +156,8 @@ Member Function Description - void **set_shadow_color** **(** :ref:`Color` shadow_color **)** +.. _class_Light_set_shadow_reverse_cull_face: + +- void **set_shadow_reverse_cull_face** **(** :ref:`bool` enable **)** + diff --git a/classes/class_light2d.rst b/classes/class_light2d.rst index 3201185a3..02337df25 100644 --- a/classes/class_light2d.rst +++ b/classes/class_light2d.rst @@ -45,7 +45,7 @@ Member Functions +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_shadow_smooth` **(** **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_texture` **(** **)** const | +| :ref:`Texture` | :ref:`get_texture` **(** **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_texture_offset` **(** **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ @@ -93,7 +93,7 @@ Member Functions +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_shadow_smooth` **(** :ref:`float` smooth **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Object` texture **)** | +| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_texture_offset` **(** :ref:`Vector2` texture_offset **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ @@ -119,15 +119,15 @@ Member Variables - :ref:`int` **range_layer_min** - :ref:`int` **range_z_max** - :ref:`int` **range_z_min** -- :ref:`float` **scale** - :ref:`int` **shadow_buffer_size** - :ref:`Color` **shadow_color** - :ref:`bool` **shadow_enabled** -- :ref:`float` **shadow_filter** +- :ref:`int` **shadow_filter** - :ref:`float` **shadow_filter_smooth** - :ref:`float` **shadow_gradient_length** - :ref:`int` **shadow_item_cull_mask** - :ref:`Texture` **texture** +- :ref:`float` **texture_scale** Numeric Constants ----------------- @@ -215,7 +215,7 @@ Return the color of casted shadows for this Light2D. .. _class_Light2D_get_texture: -- :ref:`Object` **get_texture** **(** **)** const +- :ref:`Texture` **get_texture** **(** **)** const Return the texture of the Light2D. @@ -349,7 +349,7 @@ Enable or disable shadows casting from this Light2D according to the 'enabled' p .. _class_Light2D_set_texture: -- void **set_texture** **(** :ref:`Object` texture **)** +- void **set_texture** **(** :ref:`Texture` texture **)** Set the texture of the Light2D. diff --git a/classes/class_line2d.rst b/classes/class_line2d.rst index d05d20a84..ef52da625 100644 --- a/classes/class_line2d.rst +++ b/classes/class_line2d.rst @@ -27,7 +27,7 @@ Member Functions +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_end_cap_mode` **(** **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_gradient` **(** **)** const | +| :ref:`Gradient` | :ref:`get_gradient` **(** **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_joint_mode` **(** **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ @@ -41,7 +41,7 @@ Member Functions +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_sharp_limit` **(** **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_texture` **(** **)** const | +| :ref:`Texture` | :ref:`get_texture` **(** **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_texture_mode` **(** **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ @@ -55,7 +55,7 @@ Member Functions +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_end_cap_mode` **(** :ref:`int` mode **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gradient` **(** :ref:`Object` color **)** | +| void | :ref:`set_gradient` **(** :ref:`Gradient` color **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_joint_mode` **(** :ref:`int` mode **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ @@ -67,7 +67,7 @@ Member Functions +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_sharp_limit` **(** :ref:`float` limit **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Object` texture **)** | +| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_texture_mode` **(** :ref:`int` mode **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ @@ -122,7 +122,7 @@ Member Function Description .. _class_Line2D_get_gradient: -- :ref:`Object` **get_gradient** **(** **)** const +- :ref:`Gradient` **get_gradient** **(** **)** const .. _class_Line2D_get_joint_mode: @@ -150,7 +150,7 @@ Member Function Description .. _class_Line2D_get_texture: -- :ref:`Object` **get_texture** **(** **)** const +- :ref:`Texture` **get_texture** **(** **)** const .. _class_Line2D_get_texture_mode: @@ -178,7 +178,7 @@ Member Function Description .. _class_Line2D_set_gradient: -- void **set_gradient** **(** :ref:`Object` color **)** +- void **set_gradient** **(** :ref:`Gradient` color **)** .. _class_Line2D_set_joint_mode: @@ -202,7 +202,7 @@ Member Function Description .. _class_Line2D_set_texture: -- void **set_texture** **(** :ref:`Object` texture **)** +- void **set_texture** **(** :ref:`Texture` texture **)** .. _class_Line2D_set_texture_mode: diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index 95f076496..67eefb714 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -53,7 +53,7 @@ Member Functions +------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`menu_option` **(** :ref:`int` option **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select` **(** :ref:`int` from=0, :ref:`int` to=-1 **)** | +| void | :ref:`select` **(** :ref:`int` from=-1, :ref:`int` to=0 **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`select_all` **(** **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ @@ -216,7 +216,7 @@ Return the *secret* status of the :ref:`LineEdit` (see :ref:`set .. _class_LineEdit_select: -- void **select** **(** :ref:`int` from=0, :ref:`int` to=-1 **)** +- void **select** **(** :ref:`int` from=-1, :ref:`int` to=0 **)** .. _class_LineEdit_select_all: diff --git a/classes/class_mainloop.rst b/classes/class_mainloop.rst index c99922e75..2570d7b4d 100644 --- a/classes/class_mainloop.rst +++ b/classes/class_mainloop.rst @@ -41,7 +41,7 @@ Member Functions +--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`init` **(** **)** | +--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`input_event` **(** :ref:`Object` ev **)** | +| void | :ref:`input_event` **(** :ref:`InputEvent` ev **)** | +--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`input_text` **(** :ref:`String` text **)** | +--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -58,6 +58,8 @@ Numeric Constants - **NOTIFICATION_WM_QUIT_REQUEST** = **6** - **NOTIFICATION_WM_UNFOCUS_REQUEST** = **8** - **NOTIFICATION_OS_MEMORY_WARNING** = **9** +- **NOTIFICATION_TRANSLATION_CHANGED** = **90** +- **NOTIFICATION_WM_ABOUT** = **91** Description ----------- @@ -109,7 +111,7 @@ Member Function Description .. _class_MainLoop_input_event: -- void **input_event** **(** :ref:`Object` ev **)** +- void **input_event** **(** :ref:`InputEvent` ev **)** .. _class_MainLoop_input_text: diff --git a/classes/class_material.rst b/classes/class_material.rst index aeba6b657..d7df9d03a 100644 --- a/classes/class_material.rst +++ b/classes/class_material.rst @@ -20,16 +20,27 @@ Abstract base :ref:`Resource` for coloring and shading geometry. Member Functions ---------------- -+----------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`get_next_pass` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_next_pass` **(** :ref:`Material` next_pass **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------+ ++----------------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`get_next_pass` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_render_priority` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_next_pass` **(** :ref:`Material` next_pass **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_render_priority` **(** :ref:`int` priority **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- - :ref:`Material` **next_pass** +- :ref:`int` **render_priority** + +Numeric Constants +----------------- + +- **RENDER_PRIORITY_MAX** = **127** +- **RENDER_PRIORITY_MIN** = **-128** Description ----------- @@ -43,8 +54,16 @@ Member Function Description - :ref:`Material` **get_next_pass** **(** **)** const +.. _class_Material_get_render_priority: + +- :ref:`int` **get_render_priority** **(** **)** const + .. _class_Material_set_next_pass: - void **set_next_pass** **(** :ref:`Material` next_pass **)** +.. _class_Material_set_render_priority: + +- void **set_render_priority** **(** :ref:`int` priority **)** + diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index c17dac1be..844971f9a 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -23,7 +23,7 @@ Member Functions +--------------------------------------------------+-------------------------------------------------------------------------------------------------------+ | :ref:`Shape` | :ref:`create_convex_shape` **(** **)** const | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`ArrayMesh` | :ref:`create_outline` **(** :ref:`float` margin **)** const | +| :ref:`Mesh` | :ref:`create_outline` **(** :ref:`float` margin **)** const | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------+ | :ref:`Shape` | :ref:`create_trimesh_shape` **(** **)** const | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------+ @@ -57,7 +57,7 @@ Member Function Description .. _class_Mesh_create_outline: -- :ref:`ArrayMesh` **create_outline** **(** :ref:`float` margin **)** const +- :ref:`Mesh` **create_outline** **(** :ref:`float` margin **)** const .. _class_Mesh_create_trimesh_shape: diff --git a/classes/class_meshdatatool.rst b/classes/class_meshdatatool.rst index cbaf464a4..fefc8b212 100644 --- a/classes/class_meshdatatool.rst +++ b/classes/class_meshdatatool.rst @@ -21,9 +21,9 @@ Member Functions +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`commit_to_surface` **(** :ref:`Object` mesh **)** | +| :ref:`int` | :ref:`commit_to_surface` **(** :ref:`ArrayMesh` mesh **)** | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`create_from_surface` **(** :ref:`Object` mesh, :ref:`int` surface **)** | +| :ref:`int` | :ref:`create_from_surface` **(** :ref:`ArrayMesh` mesh, :ref:`int` surface **)** | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_edge_count` **(** **)** const | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -45,7 +45,7 @@ Member Functions +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_format` **(** **)** const | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_material` **(** **)** const | +| :ref:`Material` | :ref:`get_material` **(** **)** const | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_vertex` **(** :ref:`int` idx **)** const | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -105,11 +105,11 @@ Member Function Description .. _class_MeshDataTool_commit_to_surface: -- :ref:`int` **commit_to_surface** **(** :ref:`Object` mesh **)** +- :ref:`int` **commit_to_surface** **(** :ref:`ArrayMesh` mesh **)** .. _class_MeshDataTool_create_from_surface: -- :ref:`int` **create_from_surface** **(** :ref:`Object` mesh, :ref:`int` surface **)** +- :ref:`int` **create_from_surface** **(** :ref:`ArrayMesh` mesh, :ref:`int` surface **)** .. _class_MeshDataTool_get_edge_count: @@ -153,7 +153,7 @@ Member Function Description .. _class_MeshDataTool_get_material: -- :ref:`Object` **get_material** **(** **)** const +- :ref:`Material` **get_material** **(** **)** const .. _class_MeshDataTool_get_vertex: diff --git a/classes/class_meshlibrary.rst b/classes/class_meshlibrary.rst index 657ee1f36..3ba24d210 100644 --- a/classes/class_meshlibrary.rst +++ b/classes/class_meshlibrary.rst @@ -31,7 +31,9 @@ Member Functions +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`NavigationMesh` | :ref:`get_item_navmesh` **(** :ref:`int` id **)** const | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape` | :ref:`get_item_shape` **(** :ref:`int` id **)** const | +| :ref:`Texture` | :ref:`get_item_preview` **(** :ref:`int` id **)** const | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_item_shapes` **(** :ref:`int` id **)** const | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_last_unused_item_id` **(** **)** const | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -43,7 +45,9 @@ Member Functions +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_navmesh` **(** :ref:`int` id, :ref:`NavigationMesh` navmesh **)** | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_shape` **(** :ref:`int` id, :ref:`Shape` shape **)** | +| void | :ref:`set_item_preview` **(** :ref:`int` id, :ref:`Texture` texture **)** | ++----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ Description @@ -88,9 +92,13 @@ Return the name of the item. - :ref:`NavigationMesh` **get_item_navmesh** **(** :ref:`int` id **)** const -.. _class_MeshLibrary_get_item_shape: +.. _class_MeshLibrary_get_item_preview: -- :ref:`Shape` **get_item_shape** **(** :ref:`int` id **)** const +- :ref:`Texture` **get_item_preview** **(** :ref:`int` id **)** const + +.. _class_MeshLibrary_get_item_shapes: + +- :ref:`Array` **get_item_shapes** **(** :ref:`int` id **)** const .. _class_MeshLibrary_get_last_unused_item_id: @@ -120,8 +128,12 @@ Set the name of the item. - void **set_item_navmesh** **(** :ref:`int` id, :ref:`NavigationMesh` navmesh **)** -.. _class_MeshLibrary_set_item_shape: +.. _class_MeshLibrary_set_item_preview: -- void **set_item_shape** **(** :ref:`int` id, :ref:`Shape` shape **)** +- void **set_item_preview** **(** :ref:`int` id, :ref:`Texture` texture **)** + +.. _class_MeshLibrary_set_item_shapes: + +- void **set_item_shapes** **(** :ref:`int` id, :ref:`Array` shapes **)** diff --git a/classes/class_multimeshinstance.rst b/classes/class_multimeshinstance.rst index ae1600c69..6b2b539e6 100644 --- a/classes/class_multimeshinstance.rst +++ b/classes/class_multimeshinstance.rst @@ -18,11 +18,11 @@ Node that instances a :ref:`MultiMesh`. Member Functions ---------------- -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_multimesh` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_multimesh` **(** :ref:`Object` multimesh **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------+ ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`MultiMesh` | :ref:`get_multimesh` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_multimesh` **(** :ref:`MultiMesh` multimesh **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -39,14 +39,14 @@ Member Function Description .. _class_MultiMeshInstance_get_multimesh: -- :ref:`Object` **get_multimesh** **(** **)** const +- :ref:`MultiMesh` **get_multimesh** **(** **)** const Return the :ref:`MultiMesh` that is used for instancing. .. _class_MultiMeshInstance_set_multimesh: -- void **set_multimesh** **(** :ref:`Object` multimesh **)** +- void **set_multimesh** **(** :ref:`MultiMesh` multimesh **)** -Set the :ref:`MultiMesh` to be instance. +Set the :ref:`MultiMesh` to be instanced. diff --git a/classes/class_mutex.rst b/classes/class_mutex.rst index a5b9e9edf..3761a1a87 100644 --- a/classes/class_mutex.rst +++ b/classes/class_mutex.rst @@ -18,13 +18,13 @@ A synchronization Mutex. Member Functions ---------------- -+--------+----------------------------------------------------+ -| void | :ref:`lock` **(** **)** | -+--------+----------------------------------------------------+ -| Error | :ref:`try_lock` **(** **)** | -+--------+----------------------------------------------------+ -| void | :ref:`unlock` **(** **)** | -+--------+----------------------------------------------------+ ++------------------------+----------------------------------------------------+ +| void | :ref:`lock` **(** **)** | ++------------------------+----------------------------------------------------+ +| :ref:`int` | :ref:`try_lock` **(** **)** | ++------------------------+----------------------------------------------------+ +| void | :ref:`unlock` **(** **)** | ++------------------------+----------------------------------------------------+ Description ----------- @@ -42,7 +42,7 @@ Lock this :ref:`Mutex`, blocks until it is unlocked by the current .. _class_Mutex_try_lock: -- Error **try_lock** **(** **)** +- :ref:`int` **try_lock** **(** **)** Try locking this :ref:`Mutex`, does not block. Returns OK on success else ERR_BUSY. diff --git a/classes/class_nativescript.rst b/classes/class_nativescript.rst new file mode 100644 index 000000000..f15165ddc --- /dev/null +++ b/classes/class_nativescript.rst @@ -0,0 +1,62 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. + +.. _class_NativeScript: + +NativeScript +============ + +**Inherits:** :ref:`Script` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_class_name` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`GDNativeLibrary` | :ref:`get_library` **(** **)** const | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`new` **(** **)** vararg | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_class_name` **(** :ref:`String` class_name **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_library` **(** :ref:`GDNativeLibrary` library **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`String` **class_name** +- :ref:`GDNativeLibrary` **library** + +Member Function Description +--------------------------- + +.. _class_NativeScript_get_class_name: + +- :ref:`String` **get_class_name** **(** **)** const + +.. _class_NativeScript_get_library: + +- :ref:`GDNativeLibrary` **get_library** **(** **)** const + +.. _class_NativeScript_new: + +- :ref:`Object` **new** **(** **)** vararg + +.. _class_NativeScript_set_class_name: + +- void **set_class_name** **(** :ref:`String` class_name **)** + +.. _class_NativeScript_set_library: + +- void **set_library** **(** :ref:`GDNativeLibrary` library **)** + + diff --git a/classes/class_navigation.rst b/classes/class_navigation.rst index 62fd8c76a..e2434d847 100644 --- a/classes/class_navigation.rst +++ b/classes/class_navigation.rst @@ -18,27 +18,27 @@ Brief Description Member Functions ---------------- -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point` **(** :ref:`Vector3` to_point **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point_normal` **(** :ref:`Vector3` to_point **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_closest_point_owner` **(** :ref:`Vector3` to_point **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=false **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_simple_path` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=true **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_up_vector` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`navmesh_create` **(** :ref:`NavigationMesh` mesh, :ref:`Transform` xform, :ref:`Object` owner=NULL **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`navmesh_remove` **(** :ref:`int` id **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`navmesh_set_transform` **(** :ref:`int` id, :ref:`Transform` xform **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_up_vector` **(** :ref:`Vector3` up **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point` **(** :ref:`Vector3` to_point **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point_normal` **(** :ref:`Vector3` to_point **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_closest_point_owner` **(** :ref:`Vector3` to_point **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=null **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_simple_path` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=null **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_up_vector` **(** **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`navmesh_create` **(** :ref:`NavigationMesh` mesh, :ref:`Transform` xform, :ref:`Object` owner=null **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`navmesh_remove` **(** :ref:`int` id **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`navmesh_set_transform` **(** :ref:`int` id, :ref:`Transform` xform **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_up_vector` **(** :ref:`Vector3` up **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -62,11 +62,11 @@ Member Function Description .. _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 **)** +- :ref:`Vector3` **get_closest_point_to_segment** **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=null **)** .. _class_Navigation_get_simple_path: -- :ref:`PoolVector3Array` **get_simple_path** **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=true **)** +- :ref:`PoolVector3Array` **get_simple_path** **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=null **)** .. _class_Navigation_get_up_vector: @@ -74,7 +74,7 @@ Member Function Description .. _class_Navigation_navmesh_create: -- :ref:`int` **navmesh_create** **(** :ref:`NavigationMesh` mesh, :ref:`Transform` xform, :ref:`Object` owner=NULL **)** +- :ref:`int` **navmesh_create** **(** :ref:`NavigationMesh` mesh, :ref:`Transform` xform, :ref:`Object` owner=null **)** .. _class_Navigation_navmesh_remove: diff --git a/classes/class_navigation2d.rst b/classes/class_navigation2d.rst index 0792f7d83..08d90df6d 100644 --- a/classes/class_navigation2d.rst +++ b/classes/class_navigation2d.rst @@ -23,9 +23,9 @@ Member Functions +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`get_closest_point_owner` **(** :ref:`Vector2` to_point **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_simple_path` **(** :ref:`Vector2` start, :ref:`Vector2` end, :ref:`bool` optimize=true **)** | +| :ref:`PoolVector2Array` | :ref:`get_simple_path` **(** :ref:`Vector2` start, :ref:`Vector2` end, :ref:`bool` optimize=null **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`navpoly_create` **(** :ref:`NavigationPolygon` mesh, :ref:`Transform2D` xform, :ref:`Object` owner=NULL **)** | +| :ref:`int` | :ref:`navpoly_create` **(** :ref:`NavigationPolygon` mesh, :ref:`Transform2D` xform, :ref:`Object` owner=null **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`navpoly_remove` **(** :ref:`int` id **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -45,11 +45,11 @@ Member Function Description .. _class_Navigation2D_get_simple_path: -- :ref:`PoolVector2Array` **get_simple_path** **(** :ref:`Vector2` start, :ref:`Vector2` end, :ref:`bool` optimize=true **)** +- :ref:`PoolVector2Array` **get_simple_path** **(** :ref:`Vector2` start, :ref:`Vector2` end, :ref:`bool` optimize=null **)** .. _class_Navigation2D_navpoly_create: -- :ref:`int` **navpoly_create** **(** :ref:`NavigationPolygon` mesh, :ref:`Transform2D` xform, :ref:`Object` owner=NULL **)** +- :ref:`int` **navpoly_create** **(** :ref:`NavigationPolygon` mesh, :ref:`Transform2D` xform, :ref:`Object` owner=null **)** .. _class_Navigation2D_navpoly_remove: diff --git a/classes/class_navigationmesh.rst b/classes/class_navigationmesh.rst index ffdabe48a..2b689b24f 100644 --- a/classes/class_navigationmesh.rst +++ b/classes/class_navigationmesh.rst @@ -23,6 +23,8 @@ Member Functions +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_polygons` **(** **)** | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_from_mesh` **(** :ref:`Mesh` mesh **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolIntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_polygon_count` **(** **)** const | @@ -49,6 +51,10 @@ Member Function Description - void **clear_polygons** **(** **)** +.. _class_NavigationMesh_create_from_mesh: + +- void **create_from_mesh** **(** :ref:`Mesh` mesh **)** + .. _class_NavigationMesh_get_polygon: - :ref:`PoolIntArray` **get_polygon** **(** :ref:`int` idx **)** diff --git a/classes/class_navigationmeshinstance.rst b/classes/class_navigationmeshinstance.rst index 578fe04b2..747a7134d 100644 --- a/classes/class_navigationmeshinstance.rst +++ b/classes/class_navigationmeshinstance.rst @@ -18,15 +18,15 @@ Brief Description Member Functions ---------------- -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_navigation_mesh` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_enabled` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enabled` **(** :ref:`bool` enabled **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_navigation_mesh` **(** :ref:`Object` navmesh **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NavigationMesh` | :ref:`get_navigation_mesh` **(** **)** const | ++----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_enabled` **(** **)** const | ++----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_enabled` **(** :ref:`bool` enabled **)** | ++----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_navigation_mesh` **(** :ref:`NavigationMesh` navmesh **)** | ++----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -39,7 +39,7 @@ Member Function Description .. _class_NavigationMeshInstance_get_navigation_mesh: -- :ref:`Object` **get_navigation_mesh** **(** **)** const +- :ref:`NavigationMesh` **get_navigation_mesh** **(** **)** const .. _class_NavigationMeshInstance_is_enabled: @@ -51,6 +51,6 @@ Member Function Description .. _class_NavigationMeshInstance_set_navigation_mesh: -- void **set_navigation_mesh** **(** :ref:`Object` navmesh **)** +- void **set_navigation_mesh** **(** :ref:`NavigationMesh` navmesh **)** diff --git a/classes/class_navigationpolygon.rst b/classes/class_navigationpolygon.rst index d55dcee05..b5ce1a575 100644 --- a/classes/class_navigationpolygon.rst +++ b/classes/class_navigationpolygon.rst @@ -53,7 +53,7 @@ Member Variables - :ref:`Array` **outlines** - :ref:`Array` **polygons** -- :ref:`PoolVector3Array` **vertices** +- :ref:`PoolVector2Array` **vertices** Member Function Description --------------------------- diff --git a/classes/class_networkedmultiplayerenet.rst b/classes/class_networkedmultiplayerenet.rst index f99a1a23c..0bb0bce45 100644 --- a/classes/class_networkedmultiplayerenet.rst +++ b/classes/class_networkedmultiplayerenet.rst @@ -18,19 +18,19 @@ PacketPeer implementation using the ENet library. Member Functions ---------------- -+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`close_connection` **(** **)** | -+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`create_client` **(** :ref:`String` ip, :ref:`int` port, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** | -+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`create_server` **(** :ref:`int` port, :ref:`int` max_clients=32, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** | -+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_compression_mode` **(** **)** const | -+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bind_ip` **(** :ref:`String` ip **)** | -+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_compression_mode` **(** :ref:`int` mode **)** | -+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`close_connection` **(** **)** | ++------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`create_client` **(** :ref:`String` ip, :ref:`int` port, :ref:`int` in_bandwidth=null, :ref:`int` out_bandwidth=null **)** | ++------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`create_server` **(** :ref:`int` port, :ref:`int` max_clients=0, :ref:`int` in_bandwidth=32, :ref:`int` out_bandwidth=null **)** | ++------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_compression_mode` **(** **)** const | ++------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bind_ip` **(** :ref:`String` ip **)** | ++------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_compression_mode` **(** :ref:`int` mode **)** | ++------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -55,11 +55,11 @@ Member Function Description .. _class_NetworkedMultiplayerENet_create_client: -- :ref:`int` **create_client** **(** :ref:`String` ip, :ref:`int` port, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** +- :ref:`int` **create_client** **(** :ref:`String` ip, :ref:`int` port, :ref:`int` in_bandwidth=null, :ref:`int` out_bandwidth=null **)** .. _class_NetworkedMultiplayerENet_create_server: -- :ref:`int` **create_server** **(** :ref:`int` port, :ref:`int` max_clients=32, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** +- :ref:`int` **create_server** **(** :ref:`int` port, :ref:`int` max_clients=0, :ref:`int` in_bandwidth=32, :ref:`int` out_bandwidth=null **)** .. _class_NetworkedMultiplayerENet_get_compression_mode: diff --git a/classes/class_ninepatchrect.rst b/classes/class_ninepatchrect.rst index db987df62..8f59b9358 100644 --- a/classes/class_ninepatchrect.rst +++ b/classes/class_ninepatchrect.rst @@ -18,31 +18,31 @@ Brief Description Member Functions ---------------- -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_draw_center` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_h_axis_stretch_mode` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_patch_margin` **(** :ref:`int` margin **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_region_rect` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_texture` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_v_axis_stretch_mode` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_draw_center` **(** :ref:`bool` draw_center **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_axis_stretch_mode` **(** :ref:`int` mode **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_patch_margin` **(** :ref:`int` margin, :ref:`int` value **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_region_rect` **(** :ref:`Rect2` rect **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Object` texture **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_axis_stretch_mode` **(** :ref:`int` mode **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_h_axis_stretch_mode` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_patch_margin` **(** :ref:`int` margin **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_region_rect` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_texture` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_v_axis_stretch_mode` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_draw_center_enabled` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_draw_center` **(** :ref:`bool` draw_center **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_axis_stretch_mode` **(** :ref:`int` mode **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_patch_margin` **(** :ref:`int` margin, :ref:`int` value **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_region_rect` **(** :ref:`Rect2` rect **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_axis_stretch_mode` **(** :ref:`int` mode **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -72,10 +72,6 @@ Numeric Constants Member Function Description --------------------------- -.. _class_NinePatchRect_get_draw_center: - -- :ref:`bool` **get_draw_center** **(** **)** const - .. _class_NinePatchRect_get_h_axis_stretch_mode: - :ref:`int` **get_h_axis_stretch_mode** **(** **)** const @@ -90,12 +86,16 @@ Member Function Description .. _class_NinePatchRect_get_texture: -- :ref:`Object` **get_texture** **(** **)** const +- :ref:`Texture` **get_texture** **(** **)** const .. _class_NinePatchRect_get_v_axis_stretch_mode: - :ref:`int` **get_v_axis_stretch_mode** **(** **)** const +.. _class_NinePatchRect_is_draw_center_enabled: + +- :ref:`bool` **is_draw_center_enabled** **(** **)** const + .. _class_NinePatchRect_set_draw_center: - void **set_draw_center** **(** :ref:`bool` draw_center **)** @@ -114,7 +114,7 @@ Member Function Description .. _class_NinePatchRect_set_texture: -- void **set_texture** **(** :ref:`Object` texture **)** +- void **set_texture** **(** :ref:`Texture` texture **)** .. _class_NinePatchRect_set_v_axis_stretch_mode: diff --git a/classes/class_node.rst b/classes/class_node.rst index 44ee80b59..626a41b9c 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -8,7 +8,7 @@ Node **Inherits:** :ref:`Object` -**Inherited By:** :ref:`Viewport`, :ref:`Timer`, :ref:`AudioStreamPlayer`, :ref:`CanvasLayer`, :ref:`Tween`, :ref:`Spatial`, :ref:`AnimationPlayer`, :ref:`EditorFileSystem`, :ref:`EditorPlugin`, :ref:`ResourcePreloader`, :ref:`AnimationTreePlayer`, :ref:`WorldEnvironment`, :ref:`InstancePlaceholder`, :ref:`HTTPRequest`, :ref:`EditorResourcePreview`, :ref:`CanvasItem` +**Inherited By:** :ref:`Viewport`, :ref:`Timer`, :ref:`AudioStreamPlayer`, :ref:`CanvasLayer`, :ref:`Tween`, :ref:`Spatial`, :ref:`AnimationPlayer`, :ref:`EditorFileSystem`, :ref:`EditorPlugin`, :ref:`ResourcePreloader`, :ref:`AnimationTreePlayer`, :ref:`WorldEnvironment`, :ref:`InstancePlaceholder`, :ref:`HTTPRequest`, :ref:`EditorInterface`, :ref:`EditorResourcePreview`, :ref:`CanvasItem` **Category:** Core @@ -20,175 +20,177 @@ Base class for all the *scene* elements. Member Functions ---------------- -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_enter_tree` **(** **)** virtual | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_exit_tree` **(** **)** virtual | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_fixed_process` **(** :ref:`float` delta **)** virtual | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_input` **(** :ref:`InputEvent` event **)** virtual | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_process` **(** :ref:`float` delta **)** virtual | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_ready` **(** **)** virtual | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_unhandled_input` **(** :ref:`InputEvent` event **)** virtual | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_unhandled_key_input` **(** :ref:`InputEventKey` event **)** virtual | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_child` **(** :ref:`Node` node, :ref:`bool` legible_unique_name=false **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_to_group` **(** :ref:`String` group, :ref:`bool` persistent=false **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_process` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`duplicate` **(** :ref:`int` flags=15 **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`find_node` **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_child` **(** :ref:`int` idx **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_child_count` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_children` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_filename` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fixed_process_delta_time` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_groups` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_index` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_network_master` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_node` **(** :ref:`NodePath` path **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_node_and_resource` **(** :ref:`NodePath` path **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_owner` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_parent` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_path` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_path_to` **(** :ref:`Node` node **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_pause_mode` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_position_in_parent` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_process_delta_time` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_scene_instance_load_placeholder` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SceneTree` | :ref:`get_tree` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_viewport` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node` **(** :ref:`NodePath` path **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node_and_resource` **(** :ref:`NodePath` path **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_a_parent_of` **(** :ref:`Node` node **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_displayed_folded` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_fixed_processing` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_fixed_processing_internal` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_greater_than` **(** :ref:`Node` node **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_in_group` **(** :ref:`String` group **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_inside_tree` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_network_master` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_input` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_internal` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_unhandled_input` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_unhandled_key_input` **(** **)** const | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_child` **(** :ref:`Node` child_node, :ref:`int` to_pos **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_stray_nodes` **(** **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_tree` **(** **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`propagate_notification` **(** :ref:`int` what **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_free` **(** **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`raise` **(** **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_and_skip` **(** **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_child` **(** :ref:`Node` node **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_from_group` **(** :ref:`String` group **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`replace_by` **(** :ref:`Node` node, :ref:`bool` keep_data=false **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`request_ready` **(** **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rpc` **(** :ref:`String` method **)** vararg | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rpc_config` **(** :ref:`String` method, :ref:`int` mode **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rpc_id` **(** :ref:`int` peer_id, :ref:`String` method **)** vararg | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rpc_unreliable` **(** :ref:`String` method **)** vararg | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rpc_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` method **)** vararg | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset` **(** :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset_config` **(** :ref:`String` property, :ref:`int` mode **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset_unreliable` **(** :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_display_folded` **(** :ref:`bool` fold **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_filename` **(** :ref:`String` filename **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fixed_process` **(** :ref:`bool` enable **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fixed_process_internal` **(** :ref:`bool` enable **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_name` **(** :ref:`String` name **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_network_master` **(** :ref:`int` id, :ref:`bool` recursive=true **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_owner` **(** :ref:`Node` owner **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pause_mode` **(** :ref:`int` mode **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process` **(** :ref:`bool` enable **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_input` **(** :ref:`bool` enable **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_internal` **(** :ref:`bool` enable **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_unhandled_input` **(** :ref:`bool` enable **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_unhandled_key_input` **(** :ref:`bool` enable **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scene_instance_load_placeholder` **(** :ref:`bool` load_placeholder **)** | -+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_enter_tree` **(** **)** virtual | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_exit_tree` **(** **)** virtual | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_fixed_process` **(** :ref:`float` delta **)** virtual | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_input` **(** :ref:`InputEvent` event **)** virtual | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_process` **(** :ref:`float` delta **)** virtual | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_ready` **(** **)** virtual | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_unhandled_input` **(** :ref:`InputEvent` event **)** virtual | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_unhandled_key_input` **(** :ref:`InputEventKey` event **)** virtual | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_child` **(** :ref:`Node` node, :ref:`bool` legible_unique_name=null **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_to_group` **(** :ref:`String` group, :ref:`bool` persistent=null **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_process` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`duplicate` **(** :ref:`int` flags=15 **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`find_node` **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=null **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_child` **(** :ref:`int` idx **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_child_count` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_children` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_filename` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fixed_process_delta_time` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_groups` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_index` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_network_master` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_node` **(** :ref:`NodePath` path **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_node_and_resource` **(** :ref:`NodePath` path **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_owner` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_parent` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_path` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_path_to` **(** :ref:`Node` node **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_pause_mode` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_position_in_parent` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_process_delta_time` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_scene_instance_load_placeholder` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`SceneTree` | :ref:`get_tree` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Viewport` | :ref:`get_viewport` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_node` **(** :ref:`NodePath` path **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_node_and_resource` **(** :ref:`NodePath` path **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_a_parent_of` **(** :ref:`Node` node **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_displayed_folded` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_fixed_processing` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_fixed_processing_internal` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_greater_than` **(** :ref:`Node` node **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_in_group` **(** :ref:`String` group **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_inside_tree` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_network_master` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_input` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_internal` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_unhandled_input` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_unhandled_key_input` **(** **)** const | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_child` **(** :ref:`Node` child_node, :ref:`int` to_pos **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_stray_nodes` **(** **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_tree` **(** **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`propagate_call` **(** :ref:`String` method, :ref:`Array` args=[ ], :ref:`bool` parent_first=null **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`propagate_notification` **(** :ref:`int` what **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_free` **(** **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`raise` **(** **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_and_skip` **(** **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_child` **(** :ref:`Node` node **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_from_group` **(** :ref:`String` group **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`replace_by` **(** :ref:`Node` node, :ref:`bool` keep_data=null **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`request_ready` **(** **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`rpc` **(** :ref:`String` method **)** vararg | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rpc_config` **(** :ref:`String` method, :ref:`int` mode **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`rpc_id` **(** :ref:`int` peer_id, :ref:`String` method **)** vararg | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`rpc_unreliable` **(** :ref:`String` method **)** vararg | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`rpc_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` method **)** vararg | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset` **(** :ref:`String` property, :ref:`Variant` value **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset_config` **(** :ref:`String` property, :ref:`int` mode **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset_unreliable` **(** :ref:`String` property, :ref:`Variant` value **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_display_folded` **(** :ref:`bool` fold **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_filename` **(** :ref:`String` filename **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fixed_process` **(** :ref:`bool` enable **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fixed_process_internal` **(** :ref:`bool` enable **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_name` **(** :ref:`String` name **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_network_master` **(** :ref:`int` id, :ref:`bool` recursive=null **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_owner` **(** :ref:`Node` owner **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pause_mode` **(** :ref:`int` mode **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process` **(** :ref:`bool` enable **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_input` **(** :ref:`bool` enable **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_internal` **(** :ref:`bool` enable **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_unhandled_input` **(** :ref:`bool` enable **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_unhandled_key_input` **(** :ref:`bool` enable **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scene_instance_load_placeholder` **(** :ref:`bool` load_placeholder **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -323,7 +325,7 @@ Corresponds to the NOTIFICATION_READY notification in :ref:`Object._notification .. _class_Node_add_child: -- void **add_child** **(** :ref:`Node` node, :ref:`bool` legible_unique_name=false **)** +- void **add_child** **(** :ref:`Node` node, :ref:`bool` legible_unique_name=null **)** Add a child :ref:`Node`. Nodes can have as many children as they want, but every child must have a unique name. Children nodes are automatically deleted when the parent node is deleted, so deleting a whole scene is performed by deleting its topmost node. @@ -331,7 +333,7 @@ The optional boolean argument enforces creating child nodes with human-readable .. _class_Node_add_to_group: -- void **add_to_group** **(** :ref:`String` group, :ref:`bool` persistent=false **)** +- void **add_to_group** **(** :ref:`String` group, :ref:`bool` persistent=null **)** Add a node to a group. Groups are helpers to name and organize a subset of nodes, like for example "enemies" or "collectables". A :ref:`Node` can be in any number of groups. Nodes can be assigned a group at any time, but will not be added to it until they are inside the scene tree (see :ref:`is_inside_tree`). @@ -351,7 +353,7 @@ You can fine-tune the behavior using the ``flags``, which are based on the DUPLI .. _class_Node_find_node: -- :ref:`Node` **find_node** **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** const +- :ref:`Node` **find_node** **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=null **)** const Find 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. @@ -489,7 +491,7 @@ Return the time elapsed (in seconds) since the last process callback. This is al .. _class_Node_get_viewport: -- :ref:`Object` **get_viewport** **(** **)** const +- :ref:`Viewport` **get_viewport** **(** **)** const .. _class_Node_has_node: @@ -579,6 +581,12 @@ Move a child node to a different position (order) amongst the other children. Si Print the scene to stdout. Used mainly for debugging purposes. +.. _class_Node_propagate_call: + +- void **propagate_call** **(** :ref:`String` method, :ref:`Array` args=[ ], :ref:`bool` parent_first=null **)** + +Calls the method (if present) with the arguments given in "args" on this Node and recursively on all children. If the parent_first argument is true then the method will be called on the current :ref:`Node` first, then on all children. If it is false then the children will get called first. + .. _class_Node_propagate_notification: - void **propagate_notification** **(** :ref:`int` what **)** @@ -615,7 +623,7 @@ Remove a node from a group. .. _class_Node_replace_by: -- void **replace_by** **(** :ref:`Node` node, :ref:`bool` keep_data=false **)** +- void **replace_by** **(** :ref:`Node` node, :ref:`bool` keep_data=null **)** Replace a node in a scene by a given one. Subscriptions that pass through this node will be lost. @@ -625,7 +633,7 @@ Replace a node in a scene by a given one. Subscriptions that pass through this n .. _class_Node_rpc: -- void **rpc** **(** :ref:`String` method **)** vararg +- :ref:`Variant` **rpc** **(** :ref:`String` method **)** vararg Send a remote procedure call request to all peers on the network (and locally), optionally sending additional data as arguments. Call request will be received by nodes with the same :ref:`NodePath`. @@ -637,19 +645,19 @@ Change the method's RPC mode (one of RPC_MODE\_\* constants). .. _class_Node_rpc_id: -- void **rpc_id** **(** :ref:`int` peer_id, :ref:`String` method **)** vararg +- :ref:`Variant` **rpc_id** **(** :ref:`int` peer_id, :ref:`String` method **)** vararg Send a :ref:`rpc` to a specific peer identified by *peer_id*. .. _class_Node_rpc_unreliable: -- void **rpc_unreliable** **(** :ref:`String` method **)** vararg +- :ref:`Variant` **rpc_unreliable** **(** :ref:`String` method **)** vararg Send a :ref:`rpc` using an unreliable protocol. .. _class_Node_rpc_unreliable_id: -- void **rpc_unreliable_id** **(** :ref:`int` peer_id, :ref:`String` method **)** vararg +- :ref:`Variant` **rpc_unreliable_id** **(** :ref:`int` peer_id, :ref:`String` method **)** vararg Send a :ref:`rpc` to a specific peer identified by *peer_id* using an unreliable protocol. @@ -711,7 +719,7 @@ Set the name of the :ref:`Node`. Name must be unique within parent, .. _class_Node_set_network_master: -- void **set_network_master** **(** :ref:`int` id, :ref:`bool` recursive=true **)** +- void **set_network_master** **(** :ref:`int` id, :ref:`bool` recursive=null **)** .. _class_Node_set_owner: diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index c6febcf3b..28836d5de 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -20,79 +20,83 @@ Base node for 2D system. Member Functions ---------------- -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit_set_pivot` **(** :ref:`Vector2` pivot **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_angle_to` **(** :ref:`Vector2` point **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_global_position` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_global_rotation` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_global_rotation_in_degrees` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_global_scale` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_position` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_relative_transform_to_parent` **(** :ref:`Object` parent **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotation` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_rotation_in_degrees` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scale` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_z` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_translate` **(** :ref:`Vector2` offset **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_z_relative` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`look_at` **(** :ref:`Vector2` point **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_local_x` **(** :ref:`float` delta, :ref:`bool` scaled=false **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_local_y` **(** :ref:`float` delta, :ref:`bool` scaled=false **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rotate` **(** :ref:`float` radians **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scale` **(** :ref:`Vector2` ratio **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_position` **(** :ref:`Vector2` pos **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_rotation` **(** :ref:`float` radians **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_rotation_in_degrees` **(** :ref:`float` degrees **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_scale` **(** :ref:`Vector2` scale **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_transform` **(** :ref:`Transform2D` xform **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_position` **(** :ref:`Vector2` pos **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation` **(** :ref:`float` radians **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation_in_degrees` **(** :ref:`float` degrees **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scale` **(** :ref:`Vector2` scale **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transform` **(** :ref:`Transform2D` xform **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_z` **(** :ref:`int` z **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_z_as_relative` **(** :ref:`bool` enable **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`translate` **(** :ref:`Vector2` offset **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_scale` **(** :ref:`Vector2` ratio **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`edit_set_pivot` **(** :ref:`Vector2` pivot **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_angle_to` **(** :ref:`Vector2` point **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_global_position` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_global_rotation` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_global_rotation_in_degrees` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_global_scale` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_position` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_relative_transform_to_parent` **(** :ref:`Node` parent **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rotation` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_rotation_in_degrees` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_scale` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_z` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_translate` **(** :ref:`Vector2` offset **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_z_relative` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`look_at` **(** :ref:`Vector2` point **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_local_x` **(** :ref:`float` delta, :ref:`bool` scaled=null **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_local_y` **(** :ref:`float` delta, :ref:`bool` scaled=null **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rotate` **(** :ref:`float` radians **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_position` **(** :ref:`Vector2` pos **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_rotation` **(** :ref:`float` radians **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_rotation_in_degrees` **(** :ref:`float` degrees **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_scale` **(** :ref:`Vector2` scale **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_transform` **(** :ref:`Transform2D` xform **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_position` **(** :ref:`Vector2` pos **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotation` **(** :ref:`float` radians **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotation_in_degrees` **(** :ref:`float` degrees **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scale` **(** :ref:`Vector2` scale **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transform` **(** :ref:`Transform2D` xform **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_z` **(** :ref:`int` z **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_z_as_relative` **(** :ref:`bool` enable **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`to_global` **(** :ref:`Vector2` local_point **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`to_local` **(** :ref:`Vector2` global_point **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`translate` **(** :ref:`Vector2` offset **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- -- :ref:`float` **global_position** +- :ref:`Vector2` **global_position** - :ref:`float` **global_rotation** - :ref:`float` **global_rotation_deg** -- :ref:`float` **global_scale** +- :ref:`Vector2` **global_scale** - :ref:`Transform2D` **global_transform** - :ref:`Vector2` **position** - :ref:`float` **rotation** @@ -110,6 +114,12 @@ Base node for 2D system. Node2D contains a position, rotation and scale, which i Member Function Description --------------------------- +.. _class_Node2D_apply_scale: + +- void **apply_scale** **(** :ref:`Vector2` ratio **)** + +Apply the 'ratio' scale to the 2D node, according to its current scale value. + .. _class_Node2D_edit_set_pivot: - void **edit_set_pivot** **(** :ref:`Vector2` pivot **)** @@ -154,7 +164,7 @@ Return the position of the 2D node. .. _class_Node2D_get_relative_transform_to_parent: -- :ref:`Transform2D` **get_relative_transform_to_parent** **(** :ref:`Object` parent **)** const +- :ref:`Transform2D` **get_relative_transform_to_parent** **(** :ref:`Node` parent **)** const Return the transform :ref:`Transform2D` calculated relatively to the parent of this 2D node. @@ -202,13 +212,13 @@ Rotate the 2d node so it points at 'point' position. .. _class_Node2D_move_local_x: -- void **move_local_x** **(** :ref:`float` delta, :ref:`bool` scaled=false **)** +- void **move_local_x** **(** :ref:`float` delta, :ref:`bool` scaled=null **)** Apply a local translation on X axis to the 2D node according to the 'delta' of the process. If 'scaled' is false, the movement is normalized. .. _class_Node2D_move_local_y: -- void **move_local_y** **(** :ref:`float` delta, :ref:`bool` scaled=false **)** +- void **move_local_y** **(** :ref:`float` delta, :ref:`bool` scaled=null **)** Apply a local translation on Y axis to the 2D node according to the 'delta' of the process. If 'scaled' is false, the movement is normalized. @@ -218,12 +228,6 @@ Apply a local translation on Y axis to the 2D node according to the 'delta' of t Apply a rotation (in radians) to the 2D node, starting from its current rotation. -.. _class_Node2D_scale: - -- void **scale** **(** :ref:`Vector2` ratio **)** - -Apply the 'ratio' scale to the 2D node, according to its current scale value. - .. _class_Node2D_set_global_position: - void **set_global_position** **(** :ref:`Vector2` pos **)** @@ -296,6 +300,14 @@ Set the Z-index value of the 2D node. Set the Z-index value as relative to the parent node of this 2D node. Thus, if this 2D node's Z-index value is 2 and its parent's effective Z-index is 3, then the effective Z-index value of this 2D node would be 3 + 2 = 5. +.. _class_Node2D_to_global: + +- :ref:`Vector2` **to_global** **(** :ref:`Vector2` local_point **)** const + +.. _class_Node2D_to_local: + +- :ref:`Vector2` **to_local** **(** :ref:`Vector2` global_point **)** const + .. _class_Node2D_translate: - void **translate** **(** :ref:`Vector2` offset **)** diff --git a/classes/class_object.rst b/classes/class_object.rst index c8efa237f..d3336abe9 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -6,7 +6,7 @@ Object ====== -**Inherited By:** :ref:`Reference`, :ref:`Physics2DServer`, :ref:`Input`, :ref:`Node`, :ref:`Geometry`, :ref:`TreeItem`, :ref:`PhysicsDirectSpaceState`, :ref:`Engine`, :ref:`Physics2DDirectSpaceState`, :ref:`MainLoop`, :ref:`InputMap`, :ref:`UndoRedo`, :ref:`PhysicsServer`, :ref:`ProjectSettings`, :ref:`ResourceSaver`, :ref:`Performance`, :ref:`ResourceLoader`, :ref:`AudioServer`, :ref:`VisualServer`, :ref:`IP`, :ref:`ClassDB`, :ref:`OS`, :ref:`PhysicsDirectBodyState`, :ref:`EditorSelection`, :ref:`Physics2DDirectBodyState`, :ref:`TranslationServer`, :ref:`EditorFileSystemDirectory` +**Inherited By:** :ref:`Reference`, :ref:`Physics2DServer`, :ref:`Input`, :ref:`Node`, :ref:`Geometry`, :ref:`ARVRPositionalTracker`, :ref:`TreeItem`, :ref:`PhysicsDirectBodyState`, :ref:`ARVRServer`, :ref:`PhysicsDirectSpaceState`, :ref:`Engine`, :ref:`Physics2DDirectSpaceState`, :ref:`MainLoop`, :ref:`InputMap`, :ref:`UndoRedo`, :ref:`PhysicsServer`, :ref:`ProjectSettings`, :ref:`ResourceSaver`, :ref:`Performance`, :ref:`ResourceLoader`, :ref:`AudioServer`, :ref:`VisualServer`, :ref:`IP`, :ref:`ClassDB`, :ref:`OS`, :ref:`EditorSelection`, :ref:`Physics2DDirectBodyState`, :ref:`TranslationServer`, :ref:`EditorFileSystemDirectory` **Category:** Core @@ -18,89 +18,87 @@ Base class for all non built-in types. Member Functions ---------------- -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`XL_MESSAGE` **(** :ref:`String` message **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_get` **(** :ref:`String` property **)** virtual | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`_get_property_list` **(** **)** virtual | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_init` **(** **)** virtual | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_notification` **(** :ref:`int` what **)** virtual | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_set` **(** :ref:`String` property, :ref:`Variant` value **)** virtual | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_user_signal` **(** :ref:`String` signal, :ref:`Array` arguments=[] **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call` **(** :ref:`String` method **)** vararg | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`call_deferred` **(** :ref:`String` method **)** vararg | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`callv` **(** :ref:`String` method, :ref:`Array` arg_array **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_translate_messages` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`connect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=[], :ref:`int` flags=0 **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`emit_signal` **(** :ref:`String` signal **)** vararg | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get` **(** :ref:`String` property **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_class` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_incoming_connections` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_instance_ID` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_meta` **(** :ref:`String` name **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_meta_list` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_method_list` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_property_list` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Script` | :ref:`get_script` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_signal_connection_list` **(** :ref:`String` signal **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_signal_list` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_meta` **(** :ref:`String` name **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_method` **(** :ref:`String` method **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_user_signal` **(** :ref:`String` signal **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_blocking_signals` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_class` **(** :ref:`String` type **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_connected` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_queued_for_deletion` **(** **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`notification` **(** :ref:`int` what, :ref:`bool` reversed=false **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`property_list_changed_notify` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_block_signals` **(** :ref:`bool` enable **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_message_translation` **(** :ref:`bool` enable **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_meta` **(** :ref:`String` name, :ref:`Variant` value **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_script` **(** :ref:`Script` script **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`tr` **(** :ref:`String` message **)** const | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_get` **(** :ref:`String` property **)** virtual | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`_get_property_list` **(** **)** virtual | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_init` **(** **)** virtual | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_notification` **(** :ref:`int` what **)** virtual | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_set` **(** :ref:`String` property, :ref:`Variant` value **)** virtual | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_user_signal` **(** :ref:`String` signal, :ref:`Array` arguments=null **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`call` **(** :ref:`String` method **)** vararg | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`call_deferred` **(** :ref:`String` method **)** vararg | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`callv` **(** :ref:`String` method, :ref:`Array` arg_array **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_translate_messages` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`connect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=null, :ref:`int` flags=null **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`emit_signal` **(** :ref:`String` signal **)** vararg | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`free` **(** **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get` **(** :ref:`String` property **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_class` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_incoming_connections` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_instance_id` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_meta` **(** :ref:`String` name **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_meta_list` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_method_list` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_property_list` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Reference` | :ref:`get_script` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_signal_connection_list` **(** :ref:`String` signal **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_signal_list` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_meta` **(** :ref:`String` name **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_method` **(** :ref:`String` method **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_user_signal` **(** :ref:`String` signal **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_blocking_signals` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_class` **(** :ref:`String` type **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_connected` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_queued_for_deletion` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`notification` **(** :ref:`int` what, :ref:`bool` reversed=null **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`property_list_changed_notify` **(** **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`String` property, :ref:`Variant` value **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_block_signals` **(** :ref:`bool` enable **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_message_translation` **(** :ref:`bool` enable **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_meta` **(** :ref:`String` name, :ref:`Variant` value **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_script` **(** :ref:`Reference` script **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`tr` **(** :ref:`String` message **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -132,12 +130,6 @@ Objects also receive notifications (:ref:`_notification` **XL_MESSAGE** **(** :ref:`String` message **)** const - -Deprecated, will go away. - .. _class_Object__get: - void **_get** **(** :ref:`String` property **)** virtual @@ -162,13 +154,13 @@ Notification request, the notification id is received. .. _class_Object__set: -- void **_set** **(** :ref:`String` property, :ref:`Variant` value **)** virtual +- :ref:`bool` **_set** **(** :ref:`String` property, :ref:`Variant` value **)** virtual Set a property. Return true if the property was found. .. _class_Object_add_user_signal: -- void **add_user_signal** **(** :ref:`String` signal, :ref:`Array` arguments=[] **)** +- void **add_user_signal** **(** :ref:`String` signal, :ref:`Array` arguments=null **)** Add a user signal (can be added anytime). Arguments are optional, but can be added as an array of dictionaries, each containing "name" and "type" (from :ref:`@Global Scope` TYPE\_\*). @@ -178,7 +170,7 @@ Add a user signal (can be added anytime). Arguments are optional, but can be add .. _class_Object_call_deferred: -- void **call_deferred** **(** :ref:`String` method **)** vararg +- :ref:`Variant` **call_deferred** **(** :ref:`String` method **)** vararg .. _class_Object_callv: @@ -192,7 +184,7 @@ Return true if this object can translate strings. .. _class_Object_connect: -- :ref:`int` **connect** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=[], :ref:`int` flags=0 **)** +- :ref:`int` **connect** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=null, :ref:`int` flags=null **)** Connect a signal to a method at a target (member function). Binds are optional and are passed as extra arguments to the call. Flags specify optional deferred or one shot connections, see enum CONNECT\_\*. A signal can only be connected once to a method, and it will throw an error if already connected. If you want to avoid this, use :ref:`is_connected` to check. @@ -204,7 +196,7 @@ Disconnect a signal from a method. .. _class_Object_emit_signal: -- void **emit_signal** **(** :ref:`String` signal **)** vararg +- :ref:`Variant` **emit_signal** **(** :ref:`String` signal **)** vararg .. _class_Object_free: @@ -236,9 +228,9 @@ Inside each :ref:`Dictionary` there are 3 fields: - "method_name" is a name of method to which signal is connected. -.. _class_Object_get_instance_ID: +.. _class_Object_get_instance_id: -- :ref:`int` **get_instance_ID** **(** **)** const +- :ref:`int` **get_instance_id** **(** **)** const Return the instance ID. All objects have a unique instance ID. @@ -266,7 +258,7 @@ Return the list of properties as an array of dictionaries, dictionaries contain: .. _class_Object_get_script: -- :ref:`Script` **get_script** **(** **)** const +- :ref:`Reference` **get_script** **(** **)** const Return the object script (or null if it doesn't have one). @@ -318,7 +310,7 @@ Return true if a connection exists for a given signal and target/method. .. _class_Object_notification: -- void **notification** **(** :ref:`int` what, :ref:`bool` reversed=false **)** +- void **notification** **(** :ref:`int` what, :ref:`bool` reversed=null **)** Notify the object of something. @@ -342,7 +334,7 @@ If set to true, signal emission is blocked. - void **set_message_translation** **(** :ref:`bool` enable **)** -Set true if this object can translate strings (in calls to tr() ). Default is true. +Define whether this object can translate strings (with calls to :ref:`tr`). Default is true. .. _class_Object_set_meta: @@ -352,7 +344,7 @@ Set a metadata into the object. Metadata is serialized. Metadata can be *anythin .. _class_Object_set_script: -- void **set_script** **(** :ref:`Script` script **)** +- void **set_script** **(** :ref:`Reference` script **)** Set a script into the object, scripts extend the object functionality. @@ -360,6 +352,6 @@ Set a script into the object, scripts extend the object functionality. - :ref:`String` **tr** **(** :ref:`String` message **)** const -Translate a message. Only works in message translation is enabled (which is by default). See :ref:`set_message_translation`. +Translate a message. Only works if message translation is enabled (which it is by default). See :ref:`set_message_translation`. diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index ebf0e301a..465efc6b4 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -21,25 +21,25 @@ Member Functions +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_icon_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1 **)** | +| void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=null **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_separator` **(** **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_ID` **(** :ref:`int` idx **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_item_count` **(** **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_id` **(** :ref:`int` idx **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_selected` **(** **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selected_ID` **(** **)** const | +| :ref:`int` | :ref:`get_selected_id` **(** **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_selected_metadata` **(** **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -49,12 +49,12 @@ Member Functions +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`select` **(** :ref:`int` idx **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_ID` **(** :ref:`int` idx, :ref:`int` id **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` texture **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_id` **(** :ref:`int` idx, :ref:`int` id **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | @@ -89,7 +89,7 @@ Add an item, with a "texture" icon, text "label" and (optionally) id. If no "id" .. _class_OptionButton_add_item: -- void **add_item** **(** :ref:`String` label, :ref:`int` id=-1 **)** +- void **add_item** **(** :ref:`String` label, :ref:`int` id=null **)** 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. @@ -105,12 +105,6 @@ Add a separator to the list of items. Separators help to group items. Separator Clear all the items in the :ref:`OptionButton`. -.. _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_count: - :ref:`int` **get_item_count** **(** **)** const @@ -123,6 +117,12 @@ Return the amount of items in the OptionButton. Return the icon of the item at index "idx". +.. _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: - :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const @@ -139,9 +139,9 @@ Return the text of the item at index "idx". Return the current item index -.. _class_OptionButton_get_selected_ID: +.. _class_OptionButton_get_selected_id: -- :ref:`int` **get_selected_ID** **(** **)** const +- :ref:`int` **get_selected_id** **(** **)** const .. _class_OptionButton_get_selected_metadata: @@ -161,12 +161,6 @@ Return the current item index Select an item by index and make it the current item. -.. _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_disabled: - void **set_item_disabled** **(** :ref:`int` idx, :ref:`bool` disabled **)** @@ -177,6 +171,12 @@ Set the ID of an item at index "idx". Set the icon of an item at index "idx". +.. _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: - void **set_item_metadata** **(** :ref:`int` idx, :ref:`Variant` metadata **)** diff --git a/classes/class_os.rst b/classes/class_os.rst index d791bffc9..ef05a951b 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -19,7 +19,7 @@ Member Functions ---------------- +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`alert` **(** :ref:`String` text, :ref:`String` title="Alert!" **)** | +| void | :ref:`alert` **(** :ref:`String` text, :ref:`String` title=null **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`can_draw` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -33,7 +33,7 @@ Member Functions +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`dump_resources_to_file` **(** :ref:`String` file **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`execute` **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=[] **)** | +| :ref:`int` | :ref:`execute` **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=null **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`find_scancode_from_string` **(** :ref:`String` string **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -75,7 +75,7 @@ Member Functions +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_power_state` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_process_ID` **(** **)** const | +| :ref:`int` | :ref:`get_process_id` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_processor_count` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -83,13 +83,13 @@ Member Functions +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_screen_count` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_screen_dpi` **(** :ref:`int` screen=0 **)** const | +| :ref:`int` | :ref:`get_screen_dpi` **(** :ref:`int` screen=-1 **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_screen_orientation` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_screen_position` **(** :ref:`int` screen=0 **)** const | +| :ref:`Vector2` | :ref:`get_screen_position` **(** :ref:`int` screen=-1 **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_screen_size` **(** :ref:`int` screen=0 **)** const | +| :ref:`Vector2` | :ref:`get_screen_size` **(** :ref:`int` screen=-1 **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_splash_tick_msec` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -107,7 +107,7 @@ Member Functions +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_time_zone_info` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_unique_ID` **(** **)** const | +| :ref:`String` | :ref:`get_unique_id` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_unix_time` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -177,9 +177,9 @@ Member Functions +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_exit_code` **(** :ref:`int` code **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon` **(** :ref:`Object` icon **)** | +| void | :ref:`set_icon` **(** :ref:`Image` icon **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ime_position` **(** :ref:`Vector2` arg0 **)** | +| void | :ref:`set_ime_position` **(** :ref:`Vector2` position **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_keep_screen_on` **(** :ref:`bool` enabled **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -265,7 +265,7 @@ Member Function Description .. _class_OS_alert: -- void **alert** **(** :ref:`String` text, :ref:`String` title="Alert!" **)** +- void **alert** **(** :ref:`String` text, :ref:`String` title=null **)** Displays a modal dialog box utilizing the host OS. @@ -313,7 +313,7 @@ At the end of the file is a statistic of all used Resource Types. .. _class_OS_execute: -- :ref:`int` **execute** **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=[] **)** +- :ref:`int` **execute** **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=null **)** Execute the binary file in given path, optionally blocking until it returns. A process ID is returned. @@ -433,9 +433,9 @@ Return the name of the host OS. Possible values are: "Android", "Haiku", "iOS", - :ref:`int` **get_power_state** **(** **)** -.. _class_OS_get_process_ID: +.. _class_OS_get_process_id: -- :ref:`int` **get_process_ID** **(** **)** const +- :ref:`int` **get_process_id** **(** **)** const Returns the game process ID @@ -459,7 +459,7 @@ Returns the number of displays attached to the host machine .. _class_OS_get_screen_dpi: -- :ref:`int` **get_screen_dpi** **(** :ref:`int` screen=0 **)** const +- :ref:`int` **get_screen_dpi** **(** :ref:`int` screen=-1 **)** const Returns the dots per inch density of the specified screen. @@ -487,11 +487,11 @@ Returns the current screen orientation, the return value will be one of the SCRE .. _class_OS_get_screen_position: -- :ref:`Vector2` **get_screen_position** **(** :ref:`int` screen=0 **)** const +- :ref:`Vector2` **get_screen_position** **(** :ref:`int` screen=-1 **)** const .. _class_OS_get_screen_size: -- :ref:`Vector2` **get_screen_size** **(** :ref:`int` screen=0 **)** const +- :ref:`Vector2` **get_screen_size** **(** :ref:`int` screen=-1 **)** const Returns the dimensions in pixels of the specified screen. @@ -533,9 +533,9 @@ Returns current time as a dictionary of keys: hour, minute, second - :ref:`Dictionary` **get_time_zone_info** **(** **)** const -.. _class_OS_get_unique_ID: +.. _class_OS_get_unique_id: -- :ref:`String` **get_unique_ID** **(** **)** const +- :ref:`String` **get_unique_id** **(** **)** const .. _class_OS_get_unix_time: @@ -713,11 +713,11 @@ Set clipboard to the OS. .. _class_OS_set_icon: -- void **set_icon** **(** :ref:`Object` icon **)** +- void **set_icon** **(** :ref:`Image` icon **)** .. _class_OS_set_ime_position: -- void **set_ime_position** **(** :ref:`Vector2` arg0 **)** +- void **set_ime_position** **(** :ref:`Vector2` position **)** .. _class_OS_set_keep_screen_on: diff --git a/classes/class_packeddatacontainer.rst b/classes/class_packeddatacontainer.rst index dcc2f70f1..8471921bd 100644 --- a/classes/class_packeddatacontainer.rst +++ b/classes/class_packeddatacontainer.rst @@ -19,7 +19,7 @@ Member Functions ---------------- +------------------------+-----------------------------------------------------------------------------------------------+ -| Error | :ref:`pack` **(** :ref:`Variant` value **)** | +| :ref:`int` | :ref:`pack` **(** :ref:`Variant` value **)** | +------------------------+-----------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`size` **(** **)** const | +------------------------+-----------------------------------------------------------------------------------------------+ @@ -34,7 +34,7 @@ Member Function Description .. _class_PackedDataContainer_pack: -- Error **pack** **(** :ref:`Variant` value **)** +- :ref:`int` **pack** **(** :ref:`Variant` value **)** .. _class_PackedDataContainer_size: diff --git a/classes/class_packetpeer.rst b/classes/class_packetpeer.rst index 0faa32d1d..11d4f11b8 100644 --- a/classes/class_packetpeer.rst +++ b/classes/class_packetpeer.rst @@ -20,19 +20,23 @@ Abstraction and base class for packet-based protocols. Member Functions ---------------- -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_available_packet_count` **(** **)** const | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_packet` **(** **)** const | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`get_packet_error` **(** **)** const | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_var` **(** **)** const | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`put_packet` **(** :ref:`PoolByteArray` buffer **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`put_var` **(** :ref:`Variant` var **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_available_packet_count` **(** **)** const | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`get_packet` **(** **)** const | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_packet_error` **(** **)** const | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_var` **(** **)** const | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_object_decoding_allowed` **(** **)** const | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`put_packet` **(** :ref:`PoolByteArray` buffer **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`put_var` **(** :ref:`Variant` var **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_allow_object_decoding` **(** :ref:`bool` enable **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -56,7 +60,7 @@ Get a raw packet. .. _class_PacketPeer_get_packet_error: -- Error **get_packet_error** **(** **)** const +- :ref:`int` **get_packet_error** **(** **)** const Return the error state of the last packet received (via :ref:`get_packet` and :ref:`get_var`). @@ -66,9 +70,13 @@ Return the error state of the last packet received (via :ref:`get_packet` **is_object_decoding_allowed** **(** **)** const + .. _class_PacketPeer_put_packet: -- Error **put_packet** **(** :ref:`PoolByteArray` buffer **)** +- :ref:`int` **put_packet** **(** :ref:`PoolByteArray` buffer **)** Send a raw packet. @@ -78,4 +86,8 @@ Send a raw packet. Send a Variant as a packet. +.. _class_PacketPeer_set_allow_object_decoding: + +- void **set_allow_object_decoding** **(** :ref:`bool` enable **)** + diff --git a/classes/class_packetpeerstream.rst b/classes/class_packetpeerstream.rst index 4ac73a3f1..2e9cfa4fa 100644 --- a/classes/class_packetpeerstream.rst +++ b/classes/class_packetpeerstream.rst @@ -18,9 +18,17 @@ Wrapper to use a PacketPeer over a StreamPeer. Member Functions ---------------- -+-------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stream_peer` **(** :ref:`StreamPeer` peer **)** | -+-------+-----------------------------------------------------------------------------------------------------------------------+ ++------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_input_buffer_max_size` **(** **)** const | ++------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_output_buffer_max_size` **(** **)** const | ++------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_input_buffer_max_size` **(** :ref:`int` max_size_bytes **)** | ++------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_output_buffer_max_size` **(** :ref:`int` max_size_bytes **)** | ++------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stream_peer` **(** :ref:`Reference` peer **)** | ++------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -30,10 +38,26 @@ PacketStreamPeer provides a wrapper for working using packets over a stream. Thi Member Function Description --------------------------- +.. _class_PacketPeerStream_get_input_buffer_max_size: + +- :ref:`int` **get_input_buffer_max_size** **(** **)** const + +.. _class_PacketPeerStream_get_output_buffer_max_size: + +- :ref:`int` **get_output_buffer_max_size** **(** **)** const + +.. _class_PacketPeerStream_set_input_buffer_max_size: + +- void **set_input_buffer_max_size** **(** :ref:`int` max_size_bytes **)** + +.. _class_PacketPeerStream_set_output_buffer_max_size: + +- void **set_output_buffer_max_size** **(** :ref:`int` max_size_bytes **)** + .. _class_PacketPeerStream_set_stream_peer: -- void **set_stream_peer** **(** :ref:`StreamPeer` peer **)** +- void **set_stream_peer** **(** :ref:`Reference` peer **)** -Set the StreamPeer object to be wrapped +Set the :ref:`StreamPeer` object to be wrapped. diff --git a/classes/class_packetpeerudp.rst b/classes/class_packetpeerudp.rst index bfbaca2b2..3daf2a72a 100644 --- a/classes/class_packetpeerudp.rst +++ b/classes/class_packetpeerudp.rst @@ -18,21 +18,21 @@ UDP packet peer. Member Functions ---------------- -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`close` **(** **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_packet_ip` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_packet_port` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_listening` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=65536 **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`set_dest_address` **(** :ref:`String` host, :ref:`int` port **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`wait` **(** **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`close` **(** **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_packet_ip` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_packet_port` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_listening` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=null **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`set_dest_address` **(** :ref:`String` host, :ref:`int` port **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`wait` **(** **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -68,7 +68,7 @@ Return whether this :ref:`PacketPeerUDP` is listening. .. _class_PacketPeerUDP_listen: -- Error **listen** **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=65536 **)** +- :ref:`int` **listen** **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=null **)** Make this :ref:`PacketPeerUDP` listen on the "port" binding to "bind_address" with a buffer size "recv_buf_size". @@ -86,7 +86,7 @@ Set the destination address and port for sending packets and variables, a hostna .. _class_PacketPeerUDP_wait: -- Error **wait** **(** **)** +- :ref:`int` **wait** **(** **)** Wait for a packet to arrive on the listening port, see :ref:`listen`. diff --git a/classes/class_particles.rst b/classes/class_particles.rst index 0a9cdba11..53738e396 100644 --- a/classes/class_particles.rst +++ b/classes/class_particles.rst @@ -106,7 +106,7 @@ Member Variables - :ref:`bool` **local_coords** - :ref:`bool` **one_shot** - :ref:`float` **preprocess** -- ShaderMaterial,ParticlesMaterial **process_material** +- :ref:`Material` **process_material** - :ref:`float` **randomness** - :ref:`float` **speed_scale** - :ref:`Rect3` **visibility_aabb** diff --git a/classes/class_particles2d.rst b/classes/class_particles2d.rst index 77595f3f2..45bbeef37 100644 --- a/classes/class_particles2d.rst +++ b/classes/class_particles2d.rst @@ -111,12 +111,12 @@ Member Variables - :ref:`Texture` **normal_map** - :ref:`bool` **one_shot** - :ref:`float` **preprocess** -- ShaderMaterial,ParticlesMaterial **process_material** +- :ref:`Material` **process_material** - :ref:`float` **randomness** - :ref:`float` **speed_scale** - :ref:`Texture` **texture** - :ref:`int` **v_frames** -- :ref:`Rect3` **visibility_rect** +- :ref:`Rect2` **visibility_rect** Numeric Constants ----------------- diff --git a/classes/class_particlesmaterial.rst b/classes/class_particlesmaterial.rst index dad26bc82..58bc5519f 100644 --- a/classes/class_particlesmaterial.rst +++ b/classes/class_particlesmaterial.rst @@ -47,7 +47,7 @@ Member Functions +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_param_randomness` **(** :ref:`int` param **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_param_texture` **(** :ref:`int` param **)** const | +| :ref:`Texture` | :ref:`get_param_texture` **(** :ref:`int` param **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_spread` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -85,7 +85,7 @@ Member Functions +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_param_randomness` **(** :ref:`int` param, :ref:`float` randomness **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param_texture` **(** :ref:`int` param, :ref:`Object` texture **)** | +| void | :ref:`set_param_texture` **(** :ref:`int` param, :ref:`Texture` texture **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_spread` **(** :ref:`float` degrees **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -100,22 +100,22 @@ Member Variables ---------------- - :ref:`float` **angle** -- :ref:`CurveTexture` **angle_curve** +- :ref:`Texture` **angle_curve** - :ref:`float` **angle_random** - :ref:`float` **angular_velocity** -- :ref:`CurveTexture` **angular_velocity_curve** +- :ref:`Texture` **angular_velocity_curve** - :ref:`float` **angular_velocity_random** - :ref:`bool` **anim_loop** - :ref:`float` **anim_offset** -- :ref:`CurveTexture` **anim_offset_curve** +- :ref:`Texture` **anim_offset_curve** - :ref:`float` **anim_offset_random** - :ref:`float` **anim_speed** -- :ref:`CurveTexture` **anim_speed_curve** +- :ref:`Texture` **anim_speed_curve** - :ref:`float` **anim_speed_random** - :ref:`Color` **color** -- :ref:`GradientTexture` **color_ramp** +- :ref:`Texture` **color_ramp** - :ref:`float` **damping** -- :ref:`CurveTexture` **damping_curve** +- :ref:`Texture` **damping_curve** - :ref:`float` **damping_random** - :ref:`Vector3` **emission_box_extents** - :ref:`Texture` **emission_color_texture** @@ -130,25 +130,25 @@ Member Variables - :ref:`float` **flatness** - :ref:`Vector3` **gravity** - :ref:`float` **hue_variation** -- :ref:`CurveTexture` **hue_variation_curve** +- :ref:`Texture` **hue_variation_curve** - :ref:`float` **hue_variation_random** - :ref:`float` **initial_velocity** - :ref:`float` **initial_velocity_random** - :ref:`float` **linear_accel** -- :ref:`CurveTexture` **linear_accel_curve** +- :ref:`Texture` **linear_accel_curve** - :ref:`float` **linear_accel_random** - :ref:`float` **orbit_velocity** -- :ref:`CurveTexture` **orbit_velocity_curve** +- :ref:`Texture` **orbit_velocity_curve** - :ref:`float` **orbit_velocity_random** - :ref:`float` **radial_accel** -- :ref:`CurveTexture` **radial_accel_curve** +- :ref:`Texture` **radial_accel_curve** - :ref:`float` **radial_accel_random** - :ref:`float` **scale** -- :ref:`CurveTexture` **scale_curve** +- :ref:`Texture` **scale_curve** - :ref:`float` **scale_random** - :ref:`float` **spread** - :ref:`float` **tangential_accel** -- :ref:`CurveTexture` **tangential_accel_curve** +- :ref:`Texture` **tangential_accel_curve** - :ref:`float` **tangential_accel_random** - :ref:`GradientTexture` **trail_color_modifier** - :ref:`int` **trail_divisor** @@ -240,7 +240,7 @@ Member Function Description .. _class_ParticlesMaterial_get_param_texture: -- :ref:`Object` **get_param_texture** **(** :ref:`int` param **)** const +- :ref:`Texture` **get_param_texture** **(** :ref:`int` param **)** const .. _class_ParticlesMaterial_get_spread: @@ -316,7 +316,7 @@ Member Function Description .. _class_ParticlesMaterial_set_param_texture: -- void **set_param_texture** **(** :ref:`int` param, :ref:`Object` texture **)** +- void **set_param_texture** **(** :ref:`int` param, :ref:`Texture` texture **)** .. _class_ParticlesMaterial_set_spread: diff --git a/classes/class_physics2ddirectspacestate.rst b/classes/class_physics2ddirectspacestate.rst index a64a5181a..1278be7c0 100644 --- a/classes/class_physics2ddirectspacestate.rst +++ b/classes/class_physics2ddirectspacestate.rst @@ -18,19 +18,19 @@ Direct access object to a space in the :ref:`Physics2DServer` | :ref:`cast_motion` **(** :ref:`Physics2DShapeQueryParameters` shape **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`collide_shape` **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`Physics2DShapeQueryParameters` shape **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`intersect_point` **(** :ref:`Vector2` point, :ref:`int` max_results=32, :ref:`Array` exclude=[], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=[], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`intersect_shape` **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`cast_motion` **(** :ref:`Physics2DShapeQueryParameters` shape **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`collide_shape` **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=null **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`Physics2DShapeQueryParameters` shape **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`intersect_point` **(** :ref:`Vector2` point, :ref:`int` max_results=2147483647, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=32, :ref:`int` type_mask=null **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=null, :ref:`int` type_mask=null **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`intersect_shape` **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=null **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -60,7 +60,7 @@ If the shape can not move, the array will be empty. .. _class_Physics2DDirectSpaceState_collide_shape: -- :ref:`Array` **collide_shape** **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** +- :ref:`Array` **collide_shape** **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=null **)** Check 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. @@ -90,7 +90,7 @@ If the shape did not intersect anything, then an empty dictionary (dir.empty()== .. _class_Physics2DDirectSpaceState_intersect_point: -- :ref:`Array` **intersect_point** **(** :ref:`Vector2` point, :ref:`int` max_results=32, :ref:`Array` exclude=[], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** +- :ref:`Array` **intersect_point** **(** :ref:`Vector2` point, :ref:`int` max_results=2147483647, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=32, :ref:`int` type_mask=null **)** Check whether a point is inside any shape. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: @@ -108,7 +108,7 @@ Additionally, the method can take an array of objects or :ref:`RID`\ .. _class_Physics2DDirectSpaceState_intersect_ray: -- :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=[], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** +- :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=null, :ref:`int` type_mask=null **)** Intersect a ray in a given space. The returned object is a dictionary with the following fields: @@ -132,7 +132,7 @@ Additionally, the method can take an array of objects or :ref:`RID`\ .. _class_Physics2DDirectSpaceState_intersect_shape: -- :ref:`Array` **intersect_shape** **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** +- :ref:`Array` **intersect_shape** **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=null **)** Check the intersections of a shape, given through a :ref:`Physics2DShapeQueryParameters` object, against the space. The intersected shapes are returned in an array containing dictionaries with the following fields: diff --git a/classes/class_physics2dserver.rst b/classes/class_physics2dserver.rst index 703662e2a..1fc6a2da2 100644 --- a/classes/class_physics2dserver.rst +++ b/classes/class_physics2dserver.rst @@ -21,17 +21,17 @@ Member Functions ---------------- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform2D` transform=((1, 0), (0, 1), (0, 0)) **)** | +| void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform2D` transform=null **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_attach_object_instance_ID` **(** :ref:`RID` area, :ref:`int` id **)** | +| void | :ref:`area_attach_object_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`area_clear_shapes` **(** :ref:`RID` area **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`area_create` **(** **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_get_object_instance_ID` **(** :ref:`RID` area **)** const | +| :ref:`int` | :ref:`area_get_object_instance_id` **(** :ref:`RID` area **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_get_param` **(** :ref:`RID` area, :ref:`int` param **)** const | +| :ref:`Variant` | :ref:`area_get_param` **(** :ref:`RID` area, :ref:`int` param **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -71,15 +71,15 @@ Member Functions +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_add_force` **(** :ref:`RID` body, :ref:`Vector2` offset, :ref:`Vector2` force **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform=((1, 0), (0, 1), (0, 0)) **)** | +| void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform=null **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector2` pos, :ref:`Vector2` impulse **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_attach_object_instance_ID` **(** :ref:`RID` body, :ref:`int` id **)** | +| void | :ref:`body_attach_object_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_clear_shapes` **(** :ref:`RID` body **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_create` **(** :ref:`int` mode=2, :ref:`bool` init_sleeping=false **)** | +| :ref:`RID` | :ref:`body_create` **(** :ref:`int` mode=false, :ref:`bool` init_sleeping=2 **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`body_get_collision_layer` **(** :ref:`RID` body **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -91,7 +91,7 @@ Member Functions +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`body_get_mode` **(** :ref:`RID` body **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_object_instance_ID` **(** :ref:`RID` body **)** const | +| :ref:`int` | :ref:`body_get_object_instance_id` **(** :ref:`RID` body **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`body_get_param` **(** :ref:`RID` body, :ref:`int` param **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -99,13 +99,13 @@ Member Functions +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`body_get_shape_count` **(** :ref:`RID` body **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_get_shape_metadata` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | +| :ref:`Variant` | :ref:`body_get_shape_metadata` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`body_get_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`body_get_space` **(** :ref:`RID` body **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_get_state` **(** :ref:`RID` body, :ref:`int` state **)** const | +| :ref:`Variant` | :ref:`body_get_state` **(** :ref:`RID` body, :ref:`int` state **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`body_is_omitting_force_integration` **(** :ref:`RID` body **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -121,7 +121,7 @@ Member Functions +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_set_continuous_collision_detection_mode` **(** :ref:`RID` body, :ref:`int` mode **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=NULL **)** | +| void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -145,9 +145,9 @@ Member Functions +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_set_state` **(** :ref:`RID` body, :ref:`int` state, :ref:`Variant` value **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_test_motion` **(** :ref:`RID` body, :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=NULL **)** | +| :ref:`bool` | :ref:`body_test_motion` **(** :ref:`RID` body, :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`float` margin=null, :ref:`Physics2DTestMotionResult` result=null **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`damped_spring_joint_create` **(** :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b=[RID] **)** | +| :ref:`RID` | :ref:`damped_spring_joint_create` **(** :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b=null **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`damped_string_joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -157,7 +157,7 @@ Member Functions +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_process_info` **(** :ref:`int` process_info **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`groove_joint_create` **(** :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a=[RID], :ref:`RID` body_b=[RID] **)** | +| :ref:`RID` | :ref:`groove_joint_create` **(** :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a=null, :ref:`RID` body_b=null **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -165,13 +165,13 @@ Member Functions +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`joint_set_param` **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`pin_joint_create` **(** :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b=[RID] **)** | +| :ref:`RID` | :ref:`pin_joint_create` **(** :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b=null **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_active` **(** :ref:`bool` active **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`shape_create` **(** :ref:`int` type **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_get_data` **(** :ref:`RID` shape **)** const | +| :ref:`Variant` | :ref:`shape_get_data` **(** :ref:`RID` shape **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`shape_get_type` **(** :ref:`RID` shape **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -263,13 +263,13 @@ Member Function Description .. _class_Physics2DServer_area_add_shape: -- void **area_add_shape** **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform2D` transform=((1, 0), (0, 1), (0, 0)) **)** +- void **area_add_shape** **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform2D` transform=null **)** Add 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 **)** +- void **area_attach_object_instance_id** **(** :ref:`RID` area, :ref:`int` id **)** Assign the area to a descendant of :ref:`Object`, so it can exist in the node tree. @@ -285,15 +285,15 @@ Remove all shapes from an area. It does not delete the shapes, so they can be re Create 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 +- :ref:`int` **area_get_object_instance_id** **(** :ref:`RID` area **)** const Get the instance ID of the object the area is assigned to. .. _class_Physics2DServer_area_get_param: -- void **area_get_param** **(** :ref:`RID` area, :ref:`int` param **)** const +- :ref:`Variant` **area_get_param** **(** :ref:`RID` area, :ref:`int` param **)** const Return an area parameter value. @@ -421,7 +421,7 @@ Add a positioned force to the applied force and torque. As with :ref:`body_apply .. _class_Physics2DServer_body_add_shape: -- void **body_add_shape** **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform=((1, 0), (0, 1), (0, 0)) **)** +- void **body_add_shape** **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform=null **)** Add 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. @@ -431,9 +431,9 @@ Add a shape to the body, along with a transform matrix. Shapes are usually refer Add 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_attach_object_instance_ID: +.. _class_Physics2DServer_body_attach_object_instance_id: -- void **body_attach_object_instance_ID** **(** :ref:`RID` body, :ref:`int` id **)** +- void **body_attach_object_instance_id** **(** :ref:`RID` body, :ref:`int` id **)** Assign the area to a descendant of :ref:`Object`, so it can exist in the node tree. @@ -445,7 +445,7 @@ Remove all shapes from a body. .. _class_Physics2DServer_body_create: -- :ref:`RID` **body_create** **(** :ref:`int` mode=2, :ref:`bool` init_sleeping=false **)** +- :ref:`RID` **body_create** **(** :ref:`int` mode=false, :ref:`bool` init_sleeping=2 **)** Create 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. @@ -479,9 +479,9 @@ Return the maximum contacts that can be reported. See :ref:`body_set_max_contact Return 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 +- :ref:`int` **body_get_object_instance_id** **(** :ref:`RID` body **)** const Get the instance ID of the object the area is assigned to. @@ -505,7 +505,7 @@ Return the number of shapes assigned to a body. .. _class_Physics2DServer_body_get_shape_metadata: -- void **body_get_shape_metadata** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const +- :ref:`Variant` **body_get_shape_metadata** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const Return the metadata of a shape of a body. @@ -523,7 +523,7 @@ Return the :ref:`RID` of the space assigned to a body. .. _class_Physics2DServer_body_get_state: -- void **body_get_state** **(** :ref:`RID` body, :ref:`int` state **)** const +- :ref:`Variant` **body_get_state** **(** :ref:`RID` body, :ref:`int` state **)** const Return a body state. @@ -573,7 +573,7 @@ Continuous collision detection tries to predict where a moving body will collide .. _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 **)** +- void **body_set_force_integration_callback** **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** Set the function used to calculate physics for an object, if that object allows it (see :ref:`body_set_omit_force integration`). @@ -641,13 +641,13 @@ Set a body state (see BODY_STATE\* constants). .. _class_Physics2DServer_body_test_motion: -- :ref:`bool` **body_test_motion** **(** :ref:`RID` body, :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=NULL **)** +- :ref:`bool` **body_test_motion** **(** :ref:`RID` body, :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`float` margin=null, :ref:`Physics2DTestMotionResult` result=null **)** Return 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_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=[RID] **)** +- :ref:`RID` **damped_spring_joint_create** **(** :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b=null **)** Create a damped spring joint between two bodies. If not specified, the second body is assumed to be the joint itself. @@ -677,7 +677,7 @@ Return information about the current state of the 2D physics engine. The states .. _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=[RID], :ref:`RID` body_b=[RID] **)** +- :ref:`RID` **groove_joint_create** **(** :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a=null, :ref:`RID` body_b=null **)** Create a groove joint between two bodies. If not specified, the bodyies are assumed to be the joint itself. @@ -701,7 +701,7 @@ Set a joint parameter. Parameters are explained in the JOINT_PARAM\* constants. .. _class_Physics2DServer_pin_joint_create: -- :ref:`RID` **pin_joint_create** **(** :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b=[RID] **)** +- :ref:`RID` **pin_joint_create** **(** :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b=null **)** Create a pin joint between two bodies. If not specified, the second body is assumed to be the joint itself. @@ -719,7 +719,7 @@ Create a shape of type SHAPE\_\*. Does not assign it to a body or an area. To do .. _class_Physics2DServer_shape_get_data: -- void **shape_get_data** **(** :ref:`RID` shape **)** const +- :ref:`Variant` **shape_get_data** **(** :ref:`RID` shape **)** const Return the shape data. diff --git a/classes/class_physics2dshapequeryparameters.rst b/classes/class_physics2dshapequeryparameters.rst index f604b2b9a..ef3371df0 100644 --- a/classes/class_physics2dshapequeryparameters.rst +++ b/classes/class_physics2dshapequeryparameters.rst @@ -43,7 +43,7 @@ Member Functions +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_object_type_mask` **(** :ref:`int` object_type_mask **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape` **(** :ref:`Shape2D` shape **)** | +| void | :ref:`set_shape` **(** :ref:`Resource` shape **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_shape_rid` **(** :ref:`RID` shape **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ @@ -132,7 +132,7 @@ Set the type of object the shape belongs to (see Physics2DDirectSpaceState.TYPE_ .. _class_Physics2DShapeQueryParameters_set_shape: -- void **set_shape** **(** :ref:`Shape2D` shape **)** +- void **set_shape** **(** :ref:`Resource` shape **)** Set the :ref:`Shape2D` that will be used for collision/intersection queries. diff --git a/classes/class_physicsbody.rst b/classes/class_physicsbody.rst index 8bfdde908..ff08266d0 100644 --- a/classes/class_physicsbody.rst +++ b/classes/class_physicsbody.rst @@ -20,27 +20,27 @@ Base class for different types of Physics bodies. Member Functions ---------------- -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_exception_with` **(** :ref:`PhysicsBody` body **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_collision_exception_with` **(** :ref:`PhysicsBody` body **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask` **(** :ref:`int` mask **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_collision_exception_with` **(** :ref:`Node` body **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_collision_exception_with` **(** :ref:`Node` body **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask` **(** :ref:`int` mask **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -58,7 +58,9 @@ Member Function Description .. _class_PhysicsBody_add_collision_exception_with: -- void **add_collision_exception_with** **(** :ref:`PhysicsBody` body **)** +- void **add_collision_exception_with** **(** :ref:`Node` body **)** + +Adds a body to the collision exception list. This list contains bodies that this body will not collide with. .. _class_PhysicsBody_get_collision_layer: @@ -78,7 +80,9 @@ Member Function Description .. _class_PhysicsBody_remove_collision_exception_with: -- void **remove_collision_exception_with** **(** :ref:`PhysicsBody` body **)** +- void **remove_collision_exception_with** **(** :ref:`Node` body **)** + +Removes a body from the collision exception list. .. _class_PhysicsBody_set_collision_layer: diff --git a/classes/class_physicsbody2d.rst b/classes/class_physicsbody2d.rst index f278ff513..8e5eaa25a 100644 --- a/classes/class_physicsbody2d.rst +++ b/classes/class_physicsbody2d.rst @@ -20,27 +20,27 @@ Base class for all objects affected by physics. Member Functions ---------------- -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_exception_with` **(** :ref:`PhysicsBody2D` body **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_collision_exception_with` **(** :ref:`PhysicsBody2D` body **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask` **(** :ref:`int` mask **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_collision_exception_with` **(** :ref:`Node` body **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_collision_exception_with` **(** :ref:`Node` body **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask` **(** :ref:`int` mask **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -59,9 +59,7 @@ Member Function Description .. _class_PhysicsBody2D_add_collision_exception_with: -- void **add_collision_exception_with** **(** :ref:`PhysicsBody2D` body **)** - -Adds a body to the collision exception list. This list contains bodies that this body will not collide with. +- void **add_collision_exception_with** **(** :ref:`Node` body **)** .. _class_PhysicsBody2D_get_collision_layer: @@ -89,9 +87,7 @@ Return an individual bit on the collision mask. .. _class_PhysicsBody2D_remove_collision_exception_with: -- void **remove_collision_exception_with** **(** :ref:`PhysicsBody2D` body **)** - -Removes a body from the collision exception list. +- void **remove_collision_exception_with** **(** :ref:`Node` body **)** .. _class_PhysicsBody2D_set_collision_layer: diff --git a/classes/class_physicsdirectbodystate.rst b/classes/class_physicsdirectbodystate.rst index fc4239263..9dc3fba7d 100644 --- a/classes/class_physicsdirectbodystate.rst +++ b/classes/class_physicsdirectbodystate.rst @@ -57,7 +57,7 @@ Member Functions +----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_linear_velocity` **(** **)** const | +----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`get_principal_inetria_axes` **(** **)** const | +| :ref:`Basis` | :ref:`get_principal_inertia_axes` **(** **)** const | +----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PhysicsDirectSpaceState` | :ref:`get_space_state` **(** **)** | +----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -159,9 +159,9 @@ Member Function Description - :ref:`Vector3` **get_linear_velocity** **(** **)** const -.. _class_PhysicsDirectBodyState_get_principal_inetria_axes: +.. _class_PhysicsDirectBodyState_get_principal_inertia_axes: -- :ref:`Basis` **get_principal_inetria_axes** **(** **)** const +- :ref:`Basis` **get_principal_inertia_axes** **(** **)** const .. _class_PhysicsDirectBodyState_get_space_state: diff --git a/classes/class_physicsdirectspacestate.rst b/classes/class_physicsdirectspacestate.rst index 323dc585f..73c8dd6dc 100644 --- a/classes/class_physicsdirectspacestate.rst +++ b/classes/class_physicsdirectspacestate.rst @@ -18,17 +18,17 @@ Brief Description Member Functions ---------------- -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`cast_motion` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`Vector3` motion **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`collide_shape` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`PhysicsShapeQueryParameters` shape **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=[], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`intersect_shape` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`cast_motion` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`Vector3` motion **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`collide_shape` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=null **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`PhysicsShapeQueryParameters` shape **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=null, :ref:`int` type_mask=null **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`intersect_shape` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=null **)** | ++--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -49,7 +49,7 @@ Member Function Description .. _class_PhysicsDirectSpaceState_collide_shape: -- :ref:`Array` **collide_shape** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** +- :ref:`Array` **collide_shape** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=null **)** .. _class_PhysicsDirectSpaceState_get_rest_info: @@ -57,10 +57,10 @@ Member Function Description .. _class_PhysicsDirectSpaceState_intersect_ray: -- :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=[], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** +- :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=null, :ref:`int` type_mask=null **)** .. _class_PhysicsDirectSpaceState_intersect_shape: -- :ref:`Array` **intersect_shape** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** +- :ref:`Array` **intersect_shape** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=null **)** diff --git a/classes/class_physicsserver.rst b/classes/class_physicsserver.rst index 230df49b9..0905041fd 100644 --- a/classes/class_physicsserver.rst +++ b/classes/class_physicsserver.rst @@ -21,17 +21,17 @@ Member Functions ---------------- +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform` transform=Transform() **)** | +| void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform` transform=null **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_attach_object_instance_ID` **(** :ref:`RID` area, :ref:`int` id **)** | +| void | :ref:`area_attach_object_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`area_clear_shapes` **(** :ref:`RID` area **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`area_create` **(** **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_get_object_instance_ID` **(** :ref:`RID` area **)** const | +| :ref:`int` | :ref:`area_get_object_instance_id` **(** :ref:`RID` area **)** const | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_get_param` **(** :ref:`RID` area, :ref:`int` param **)** const | +| :ref:`Variant` | :ref:`area_get_param` **(** :ref:`RID` area, :ref:`int` param **)** const | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -71,17 +71,17 @@ Member Functions +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform` transform=Transform() **)** | +| void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform` transform=null **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector3` pos, :ref:`Vector3` impulse **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_apply_torque_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_attach_object_instance_ID` **(** :ref:`RID` body, :ref:`int` id **)** | +| void | :ref:`body_attach_object_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_clear_shapes` **(** :ref:`RID` body **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_create` **(** :ref:`int` mode=2, :ref:`bool` init_sleeping=false **)** | +| :ref:`RID` | :ref:`body_create` **(** :ref:`int` mode=false, :ref:`bool` init_sleeping=2 **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`body_get_axis_lock` **(** :ref:`RID` body **)** const | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -93,7 +93,7 @@ Member Functions +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`body_get_mode` **(** :ref:`RID` body **)** const | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_object_instance_ID` **(** :ref:`RID` body **)** const | +| :ref:`int` | :ref:`body_get_object_instance_id` **(** :ref:`RID` body **)** const | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`body_get_param` **(** :ref:`RID` body, :ref:`int` param **)** const | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -105,7 +105,7 @@ Member Functions +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`body_get_space` **(** :ref:`RID` body **)** const | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_get_state` **(** :ref:`RID` body, :ref:`int` state **)** const | +| :ref:`Variant` | :ref:`body_get_state` **(** :ref:`RID` body, :ref:`int` state **)** const | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`body_is_continuous_collision_detection_enabled` **(** :ref:`RID` body **)** const | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -127,7 +127,7 @@ Member Functions +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_set_enable_continuous_collision_detection` **(** :ref:`RID` body, :ref:`bool` enable **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=NULL **)** | +| void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -187,15 +187,15 @@ Member Functions +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`joint_set_solver_priority` **(** :ref:`RID` joint, :ref:`int` priority **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`pin_joint_get_local_A` **(** :ref:`RID` joint **)** const | +| :ref:`Vector3` | :ref:`pin_joint_get_local_a` **(** :ref:`RID` joint **)** const | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`pin_joint_get_local_B` **(** :ref:`RID` joint **)** const | +| :ref:`Vector3` | :ref:`pin_joint_get_local_b` **(** :ref:`RID` joint **)** const | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`pin_joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`pin_joint_set_local_A` **(** :ref:`RID` joint, :ref:`Vector3` local_A **)** | +| void | :ref:`pin_joint_set_local_a` **(** :ref:`RID` joint, :ref:`Vector3` local_A **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`pin_joint_set_local_B` **(** :ref:`RID` joint, :ref:`Vector3` local_B **)** | +| void | :ref:`pin_joint_set_local_b` **(** :ref:`RID` joint, :ref:`Vector3` local_B **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`pin_joint_set_param` **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -203,7 +203,7 @@ Member Functions +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`shape_create` **(** :ref:`int` type **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_get_data` **(** :ref:`RID` shape **)** const | +| :ref:`Variant` | :ref:`shape_get_data` **(** :ref:`RID` shape **)** const | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`shape_get_type` **(** :ref:`RID` shape **)** const | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -341,11 +341,11 @@ Member Function Description .. _class_PhysicsServer_area_add_shape: -- void **area_add_shape** **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform` transform=Transform() **)** +- void **area_add_shape** **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform` transform=null **)** -.. _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 **)** +- void **area_attach_object_instance_id** **(** :ref:`RID` area, :ref:`int` id **)** .. _class_PhysicsServer_area_clear_shapes: @@ -355,13 +355,13 @@ Member Function Description - :ref:`RID` **area_create** **(** **)** -.. _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 +- :ref:`int` **area_get_object_instance_id** **(** :ref:`RID` area **)** const .. _class_PhysicsServer_area_get_param: -- void **area_get_param** **(** :ref:`RID` area, :ref:`int` param **)** const +- :ref:`Variant` **area_get_param** **(** :ref:`RID` area, :ref:`int` param **)** const .. _class_PhysicsServer_area_get_shape: @@ -441,7 +441,7 @@ Member Function Description .. _class_PhysicsServer_body_add_shape: -- void **body_add_shape** **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform` transform=Transform() **)** +- void **body_add_shape** **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform` transform=null **)** .. _class_PhysicsServer_body_apply_impulse: @@ -451,9 +451,9 @@ Member Function Description - void **body_apply_torque_impulse** **(** :ref:`RID` body, :ref:`Vector3` impulse **)** -.. _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 **)** +- void **body_attach_object_instance_id** **(** :ref:`RID` body, :ref:`int` id **)** .. _class_PhysicsServer_body_clear_shapes: @@ -461,7 +461,7 @@ Member Function Description .. _class_PhysicsServer_body_create: -- :ref:`RID` **body_create** **(** :ref:`int` mode=2, :ref:`bool` init_sleeping=false **)** +- :ref:`RID` **body_create** **(** :ref:`int` mode=false, :ref:`bool` init_sleeping=2 **)** .. _class_PhysicsServer_body_get_axis_lock: @@ -483,9 +483,9 @@ Member Function Description - :ref:`int` **body_get_mode** **(** :ref:`RID` body **)** const -.. _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 +- :ref:`int` **body_get_object_instance_id** **(** :ref:`RID` body **)** const .. _class_PhysicsServer_body_get_param: @@ -509,7 +509,7 @@ Member Function Description .. _class_PhysicsServer_body_get_state: -- void **body_get_state** **(** :ref:`RID` body, :ref:`int` state **)** const +- :ref:`Variant` **body_get_state** **(** :ref:`RID` body, :ref:`int` state **)** const .. _class_PhysicsServer_body_is_continuous_collision_detection_enabled: @@ -553,7 +553,7 @@ Member Function Description .. _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 **)** +- void **body_set_force_integration_callback** **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** .. _class_PhysicsServer_body_set_max_contacts_reported: @@ -671,25 +671,25 @@ Member Function Description - void **joint_set_solver_priority** **(** :ref:`RID` joint, :ref:`int` priority **)** -.. _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 +- :ref:`Vector3` **pin_joint_get_local_a** **(** :ref:`RID` joint **)** const -.. _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 +- :ref:`Vector3` **pin_joint_get_local_b** **(** :ref:`RID` joint **)** const .. _class_PhysicsServer_pin_joint_get_param: - :ref:`float` **pin_joint_get_param** **(** :ref:`RID` joint, :ref:`int` param **)** const -.. _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 **)** +- void **pin_joint_set_local_a** **(** :ref:`RID` joint, :ref:`Vector3` local_A **)** -.. _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 **)** +- void **pin_joint_set_local_b** **(** :ref:`RID` joint, :ref:`Vector3` local_B **)** .. _class_PhysicsServer_pin_joint_set_param: @@ -705,7 +705,7 @@ Member Function Description .. _class_PhysicsServer_shape_get_data: -- void **shape_get_data** **(** :ref:`RID` shape **)** const +- :ref:`Variant` **shape_get_data** **(** :ref:`RID` shape **)** const .. _class_PhysicsServer_shape_get_type: diff --git a/classes/class_physicsshapequeryparameters.rst b/classes/class_physicsshapequeryparameters.rst index 364a386cf..0280b819e 100644 --- a/classes/class_physicsshapequeryparameters.rst +++ b/classes/class_physicsshapequeryparameters.rst @@ -39,7 +39,7 @@ Member Functions +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_object_type_mask` **(** :ref:`int` object_type_mask **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape` **(** :ref:`Shape` shape **)** | +| void | :ref:`set_shape` **(** :ref:`Resource` shape **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_shape_rid` **(** :ref:`RID` shape **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ @@ -91,7 +91,7 @@ Member Function Description .. _class_PhysicsShapeQueryParameters_set_shape: -- void **set_shape** **(** :ref:`Shape` shape **)** +- void **set_shape** **(** :ref:`Resource` shape **)** .. _class_PhysicsShapeQueryParameters_set_shape_rid: diff --git a/classes/class_polygon2d.rst b/classes/class_polygon2d.rst index 44d9387b3..c6db91a93 100644 --- a/classes/class_polygon2d.rst +++ b/classes/class_polygon2d.rst @@ -18,6 +18,8 @@ Brief Description Member Functions ---------------- ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_antialiased` **(** **)** const | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_color` **(** **)** const | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ @@ -29,7 +31,7 @@ Member Functions +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolVector2Array` | :ref:`get_polygon` **(** **)** const | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_texture` **(** **)** const | +| :ref:`Texture` | :ref:`get_texture` **(** **)** const | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_texture_offset` **(** **)** const | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ @@ -41,6 +43,8 @@ Member Functions +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolColorArray` | :ref:`get_vertex_colors` **(** **)** const | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_antialiased` **(** :ref:`bool` antialiased **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_color` **(** :ref:`Color` color **)** | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_invert` **(** :ref:`bool` invert **)** | @@ -51,7 +55,7 @@ Member Functions +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_polygon` **(** :ref:`PoolVector2Array` polygon **)** | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Object` texture **)** | +| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_texture_offset` **(** :ref:`Vector2` texture_offset **)** | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ @@ -67,6 +71,7 @@ Member Functions Member Variables ---------------- +- :ref:`bool` **antialiased** - :ref:`Color` **color** - :ref:`float` **invert_border** - :ref:`bool` **invert_enable** @@ -87,6 +92,10 @@ A Polygon2D is defined by a set of n vertices connected together by line segment Member Function Description --------------------------- +.. _class_Polygon2D_get_antialiased: + +- :ref:`bool` **get_antialiased** **(** **)** const + .. _class_Polygon2D_get_color: - :ref:`Color` **get_color** **(** **)** const @@ -119,7 +128,7 @@ Return the set of vertices that defines this polygon. .. _class_Polygon2D_get_texture: -- :ref:`Object` **get_texture** **(** **)** const +- :ref:`Texture` **get_texture** **(** **)** const Return the polygon texture @@ -153,6 +162,10 @@ Return the texture coordinates associated with every vertex of the polygon. Return the list of vertex colors. +.. _class_Polygon2D_set_antialiased: + +- void **set_antialiased** **(** :ref:`bool` antialiased **)** + .. _class_Polygon2D_set_color: - void **set_color** **(** :ref:`Color` color **)** @@ -185,9 +198,7 @@ Define the set of vertices that will represent the polygon. .. _class_Polygon2D_set_texture: -- void **set_texture** **(** :ref:`Object` texture **)** - -Set the polygon texture. +- void **set_texture** **(** :ref:`Texture` texture **)** .. _class_Polygon2D_set_texture_offset: diff --git a/classes/class_popup.rst b/classes/class_popup.rst index fd53566df..aabaa3594 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -20,19 +20,19 @@ Base container control for popups and dialogs. Member Functions ---------------- -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_exclusive` **(** **)** const | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`popup` **(** :ref:`Rect2` bounds=Rect2(0, 0, 0, 0) **)** | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`popup_centered` **(** :ref:`Vector2` size=Vector2(0, 0) **)** | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`popup_centered_minsize` **(** :ref:`Vector2` minsize=Vector2(0, 0) **)** | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`popup_centered_ratio` **(** :ref:`float` ratio=0.75 **)** | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_exclusive` **(** :ref:`bool` enable **)** | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_exclusive` **(** **)** const | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`popup` **(** :ref:`Rect2` bounds=Rect2( 0, 0, 0, 0 ) **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`popup_centered` **(** :ref:`Vector2` size=Vector2( 0, 0 ) **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`popup_centered_minsize` **(** :ref:`Vector2` minsize=Vector2( 0, 0 ) **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`popup_centered_ratio` **(** :ref:`float` ratio=0.75 **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_exclusive` **(** :ref:`bool` enable **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -71,19 +71,19 @@ Returns whether the popup will hide other popups when shown on the screen. .. _class_Popup_popup: -- void **popup** **(** :ref:`Rect2` bounds=Rect2(0, 0, 0, 0) **)** +- void **popup** **(** :ref:`Rect2` bounds=Rect2( 0, 0, 0, 0 ) **)** Popup (show the control in modal form). .. _class_Popup_popup_centered: -- void **popup_centered** **(** :ref:`Vector2` size=Vector2(0, 0) **)** +- 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: -- void **popup_centered_minsize** **(** :ref:`Vector2` minsize=Vector2(0, 0) **)** +- 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``. diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index bbe71d8f2..34eeecf58 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -18,93 +18,93 @@ PopupMenu displays a list of options. Member Functions ---------------- -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_check_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_check_item` **(** :ref:`Object` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_check_shortcut` **(** :ref:`Object` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_item` **(** :ref:`Object` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_shortcut` **(** :ref:`Object` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_separator` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_submenu_item` **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_ID` **(** :ref:`int` idx **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_accelerator` **(** :ref:`int` idx **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_count` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_index` **(** :ref:`int` id **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ShortCut` | :ref:`get_item_shortcut` **(** :ref:`int` idx **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_submenu` **(** :ref:`int` idx **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_hide_on_checkable_item_selection` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_hide_on_item_selection` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_checkable` **(** :ref:`int` idx **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_checked` **(** :ref:`int` idx **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_separator` **(** :ref:`int` idx **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_item` **(** :ref:`int` idx **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hide_on_checkable_item_selection` **(** :ref:`bool` enable **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hide_on_item_selection` **(** :ref:`bool` enable **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_ID` **(** :ref:`int` idx, :ref:`int` id **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_accelerator` **(** :ref:`int` idx, :ref:`int` accel **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_as_checkable` **(** :ref:`int` idx, :ref:`bool` enable **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_as_separator` **(** :ref:`int` idx, :ref:`bool` enable **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_checked` **(** :ref:`int` idx, :ref:`bool` checked **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Object` icon **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_shortcut` **(** :ref:`int` idx, :ref:`ShortCut` shortcut, :ref:`bool` global=false **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_submenu` **(** :ref:`int` idx, :ref:`String` submenu **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_tooltip` **(** :ref:`int` idx, :ref:`String` tooltip **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`toggle_item_checked` **(** :ref:`int` idx **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=null **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_check_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=null **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_check_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=null, :ref:`int` accel=null **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_check_shortcut` **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=null, :ref:`bool` global=null **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=null, :ref:`int` accel=null **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_shortcut` **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=null, :ref:`bool` global=null **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=null **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_separator` **(** **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=null **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_submenu_item` **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=null **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_accelerator` **(** :ref:`int` idx **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_count` **(** **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_id` **(** :ref:`int` idx **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_index` **(** :ref:`int` id **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ShortCut` | :ref:`get_item_shortcut` **(** :ref:`int` idx **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_submenu` **(** :ref:`int` idx **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_hide_on_checkable_item_selection` **(** **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_hide_on_item_selection` **(** **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_checkable` **(** :ref:`int` idx **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_checked` **(** :ref:`int` idx **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_separator` **(** :ref:`int` idx **)** const | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_item` **(** :ref:`int` idx **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hide_on_checkable_item_selection` **(** :ref:`bool` enable **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hide_on_item_selection` **(** :ref:`bool` enable **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_accelerator` **(** :ref:`int` idx, :ref:`int` accel **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_as_checkable` **(** :ref:`int` idx, :ref:`bool` enable **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_as_separator` **(** :ref:`int` idx, :ref:`bool` enable **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_checked` **(** :ref:`int` idx, :ref:`bool` checked **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` icon **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_id` **(** :ref:`int` idx, :ref:`int` id **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_shortcut` **(** :ref:`int` idx, :ref:`ShortCut` shortcut, :ref:`bool` global=null **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_submenu` **(** :ref:`int` idx, :ref:`String` submenu **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_tooltip` **(** :ref:`int` idx, :ref:`String` tooltip **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`toggle_item_checked` **(** :ref:`int` idx **)** | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -133,37 +133,39 @@ Member Function Description .. _class_PopupMenu_add_check_item: -- void **add_check_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** +- void **add_check_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=null **)** 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: -- void **add_check_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** +- void **add_check_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=null **)** .. _class_PopupMenu_add_icon_check_item: -- void **add_icon_check_item** **(** :ref:`Object` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** +- void **add_icon_check_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=null, :ref:`int` accel=null **)** -Add a new checkable item with text "label" and icon "texture". 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. +Add a new checkable item with text "label" and icon "texture". 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_icon_check_shortcut: -- void **add_icon_check_shortcut** **(** :ref:`Object` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** +- void **add_icon_check_shortcut** **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=null, :ref:`bool` global=null **)** .. _class_PopupMenu_add_icon_item: -- void **add_icon_item** **(** :ref:`Object` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** +- void **add_icon_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=null, :ref:`int` accel=null **)** 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: -- void **add_icon_shortcut** **(** :ref:`Object` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** +- void **add_icon_shortcut** **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=null, :ref:`bool` global=null **)** .. _class_PopupMenu_add_item: -- void **add_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** +- void **add_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=null **)** 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. @@ -175,11 +177,11 @@ Add a separator between items. Separators also occupy an index. .. _class_PopupMenu_add_shortcut: -- void **add_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** +- void **add_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=null **)** .. _class_PopupMenu_add_submenu_item: -- void **add_submenu_item** **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** +- void **add_submenu_item** **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=null **)** 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. @@ -189,12 +191,6 @@ Adds an item with a submenu. The submenu is the name of a child PopupMenu node t Clear the popup menu, in effect removing all items. -.. _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_accelerator: - :ref:`int` **get_item_accelerator** **(** :ref:`int` idx **)** const @@ -209,10 +205,16 @@ Return the amount of items. .. _class_PopupMenu_get_item_icon: -- :ref:`Object` **get_item_icon** **(** :ref:`int` idx **)** const +- :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const Return the icon of the item at index "idx". +.. _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: - :ref:`int` **get_item_index** **(** :ref:`int` id **)** const @@ -299,12 +301,6 @@ Sets whether or not the PopupMenu will hide on checkable item selection. Sets whether or not the PopupMenu will hide on item selection. -.. _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_accelerator: - void **set_item_accelerator** **(** :ref:`int` idx, :ref:`int` accel **)** @@ -337,9 +333,13 @@ Sets whether the item at index "idx" is disabled or not. When it is disabled it .. _class_PopupMenu_set_item_icon: -- void **set_item_icon** **(** :ref:`int` idx, :ref:`Object` icon **)** +- void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture` icon **)** -Set the icon of the item at index "idx". +.. _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: @@ -349,7 +349,7 @@ Sets the metadata of an item, which might be of any type. You can later get it w .. _class_PopupMenu_set_item_shortcut: -- void **set_item_shortcut** **(** :ref:`int` idx, :ref:`ShortCut` shortcut, :ref:`bool` global=false **)** +- void **set_item_shortcut** **(** :ref:`int` idx, :ref:`ShortCut` shortcut, :ref:`bool` global=null **)** .. _class_PopupMenu_set_item_submenu: diff --git a/classes/class_portal.rst b/classes/class_portal.rst deleted file mode 100644 index 1d717b319..000000000 --- a/classes/class_portal.rst +++ /dev/null @@ -1,111 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. - -.. _class_Portal: - -Portal -====== - -**Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - -Portals provide virtual openings to rooms. - -Member Functions ----------------- - -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_connect_range` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_disable_distance` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_disabled_color` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_shape` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_enabled` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_connect_range` **(** :ref:`float` range **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disable_distance` **(** :ref:`float` distance **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disabled_color` **(** :ref:`Color` color **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enabled` **(** :ref:`bool` enable **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape` **(** :ref:`PoolVector2Array` points **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ - -Description ------------ - -Portals provide virtual openings to :ref:`VisualInstance` nodes, so cameras can look at them from the outside. Note that portals are a visibility optimization technique, and are in no way related to the game of the same name (as in, they are not used for teleportation). For more information on how rooms and portals work, see :ref:`VisualInstance`. Portals are represented as 2D convex polygon shapes (in the X,Y local plane), and are placed on the surface of the areas occupied by a :ref:`VisualInstance`, to indicate that the room can be accessed or looked-at through them. If two rooms are next to each other, and two similar portals in each of them share the same world position (and are parallel and opposed to each other), they will automatically "connect" and form "doors" (for example, the portals that connect a kitchen to a living room are placed in the door they share). Portals must always have a :ref:`VisualInstance` node as a parent, grandparent or far parent, or else they will not be active. - -Member Function Description ---------------------------- - -.. _class_Portal_get_connect_range: - -- :ref:`float` **get_connect_range** **(** **)** const - -Return the range for auto-connecting two portals from different rooms sharing the same space. - -.. _class_Portal_get_disable_distance: - -- :ref:`float` **get_disable_distance** **(** **)** const - -Return the distance threshold for disabling the portal. Every time that the portal goes beyond "distance", it disables itself, becoming the opaque color (see :ref:`set_disabled_color`). - -.. _class_Portal_get_disabled_color: - -- :ref:`Color` **get_disabled_color** **(** **)** const - -Return the color for when the portal goes beyond the disable distance (see :ref:`set_disable_distance`) and becomes disabled. - -.. _class_Portal_get_shape: - -- :ref:`PoolVector2Array` **get_shape** **(** **)** const - -Return the portal shape. The shape is an array of :ref:`Vector2` points, representing a convex polygon in the X,Y plane. - -.. _class_Portal_is_enabled: - -- :ref:`bool` **is_enabled** **(** **)** const - -Return whether the portal is active. When disabled it causes the parent :ref:`VisualInstance` to not be visible any longer when looking through the portal. - -.. _class_Portal_set_connect_range: - -- void **set_connect_range** **(** :ref:`float` range **)** - -Set the range for auto-connecting two portals from different rooms sharing the same space. - -.. _class_Portal_set_disable_distance: - -- void **set_disable_distance** **(** :ref:`float` distance **)** - -Set the distance threshold for disabling the portal. Every time that the portal goes beyond "distance", it disables itself, becoming the opaque color (see :ref:`set_disabled_color`). - -.. _class_Portal_set_disabled_color: - -- void **set_disabled_color** **(** :ref:`Color` color **)** - -When the portal goes beyond the disable distance (see :ref:`set_disable_distance`), it becomes opaque and displayed with color "color". - -.. _class_Portal_set_enabled: - -- void **set_enabled** **(** :ref:`bool` enable **)** - -Enable the portal (it is enabled by default though), disabling it will cause the parent :ref:`VisualInstance` to not be visible any longer when looking through the portal. - -.. _class_Portal_set_shape: - -- void **set_shape** **(** :ref:`PoolVector2Array` points **)** - -Set the portal shape. The shape is an array of :ref:`Vector2` points, representing a convex polygon in the X,Y plane. - - diff --git a/classes/class_prismmesh.rst b/classes/class_prismmesh.rst index 952128672..1f3200ca5 100644 --- a/classes/class_prismmesh.rst +++ b/classes/class_prismmesh.rst @@ -44,7 +44,7 @@ Member Variables ---------------- - :ref:`float` **left_to_right** -- :ref:`Vector2` **size** +- :ref:`Vector3` **size** - :ref:`int` **subdivide_depth** - :ref:`int` **subdivide_height** - :ref:`int` **subdivide_width** diff --git a/classes/class_proceduralsky.rst b/classes/class_proceduralsky.rst index e4d3bff3e..024a58c32 100644 --- a/classes/class_proceduralsky.rst +++ b/classes/class_proceduralsky.rst @@ -104,6 +104,16 @@ Member Variables - :ref:`float` **sun_longitude** - :ref:`int` **texture_size** +Numeric Constants +----------------- + +- **TEXTURE_SIZE_256** = **0** +- **TEXTURE_SIZE_512** = **1** +- **TEXTURE_SIZE_1024** = **2** +- **TEXTURE_SIZE_2048** = **3** +- **TEXTURE_SIZE_4096** = **4** +- **TEXTURE_SIZE_MAX** = **5** + Member Function Description --------------------------- diff --git a/classes/class_range.rst b/classes/class_range.rst index 7070a7b83..f5599f17f 100644 --- a/classes/class_range.rst +++ b/classes/class_range.rst @@ -53,7 +53,7 @@ Member Functions +----------------------------+-----------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_value` **(** :ref:`float` value **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`share` **(** :ref:`Object` with **)** | +| void | :ref:`share` **(** :ref:`Node` with **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------+ | void | :ref:`unshare` **(** **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------+ @@ -171,7 +171,7 @@ Set step value. If step is 0, stepping will be disabled. .. _class_Range_share: -- void **share** **(** :ref:`Object` with **)** +- void **share** **(** :ref:`Node` with **)** .. _class_Range_unshare: diff --git a/classes/class_reference.rst b/classes/class_reference.rst index 035d7f617..88625bc8f 100644 --- a/classes/class_reference.rst +++ b/classes/class_reference.rst @@ -8,7 +8,7 @@ Reference **Inherits:** :ref:`Object` -**Inherited By:** :ref:`RegExMatch`, :ref:`SurfaceTool`, :ref:`SpatialGizmo`, :ref:`TriangleMesh`, :ref:`PhysicsShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`FuncRef`, :ref:`Marshalls`, :ref:`File`, :ref:`TCP_Server`, :ref:`Physics2DShapeQueryResult`, :ref:`ConfigFile`, :ref:`StreamPeer`, :ref:`HTTPClient`, :ref:`AudioStreamPlayback`, :ref:`VisualScriptFunctionState`, :ref:`GDFunctionState`, :ref:`SpatialVelocityTracker`, :ref:`EditorResourcePreviewGenerator`, :ref:`Physics2DShapeQueryParameters`, :ref:`EditorScript`, :ref:`Mutex`, :ref:`PacketPeer`, :ref:`Semaphore`, :ref:`XMLParser`, :ref:`EditorImportPlugin`, :ref:`Directory`, :ref:`AStar`, :ref:`SceneState`, :ref:`GDNativeClass`, :ref:`PCKPacker`, :ref:`MeshDataTool`, :ref:`WeakRef`, :ref:`ResourceImporter`, :ref:`Resource`, :ref:`SceneTreeTimer`, :ref:`Thread`, :ref:`PackedDataContainerRef`, :ref:`ResourceInteractiveLoader`, :ref:`PhysicsShapeQueryParameters` +**Inherited By:** :ref:`RegExMatch`, :ref:`EncodedObjectAsID`, :ref:`SurfaceTool`, :ref:`SpatialGizmo`, :ref:`TriangleMesh`, :ref:`PhysicsShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`FuncRef`, :ref:`Marshalls`, :ref:`File`, :ref:`TCP_Server`, :ref:`Physics2DShapeQueryResult`, :ref:`ConfigFile`, :ref:`StreamPeer`, :ref:`HTTPClient`, :ref:`AudioStreamPlayback`, :ref:`VisualScriptFunctionState`, :ref:`GDFunctionState`, :ref:`SpatialVelocityTracker`, :ref:`EditorResourcePreviewGenerator`, :ref:`Physics2DShapeQueryParameters`, :ref:`ARVRInterface`, :ref:`EditorScript`, :ref:`Mutex`, :ref:`PacketPeer`, :ref:`Semaphore`, :ref:`XMLParser`, :ref:`EditorImportPlugin`, :ref:`Directory`, :ref:`AStar`, :ref:`SceneState`, :ref:`GDNativeClass`, :ref:`RegEx`, :ref:`PCKPacker`, :ref:`MeshDataTool`, :ref:`WeakRef`, :ref:`ResourceImporter`, :ref:`Resource`, :ref:`SceneTreeTimer`, :ref:`Thread`, :ref:`PackedDataContainerRef`, :ref:`ResourceInteractiveLoader`, :ref:`GDNative`, :ref:`PhysicsShapeQueryParameters` **Category:** Core diff --git a/classes/class_reflectionprobe.rst b/classes/class_reflectionprobe.rst index 80db9e4e5..65194e08c 100644 --- a/classes/class_reflectionprobe.rst +++ b/classes/class_reflectionprobe.rst @@ -74,14 +74,14 @@ Member Variables - :ref:`bool` **box_projection** - :ref:`int` **cull_mask** - :ref:`bool` **enable_shadows** -- :ref:`Vector2` **extents** +- :ref:`Vector3` **extents** - :ref:`float` **intensity** - :ref:`Color` **interior_ambient_color** - :ref:`float` **interior_ambient_contrib** - :ref:`float` **interior_ambient_energy** - :ref:`bool` **interior_enable** - :ref:`float` **max_distance** -- :ref:`Vector2` **origin_offset** +- :ref:`Vector3` **origin_offset** - :ref:`int` **update_mode** Numeric Constants diff --git a/classes/class_regex.rst b/classes/class_regex.rst index c8f0699c8..8bad8f01f 100644 --- a/classes/class_regex.rst +++ b/classes/class_regex.rst @@ -6,7 +6,7 @@ RegEx ===== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core @@ -18,28 +18,23 @@ Simple regular expression matcher. Member Functions ---------------- -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`compile` **(** :ref:`String` pattern **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_group_count` **(** **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_names` **(** **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_pattern` **(** **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid` **(** **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RegExMatch` | :ref:`search` **(** :ref:`String` text, :ref:`int` start=0, :ref:`int` end=-1 **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`sub` **(** :ref:`String` text, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` start=0, :ref:`int` end=-1 **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Member Variables ----------------- - -- :ref:`String` **pattern** ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`compile` **(** :ref:`String` pattern **)** | ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_group_count` **(** **)** const | ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_names` **(** **)** const | ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_pattern` **(** **)** const | ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid` **(** **)** const | ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RegExMatch` | :ref:`search` **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=null **)** const | ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`sub` **(** :ref:`String` subject, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` offset=null, :ref:`int` end=null **)** const | ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -133,13 +128,13 @@ Returns whether this object has a valid regular expression assigned. .. _class_RegEx_search: -- :ref:`RegExMatch` **search** **(** :ref:`String` text, :ref:`int` start=0, :ref:`int` end=-1 **)** const +- :ref:`RegExMatch` **search** **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=null **)** const Searches the text for the compiled pattern. Returns a :ref:`RegExMatch` container of the first matching reult if found, otherwise null. The region to search within can be specified without modifying where the start and end anchor would be. .. _class_RegEx_sub: -- :ref:`String` **sub** **(** :ref:`String` text, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` start=0, :ref:`int` end=-1 **)** const +- :ref:`String` **sub** **(** :ref:`String` subject, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` offset=null, :ref:`int` end=null **)** 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 1bbbfce5e..b022dc534 100644 --- a/classes/class_regexmatch.rst +++ b/classes/class_regexmatch.rst @@ -18,60 +18,40 @@ Brief Description Member Functions ---------------- -+--------------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`expand` **(** :ref:`String` template **)** const | +--------------------------------------+---------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_end` **(** :ref:`Variant` name=0 **)** const | +--------------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_group_array` **(** **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_group_count` **(** **)** const | +--------------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_name_dict` **(** **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_names` **(** **)** const | +| :ref:`Dictionary` | :ref:`get_names` **(** **)** const | +--------------------------------------+---------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_start` **(** :ref:`Variant` name=0 **)** const | +--------------------------------------+---------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_string` **(** :ref:`Variant` name=0 **)** const | +--------------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_strings` **(** **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_subject` **(** **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- -.. _class_RegExMatch_expand: - -- :ref:`String` **expand** **(** :ref:`String` template **)** const - -Using results from the search, returns the specified string with escapes and backreferences such as ``\1`` and ``\g`` expanded and resolved. - .. _class_RegExMatch_get_end: - :ref:`int` **get_end** **(** :ref:`Variant` name=0 **)** const Returns the end position of the match in the string. An integer can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern). -.. _class_RegExMatch_get_group_array: - -- :ref:`Array` **get_group_array** **(** **)** const - -Returns an array of the results of the numeric groups. - .. _class_RegExMatch_get_group_count: - :ref:`int` **get_group_count** **(** **)** const Returns the number of numeric capturing groups. -.. _class_RegExMatch_get_name_dict: - -- :ref:`Dictionary` **get_name_dict** **(** **)** const - -Returns a dictionary containing the named capturing groups and their results. - .. _class_RegExMatch_get_names: -- :ref:`Array` **get_names** **(** **)** const +- :ref:`Dictionary` **get_names** **(** **)** const Returns an array of names of named capturing groups. @@ -87,4 +67,12 @@ Returns the starting position of the match in the string. An integer can be spec Returns the result of the match in the string. An integer can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern). +.. _class_RegExMatch_get_strings: + +- :ref:`Array` **get_strings** **(** **)** const + +.. _class_RegExMatch_get_subject: + +- :ref:`String` **get_subject** **(** **)** const + diff --git a/classes/class_resource.rst b/classes/class_resource.rst index 424b0b798..aaef19aa5 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -8,7 +8,7 @@ Resource **Inherits:** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`Theme`, :ref:`AudioStream`, :ref:`Sky`, :ref:`CubeMap`, :ref:`DynamicFontData`, :ref:`SpriteFrames`, :ref:`Translation`, :ref:`Curve2D`, :ref:`Shape`, :ref:`Shape2D`, :ref:`Curve`, :ref:`StyleBox`, :ref:`GDNativeLibrary`, :ref:`Material`, :ref:`VideoStream`, :ref:`RoomBounds`, :ref:`Texture`, :ref:`PackedScene`, :ref:`OccluderPolygon2D`, :ref:`Mesh`, :ref:`ButtonGroup`, :ref:`TileSet`, :ref:`ShortCut`, :ref:`BitMap`, :ref:`Animation`, :ref:`Script`, :ref:`PolygonPathFinder`, :ref:`Shader`, :ref:`AudioBusLayout`, :ref:`World`, :ref:`RegEx`, :ref:`AudioEffect`, :ref:`VisualScriptNode`, :ref:`World2D`, :ref:`GIProbeData`, :ref:`Font`, :ref:`MeshLibrary`, :ref:`Curve3D`, :ref:`NavigationPolygon`, :ref:`InputEvent`, :ref:`EditorSettings`, :ref:`Image`, :ref:`Gradient`, :ref:`Environment`, :ref:`MultiMesh`, :ref:`PackedDataContainer`, :ref:`NavigationMesh` +**Inherited By:** :ref:`Theme`, :ref:`AudioStream`, :ref:`Sky`, :ref:`CubeMap`, :ref:`DynamicFontData`, :ref:`SpriteFrames`, :ref:`Translation`, :ref:`Curve2D`, :ref:`Shape`, :ref:`Shape2D`, :ref:`Curve`, :ref:`StyleBox`, :ref:`GDNativeLibrary`, :ref:`Material`, :ref:`VideoStream`, :ref:`PackedScene`, :ref:`Texture`, :ref:`Script`, :ref:`OccluderPolygon2D`, :ref:`Mesh`, :ref:`ButtonGroup`, :ref:`TileSet`, :ref:`ShortCut`, :ref:`BitMap`, :ref:`Animation`, :ref:`PolygonPathFinder`, :ref:`Shader`, :ref:`AudioBusLayout`, :ref:`World`, :ref:`AudioEffect`, :ref:`VisualScriptNode`, :ref:`World2D`, :ref:`GIProbeData`, :ref:`Font`, :ref:`MeshLibrary`, :ref:`Curve3D`, :ref:`NavigationPolygon`, :ref:`InputEvent`, :ref:`EditorSettings`, :ref:`Image`, :ref:`Gradient`, :ref:`Environment`, :ref:`MultiMesh`, :ref:`PackedDataContainer`, :ref:`NavigationMesh` **Category:** Core @@ -20,31 +20,31 @@ Base class for all resources. Member Functions ---------------- -+------------------------------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`_setup_local_to_scene` **(** **)** virtual | -+------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`duplicate` **(** :ref:`bool` subresources=false **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_local_scene` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_path` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_rid` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_local_to_scene` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_local_to_scene` **(** :ref:`bool` enable **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_name` **(** :ref:`String` name **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_path` **(** :ref:`String` path **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`setup_local_to_scene` **(** **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------+ -| void | :ref:`take_over_path` **(** :ref:`String` path **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------+ ++----------------------------------+-----------------------------------------------------------------------------------------------------------+ +| void | :ref:`_setup_local_to_scene` **(** **)** virtual | ++----------------------------------+-----------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`duplicate` **(** :ref:`bool` subresources=false **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_local_scene` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_path` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_rid` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_local_to_scene` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_local_to_scene` **(** :ref:`bool` enable **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_name` **(** :ref:`String` name **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_path` **(** :ref:`String` path **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------+ +| void | :ref:`setup_local_to_scene` **(** **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------+ +| void | :ref:`take_over_path` **(** :ref:`String` path **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------+ Signals ------- @@ -72,7 +72,7 @@ Member Function Description .. _class_Resource_duplicate: -- :ref:`Object` **duplicate** **(** :ref:`bool` subresources=false **)** const +- :ref:`Resource` **duplicate** **(** :ref:`bool` subresources=false **)** const .. _class_Resource_get_local_scene: diff --git a/classes/class_resourceinteractiveloader.rst b/classes/class_resourceinteractiveloader.rst index 53a15ee45..9ce7eebfa 100644 --- a/classes/class_resourceinteractiveloader.rst +++ b/classes/class_resourceinteractiveloader.rst @@ -18,17 +18,17 @@ Interactive Resource Loader. Member Functions ---------------- -+------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_resource` **(** **)** | -+------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_stage` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_stage_count` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`poll` **(** **)** | -+------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`wait` **(** **)** | -+------------------------------+--------------------------------------------------------------------------------------------+ ++----------------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`get_resource` **(** **)** | ++----------------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_stage` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_stage_count` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`poll` **(** **)** | ++----------------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`wait` **(** **)** | ++----------------------------------+--------------------------------------------------------------------------------------------+ Description ----------- @@ -40,7 +40,7 @@ Member Function Description .. _class_ResourceInteractiveLoader_get_resource: -- :ref:`Object` **get_resource** **(** **)** +- :ref:`Resource` **get_resource** **(** **)** Return the loaded resource (only if loaded). Otherwise, returns null. diff --git a/classes/class_resourceloader.rst b/classes/class_resourceloader.rst index 98f4c2efd..738d37346 100644 --- a/classes/class_resourceloader.rst +++ b/classes/class_resourceloader.rst @@ -18,19 +18,19 @@ Resource Loader. Member Functions ---------------- -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_dependencies` **(** :ref:`String` path **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_recognized_extensions_for_type` **(** :ref:`String` type **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has` **(** :ref:`String` path **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`load` **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` p_no_cache=false **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ResourceInteractiveLoader` | :ref:`load_interactive` **(** :ref:`String` path, :ref:`String` type_hint="" **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_abort_on_missing_resources` **(** :ref:`bool` abort **)** | -+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_dependencies` **(** :ref:`String` path **)** | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_recognized_extensions_for_type` **(** :ref:`String` type **)** | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has` **(** :ref:`String` path **)** | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`load` **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` p_no_cache=null **)** | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ResourceInteractiveLoader` | :ref:`load_interactive` **(** :ref:`String` path, :ref:`String` type_hint=null **)** | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_abort_on_missing_resources` **(** :ref:`bool` abort **)** | ++--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -56,11 +56,11 @@ Return the list of recognized extensions for a resource type. .. _class_ResourceLoader_load: -- :ref:`Resource` **load** **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` p_no_cache=false **)** +- :ref:`Resource` **load** **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` p_no_cache=null **)** .. _class_ResourceLoader_load_interactive: -- :ref:`ResourceInteractiveLoader` **load_interactive** **(** :ref:`String` path, :ref:`String` type_hint="" **)** +- :ref:`ResourceInteractiveLoader` **load_interactive** **(** :ref:`String` path, :ref:`String` type_hint=null **)** Load a resource interactively, the returned object allows to load with high granularity. diff --git a/classes/class_resourcepreloader.rst b/classes/class_resourcepreloader.rst index b55c4e147..c4708d005 100644 --- a/classes/class_resourcepreloader.rst +++ b/classes/class_resourcepreloader.rst @@ -19,9 +19,9 @@ Member Functions ---------------- +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_resource` **(** :ref:`String` name, :ref:`Object` resource **)** | +| void | :ref:`add_resource` **(** :ref:`String` name, :ref:`Resource` resource **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_resource` **(** :ref:`String` name **)** const | +| :ref:`Resource` | :ref:`get_resource` **(** :ref:`String` name **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolStringArray` | :ref:`get_resource_list` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -47,13 +47,11 @@ Member Function Description .. _class_ResourcePreloader_add_resource: -- void **add_resource** **(** :ref:`String` name, :ref:`Object` resource **)** - -Add a resource to the preloader. Set the text-id that will be used to identify it (retrieve it/erase it/etc). +- void **add_resource** **(** :ref:`String` name, :ref:`Resource` resource **)** .. _class_ResourcePreloader_get_resource: -- :ref:`Object` **get_resource** **(** :ref:`String` name **)** const +- :ref:`Resource` **get_resource** **(** :ref:`String` name **)** const Return the resource given a text-id. diff --git a/classes/class_resourcesaver.rst b/classes/class_resourcesaver.rst index 1c7ab2cee..13f47192d 100644 --- a/classes/class_resourcesaver.rst +++ b/classes/class_resourcesaver.rst @@ -18,11 +18,11 @@ Resource Saving Interface. Member Functions ---------------- -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_recognized_extensions` **(** :ref:`Object` type **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`save` **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags=0 **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_recognized_extensions` **(** :ref:`Resource` type **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`save` **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags=null **)** | ++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -44,13 +44,13 @@ Member Function Description .. _class_ResourceSaver_get_recognized_extensions: -- :ref:`PoolStringArray` **get_recognized_extensions** **(** :ref:`Object` type **)** +- :ref:`PoolStringArray` **get_recognized_extensions** **(** :ref:`Resource` type **)** Return the list of extensions available for saving a resource of a given type. .. _class_ResourceSaver_save: -- :ref:`int` **save** **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags=0 **)** +- :ref:`int` **save** **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags=null **)** Save a resource to disk, to a given path. diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index 367e9f83b..107fba7f3 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -75,7 +75,7 @@ Member Functions +--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`push_underline` **(** **)** | +--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`remove_line` **(** :ref:`int` arg0 **)** | +| :ref:`bool` | :ref:`remove_line` **(** :ref:`int` line **)** | +--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`scroll_to_line` **(** :ref:`int` line **)** | +--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -263,7 +263,7 @@ Return true if selecting the text inside this richtext is allowed. .. _class_RichTextLabel_remove_line: -- :ref:`bool` **remove_line** **(** :ref:`int` arg0 **)** +- :ref:`bool` **remove_line** **(** :ref:`int` line **)** .. _class_RichTextLabel_scroll_to_line: diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index 7abfcb6b0..72964c72b 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -105,7 +105,7 @@ Member Functions +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_weight` **(** :ref:`float` weight **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`test_motion` **(** :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=NULL **)** | +| :ref:`bool` | :ref:`test_motion` **(** :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -438,7 +438,7 @@ Set the body weight given standard earth-weight (gravity 9.8). Not really useful .. _class_RigidBody2D_test_motion: -- :ref:`bool` **test_motion** **(** :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=NULL **)** +- :ref:`bool` **test_motion** **(** :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** Return whether the body would collide, if it tried to move in the given vector. This method allows two extra parameters: A margin, which increases slightly the size of the shapes involved in the collision detection, and an object of type :ref:`Physics2DTestMotionResult`, which will store additional information about the collision (should there be one). diff --git a/classes/class_room.rst b/classes/class_room.rst deleted file mode 100644 index a6bd15e8d..000000000 --- a/classes/class_room.rst +++ /dev/null @@ -1,48 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. - -.. _class_Room: - -Room -==== - -**Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - -Room data resource. - -Member Functions ----------------- - -+--------------------------+---------------------------------------------------------------------------------+ -| :ref:`Room` | :ref:`get_room` **(** **)** const | -+--------------------------+---------------------------------------------------------------------------------+ -| void | :ref:`set_room` **(** :ref:`Room` room **)** | -+--------------------------+---------------------------------------------------------------------------------+ - -Member Variables ----------------- - -- :ref:`Area` **room/room** - -Description ------------ - -Room contains the data to define the bounds of a scene (using a BSP Tree). It is instanced by a :ref:`VisualInstance` node to create rooms. See that class documentation for more information about rooms. - -Member Function Description ---------------------------- - -.. _class_Room_get_room: - -- :ref:`Room` **get_room** **(** **)** const - -.. _class_Room_set_room: - -- void **set_room** **(** :ref:`Room` room **)** - - diff --git a/classes/class_roombounds.rst b/classes/class_roombounds.rst deleted file mode 100644 index 7cae72842..000000000 --- a/classes/class_roombounds.rst +++ /dev/null @@ -1,43 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. - -.. _class_RoomBounds: - -RoomBounds -========== - -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - -Member Functions ----------------- - -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_geometry_hint` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_geometry_hint` **(** :ref:`PoolVector3Array` triangles **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - -Member Variables ----------------- - -- :ref:`PoolVector3Array` **geometry_hint** - -Member Function Description ---------------------------- - -.. _class_RoomBounds_get_geometry_hint: - -- :ref:`PoolVector3Array` **get_geometry_hint** **(** **)** const - -.. _class_RoomBounds_set_geometry_hint: - -- void **set_geometry_hint** **(** :ref:`PoolVector3Array` triangles **)** - - diff --git a/classes/class_scenestate.rst b/classes/class_scenestate.rst index e047f5370..dd3b0aa73 100644 --- a/classes/class_scenestate.rst +++ b/classes/class_scenestate.rst @@ -45,7 +45,7 @@ Member Functions +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`NodePath` | :ref:`get_node_owner_path` **(** :ref:`int` idx **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_node_path` **(** :ref:`int` idx, :ref:`bool` for_parent=false **)** const | +| :ref:`NodePath` | :ref:`get_node_path` **(** :ref:`int` idx, :ref:`bool` for_parent=null **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_node_property_count` **(** :ref:`int` idx **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -122,7 +122,7 @@ Member Function Description .. _class_SceneState_get_node_path: -- :ref:`NodePath` **get_node_path** **(** :ref:`int` idx, :ref:`bool` for_parent=false **)** const +- :ref:`NodePath` **get_node_path** **(** :ref:`int` idx, :ref:`bool` for_parent=null **)** const .. _class_SceneState_get_node_property_count: diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index cdc92ee68..7cf89a94a 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -19,19 +19,19 @@ Member Functions ---------------- +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`call_group` **(** :ref:`String` group, :ref:`String` method **)** vararg | +| :ref:`Variant` | :ref:`call_group` **(** :ref:`String` group, :ref:`String` method **)** vararg | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`call_group_flags` **(** :ref:`int` flags, :ref:`String` group, :ref:`String` method **)** vararg | +| :ref:`Variant` | :ref:`call_group_flags` **(** :ref:`int` flags, :ref:`String` group, :ref:`String` method **)** vararg | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`change_scene` **(** :ref:`String` path **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`change_scene_to` **(** :ref:`PackedScene` packed_scene **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SceneTreeTimer` | :ref:`create_timer` **(** :ref:`float` time_sec, :ref:`bool` pause_mode_process=true **)** | +| :ref:`SceneTreeTimer` | :ref:`create_timer` **(** :ref:`float` time_sec, :ref:`bool` pause_mode_process=null **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Node` | :ref:`get_current_scene` **(** **)** const | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_edited_scene_root` **(** **)** const | +| :ref:`Node` | :ref:`get_edited_scene_root` **(** **)** const | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_frame` **(** **)** const | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -45,6 +45,8 @@ Member Functions +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Viewport` | :ref:`get_root` **(** **)** const | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_rpc_sender_id` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_group` **(** :ref:`String` name **)** const | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_network_peer` **(** **)** const | @@ -53,8 +55,6 @@ Member Functions +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_debugging_navigation_hint` **(** **)** const | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_editor_hint` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_input_handled` **(** **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_network_server` **(** **)** const | @@ -63,7 +63,7 @@ Member Functions +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_refusing_new_network_connections` **(** **)** const | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`notify_group` **(** :ref:`String` call_flags, :ref:`int` group **)** | +| void | :ref:`notify_group` **(** :ref:`String` group, :ref:`int` notification **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`notify_group_flags` **(** :ref:`int` call_flags, :ref:`String` group, :ref:`int` notification **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -81,11 +81,9 @@ Member Functions +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_debug_navigation_hint` **(** :ref:`bool` enable **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_edited_scene_root` **(** :ref:`Object` scene **)** | +| void | :ref:`set_edited_scene_root` **(** :ref:`Node` scene **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_editor_hint` **(** :ref:`bool` enable **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_group` **(** :ref:`String` call_flags, :ref:`String` group, :ref:`Variant` property **)** | +| void | :ref:`set_group` **(** :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_group_flags` **(** :ref:`int` call_flags, :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -97,7 +95,7 @@ Member Functions +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_refuse_new_network_connections` **(** :ref:`bool` refuse **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_screen_stretch` **(** :ref:`int` mode, :ref:`int` aspect, :ref:`Vector2` minsize **)** | +| void | :ref:`set_screen_stretch` **(** :ref:`int` mode, :ref:`int` aspect, :ref:`Vector2` minsize, :ref:`int` shrink=null **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -136,11 +134,11 @@ Member Function Description .. _class_SceneTree_call_group: -- void **call_group** **(** :ref:`String` group, :ref:`String` method **)** vararg +- :ref:`Variant` **call_group** **(** :ref:`String` group, :ref:`String` method **)** vararg .. _class_SceneTree_call_group_flags: -- void **call_group_flags** **(** :ref:`int` flags, :ref:`String` group, :ref:`String` method **)** vararg +- :ref:`Variant` **call_group_flags** **(** :ref:`int` flags, :ref:`String` group, :ref:`String` method **)** vararg .. _class_SceneTree_change_scene: @@ -152,7 +150,7 @@ Member Function Description .. _class_SceneTree_create_timer: -- :ref:`SceneTreeTimer` **create_timer** **(** :ref:`float` time_sec, :ref:`bool` pause_mode_process=true **)** +- :ref:`SceneTreeTimer` **create_timer** **(** :ref:`float` time_sec, :ref:`bool` pause_mode_process=null **)** .. _class_SceneTree_get_current_scene: @@ -160,7 +158,7 @@ Member Function Description .. _class_SceneTree_get_edited_scene_root: -- :ref:`Object` **get_edited_scene_root** **(** **)** const +- :ref:`Node` **get_edited_scene_root** **(** **)** const .. _class_SceneTree_get_frame: @@ -186,6 +184,10 @@ Member Function Description - :ref:`Viewport` **get_root** **(** **)** const +.. _class_SceneTree_get_rpc_sender_id: + +- :ref:`int` **get_rpc_sender_id** **(** **)** const + .. _class_SceneTree_has_group: - :ref:`bool` **has_group** **(** :ref:`String` name **)** const @@ -204,10 +206,6 @@ Returns true if there is a :ref:`NetworkedMultiplayerPeer` **is_debugging_navigation_hint** **(** **)** const -.. _class_SceneTree_is_editor_hint: - -- :ref:`bool` **is_editor_hint** **(** **)** const - .. _class_SceneTree_is_input_handled: - :ref:`bool` **is_input_handled** **(** **)** @@ -228,7 +226,7 @@ Returns true if this SceneTree's :ref:`NetworkedMultiplayerPeer` call_flags, :ref:`int` group **)** +- void **notify_group** **(** :ref:`String` group, :ref:`int` notification **)** .. _class_SceneTree_notify_group_flags: @@ -264,15 +262,11 @@ Returns true if this SceneTree's :ref:`NetworkedMultiplayerPeer` scene **)** - -.. _class_SceneTree_set_editor_hint: - -- void **set_editor_hint** **(** :ref:`bool` enable **)** +- void **set_edited_scene_root** **(** :ref:`Node` scene **)** .. _class_SceneTree_set_group: -- void **set_group** **(** :ref:`String` call_flags, :ref:`String` group, :ref:`Variant` property **)** +- void **set_group** **(** :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** .. _class_SceneTree_set_group_flags: @@ -298,6 +292,6 @@ Set the peer object to handle the RPC system (effectively enabling networking). .. _class_SceneTree_set_screen_stretch: -- void **set_screen_stretch** **(** :ref:`int` mode, :ref:`int` aspect, :ref:`Vector2` minsize **)** +- void **set_screen_stretch** **(** :ref:`int` mode, :ref:`int` aspect, :ref:`Vector2` minsize, :ref:`int` shrink=null **)** diff --git a/classes/class_script.rst b/classes/class_script.rst index 6dc9555c3..e3ad07558 100644 --- a/classes/class_script.rst +++ b/classes/class_script.rst @@ -8,7 +8,7 @@ Script **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`VisualScript`, :ref:`GDScript`, :ref:`GDNativeScript` +**Inherited By:** :ref:`VisualScript`, :ref:`GDScript`, :ref:`NativeScript` **Category:** Core @@ -20,19 +20,25 @@ Base class for scripts. Member Functions ---------------- -+------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_instance` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_source_code` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_source_code` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`instance_has` **(** :ref:`Object` base_object **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`reload` **(** :ref:`bool` keep_state=false **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_source_code` **(** :ref:`String` source **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------+ ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_instance` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_node_type` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_source_code` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_script_signal` **(** :ref:`String` signal_name **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_source_code` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`instance_has` **(** :ref:`Object` base_object **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_tool` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`reload` **(** :ref:`bool` keep_state=false **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_source_code` **(** :ref:`String` source **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -48,12 +54,20 @@ Member Function Description Return true if this script can be instance (ie not a library). +.. _class_Script_get_node_type: + +- :ref:`String` **get_node_type** **(** **)** const + .. _class_Script_get_source_code: - :ref:`String` **get_source_code** **(** **)** const Return the script source code (if available). +.. _class_Script_has_script_signal: + +- :ref:`bool` **has_script_signal** **(** :ref:`String` signal_name **)** const + .. _class_Script_has_source_code: - :ref:`bool` **has_source_code** **(** **)** const @@ -66,6 +80,10 @@ Return true if the script contains source code. Return true if a given object uses an instance of this script. +.. _class_Script_is_tool: + +- :ref:`bool` **is_tool** **(** **)** const + .. _class_Script_reload: - :ref:`int` **reload** **(** :ref:`bool` keep_state=false **)** diff --git a/classes/class_scripteditor.rst b/classes/class_scripteditor.rst index a366fc637..0802e9e04 100644 --- a/classes/class_scripteditor.rst +++ b/classes/class_scripteditor.rst @@ -18,19 +18,19 @@ Brief Description Member Functions ---------------- -+------------------------------+-------------------------------------------------------------------------------+ -| :ref:`Script` | :ref:`get_current_script` **(** **)** | -+------------------------------+-------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_open_scripts` **(** **)** | -+------------------------------+-------------------------------------------------------------------------------+ ++------------------------------+---------------------------------------------------------------------------------+ +| :ref:`Script` | :ref:`get_current_script` **(** **)** | ++------------------------------+---------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_open_scripts` **(** **)** const | ++------------------------------+---------------------------------------------------------------------------------+ Signals ------- -- **editor_script_changed** **(** :ref:`Script` script **)** +- **editor_script_changed** **(** :ref:`Object` script **)** Emitted when user changed active script. Argument is a freshly activated :ref:`Script`. -- **script_close** **(** :ref:`Script` script **)** +- **script_close** **(** :ref:`Object` script **)** Emitted when editor is about to close the active script. Argument is a :ref:`Script` that is going to be closed. @@ -45,7 +45,7 @@ Returns a :ref:`Script` that is currently active in editor. .. _class_ScriptEditor_get_open_scripts: -- :ref:`Array` **get_open_scripts** **(** **)** +- :ref:`Array` **get_open_scripts** **(** **)** const Returns an array with all :ref:`Script` objects which are currently open in editor. diff --git a/classes/class_scrollbar.rst b/classes/class_scrollbar.rst index 3baac4a9b..bd9de0d1e 100644 --- a/classes/class_scrollbar.rst +++ b/classes/class_scrollbar.rst @@ -26,6 +26,11 @@ Member Functions | void | :ref:`set_custom_step` **(** :ref:`float` step **)** | +----------------------------+------------------------------------------------------------------------------------------------------+ +Signals +------- + +- **scrolling** **(** **)** + Member Variables ---------------- diff --git a/classes/class_semaphore.rst b/classes/class_semaphore.rst index 528d2a47c..0a4b96633 100644 --- a/classes/class_semaphore.rst +++ b/classes/class_semaphore.rst @@ -18,11 +18,11 @@ A synchronization Semaphore. Member Functions ---------------- -+--------+------------------------------------------------+ -| Error | :ref:`post` **(** **)** | -+--------+------------------------------------------------+ -| Error | :ref:`wait` **(** **)** | -+--------+------------------------------------------------+ ++------------------------+------------------------------------------------+ +| :ref:`int` | :ref:`post` **(** **)** | ++------------------------+------------------------------------------------+ +| :ref:`int` | :ref:`wait` **(** **)** | ++------------------------+------------------------------------------------+ Description ----------- @@ -34,13 +34,13 @@ Member Function Description .. _class_Semaphore_post: -- Error **post** **(** **)** +- :ref:`int` **post** **(** **)** Lowers the :ref:`Semaphore`, allowing one more thread in. .. _class_Semaphore_wait: -- Error **wait** **(** **)** +- :ref:`int` **wait** **(** **)** Tries to wait for the :ref:`Semaphore`, if its value is zero, blocks until non-zero. diff --git a/classes/class_sky.rst b/classes/class_sky.rst index c4ac8d76c..179b54af2 100644 --- a/classes/class_sky.rst +++ b/classes/class_sky.rst @@ -34,11 +34,14 @@ Member Variables Numeric Constants ----------------- -- **RADIANCE_SIZE_256** = **0** -- **RADIANCE_SIZE_512** = **1** -- **RADIANCE_SIZE_1024** = **2** -- **RADIANCE_SIZE_2048** = **3** -- **RADIANCE_SIZE_MAX** = **4** +- **RADIANCE_SIZE_32** = **0** +- **RADIANCE_SIZE_64** = **1** +- **RADIANCE_SIZE_128** = **2** +- **RADIANCE_SIZE_256** = **3** +- **RADIANCE_SIZE_512** = **4** +- **RADIANCE_SIZE_1024** = **5** +- **RADIANCE_SIZE_2048** = **6** +- **RADIANCE_SIZE_MAX** = **7** Member Function Description --------------------------- diff --git a/classes/class_spatial.rst b/classes/class_spatial.rst index 422ef6839..4ccc27cd7 100644 --- a/classes/class_spatial.rst +++ b/classes/class_spatial.rst @@ -8,7 +8,7 @@ Spatial **Inherits:** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`Joint`, :ref:`RayCast`, :ref:`Camera`, :ref:`BoneAttachment`, :ref:`CollisionShape`, :ref:`AudioStreamPlayer3D`, :ref:`Path`, :ref:`VisualInstance`, :ref:`VehicleWheel`, :ref:`Position3D`, :ref:`ProximityGroup`, :ref:`RemoteTransform`, :ref:`CollisionObject`, :ref:`Listener`, :ref:`PathFollow`, :ref:`NavigationMeshInstance`, :ref:`VisibilityNotifier`, :ref:`Navigation`, :ref:`CollisionPolygon`, :ref:`GridMap`, :ref:`Skeleton` +**Inherited By:** :ref:`Joint`, :ref:`RayCast`, :ref:`Camera`, :ref:`BoneAttachment`, :ref:`CollisionShape`, :ref:`AudioStreamPlayer3D`, :ref:`Path`, :ref:`ARVRController`, :ref:`VisualInstance`, :ref:`VehicleWheel`, :ref:`Position3D`, :ref:`ProximityGroup`, :ref:`ARVRAnchor`, :ref:`RemoteTransform`, :ref:`CollisionObject`, :ref:`Listener`, :ref:`PathFollow`, :ref:`NavigationMeshInstance`, :ref:`VisibilityNotifier`, :ref:`Navigation`, :ref:`CollisionPolygon`, :ref:`GridMap`, :ref:`Skeleton`, :ref:`ARVROrigin` **Category:** Core @@ -25,7 +25,7 @@ Member Functions +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform` | :ref:`get_global_transform` **(** **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_parent_spatial` **(** **)** const | +| :ref:`Spatial` | :ref:`get_parent_spatial` **(** **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_rotation` **(** **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -93,10 +93,14 @@ Member Functions +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_translation` **(** :ref:`Vector3` translation **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_visible` **(** :ref:`bool` arg0 **)** | +| void | :ref:`set_visible` **(** :ref:`bool` visible **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`show` **(** **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`to_global` **(** :ref:`Vector3` local_point **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`to_local` **(** :ref:`Vector3` global_point **)** const | ++------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`translate` **(** :ref:`Vector3` offset **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`update_gizmo` **(** **)** | @@ -146,7 +150,7 @@ Return the global transform, relative to worldspace. .. _class_Spatial_get_parent_spatial: -- :ref:`Object` **get_parent_spatial** **(** **)** const +- :ref:`Spatial` **get_parent_spatial** **(** **)** const Return the parent :ref:`Spatial`, or an empty :ref:`Object` if no parent exists or parent is not of type :ref:`Spatial`. @@ -298,12 +302,20 @@ Set the transform locally, relative to the parent spatial node. .. _class_Spatial_set_visible: -- void **set_visible** **(** :ref:`bool` arg0 **)** +- void **set_visible** **(** :ref:`bool` visible **)** .. _class_Spatial_show: - void **show** **(** **)** +.. _class_Spatial_to_global: + +- :ref:`Vector3` **to_global** **(** :ref:`Vector3` local_point **)** const + +.. _class_Spatial_to_local: + +- :ref:`Vector3` **to_local** **(** :ref:`Vector3` global_point **)** const + .. _class_Spatial_translate: - void **translate** **(** :ref:`Vector3` offset **)** diff --git a/classes/class_spatialmaterial.rst b/classes/class_spatialmaterial.rst index b97e0fd51..3fe94484e 100644 --- a/classes/class_spatialmaterial.rst +++ b/classes/class_spatialmaterial.rst @@ -21,8 +21,12 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_albedo` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_alpha_scissor_threshold` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_anisotropy` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_ao_texture_channel` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_billboard_mode` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_blend_mode` **(** **)** const | @@ -53,7 +57,7 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_feature` **(** :ref:`int` feature **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_flag` **(** :ref:`int` arg0 **)** const | +| :ref:`bool` | :ref:`get_flag` **(** :ref:`int` flag **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_grow` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -61,6 +65,8 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_metallic` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_metallic_texture_channel` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_normal_scale` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_particles_anim_h_frames` **(** **)** const | @@ -73,19 +79,23 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_refraction` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_refraction_texture_channel` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_rim` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_rim_tint` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_roughness` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_roughness_texture_channel` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_specular` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_specular_mode` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_subsurface_scattering_strength` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** :ref:`Texture` param **)** const | +| :ref:`Texture` | :ref:`get_texture` **(** :ref:`int` param **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_uv1_offset` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -105,8 +115,12 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_albedo` **(** :ref:`Color` albedo **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_alpha_scissor_threshold` **(** :ref:`float` threshold **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_anisotropy` **(** :ref:`float` anisotropy **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ao_texture_channel` **(** :ref:`int` channel **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_billboard_mode` **(** :ref:`int` mode **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_blend_mode` **(** :ref:`int` blend_mode **)** | @@ -149,6 +163,8 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_metallic` **(** :ref:`float` metallic **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_metallic_texture_channel` **(** :ref:`int` channel **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_normal_scale` **(** :ref:`float` normal_scale **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_particles_anim_h_frames` **(** :ref:`int` frames **)** | @@ -161,19 +177,23 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_refraction` **(** :ref:`float` refraction **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_refraction_texture_channel` **(** :ref:`int` channel **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_rim` **(** :ref:`float` rim **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_rim_tint` **(** :ref:`float` rim_tint **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_roughness` **(** :ref:`float` roughness **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_roughness_texture_channel` **(** :ref:`int` channel **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_specular` **(** :ref:`float` specular **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_specular_mode` **(** :ref:`int` specular_mode **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_subsurface_scattering_strength` **(** :ref:`float` strength **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Texture` param, :ref:`Object` texture **)** | +| void | :ref:`set_texture` **(** :ref:`int` param, :ref:`Texture` texture **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_uv1_offset` **(** :ref:`Vector3` offset **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -199,6 +219,7 @@ Member Variables - :ref:`bool` **ao_enabled** - :ref:`bool` **ao_on_uv2** - :ref:`Texture` **ao_texture** +- :ref:`int` **ao_texture_channel** - :ref:`float` **clearcoat** - :ref:`bool` **clearcoat_enabled** - :ref:`float` **clearcoat_gloss** @@ -220,16 +241,19 @@ Member Variables - :ref:`float` **emission_energy** - :ref:`Texture` **emission_texture** - :ref:`bool` **flags_fixed_size** -- :ref:`bool` **flags_on_top** +- :ref:`bool` **flags_no_depth_test** - :ref:`bool` **flags_transparent** - :ref:`bool` **flags_unshaded** - :ref:`bool` **flags_use_point_size** +- :ref:`bool` **flags_vertex_lighting** - :ref:`float` **metallic** - :ref:`float` **metallic_specular** - :ref:`Texture` **metallic_texture** +- :ref:`int` **metallic_texture_channel** - :ref:`bool` **normal_enabled** - :ref:`float` **normal_scale** - :ref:`Texture` **normal_texture** +- :ref:`float` **params_alpha_scissor_threshold** - :ref:`int` **params_billboard_mode** - :ref:`int` **params_blend_mode** - :ref:`int` **params_cull_mode** @@ -240,18 +264,21 @@ Member Variables - :ref:`float` **params_line_width** - :ref:`float` **params_point_size** - :ref:`int` **params_specular_mode** +- :ref:`bool` **params_use_alpha_scissor** - :ref:`int` **particles_anim_h_frames** -- :ref:`bool` **particles_anim_loop** +- :ref:`int` **particles_anim_loop** - :ref:`int` **particles_anim_v_frames** - :ref:`bool` **refraction_enabled** - :ref:`float` **refraction_scale** - :ref:`Texture` **refraction_texture** +- :ref:`int` **refraction_texture_channel** - :ref:`float` **rim** - :ref:`bool` **rim_enabled** - :ref:`Texture` **rim_texture** - :ref:`float` **rim_tint** - :ref:`float` **roughness** - :ref:`Texture` **roughness_texture** +- :ref:`int` **roughness_texture_channel** - :ref:`bool` **subsurf_scatter_enabled** - :ref:`float` **subsurf_scatter_strength** - :ref:`Texture` **subsurf_scatter_texture** @@ -311,12 +338,17 @@ Numeric Constants - **CULL_FRONT** = **1** - **CULL_DISABLED** = **2** - **FLAG_UNSHADED** = **0** -- **FLAG_ONTOP** = **1** -- **FLAG_ALBEDO_FROM_VERTEX_COLOR** = **2** -- **FLAG_SRGB_VERTEX_COLOR** = **3** -- **FLAG_USE_POINT_SIZE** = **4** -- **FLAG_FIXED_SIZE** = **5** -- **FLAG_MAX** = **9** +- **FLAG_USE_VERTEX_LIGHTING** = **1** +- **FLAG_DISABLE_DEPTH_TEST** = **2** +- **FLAG_ALBEDO_FROM_VERTEX_COLOR** = **3** +- **FLAG_SRGB_VERTEX_COLOR** = **4** +- **FLAG_USE_POINT_SIZE** = **5** +- **FLAG_FIXED_SIZE** = **6** +- **FLAG_UV1_USE_TRIPLANAR** = **7** +- **FLAG_UV2_USE_TRIPLANAR** = **8** +- **FLAG_AO_ON_UV2** = **9** +- **FLAG_USE_ALPHA_SCISSOR** = **10** +- **FLAG_MAX** = **11** - **DIFFUSE_LAMBERT** = **0** - **DIFFUSE_HALF_LAMBERT** = **1** - **DIFFUSE_OREN_NAYAR** = **2** @@ -331,6 +363,11 @@ Numeric Constants - **BILLBOARD_ENABLED** = **1** - **BILLBOARD_FIXED_Y** = **2** - **BILLBOARD_PARTICLES** = **3** +- **TEXTURE_CHANNEL_RED** = **0** +- **TEXTURE_CHANNEL_GREEN** = **1** +- **TEXTURE_CHANNEL_BLUE** = **2** +- **TEXTURE_CHANNEL_ALPHA** = **3** +- **TEXTURE_CHANNEL_GRAYSCALE** = **4** Member Function Description --------------------------- @@ -339,10 +376,18 @@ Member Function Description - :ref:`Color` **get_albedo** **(** **)** const +.. _class_SpatialMaterial_get_alpha_scissor_threshold: + +- :ref:`float` **get_alpha_scissor_threshold** **(** **)** const + .. _class_SpatialMaterial_get_anisotropy: - :ref:`float` **get_anisotropy** **(** **)** const +.. _class_SpatialMaterial_get_ao_texture_channel: + +- :ref:`int` **get_ao_texture_channel** **(** **)** const + .. _class_SpatialMaterial_get_billboard_mode: - :ref:`int` **get_billboard_mode** **(** **)** const @@ -405,7 +450,7 @@ Member Function Description .. _class_SpatialMaterial_get_flag: -- :ref:`bool` **get_flag** **(** :ref:`int` arg0 **)** const +- :ref:`bool` **get_flag** **(** :ref:`int` flag **)** const .. _class_SpatialMaterial_get_grow: @@ -419,6 +464,10 @@ Member Function Description - :ref:`float` **get_metallic** **(** **)** const +.. _class_SpatialMaterial_get_metallic_texture_channel: + +- :ref:`int` **get_metallic_texture_channel** **(** **)** const + .. _class_SpatialMaterial_get_normal_scale: - :ref:`float` **get_normal_scale** **(** **)** const @@ -443,6 +492,10 @@ Member Function Description - :ref:`float` **get_refraction** **(** **)** const +.. _class_SpatialMaterial_get_refraction_texture_channel: + +- :ref:`int` **get_refraction_texture_channel** **(** **)** const + .. _class_SpatialMaterial_get_rim: - :ref:`float` **get_rim** **(** **)** const @@ -455,6 +508,10 @@ Member Function Description - :ref:`float` **get_roughness** **(** **)** const +.. _class_SpatialMaterial_get_roughness_texture_channel: + +- :ref:`int` **get_roughness_texture_channel** **(** **)** const + .. _class_SpatialMaterial_get_specular: - :ref:`float` **get_specular** **(** **)** const @@ -469,7 +526,7 @@ Member Function Description .. _class_SpatialMaterial_get_texture: -- :ref:`Texture` **get_texture** **(** :ref:`Texture` param **)** const +- :ref:`Texture` **get_texture** **(** :ref:`int` param **)** const .. _class_SpatialMaterial_get_uv1_offset: @@ -507,10 +564,18 @@ Member Function Description - void **set_albedo** **(** :ref:`Color` albedo **)** +.. _class_SpatialMaterial_set_alpha_scissor_threshold: + +- void **set_alpha_scissor_threshold** **(** :ref:`float` threshold **)** + .. _class_SpatialMaterial_set_anisotropy: - void **set_anisotropy** **(** :ref:`float` anisotropy **)** +.. _class_SpatialMaterial_set_ao_texture_channel: + +- void **set_ao_texture_channel** **(** :ref:`int` channel **)** + .. _class_SpatialMaterial_set_billboard_mode: - void **set_billboard_mode** **(** :ref:`int` mode **)** @@ -595,6 +660,10 @@ Member Function Description - void **set_metallic** **(** :ref:`float` metallic **)** +.. _class_SpatialMaterial_set_metallic_texture_channel: + +- void **set_metallic_texture_channel** **(** :ref:`int` channel **)** + .. _class_SpatialMaterial_set_normal_scale: - void **set_normal_scale** **(** :ref:`float` normal_scale **)** @@ -619,6 +688,10 @@ Member Function Description - void **set_refraction** **(** :ref:`float` refraction **)** +.. _class_SpatialMaterial_set_refraction_texture_channel: + +- void **set_refraction_texture_channel** **(** :ref:`int` channel **)** + .. _class_SpatialMaterial_set_rim: - void **set_rim** **(** :ref:`float` rim **)** @@ -631,6 +704,10 @@ Member Function Description - void **set_roughness** **(** :ref:`float` roughness **)** +.. _class_SpatialMaterial_set_roughness_texture_channel: + +- void **set_roughness_texture_channel** **(** :ref:`int` channel **)** + .. _class_SpatialMaterial_set_specular: - void **set_specular** **(** :ref:`float` specular **)** @@ -645,7 +722,7 @@ Member Function Description .. _class_SpatialMaterial_set_texture: -- void **set_texture** **(** :ref:`Texture` param, :ref:`Object` texture **)** +- void **set_texture** **(** :ref:`int` param, :ref:`Texture` texture **)** .. _class_SpatialMaterial_set_uv1_offset: diff --git a/classes/class_spinbox.rst b/classes/class_spinbox.rst index 9492881e4..f70440f74 100644 --- a/classes/class_spinbox.rst +++ b/classes/class_spinbox.rst @@ -18,21 +18,21 @@ Numerical input text field. Member Functions ---------------- -+------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_line_edit` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_prefix` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_suffix` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_editable` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------+ -| void | :ref:`set_editable` **(** :ref:`bool` editable **)** | -+------------------------------+------------------------------------------------------------------------------------------------+ -| void | :ref:`set_prefix` **(** :ref:`String` prefix **)** | -+------------------------------+------------------------------------------------------------------------------------------------+ -| void | :ref:`set_suffix` **(** :ref:`String` suffix **)** | -+------------------------------+------------------------------------------------------------------------------------------------+ ++----------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`LineEdit` | :ref:`get_line_edit` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_prefix` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_suffix` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_editable` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------+ +| void | :ref:`set_editable` **(** :ref:`bool` editable **)** | ++----------------------------------+------------------------------------------------------------------------------------------------+ +| void | :ref:`set_prefix` **(** :ref:`String` prefix **)** | ++----------------------------------+------------------------------------------------------------------------------------------------+ +| void | :ref:`set_suffix` **(** :ref:`String` suffix **)** | ++----------------------------------+------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -51,7 +51,7 @@ Member Function Description .. _class_SpinBox_get_line_edit: -- :ref:`Object` **get_line_edit** **(** **)** +- :ref:`LineEdit` **get_line_edit** **(** **)** .. _class_SpinBox_get_prefix: diff --git a/classes/class_spriteframes.rst b/classes/class_spriteframes.rst index 7a0c0086c..7d5ee5cde 100644 --- a/classes/class_spriteframes.rst +++ b/classes/class_spriteframes.rst @@ -18,37 +18,37 @@ Sprite frame library for AnimatedSprite. Member Functions ---------------- -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_animation` **(** :ref:`String` anim **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_frame` **(** :ref:`String` anim, :ref:`Object` frame, :ref:`int` atpos=-1 **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** :ref:`String` anim **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_all` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_animation_loop` **(** :ref:`String` anim **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_animation_speed` **(** :ref:`String` anim **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_frame` **(** :ref:`String` anim, :ref:`int` idx **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frame_count` **(** :ref:`String` anim **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` anim **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_animation` **(** :ref:`String` anim **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_frame` **(** :ref:`String` anim, :ref:`int` idx **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_animation` **(** :ref:`String` anim, :ref:`String` newname **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_animation_loop` **(** :ref:`String` anim, :ref:`bool` loop **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_animation_speed` **(** :ref:`String` anim, :ref:`float` speed **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_frame` **(** :ref:`String` anim, :ref:`int` idx, :ref:`Object` txt **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_animation` **(** :ref:`String` anim **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_frame` **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` atpos=null **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** :ref:`String` anim **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_all` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_animation_loop` **(** :ref:`String` anim **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_animation_speed` **(** :ref:`String` anim **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_frame` **(** :ref:`String` anim, :ref:`int` idx **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_frame_count` **(** :ref:`String` anim **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` anim **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_animation` **(** :ref:`String` anim **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_frame` **(** :ref:`String` anim, :ref:`int` idx **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_animation` **(** :ref:`String` anim, :ref:`String` newname **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_animation_loop` **(** :ref:`String` anim, :ref:`bool` loop **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_animation_speed` **(** :ref:`String` anim, :ref:`float` speed **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_frame` **(** :ref:`String` anim, :ref:`int` idx, :ref:`Texture` txt **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -70,7 +70,7 @@ Member Function Description .. _class_SpriteFrames_add_frame: -- void **add_frame** **(** :ref:`String` anim, :ref:`Object` frame, :ref:`int` atpos=-1 **)** +- void **add_frame** **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` atpos=null **)** .. _class_SpriteFrames_clear: @@ -90,7 +90,7 @@ Member Function Description .. _class_SpriteFrames_get_frame: -- :ref:`Object` **get_frame** **(** :ref:`String` anim, :ref:`int` idx **)** const +- :ref:`Texture` **get_frame** **(** :ref:`String` anim, :ref:`int` idx **)** const .. _class_SpriteFrames_get_frame_count: @@ -122,6 +122,6 @@ Member Function Description .. _class_SpriteFrames_set_frame: -- void **set_frame** **(** :ref:`String` anim, :ref:`int` idx, :ref:`Object` txt **)** +- void **set_frame** **(** :ref:`String` anim, :ref:`int` idx, :ref:`Texture` txt **)** diff --git a/classes/class_streampeer.rst b/classes/class_streampeer.rst index 1b9724c06..4e6c2e06a 100644 --- a/classes/class_streampeer.rst +++ b/classes/class_streampeer.rst @@ -182,7 +182,7 @@ Get an unsigned byte from the stream. - :ref:`String` **get_utf8_string** **(** :ref:`int` bytes **)** -Get an utf8 string with byte-length "bytes" from the stream (this decodes the string sent as utf8). +Get a utf8 string with byte-length "bytes" from the stream (this decodes the string sent as utf8). .. _class_StreamPeer_get_var: diff --git a/classes/class_streampeerssl.rst b/classes/class_streampeerssl.rst index d223bfbcf..bf7f1e2c4 100644 --- a/classes/class_streampeerssl.rst +++ b/classes/class_streampeerssl.rst @@ -18,15 +18,15 @@ SSL Stream peer. Member Functions ---------------- -+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`accept_stream` **(** :ref:`StreamPeer` stream **)** | -+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`connect_to_stream` **(** :ref:`StreamPeer` stream, :ref:`bool` validate_certs=false, :ref:`String` for_hostname="" **)** | -+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_from_stream` **(** **)** | -+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_status` **(** **)** const | -+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`accept_stream` **(** :ref:`StreamPeer` stream **)** | ++------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`connect_to_stream` **(** :ref:`StreamPeer` stream, :ref:`bool` validate_certs=false, :ref:`String` for_hostname=null **)** | ++------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_from_stream` **(** **)** | ++------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_status` **(** **)** const | ++------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -46,11 +46,11 @@ Member Function Description .. _class_StreamPeerSSL_accept_stream: -- Error **accept_stream** **(** :ref:`StreamPeer` stream **)** +- :ref:`int` **accept_stream** **(** :ref:`StreamPeer` stream **)** .. _class_StreamPeerSSL_connect_to_stream: -- Error **connect_to_stream** **(** :ref:`StreamPeer` stream, :ref:`bool` validate_certs=false, :ref:`String` for_hostname="" **)** +- :ref:`int` **connect_to_stream** **(** :ref:`StreamPeer` stream, :ref:`bool` validate_certs=false, :ref:`String` for_hostname=null **)** Connect to a peer using an underlying :ref:`StreamPeer` "stream", when "validate_certs" is true, :ref:`StreamPeerSSL` will validate that the certificate presented by the peer matches the "for_hostname". diff --git a/classes/class_string.rst b/classes/class_string.rst index 263a4a963..1a9c8e78c 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -406,7 +406,7 @@ Hash the string and return a 32 bits integer. - :ref:`int` **hex_to_int** **(** **)** -Convert a string containing an hexadecimal number into an int. +Convert a string containing a hexadecimal number into an int. .. _class_String_insert: diff --git a/classes/class_styleboxflat.rst b/classes/class_styleboxflat.rst index a891f9474..c84cb6cd4 100644 --- a/classes/class_styleboxflat.rst +++ b/classes/class_styleboxflat.rst @@ -18,41 +18,92 @@ Stylebox of a single color. Member Functions ---------------- -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_bg_color` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_border_blend` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_border_size` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_dark_color` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_draw_center` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_light_color` **(** **)** const | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bg_color` **(** :ref:`Color` color **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_border_blend` **(** :ref:`bool` blend **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_border_size` **(** :ref:`int` size **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_dark_color` **(** :ref:`Color` color **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_draw_center` **(** :ref:`bool` size **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_light_color` **(** :ref:`Color` color **)** | -+----------------------------+----------------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_aa_size` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_bg_color` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_border_blend` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_border_color` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_border_width` **(** :ref:`int` margin **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_border_width_min` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_corner_detail` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_corner_radius` **(** :ref:`int` corner **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_expand_margin` **(** :ref:`int` margin **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_shadow_color` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_shadow_size` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_anti_aliased` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_draw_center_enabled` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_aa_size` **(** :ref:`int` size **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_anti_aliased` **(** :ref:`bool` anti_aliased **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bg_color` **(** :ref:`Color` color **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_border_blend` **(** :ref:`bool` blend **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_border_color` **(** :ref:`Color` color **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_border_width` **(** :ref:`int` margin, :ref:`int` width **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_border_width_all` **(** :ref:`int` width **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_corner_detail` **(** :ref:`int` detail **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_corner_radius` **(** :ref:`int` corner, :ref:`int` radius **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_corner_radius_all` **(** :ref:`int` radius **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_corner_radius_individual` **(** :ref:`int` radius_top_left, :ref:`int` radius_top_right, :ref:`int` radius_botton_right, :ref:`int` radius_bottom_left **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_draw_center` **(** :ref:`bool` draw_center **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_margin` **(** :ref:`int` margin, :ref:`float` size **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_margin_all` **(** :ref:`float` size **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_margin_individual` **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_color` **(** :ref:`Color` color **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_size` **(** :ref:`int` size **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- +- :ref:`bool` **anti_aliasing** +- :ref:`int` **anti_aliasing_size** - :ref:`Color` **bg_color** - :ref:`bool` **border_blend** -- :ref:`int` **border_size** -- :ref:`Color` **dark_color** -- :ref:`bool` **draw_bg** -- :ref:`Color` **light_color** +- :ref:`Color` **border_color** +- :ref:`int` **border_width_bottom** +- :ref:`int` **border_width_left** +- :ref:`int` **border_width_right** +- :ref:`int` **border_width_top** +- :ref:`int` **corner_detail** +- :ref:`int` **corner_radius_bottom_left** +- :ref:`int` **corner_radius_bottom_right** +- :ref:`int` **corner_radius_top_left** +- :ref:`int` **corner_radius_top_right** +- :ref:`bool` **draw_center** +- :ref:`float` **expand_margin_bottom** +- :ref:`float` **expand_margin_left** +- :ref:`float` **expand_margin_right** +- :ref:`float` **expand_margin_top** +- :ref:`Color` **shadow_color** +- :ref:`int` **shadow_size** Description ----------- @@ -62,6 +113,10 @@ Stylebox of a single color. Displays the stylebox of a single color, alternative Member Function Description --------------------------- +.. _class_StyleBoxFlat_get_aa_size: + +- :ref:`int` **get_aa_size** **(** **)** const + .. _class_StyleBoxFlat_get_bg_color: - :ref:`Color` **get_bg_color** **(** **)** const @@ -70,21 +125,53 @@ Member Function Description - :ref:`bool` **get_border_blend** **(** **)** const -.. _class_StyleBoxFlat_get_border_size: +.. _class_StyleBoxFlat_get_border_color: -- :ref:`int` **get_border_size** **(** **)** const +- :ref:`Color` **get_border_color** **(** **)** const -.. _class_StyleBoxFlat_get_dark_color: +.. _class_StyleBoxFlat_get_border_width: -- :ref:`Color` **get_dark_color** **(** **)** const +- :ref:`int` **get_border_width** **(** :ref:`int` margin **)** const -.. _class_StyleBoxFlat_get_draw_center: +.. _class_StyleBoxFlat_get_border_width_min: -- :ref:`bool` **get_draw_center** **(** **)** const +- :ref:`int` **get_border_width_min** **(** **)** const -.. _class_StyleBoxFlat_get_light_color: +.. _class_StyleBoxFlat_get_corner_detail: -- :ref:`Color` **get_light_color** **(** **)** const +- :ref:`int` **get_corner_detail** **(** **)** const + +.. _class_StyleBoxFlat_get_corner_radius: + +- :ref:`int` **get_corner_radius** **(** :ref:`int` corner **)** const + +.. _class_StyleBoxFlat_get_expand_margin: + +- :ref:`float` **get_expand_margin** **(** :ref:`int` margin **)** const + +.. _class_StyleBoxFlat_get_shadow_color: + +- :ref:`Color` **get_shadow_color** **(** **)** const + +.. _class_StyleBoxFlat_get_shadow_size: + +- :ref:`int` **get_shadow_size** **(** **)** const + +.. _class_StyleBoxFlat_is_anti_aliased: + +- :ref:`bool` **is_anti_aliased** **(** **)** const + +.. _class_StyleBoxFlat_is_draw_center_enabled: + +- :ref:`bool` **is_draw_center_enabled** **(** **)** const + +.. _class_StyleBoxFlat_set_aa_size: + +- void **set_aa_size** **(** :ref:`int` size **)** + +.. _class_StyleBoxFlat_set_anti_aliased: + +- void **set_anti_aliased** **(** :ref:`bool` anti_aliased **)** .. _class_StyleBoxFlat_set_bg_color: @@ -94,20 +181,56 @@ Member Function Description - void **set_border_blend** **(** :ref:`bool` blend **)** -.. _class_StyleBoxFlat_set_border_size: +.. _class_StyleBoxFlat_set_border_color: -- void **set_border_size** **(** :ref:`int` size **)** +- void **set_border_color** **(** :ref:`Color` color **)** -.. _class_StyleBoxFlat_set_dark_color: +.. _class_StyleBoxFlat_set_border_width: -- void **set_dark_color** **(** :ref:`Color` color **)** +- void **set_border_width** **(** :ref:`int` margin, :ref:`int` width **)** + +.. _class_StyleBoxFlat_set_border_width_all: + +- void **set_border_width_all** **(** :ref:`int` width **)** + +.. _class_StyleBoxFlat_set_corner_detail: + +- void **set_corner_detail** **(** :ref:`int` detail **)** + +.. _class_StyleBoxFlat_set_corner_radius: + +- void **set_corner_radius** **(** :ref:`int` corner, :ref:`int` radius **)** + +.. _class_StyleBoxFlat_set_corner_radius_all: + +- void **set_corner_radius_all** **(** :ref:`int` radius **)** + +.. _class_StyleBoxFlat_set_corner_radius_individual: + +- void **set_corner_radius_individual** **(** :ref:`int` radius_top_left, :ref:`int` radius_top_right, :ref:`int` radius_botton_right, :ref:`int` radius_bottom_left **)** .. _class_StyleBoxFlat_set_draw_center: -- void **set_draw_center** **(** :ref:`bool` size **)** +- void **set_draw_center** **(** :ref:`bool` draw_center **)** -.. _class_StyleBoxFlat_set_light_color: +.. _class_StyleBoxFlat_set_expand_margin: -- void **set_light_color** **(** :ref:`Color` color **)** +- void **set_expand_margin** **(** :ref:`int` margin, :ref:`float` size **)** + +.. _class_StyleBoxFlat_set_expand_margin_all: + +- void **set_expand_margin_all** **(** :ref:`float` size **)** + +.. _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 **)** + +.. _class_StyleBoxFlat_set_shadow_color: + +- void **set_shadow_color** **(** :ref:`Color` color **)** + +.. _class_StyleBoxFlat_set_shadow_size: + +- void **set_shadow_size** **(** :ref:`int` size **)** diff --git a/classes/class_styleboxtexture.rst b/classes/class_styleboxtexture.rst index 8b100ab7c..5f05fa8bd 100644 --- a/classes/class_styleboxtexture.rst +++ b/classes/class_styleboxtexture.rst @@ -18,35 +18,47 @@ Texture Based 3x3 scale style. Member Functions ---------------- -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_draw_center` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_expand_margin_size` **(** :ref:`int` margin **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_margin_size` **(** :ref:`int` margin **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_modulate` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_normal_map` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_region_rect` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_draw_center` **(** :ref:`bool` enable **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_margin_size` **(** :ref:`int` margin, :ref:`float` size **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_margin_size` **(** :ref:`int` margin, :ref:`float` size **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_modulate` **(** :ref:`Color` color **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_normal_map` **(** :ref:`Texture` normal_map **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_region_rect` **(** :ref:`Rect2` region **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_expand_margin_size` **(** :ref:`int` margin **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_h_axis_stretch_mode` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_margin_size` **(** :ref:`int` margin **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_modulate` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`get_normal_map` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_region_rect` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`get_texture` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_v_axis_stretch_mode` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_draw_center_enabled` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_draw_center` **(** :ref:`bool` enable **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_margin_all` **(** :ref:`float` size **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_margin_individual` **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_margin_size` **(** :ref:`int` margin, :ref:`float` size **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_axis_stretch_mode` **(** :ref:`int` mode **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_margin_size` **(** :ref:`int` margin, :ref:`float` size **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_modulate` **(** :ref:`Color` color **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_normal_map` **(** :ref:`Resource` normal_map **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_region_rect` **(** :ref:`Rect2` region **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture` **(** :ref:`Resource` texture **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_axis_stretch_mode` **(** :ref:`int` mode **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -56,6 +68,8 @@ Signals Member Variables ---------------- +- :ref:`int` **axis_stretch_horizontal** +- :ref:`int` **axis_stretch_vertical** - :ref:`bool` **draw_center** - :ref:`float` **expand_margin_bottom** - :ref:`float` **expand_margin_left** @@ -66,9 +80,16 @@ Member Variables - :ref:`float` **margin_right** - :ref:`float` **margin_top** - :ref:`Color` **modulate_color** -- :ref:`Texture` **normal_map** +- :ref:`Resource` **normal_map** - :ref:`Rect2` **region_rect** -- :ref:`Texture` **texture** +- :ref:`Resource` **texture** + +Numeric Constants +----------------- + +- **AXIS_STRETCH_MODE_STRETCH** = **0** +- **AXIS_STRETCH_MODE_TILE** = **1** +- **AXIS_STRETCH_MODE_TILE_FIT** = **2** Description ----------- @@ -78,14 +99,14 @@ Texture Based 3x3 scale style. This stylebox performs a 3x3 scaling of a texture Member Function Description --------------------------- -.. _class_StyleBoxTexture_get_draw_center: - -- :ref:`bool` **get_draw_center** **(** **)** const - .. _class_StyleBoxTexture_get_expand_margin_size: - :ref:`float` **get_expand_margin_size** **(** :ref:`int` margin **)** const +.. _class_StyleBoxTexture_get_h_axis_stretch_mode: + +- :ref:`int` **get_h_axis_stretch_mode** **(** **)** const + .. _class_StyleBoxTexture_get_margin_size: - :ref:`float` **get_margin_size** **(** :ref:`int` margin **)** const @@ -96,7 +117,7 @@ Member Function Description .. _class_StyleBoxTexture_get_normal_map: -- :ref:`Texture` **get_normal_map** **(** **)** const +- :ref:`Resource` **get_normal_map** **(** **)** const .. _class_StyleBoxTexture_get_region_rect: @@ -104,16 +125,36 @@ Member Function Description .. _class_StyleBoxTexture_get_texture: -- :ref:`Texture` **get_texture** **(** **)** const +- :ref:`Resource` **get_texture** **(** **)** const + +.. _class_StyleBoxTexture_get_v_axis_stretch_mode: + +- :ref:`int` **get_v_axis_stretch_mode** **(** **)** const + +.. _class_StyleBoxTexture_is_draw_center_enabled: + +- :ref:`bool` **is_draw_center_enabled** **(** **)** const .. _class_StyleBoxTexture_set_draw_center: - void **set_draw_center** **(** :ref:`bool` enable **)** +.. _class_StyleBoxTexture_set_expand_margin_all: + +- void **set_expand_margin_all** **(** :ref:`float` size **)** + +.. _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 **)** + .. _class_StyleBoxTexture_set_expand_margin_size: - void **set_expand_margin_size** **(** :ref:`int` margin, :ref:`float` size **)** +.. _class_StyleBoxTexture_set_h_axis_stretch_mode: + +- void **set_h_axis_stretch_mode** **(** :ref:`int` mode **)** + .. _class_StyleBoxTexture_set_margin_size: - void **set_margin_size** **(** :ref:`int` margin, :ref:`float` size **)** @@ -124,7 +165,7 @@ Member Function Description .. _class_StyleBoxTexture_set_normal_map: -- void **set_normal_map** **(** :ref:`Texture` normal_map **)** +- void **set_normal_map** **(** :ref:`Resource` normal_map **)** .. _class_StyleBoxTexture_set_region_rect: @@ -132,6 +173,10 @@ Member Function Description .. _class_StyleBoxTexture_set_texture: -- void **set_texture** **(** :ref:`Texture` texture **)** +- void **set_texture** **(** :ref:`Resource` texture **)** + +.. _class_StyleBoxTexture_set_v_axis_stretch_mode: + +- void **set_v_axis_stretch_mode** **(** :ref:`int` mode **)** diff --git a/classes/class_surfacetool.rst b/classes/class_surfacetool.rst index 5ed414058..a584a7af1 100644 --- a/classes/class_surfacetool.rst +++ b/classes/class_surfacetool.rst @@ -18,43 +18,51 @@ Helper tool to create geometry. Member Functions ---------------- -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_bones` **(** :ref:`PoolIntArray` bones **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_color` **(** :ref:`Color` color **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_index` **(** :ref:`int` index **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_normal` **(** :ref:`Vector3` normal **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_smooth_group` **(** :ref:`bool` smooth **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_tangent` **(** :ref:`Plane` tangent **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_triangle_fan` **(** :ref:`PoolVector3Array` vertexes, :ref:`PoolVector2Array` uvs=PoolVector2Array([]), :ref:`PoolColorArray` colors=PoolColorArray([PoolColorArray]), :ref:`PoolVector2Array` uv2s=PoolVector2Array([]), :ref:`PoolVector3Array` normals=PoolVector3Array([]), :ref:`Array` tangents=[] **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_uv` **(** :ref:`Vector2` uv **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_uv2` **(** :ref:`Vector2` uv2 **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_vertex` **(** :ref:`Vector3` vertex **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_weights` **(** :ref:`PoolRealArray` weights **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`begin` **(** :ref:`int` primitive **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`commit` **(** :ref:`Mesh` existing=NULL **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`deindex` **(** **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`generate_normals` **(** **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`index` **(** **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_material` **(** :ref:`Material` material **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_bones` **(** :ref:`PoolIntArray` bones **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_color` **(** :ref:`Color` color **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_index` **(** :ref:`int` index **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_normal` **(** :ref:`Vector3` normal **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_smooth_group` **(** :ref:`bool` smooth **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_tangent` **(** :ref:`Plane` tangent **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_to_format` **(** :ref:`int` flags **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_triangle_fan` **(** :ref:`PoolVector3Array` vertexes, :ref:`PoolVector2Array` uvs=PoolVector3Array( ), :ref:`PoolColorArray` colors=PoolVector2Array( ), :ref:`PoolVector2Array` uv2s=PoolColorArray( ), :ref:`PoolVector3Array` normals=PoolVector2Array( ), :ref:`Array` tangents=null **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_uv` **(** :ref:`Vector2` uv **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_uv2` **(** :ref:`Vector2` uv2 **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_vertex` **(** :ref:`Vector3` vertex **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_weights` **(** :ref:`PoolRealArray` weights **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_from` **(** :ref:`Mesh` existing, :ref:`int` surface, :ref:`Transform` transform **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`begin` **(** :ref:`int` primitive **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ArrayMesh` | :ref:`commit` **(** :ref:`ArrayMesh` existing=null **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_from` **(** :ref:`Mesh` existing, :ref:`int` surface **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`deindex` **(** **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`generate_normals` **(** **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`generate_tangents` **(** **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`index` **(** **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_material` **(** :ref:`Material` material **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -112,9 +120,13 @@ Specify whether current Vertex (if using only Vertex arrays) or current index (i Specify a Tangent for the next Vertex to use. +.. _class_SurfaceTool_add_to_format: + +- void **add_to_format** **(** :ref:`int` flags **)** + .. _class_SurfaceTool_add_triangle_fan: -- void **add_triangle_fan** **(** :ref:`PoolVector3Array` vertexes, :ref:`PoolVector2Array` uvs=PoolVector2Array([]), :ref:`PoolColorArray` colors=PoolColorArray([PoolColorArray]), :ref:`PoolVector2Array` uv2s=PoolVector2Array([]), :ref:`PoolVector3Array` normals=PoolVector3Array([]), :ref:`Array` tangents=[] **)** +- void **add_triangle_fan** **(** :ref:`PoolVector3Array` vertexes, :ref:`PoolVector2Array` uvs=PoolVector3Array( ), :ref:`PoolColorArray` colors=PoolVector2Array( ), :ref:`PoolVector2Array` uv2s=PoolColorArray( ), :ref:`PoolVector3Array` normals=PoolVector2Array( ), :ref:`Array` tangents=null **)** Insert a triangle fan made of array data into :ref:`Mesh` being constructed. @@ -142,6 +154,10 @@ Specify position of current Vertex. Should be called after specifying other vert Specify weight value for next Vertex to use. +.. _class_SurfaceTool_append_from: + +- void **append_from** **(** :ref:`Mesh` existing, :ref:`int` surface, :ref:`Transform` transform **)** + .. _class_SurfaceTool_begin: - void **begin** **(** :ref:`int` primitive **)** @@ -156,9 +172,13 @@ Clear all information passed into the surface tool so far. .. _class_SurfaceTool_commit: -- :ref:`Mesh` **commit** **(** :ref:`Mesh` existing=NULL **)** +- :ref:`ArrayMesh` **commit** **(** :ref:`ArrayMesh` existing=null **)** -Returns a constructed :ref:`Mesh` from current information passed in. If an existing :ref:`Mesh` is passed in as an argument, will add an extra surface to the existing :ref:`Mesh`. +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: + +- void **create_from** **(** :ref:`Mesh` existing, :ref:`int` surface **)** .. _class_SurfaceTool_deindex: @@ -172,6 +192,10 @@ Removes index array by expanding Vertex array. Generates normals from Vertices so you do not have to do it manually. +.. _class_SurfaceTool_generate_tangents: + +- void **generate_tangents** **(** **)** + .. _class_SurfaceTool_index: - void **index** **(** **)** diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index 5f28b1347..a674f4535 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -43,7 +43,7 @@ Member Functions +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_current_tab` **(** :ref:`int` tab_idx **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_popup` **(** :ref:`Popup` popup **)** | +| void | :ref:`set_popup` **(** :ref:`Node` popup **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tab_align` **(** :ref:`int` align **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ @@ -150,7 +150,7 @@ Bring a tab (and the Control it represents) to the front, and hide the rest. .. _class_TabContainer_set_popup: -- void **set_popup** **(** :ref:`Popup` popup **)** +- void **set_popup** **(** :ref:`Node` popup **)** .. _class_TabContainer_set_tab_align: diff --git a/classes/class_tabs.rst b/classes/class_tabs.rst index d882b7953..e6f6e2c58 100644 --- a/classes/class_tabs.rst +++ b/classes/class_tabs.rst @@ -19,7 +19,7 @@ Member Functions ---------------- +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_tab` **(** :ref:`String` title, :ref:`Texture` icon **)** | +| void | :ref:`add_tab` **(** :ref:`String` title=null, :ref:`Texture` icon="" **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`ensure_tab_visible` **(** :ref:`int` idx **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ @@ -27,13 +27,15 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_tab_align` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tab_close_display_policy` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_tab_count` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_tab_disabled` **(** :ref:`int` tab_idx **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_tab_rect` **(** :ref:`int` tab_idx **)** | +| :ref:`Rect2` | :ref:`get_tab_rect` **(** :ref:`int` tab_idx **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ @@ -45,6 +47,8 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tab_align` **(** :ref:`int` align **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_close_display_policy` **(** :ref:`int` policy **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tab_disabled` **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** | @@ -58,6 +62,7 @@ Signals - **reposition_active_tab_request** **(** :ref:`int` idx_to **)** - **right_button_pressed** **(** :ref:`int` tab **)** - **tab_changed** **(** :ref:`int` tab **)** +- **tab_clicked** **(** :ref:`int` tab **)** - **tab_close** **(** :ref:`int` tab **)** - **tab_hover** **(** :ref:`int` tab **)** @@ -65,6 +70,7 @@ Member Variables ---------------- - :ref:`int` **current_tab** +- :ref:`int` **tab_close_display_policy** Numeric Constants ----------------- @@ -72,9 +78,11 @@ Numeric Constants - **ALIGN_LEFT** = **0** - **ALIGN_CENTER** = **1** - **ALIGN_RIGHT** = **2** +- **ALIGN_MAX** = **3** - **CLOSE_BUTTON_SHOW_ACTIVE_ONLY** = **1** - **CLOSE_BUTTON_SHOW_ALWAYS** = **2** - **CLOSE_BUTTON_SHOW_NEVER** = **0** +- **CLOSE_BUTTON_MAX** = **3** Description ----------- @@ -86,7 +94,7 @@ Member Function Description .. _class_Tabs_add_tab: -- void **add_tab** **(** :ref:`String` title, :ref:`Texture` icon **)** +- void **add_tab** **(** :ref:`String` title=null, :ref:`Texture` icon="" **)** .. _class_Tabs_ensure_tab_visible: @@ -100,6 +108,10 @@ Member Function Description - :ref:`int` **get_tab_align** **(** **)** const +.. _class_Tabs_get_tab_close_display_policy: + +- :ref:`int` **get_tab_close_display_policy** **(** **)** const + .. _class_Tabs_get_tab_count: - :ref:`int` **get_tab_count** **(** **)** const @@ -114,7 +126,7 @@ Member Function Description .. _class_Tabs_get_tab_rect: -- :ref:`Rect2` **get_tab_rect** **(** :ref:`int` tab_idx **)** +- :ref:`Rect2` **get_tab_rect** **(** :ref:`int` tab_idx **)** const Returns tab :ref:`Rect2` with local position and size. @@ -140,6 +152,10 @@ Rearrange tab. - void **set_tab_align** **(** :ref:`int` align **)** +.. _class_Tabs_set_tab_close_display_policy: + +- void **set_tab_close_display_policy** **(** :ref:`int` policy **)** + .. _class_Tabs_set_tab_disabled: - void **set_tab_disabled** **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** diff --git a/classes/class_tcp_server.rst b/classes/class_tcp_server.rst index 16d723bda..6e160cad0 100644 --- a/classes/class_tcp_server.rst +++ b/classes/class_tcp_server.rst @@ -18,15 +18,15 @@ TCP Server. Member Functions ---------------- -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_connection_available` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address="*" **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`take_connection` **(** **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_connection_available` **(** **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address=null **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StreamPeerTCP` | :ref:`take_connection` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -44,7 +44,7 @@ Return true if a connection is available for taking. .. _class_TCP_Server_listen: -- :ref:`int` **listen** **(** :ref:`int` port, :ref:`String` bind_address="*" **)** +- :ref:`int` **listen** **(** :ref:`int` port, :ref:`String` bind_address=null **)** Listen on the "port" binding to "bind_address". @@ -62,7 +62,7 @@ Stop listening. .. _class_TCP_Server_take_connection: -- :ref:`Object` **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 07730f4f6..17ad6fe4d 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -18,97 +18,105 @@ Multiline text editing control. Member Functions ---------------- -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_color_region` **(** :ref:`String` begin_key, :ref:`String` end_key, :ref:`Color` color, :ref:`bool` line_only=false **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_keyword_color` **(** :ref:`String` keyword, :ref:`Color` color **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_colors` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_undo_history` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`copy` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`cursor_get_blink_enabled` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`cursor_get_blink_speed` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`cursor_get_column` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`cursor_get_line` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`cursor_is_block_mode` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_blink_enabled` **(** :ref:`bool` enable **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_blink_speed` **(** :ref:`float` blink_speed **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_block_mode` **(** :ref:`bool` enable **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_column` **(** :ref:`int` column, :ref:`bool` adjust_viewport=true **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_line` **(** :ref:`int` line, :ref:`bool` adjust_viewport=true **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cut` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_line` **(** :ref:`int` line **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_line_count` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PopupMenu` | :ref:`get_menu` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selection_from_column` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selection_from_line` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_selection_text` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selection_to_column` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selection_to_line` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_text` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_word_under_cursor` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`insert_text_at_cursor` **(** :ref:`String` text **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_highlight_all_occurrences_enabled` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selection_active` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_show_line_numbers_enabled` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_syntax_coloring_enabled` **(** **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`menu_option` **(** :ref:`int` arg0 **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`paste` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`redo` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`search` **(** :ref:`String` flags, :ref:`int` from_line, :ref:`int` from_column, :ref:`int` to_line **)** const | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select` **(** :ref:`int` from_line, :ref:`int` from_column, :ref:`int` to_line, :ref:`int` to_column **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select_all` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_highlight_all_occurrences` **(** :ref:`bool` enable **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_chars` **(** :ref:`int` amount **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_readonly` **(** :ref:`bool` enable **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_show_line_numbers` **(** :ref:`bool` enable **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_syntax_coloring` **(** :ref:`bool` enable **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text` **(** :ref:`String` text **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_wrap` **(** :ref:`bool` enable **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`undo` **(** **)** | -+------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_color_region` **(** :ref:`String` begin_key, :ref:`String` end_key, :ref:`Color` color, :ref:`bool` line_only=null **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_keyword_color` **(** :ref:`String` keyword, :ref:`Color` color **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_colors` **(** **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_undo_history` **(** **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`copy` **(** **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`cursor_get_blink_enabled` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`cursor_get_blink_speed` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`cursor_get_column` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`cursor_get_line` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`cursor_is_block_mode` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cursor_set_blink_enabled` **(** :ref:`bool` enable **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cursor_set_blink_speed` **(** :ref:`float` blink_speed **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cursor_set_block_mode` **(** :ref:`bool` enable **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cursor_set_column` **(** :ref:`int` column, :ref:`bool` adjust_viewport=null **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cursor_set_line` **(** :ref:`int` line, :ref:`bool` adjust_viewport=null **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cut` **(** **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_line` **(** :ref:`int` line **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_line_count` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PopupMenu` | :ref:`get_menu` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selection_from_column` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selection_from_line` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_selection_text` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selection_to_column` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selection_to_line` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_text` **(** **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_v_scroll_speed` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_word_under_cursor` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`insert_text_at_cursor` **(** :ref:`String` text **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_highlight_all_occurrences_enabled` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_selection_active` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_show_line_numbers_enabled` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_smooth_scroll_enabled` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_syntax_coloring_enabled` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`menu_option` **(** :ref:`int` option **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`paste` **(** **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`redo` **(** **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`search` **(** :ref:`String` key, :ref:`int` flags, :ref:`int` from_line, :ref:`int` from_column **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select` **(** :ref:`int` from_line, :ref:`int` from_column, :ref:`int` to_line, :ref:`int` to_column **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select_all` **(** **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_highlight_all_occurrences` **(** :ref:`bool` enable **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_chars` **(** :ref:`int` amount **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_readonly` **(** :ref:`bool` enable **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_show_line_numbers` **(** :ref:`bool` enable **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_smooth_scroll_enable` **(** :ref:`bool` enable **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_syntax_coloring` **(** :ref:`bool` enable **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_text` **(** :ref:`String` text **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_scroll_speed` **(** :ref:`float` speed **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_wrap` **(** :ref:`bool` enable **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`undo` **(** **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -133,7 +141,9 @@ Member Variables - :ref:`bool` **caret_block_mode** - :ref:`bool` **highlight_all_occurrences** - :ref:`bool` **show_line_numbers** +- :ref:`bool` **smooth_scrolling** - :ref:`bool` **syntax_highlighting** +- :ref:`float` **v_scroll_speed** Numeric Constants ----------------- @@ -159,7 +169,7 @@ Member Function Description .. _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 **)** +- void **add_color_region** **(** :ref:`String` begin_key, :ref:`String` end_key, :ref:`Color` color, :ref:`bool` line_only=null **)** Add color region (given the delimiters) and its colors. @@ -237,11 +247,11 @@ Set the text editor caret to block mode. .. _class_TextEdit_cursor_set_column: -- void **cursor_set_column** **(** :ref:`int` column, :ref:`bool` adjust_viewport=true **)** +- void **cursor_set_column** **(** :ref:`int` column, :ref:`bool` adjust_viewport=null **)** .. _class_TextEdit_cursor_set_line: -- void **cursor_set_line** **(** :ref:`int` line, :ref:`bool` adjust_viewport=true **)** +- void **cursor_set_line** **(** :ref:`int` line, :ref:`bool` adjust_viewport=null **)** .. _class_TextEdit_cut: @@ -301,6 +311,10 @@ Return the selection end line. Return the whole text. +.. _class_TextEdit_get_v_scroll_speed: + +- :ref:`float` **get_v_scroll_speed** **(** **)** const + .. _class_TextEdit_get_word_under_cursor: - :ref:`String` **get_word_under_cursor** **(** **)** const @@ -329,6 +343,10 @@ Return true if the selection is active. Returns true if line numbers are enabled. +.. _class_TextEdit_is_smooth_scroll_enabled: + +- :ref:`bool` **is_smooth_scroll_enabled** **(** **)** const + .. _class_TextEdit_is_syntax_coloring_enabled: - :ref:`bool` **is_syntax_coloring_enabled** **(** **)** const @@ -337,7 +355,7 @@ Return true if the syntax coloring is enabled. .. _class_TextEdit_menu_option: -- void **menu_option** **(** :ref:`int` arg0 **)** +- void **menu_option** **(** :ref:`int` option **)** .. _class_TextEdit_paste: @@ -353,7 +371,7 @@ Perform redo operation. .. _class_TextEdit_search: -- :ref:`PoolIntArray` **search** **(** :ref:`String` flags, :ref:`int` from_line, :ref:`int` from_column, :ref:`int` to_line **)** const +- :ref:`PoolIntArray` **search** **(** :ref:`String` key, :ref:`int` flags, :ref:`int` from_line, :ref:`int` from_column **)** const Perform a search inside the text. Search flags can be specified in the SEARCH\_\* enum. @@ -393,6 +411,10 @@ Set the text editor as read-only. Text can be displayed but not edited. Set to enable showing line numbers. +.. _class_TextEdit_set_smooth_scroll_enable: + +- void **set_smooth_scroll_enable** **(** :ref:`bool` enable **)** + .. _class_TextEdit_set_syntax_coloring: - void **set_syntax_coloring** **(** :ref:`bool` enable **)** @@ -405,6 +427,10 @@ Set to enable the syntax coloring. Set the entire text. +.. _class_TextEdit_set_v_scroll_speed: + +- void **set_v_scroll_speed** **(** :ref:`float` speed **)** + .. _class_TextEdit_set_wrap: - void **set_wrap** **(** :ref:`bool` enable **)** diff --git a/classes/class_texture.rst b/classes/class_texture.rst index 939c591cc..b61f7da3e 100644 --- a/classes/class_texture.rst +++ b/classes/class_texture.rst @@ -20,25 +20,27 @@ Texture for 2D and 3D. Member Functions ---------------- -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false, :ref:`Texture` normal_map=NULL **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_rect` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false, :ref:`Texture` normal_map=NULL **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_rect_region` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false, :ref:`Texture` normal_map=NULL, :ref:`bool` clip_uv=true **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_flags` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_height` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_width` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_alpha` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flags` **(** :ref:`int` flags **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=null, :ref:`Texture` normal_map=null **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_rect` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=null, :ref:`bool` transpose=null, :ref:`Texture` normal_map=null **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_rect_region` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=null, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=null **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`get_data` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_flags` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_height` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_width` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_alpha` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flags` **(** :ref:`int` flags **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -62,15 +64,19 @@ Member Function Description .. _class_Texture_draw: -- void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false, :ref:`Texture` normal_map=NULL **)** const +- void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=null, :ref:`Texture` normal_map=null **)** const .. _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 +- void **draw_rect** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=null, :ref:`bool` transpose=null, :ref:`Texture` normal_map=null **)** const .. _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 +- 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=null, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=null **)** const + +.. _class_Texture_get_data: + +- :ref:`Image` **get_data** **(** **)** const .. _class_Texture_get_flags: diff --git a/classes/class_textureprogress.rst b/classes/class_textureprogress.rst index 28f384d24..ced5349b5 100644 --- a/classes/class_textureprogress.rst +++ b/classes/class_textureprogress.rst @@ -18,43 +18,56 @@ Textured progress bar implementation. Member Functions ---------------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fill_degrees` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_fill_mode` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_over_texture` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_progress_texture` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_radial_center_offset` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_radial_initial_angle` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_under_texture` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fill_degrees` **(** :ref:`float` mode **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fill_mode` **(** :ref:`int` mode **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_over_texture` **(** :ref:`Object` tex **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_progress_texture` **(** :ref:`Object` tex **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_radial_center_offset` **(** :ref:`Vector2` mode **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_radial_initial_angle` **(** :ref:`float` mode **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_under_texture` **(** :ref:`Object` tex **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fill_degrees` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_fill_mode` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_nine_patch_stretch` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_over_texture` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_progress_texture` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_radial_center_offset` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_radial_initial_angle` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_stretch_margin` **(** :ref:`int` margin **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_under_texture` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fill_degrees` **(** :ref:`float` mode **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fill_mode` **(** :ref:`int` mode **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_nine_patch_stretch` **(** :ref:`bool` stretch **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_over_texture` **(** :ref:`Texture` tex **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_progress_texture` **(** :ref:`Texture` tex **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_radial_center_offset` **(** :ref:`Vector2` mode **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_radial_initial_angle` **(** :ref:`float` mode **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stretch_margin` **(** :ref:`int` margin, :ref:`int` value **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_under_texture` **(** :ref:`Texture` tex **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- - :ref:`int` **fill_mode** +- :ref:`bool` **nine_patch_stretch** - :ref:`Vector2` **radial_center_offset** - :ref:`float` **radial_fill_degrees** - :ref:`float` **radial_initial_angle** +- :ref:`int` **stretch_margin_bottom** +- :ref:`int` **stretch_margin_left** +- :ref:`int` **stretch_margin_right** +- :ref:`int` **stretch_margin_top** - :ref:`Texture` **texture_over** - :ref:`Texture` **texture_progress** - :ref:`Texture` **texture_under** @@ -85,13 +98,19 @@ Member Function Description - :ref:`int` **get_fill_mode** **(** **)** +.. _class_TextureProgress_get_nine_patch_stretch: + +- :ref:`bool` **get_nine_patch_stretch** **(** **)** const + +Returns true if textures are stretched as nine-patches or false otherwise. + .. _class_TextureProgress_get_over_texture: -- :ref:`Object` **get_over_texture** **(** **)** const +- :ref:`Texture` **get_over_texture** **(** **)** const .. _class_TextureProgress_get_progress_texture: -- :ref:`Object` **get_progress_texture** **(** **)** const +- :ref:`Texture` **get_progress_texture** **(** **)** const .. _class_TextureProgress_get_radial_center_offset: @@ -101,9 +120,15 @@ Member Function Description - :ref:`float` **get_radial_initial_angle** **(** **)** +.. _class_TextureProgress_get_stretch_margin: + +- :ref:`int` **get_stretch_margin** **(** :ref:`int` margin **)** const + +Return nine-patch texture offset for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). + .. _class_TextureProgress_get_under_texture: -- :ref:`Object` **get_under_texture** **(** **)** const +- :ref:`Texture` **get_under_texture** **(** **)** const .. _class_TextureProgress_set_fill_degrees: @@ -113,13 +138,19 @@ Member Function Description - void **set_fill_mode** **(** :ref:`int` mode **)** +.. _class_TextureProgress_set_nine_patch_stretch: + +- void **set_nine_patch_stretch** **(** :ref:`bool` stretch **)** + +Set if textures should be stretched as nine-patches. + .. _class_TextureProgress_set_over_texture: -- void **set_over_texture** **(** :ref:`Object` tex **)** +- void **set_over_texture** **(** :ref:`Texture` tex **)** .. _class_TextureProgress_set_progress_texture: -- void **set_progress_texture** **(** :ref:`Object` tex **)** +- void **set_progress_texture** **(** :ref:`Texture` tex **)** .. _class_TextureProgress_set_radial_center_offset: @@ -129,8 +160,14 @@ Member Function Description - void **set_radial_initial_angle** **(** :ref:`float` mode **)** +.. _class_TextureProgress_set_stretch_margin: + +- void **set_stretch_margin** **(** :ref:`int` margin, :ref:`int` value **)** + +Set nine-patch texture offset for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). + .. _class_TextureProgress_set_under_texture: -- void **set_under_texture** **(** :ref:`Object` tex **)** +- void **set_under_texture** **(** :ref:`Texture` tex **)** diff --git a/classes/class_texturerect.rst b/classes/class_texturerect.rst index 7a06fa9cc..5b5a91272 100644 --- a/classes/class_texturerect.rst +++ b/classes/class_texturerect.rst @@ -18,19 +18,19 @@ Control Frame that draws a texture. Member Functions ---------------- -+------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_stretch_mode` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_texture` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_expand` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand` **(** :ref:`bool` enable **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stretch_mode` **(** :ref:`int` stretch_mode **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Object` texture **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_stretch_mode` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_texture` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_expand` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand` **(** :ref:`bool` enable **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stretch_mode` **(** :ref:`int` stretch_mode **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -65,7 +65,7 @@ Member Function Description .. _class_TextureRect_get_texture: -- :ref:`Object` **get_texture** **(** **)** const +- :ref:`Texture` **get_texture** **(** **)** const .. _class_TextureRect_has_expand: @@ -81,6 +81,6 @@ Member Function Description .. _class_TextureRect_set_texture: -- void **set_texture** **(** :ref:`Object` texture **)** +- void **set_texture** **(** :ref:`Texture` texture **)** diff --git a/classes/class_theme.rst b/classes/class_theme.rst index 9fe45bcf1..628a60a1c 100644 --- a/classes/class_theme.rst +++ b/classes/class_theme.rst @@ -39,7 +39,7 @@ Member Functions +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolStringArray` | :ref:`get_constant_list` **(** :ref:`String` type **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_default_font` **(** **)** const | +| :ref:`Font` | :ref:`get_default_font` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Font` | :ref:`get_font` **(** :ref:`String` name, :ref:`String` type **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -71,7 +71,7 @@ Member Functions +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_constant` **(** :ref:`String` name, :ref:`String` type, :ref:`int` constant **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_font` **(** :ref:`Object` font **)** | +| void | :ref:`set_default_font` **(** :ref:`Font` font **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_font` **(** :ref:`String` name, :ref:`String` type, :ref:`Font` font **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -137,7 +137,7 @@ Member Function Description .. _class_Theme_get_default_font: -- :ref:`Object` **get_default_font** **(** **)** const +- :ref:`Font` **get_default_font** **(** **)** const .. _class_Theme_get_font: @@ -201,7 +201,7 @@ Member Function Description .. _class_Theme_set_default_font: -- void **set_default_font** **(** :ref:`Object` font **)** +- void **set_default_font** **(** :ref:`Font` font **)** .. _class_Theme_set_font: diff --git a/classes/class_thread.rst b/classes/class_thread.rst index 710338158..d1a5538b2 100644 --- a/classes/class_thread.rst +++ b/classes/class_thread.rst @@ -18,15 +18,15 @@ A unit of execution in a process. Member Functions ---------------- -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_id` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_active` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Error | :ref:`start` **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=NULL, :ref:`int` priority=1 **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`wait_to_finish` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_id` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_active` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`start` **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=null, :ref:`int` priority=null **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`wait_to_finish` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -57,7 +57,7 @@ Whether this thread is currently active, an active Thread cannot start work on a .. _class_Thread_start: -- Error **start** **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=NULL, :ref:`int` priority=1 **)** +- :ref:`int` **start** **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=null, :ref:`int` priority=null **)** Start a new :ref:`Thread`, it will run "method" on object "instance" using "userdata" as an argument and running with "priority", one of PRIORITY\_\* enum. diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index da00fd994..4f12997f3 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -18,103 +18,105 @@ Node for 2D tile-based games. Member Functions ---------------- -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cell` **(** :ref:`int` x, :ref:`int` y **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_cell_size` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cellv` **(** :ref:`Vector2` pos **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_center_x` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_center_y` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_collision_bounce` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_collision_friction` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_use_kinematic` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_custom_transform` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_half_offset` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mode` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_occluder_light_mask` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_quadrant_size` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tile_origin` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TileSet` | :ref:`get_tileset` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_used_cells` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_used_rect` **(** **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_cell_transposed` **(** :ref:`int` x, :ref:`int` y **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_cell_x_flipped` **(** :ref:`int` x, :ref:`int` y **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_cell_y_flipped` **(** :ref:`int` x, :ref:`int` y **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_y_sort_mode_enabled` **(** **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`map_to_world` **(** :ref:`Vector2` mappos, :ref:`bool` ignore_half_ofs=false **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell` **(** :ref:`int` x, :ref:`int` y, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_size` **(** :ref:`Vector2` size **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cellv` **(** :ref:`Vector2` pos, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_center_x` **(** :ref:`bool` enable **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_center_y` **(** :ref:`bool` enable **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_bounce` **(** :ref:`float` value **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_friction` **(** :ref:`float` value **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask` **(** :ref:`int` mask **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_use_kinematic` **(** :ref:`bool` use_kinematic **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_transform` **(** :ref:`Transform2D` custom_transform **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_half_offset` **(** :ref:`int` half_offset **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mode` **(** :ref:`int` mode **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_occluder_light_mask` **(** :ref:`int` mask **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_quadrant_size` **(** :ref:`int` size **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tile_origin` **(** :ref:`int` origin **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tileset` **(** :ref:`TileSet` tileset **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_y_sort_mode` **(** :ref:`bool` enable **)** | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`world_to_map` **(** :ref:`Vector2` worldpos **)** const | -+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cell` **(** :ref:`int` x, :ref:`int` y **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_cell_size` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cellv` **(** :ref:`Vector2` pos **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_center_x` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_center_y` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_collision_bounce` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_collision_friction` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_use_kinematic` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_custom_transform` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_half_offset` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mode` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_occluder_light_mask` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_quadrant_size` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tile_origin` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TileSet` | :ref:`get_tileset` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_used_cells` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_used_cells_by_id` **(** :ref:`int` id **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_used_rect` **(** **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_cell_transposed` **(** :ref:`int` x, :ref:`int` y **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_cell_x_flipped` **(** :ref:`int` x, :ref:`int` y **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_cell_y_flipped` **(** :ref:`int` x, :ref:`int` y **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_y_sort_mode_enabled` **(** **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`map_to_world` **(** :ref:`Vector2` mappos, :ref:`bool` ignore_half_ofs=null **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell` **(** :ref:`int` x, :ref:`int` y, :ref:`int` tile, :ref:`bool` flip_x=null, :ref:`bool` flip_y=null, :ref:`bool` transpose=null **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell_size` **(** :ref:`Vector2` size **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cellv` **(** :ref:`Vector2` pos, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=null, :ref:`bool` transpose=null **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_center_x` **(** :ref:`bool` enable **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_center_y` **(** :ref:`bool` enable **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_bounce` **(** :ref:`float` value **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_friction` **(** :ref:`float` value **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask` **(** :ref:`int` mask **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_use_kinematic` **(** :ref:`bool` use_kinematic **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_transform` **(** :ref:`Transform2D` custom_transform **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_half_offset` **(** :ref:`int` half_offset **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mode` **(** :ref:`int` mode **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_occluder_light_mask` **(** :ref:`int` mask **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_quadrant_size` **(** :ref:`int` size **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tile_origin` **(** :ref:`int` origin **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tileset` **(** :ref:`TileSet` tileset **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_y_sort_mode` **(** :ref:`bool` enable **)** | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`world_to_map` **(** :ref:`Vector2` worldpos **)** const | ++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -139,7 +141,7 @@ Member Variables - :ref:`bool` **collision_use_kinematic** - :ref:`int` **mode** - :ref:`int` **occluder_light_mask** -- :ref:`Object` **tile_data** +- :ref:`PoolIntArray` **tile_data** - :ref:`TileSet` **tile_set** Numeric Constants @@ -286,6 +288,10 @@ Return the current tileset. Return an array of all cells containing a tile from the tileset (i.e. a tile index different from -1). +.. _class_TileMap_get_used_cells_by_id: + +- :ref:`Array` **get_used_cells_by_id** **(** :ref:`int` id **)** const + .. _class_TileMap_get_used_rect: - :ref:`Rect2` **get_used_rect** **(** **)** @@ -316,7 +322,7 @@ Return the Y sort mode. .. _class_TileMap_map_to_world: -- :ref:`Vector2` **map_to_world** **(** :ref:`Vector2` mappos, :ref:`bool` ignore_half_ofs=false **)** const +- :ref:`Vector2` **map_to_world** **(** :ref:`Vector2` mappos, :ref:`bool` ignore_half_ofs=null **)** const Return the absolute world position corresponding to the tilemap (grid-based) coordinates given as an argument. @@ -324,7 +330,7 @@ Optionally, the tilemap's potential half offset can be ignored. .. _class_TileMap_set_cell: -- void **set_cell** **(** :ref:`int` x, :ref:`int` y, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** +- void **set_cell** **(** :ref:`int` x, :ref:`int` y, :ref:`int` tile, :ref:`bool` flip_x=null, :ref:`bool` flip_y=null, :ref:`bool` transpose=null **)** Set the tile index for the cell referenced by its grid-based X and Y coordinates. @@ -340,7 +346,7 @@ Set the cell size. .. _class_TileMap_set_cellv: -- void **set_cellv** **(** :ref:`Vector2` pos, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** +- void **set_cellv** **(** :ref:`Vector2` pos, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=null, :ref:`bool` transpose=null **)** Set the tile index for the cell referenced by a Vector2 of grid-based coordinates. @@ -412,7 +418,7 @@ Set custom transform matrix, to use in combination with the custom orientation m - void **set_half_offset** **(** :ref:`int` half_offset **)** -Set an half offset on the X coordinate, Y coordinate, or none (use HALF_OFFSET\_\* constants as argument). +Set a half offset on the X coordinate, Y coordinate, or none (use HALF_OFFSET\_\* constants as argument). Half offset sets every other tile off by a half tile size in the specified direction. diff --git a/classes/class_tileset.rst b/classes/class_tileset.rst index af4e12516..0deb3ce93 100644 --- a/classes/class_tileset.rst +++ b/classes/class_tileset.rst @@ -18,79 +18,79 @@ Tile library for tilemaps. Member Functions ---------------- -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_tile` **(** :ref:`int` id **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_tile_by_name` **(** :ref:`String` name **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_last_unused_tile_id` **(** **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_tiles_ids` **(** **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_tile` **(** :ref:`int` id **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_add_shape` **(** :ref:`int` id, :ref:`Shape2D` shape, :ref:`Transform2D` shape_transform, :ref:`bool` one_way=false **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`OccluderPolygon2D` | :ref:`tile_get_light_occluder` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ShaderMaterial` | :ref:`tile_get_material` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`tile_get_name` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NavigationPolygon` | :ref:`tile_get_navigation_polygon` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_navigation_polygon_offset` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`tile_get_normal_map` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_occluder_offset` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`tile_get_region` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape2D` | :ref:`tile_get_shape` **(** :ref:`int` id, :ref:`int` shape_id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`tile_get_shape_count` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`tile_get_shape_one_way` **(** :ref:`int` id, :ref:`int` shape_id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`tile_get_shape_transform` **(** :ref:`int` id, :ref:`int` shape_id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`tile_get_shapes` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`tile_get_texture` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_texture_offset` **(** :ref:`int` id **)** const | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_light_occluder` **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_material` **(** :ref:`int` id, :ref:`ShaderMaterial` material **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_name` **(** :ref:`int` id, :ref:`String` name **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_navigation_polygon` **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_navigation_polygon_offset` **(** :ref:`int` id, :ref:`Vector2` navigation_polygon_offset **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_normal_map` **(** :ref:`int` id, :ref:`Texture` normal_map **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_occluder_offset` **(** :ref:`int` id, :ref:`Vector2` occluder_offset **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_region` **(** :ref:`int` id, :ref:`Rect2` region **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shape` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Shape2D` shape **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shape_one_way` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`bool` one_way **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shape_transform` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Transform2D` shape_transform **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_texture` **(** :ref:`int` id, :ref:`Texture` texture **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_texture_offset` **(** :ref:`int` id, :ref:`Vector2` texture_offset **)** | -+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_tile` **(** :ref:`int` id **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_tile_by_name` **(** :ref:`String` name **)** const | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_last_unused_tile_id` **(** **)** const | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_tiles_ids` **(** **)** const | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_tile` **(** :ref:`int` id **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_add_shape` **(** :ref:`int` id, :ref:`Shape2D` shape, :ref:`Transform2D` shape_transform, :ref:`bool` one_way=null **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`OccluderPolygon2D` | :ref:`tile_get_light_occluder` **(** :ref:`int` id **)** const | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ShaderMaterial` | :ref:`tile_get_material` **(** :ref:`int` id **)** const | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`tile_get_name` **(** :ref:`int` id **)** const | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NavigationPolygon` | :ref:`tile_get_navigation_polygon` **(** :ref:`int` id **)** const | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`tile_get_navigation_polygon_offset` **(** :ref:`int` id **)** const | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`tile_get_normal_map` **(** :ref:`int` id **)** const | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`tile_get_occluder_offset` **(** :ref:`int` id **)** const | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`tile_get_region` **(** :ref:`int` id **)** const | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shape2D` | :ref:`tile_get_shape` **(** :ref:`int` id, :ref:`int` shape_id **)** const | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`tile_get_shape_count` **(** :ref:`int` id **)** const | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`tile_get_shape_one_way` **(** :ref:`int` id, :ref:`int` shape_id **)** const | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`tile_get_shape_transform` **(** :ref:`int` id, :ref:`int` shape_id **)** const | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`tile_get_shapes` **(** :ref:`int` id **)** const | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`tile_get_texture` **(** :ref:`int` id **)** const | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`tile_get_texture_offset` **(** :ref:`int` id **)** const | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_light_occluder` **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_material` **(** :ref:`int` id, :ref:`ShaderMaterial` material **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_name` **(** :ref:`int` id, :ref:`String` name **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_navigation_polygon` **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_navigation_polygon_offset` **(** :ref:`int` id, :ref:`Vector2` navigation_polygon_offset **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_normal_map` **(** :ref:`int` id, :ref:`Texture` normal_map **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_occluder_offset` **(** :ref:`int` id, :ref:`Vector2` occluder_offset **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_region` **(** :ref:`int` id, :ref:`Rect2` region **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shape` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Shape2D` shape **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shape_one_way` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`bool` one_way **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shape_transform` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Transform2D` shape_transform **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_texture` **(** :ref:`int` id, :ref:`Texture` texture **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_texture_offset` **(** :ref:`int` id, :ref:`Vector2` texture_offset **)** | ++----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -140,7 +140,7 @@ Remove the tile referenced by the given ID. .. _class_TileSet_tile_add_shape: -- void **tile_add_shape** **(** :ref:`int` id, :ref:`Shape2D` shape, :ref:`Transform2D` shape_transform, :ref:`bool` one_way=false **)** +- void **tile_add_shape** **(** :ref:`int` id, :ref:`Shape2D` shape, :ref:`Transform2D` shape_transform, :ref:`bool` one_way=null **)** .. _class_TileSet_tile_get_light_occluder: diff --git a/classes/class_touchscreenbutton.rst b/classes/class_touchscreenbutton.rst index a2a9b5bbf..e3a106dda 100644 --- a/classes/class_touchscreenbutton.rst +++ b/classes/class_touchscreenbutton.rst @@ -18,45 +18,45 @@ Brief Description Member Functions ---------------- -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_action` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_bitmask` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_shape` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_texture` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_texture_pressed` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_visibility_mode` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_passby_press_enabled` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pressed` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_shape_centered` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_shape_visible` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_action` **(** :ref:`String` action **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bitmask` **(** :ref:`Object` bitmask **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_passby_press` **(** :ref:`bool` enabled **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape` **(** :ref:`Object` shape **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape_centered` **(** :ref:`bool` bool **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape_visible` **(** :ref:`bool` bool **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Object` texture **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture_pressed` **(** :ref:`Object` texture_pressed **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_visibility_mode` **(** :ref:`int` mode **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_action` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`BitMap` | :ref:`get_bitmask` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shape2D` | :ref:`get_shape` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_texture` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_texture_pressed` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_visibility_mode` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_passby_press_enabled` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_pressed` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_shape_centered` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_shape_visible` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_action` **(** :ref:`String` action **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bitmask` **(** :ref:`BitMap` bitmask **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_passby_press` **(** :ref:`bool` enabled **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape` **(** :ref:`Shape2D` shape **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape_centered` **(** :ref:`bool` bool **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape_visible` **(** :ref:`bool` bool **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture_pressed` **(** :ref:`Texture` texture_pressed **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_visibility_mode` **(** :ref:`int` mode **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -86,19 +86,19 @@ Member Function Description .. _class_TouchScreenButton_get_bitmask: -- :ref:`Object` **get_bitmask** **(** **)** const +- :ref:`BitMap` **get_bitmask** **(** **)** const .. _class_TouchScreenButton_get_shape: -- :ref:`Object` **get_shape** **(** **)** const +- :ref:`Shape2D` **get_shape** **(** **)** const .. _class_TouchScreenButton_get_texture: -- :ref:`Object` **get_texture** **(** **)** const +- :ref:`Texture` **get_texture** **(** **)** const .. _class_TouchScreenButton_get_texture_pressed: -- :ref:`Object` **get_texture_pressed** **(** **)** const +- :ref:`Texture` **get_texture_pressed** **(** **)** const .. _class_TouchScreenButton_get_visibility_mode: @@ -126,7 +126,7 @@ Member Function Description .. _class_TouchScreenButton_set_bitmask: -- void **set_bitmask** **(** :ref:`Object` bitmask **)** +- void **set_bitmask** **(** :ref:`BitMap` bitmask **)** .. _class_TouchScreenButton_set_passby_press: @@ -134,7 +134,7 @@ Member Function Description .. _class_TouchScreenButton_set_shape: -- void **set_shape** **(** :ref:`Object` shape **)** +- void **set_shape** **(** :ref:`Shape2D` shape **)** .. _class_TouchScreenButton_set_shape_centered: @@ -146,11 +146,11 @@ Member Function Description .. _class_TouchScreenButton_set_texture: -- void **set_texture** **(** :ref:`Object` texture **)** +- void **set_texture** **(** :ref:`Texture` texture **)** .. _class_TouchScreenButton_set_texture_pressed: -- void **set_texture_pressed** **(** :ref:`Object` texture_pressed **)** +- void **set_texture_pressed** **(** :ref:`Texture` texture_pressed **)** .. _class_TouchScreenButton_set_visibility_mode: diff --git a/classes/class_transform.rst b/classes/class_transform.rst index bccc77d43..394678c6f 100644 --- a/classes/class_transform.rst +++ b/classes/class_transform.rst @@ -29,6 +29,8 @@ Member Functions +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform` | :ref:`affine_inverse` **(** **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`interpolate_with` **(** :ref:`Transform` transform, :ref:`float` weight **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform` | :ref:`inverse` **(** **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform` | :ref:`looking_at` **(** :ref:`Vector3` target, :ref:`Vector3` up **)** | @@ -96,6 +98,10 @@ Construct the Transform from a Basis. The origin will be Vector3(0, 0, 0). Returns the inverse of the transfrom, under the assumption that the transformation is composed of rotation, scaling and translation. +.. _class_Transform_interpolate_with: + +- :ref:`Transform` **interpolate_with** **(** :ref:`Transform` transform, :ref:`float` weight **)** + .. _class_Transform_inverse: - :ref:`Transform` **inverse** **(** **)** diff --git a/classes/class_transform2d.rst b/classes/class_transform2d.rst index 6a5b5aecc..1a44c7d74 100644 --- a/classes/class_transform2d.rst +++ b/classes/class_transform2d.rst @@ -35,7 +35,7 @@ Member Functions +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_scale` **(** **)** | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`interpolate_with` **(** :ref:`Transform2D` m, :ref:`float` c **)** | +| :ref:`Transform2D` | :ref:`interpolate_with` **(** :ref:`Transform2D` transform, :ref:`float` weight **)** | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`inverse` **(** **)** | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -109,7 +109,7 @@ Return the rotation (in radians). .. _class_Transform2D_interpolate_with: -- :ref:`Transform2D` **interpolate_with** **(** :ref:`Transform2D` m, :ref:`float` c **)** +- :ref:`Transform2D` **interpolate_with** **(** :ref:`Transform2D` transform, :ref:`float` weight **)** .. _class_Transform2D_inverse: diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 518f79e18..4d9fc8978 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -18,75 +18,75 @@ Control to show a tree of items. Member Functions ---------------- -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`are_column_titles_visible` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`create_item` **(** :ref:`TreeItem` parent=NULL **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`ensure_cursor_is_visible` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_allow_rmb_select` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_column_at_pos` **(** :ref:`Vector2` pos **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_column_title` **(** :ref:`int` column **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_column_width` **(** :ref:`int` column **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_columns` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_custom_popup_rect` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_drop_mode_flags` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_edited` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_edited_column` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_item_area_rect` **(** :ref:`TreeItem` item, :ref:`int` column=-1 **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_item_at_pos` **(** :ref:`Vector2` pos **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_next_selected` **(** :ref:`TreeItem` from **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_pressed_button` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_root` **(** **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scroll` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_selected` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selected_column` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_single_select_cell_editing_only_when_already_selected` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_folding_hidden` **(** **)** const | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_allow_rmb_select` **(** :ref:`bool` allow **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_column_expand` **(** :ref:`int` column, :ref:`bool` expand **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_column_min_width` **(** :ref:`int` column, :ref:`int` min_width **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_column_title` **(** :ref:`int` column, :ref:`String` title **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_column_titles_visible` **(** :ref:`bool` visible **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_columns` **(** :ref:`int` amount **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_drop_mode_flags` **(** :ref:`int` flags **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hide_folding` **(** :ref:`bool` hide **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hide_root` **(** :ref:`bool` enable **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_select_mode` **(** :ref:`int` mode **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_single_select_cell_editing_only_when_already_selected` **(** :ref:`bool` enable **)** | -+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`are_column_titles_visible` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`create_item` **(** :ref:`Object` parent=null **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`ensure_cursor_is_visible` **(** **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_allow_reselect` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_allow_rmb_select` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_column_at_pos` **(** :ref:`Vector2` pos **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_column_title` **(** :ref:`int` column **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_column_width` **(** :ref:`int` column **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_columns` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_custom_popup_rect` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_drop_mode_flags` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_edited` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_edited_column` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_item_area_rect` **(** :ref:`Object` item, :ref:`int` column=null **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_item_at_pos` **(** :ref:`Vector2` pos **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_next_selected` **(** :ref:`Object` from **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_pressed_button` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_root` **(** **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_scroll` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_selected` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selected_column` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_folding_hidden` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_allow_reselect` **(** :ref:`bool` allow **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_allow_rmb_select` **(** :ref:`bool` allow **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_column_expand` **(** :ref:`int` column, :ref:`bool` expand **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_column_min_width` **(** :ref:`int` column, :ref:`int` min_width **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_column_title` **(** :ref:`int` column, :ref:`String` title **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_column_titles_visible` **(** :ref:`bool` visible **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_columns` **(** :ref:`int` amount **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_drop_mode_flags` **(** :ref:`int` flags **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hide_folding` **(** :ref:`bool` hide **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hide_root` **(** :ref:`bool` enable **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_select_mode` **(** :ref:`int` mode **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -115,6 +115,7 @@ Emitted when an item is collapsed by a click on the folding arrow. - **item_edited** **(** **)** Emitted when an item is editted. +- **item_rmb_edited** **(** **)** - **item_rmb_selected** **(** :ref:`Vector2` pos **)** Emitted when an item is selected with right mouse button. @@ -168,7 +169,7 @@ Clear the tree. This erases all of the items. .. _class_Tree_create_item: -- :ref:`TreeItem` **create_item** **(** :ref:`TreeItem` parent=NULL **)** +- :ref:`Object` **create_item** **(** :ref:`Object` parent=null **)** 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 last child of the root, or it'll the be the root itself if the tree is empty. @@ -178,6 +179,10 @@ Create an item in the tree and add it as the last child of ``parent``. If parent Make the current selected item visible. This will scroll the tree to make sure the selected item is in sight. +.. _class_Tree_get_allow_reselect: + +- :ref:`bool` **get_allow_reselect** **(** **)** const + .. _class_Tree_get_allow_rmb_select: - :ref:`bool` **get_allow_rmb_select** **(** **)** const @@ -234,7 +239,7 @@ Get the column of the cell for the current edited icon. This is only available f .. _class_Tree_get_item_area_rect: -- :ref:`Rect2` **get_item_area_rect** **(** :ref:`TreeItem` item, :ref:`int` column=-1 **)** const +- :ref:`Rect2` **get_item_area_rect** **(** :ref:`Object` item, :ref:`int` column=null **)** const Get the rectangle area of the the specified item. If column is specified, only get the position and size of that column, otherwise get the rectangle containing all columns. @@ -246,7 +251,7 @@ Get the tree item at the specified position (relative to the tree origin positio .. _class_Tree_get_next_selected: -- :ref:`TreeItem` **get_next_selected** **(** :ref:`TreeItem` from **)** +- :ref:`TreeItem` **get_next_selected** **(** :ref:`Object` from **)** Get the next selected item after the given one. @@ -280,18 +285,16 @@ Get the currently selected item. Get the column number of the current selection. -.. _class_Tree_get_single_select_cell_editing_only_when_already_selected: - -- :ref:`bool` **get_single_select_cell_editing_only_when_already_selected** **(** **)** const - -Get whether the editing of a cell should only happen when it is already selected. - .. _class_Tree_is_folding_hidden: - :ref:`bool` **is_folding_hidden** **(** **)** const Get whether the folding arrow is hidden. +.. _class_Tree_set_allow_reselect: + +- void **set_allow_reselect** **(** :ref:`bool` allow **)** + .. _class_Tree_set_allow_rmb_select: - void **set_allow_rmb_select** **(** :ref:`bool` allow **)** @@ -352,10 +355,4 @@ Set whether the root of the tree should be hidden. Set the selection mode. Use one of the ``SELECT\_\*`` constants. -.. _class_Tree_set_single_select_cell_editing_only_when_already_selected: - -- void **set_single_select_cell_editing_only_when_already_selected** **(** :ref:`bool` enable **)** - -Set whether the editing of a cell should only happen when it is already selected. - diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index 7ab02c6d3..134b9194d 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -18,123 +18,123 @@ Brief Description Member Functions ---------------- -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_button` **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false, :ref:`String` tooltip="" **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_custom_bg_color` **(** :ref:`int` column **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_custom_color` **(** :ref:`int` column **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`deselect` **(** :ref:`int` column **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_button` **(** :ref:`int` column, :ref:`int` button_idx **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_button` **(** :ref:`int` column, :ref:`int` button_idx **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_button_count` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cell_mode` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_children` **(** **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_custom_bg_color` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_expand_right` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_icon` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_icon_max_width` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_icon_region` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_metadata` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_next` **(** **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_next_visible` **(** **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_parent` **(** **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_prev` **(** **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_prev_visible` **(** **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_range` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_range_config` **(** :ref:`int` column **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_text` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_text_align` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tooltip` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_button_disabled` **(** :ref:`int` column, :ref:`int` button_idx **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_checked` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_collapsed` **(** **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_custom_set_as_button` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_editable` **(** :ref:`int` column **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_folding_disabled` **(** **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selectable` **(** :ref:`int` column **)** const | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selected` **(** :ref:`int` column **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_to_bottom` **(** **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_to_top` **(** **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`remove_child` **(** :ref:`Object` child **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select` **(** :ref:`int` column **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_button` **(** :ref:`int` column, :ref:`int` button_idx, :ref:`Texture` button **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_mode` **(** :ref:`int` column, :ref:`int` mode **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_checked` **(** :ref:`int` column, :ref:`bool` checked **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collapsed` **(** :ref:`bool` enable **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_as_button` **(** :ref:`int` column, :ref:`bool` enable **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_bg_color` **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=false **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_color` **(** :ref:`int` column, :ref:`Color` color **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_draw` **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disable_folding` **(** :ref:`bool` disable **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_editable` **(** :ref:`int` column, :ref:`bool` enabled **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_right` **(** :ref:`int` column, :ref:`bool` enable **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon` **(** :ref:`int` column, :ref:`Texture` texture **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon_max_width` **(** :ref:`int` column, :ref:`int` width **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon_region` **(** :ref:`int` column, :ref:`Rect2` region **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_metadata` **(** :ref:`int` column, :ref:`Variant` meta **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_range` **(** :ref:`int` column, :ref:`float` value **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_range_config` **(** :ref:`int` column, :ref:`float` min, :ref:`float` max, :ref:`float` step, :ref:`bool` expr=false **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_selectable` **(** :ref:`int` column, :ref:`bool` selectable **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text` **(** :ref:`int` column, :ref:`String` text **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text_align` **(** :ref:`int` column, :ref:`int` text_align **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tooltip` **(** :ref:`int` column, :ref:`String` tooltip **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_button` **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=null, :ref:`String` tooltip=null **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_custom_bg_color` **(** :ref:`int` column **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_custom_color` **(** :ref:`int` column **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`deselect` **(** :ref:`int` column **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_button` **(** :ref:`int` column, :ref:`int` button_idx **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_button` **(** :ref:`int` column, :ref:`int` button_idx **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_button_count` **(** :ref:`int` column **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cell_mode` **(** :ref:`int` column **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_children` **(** **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_custom_bg_color` **(** :ref:`int` column **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_expand_right` **(** :ref:`int` column **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_icon` **(** :ref:`int` column **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_icon_max_width` **(** :ref:`int` column **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_icon_region` **(** :ref:`int` column **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_metadata` **(** :ref:`int` column **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_next` **(** **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_next_visible` **(** **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_parent` **(** **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_prev` **(** **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_prev_visible` **(** **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_range` **(** :ref:`int` column **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_range_config` **(** :ref:`int` column **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_text` **(** :ref:`int` column **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_text_align` **(** :ref:`int` column **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_tooltip` **(** :ref:`int` column **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_button_disabled` **(** :ref:`int` column, :ref:`int` button_idx **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_checked` **(** :ref:`int` column **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_collapsed` **(** **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_custom_set_as_button` **(** :ref:`int` column **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_editable` **(** :ref:`int` column **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_folding_disabled` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_selectable` **(** :ref:`int` column **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_selected` **(** :ref:`int` column **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_to_bottom` **(** **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_to_top` **(** **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_child` **(** :ref:`Object` child **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select` **(** :ref:`int` column **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_button` **(** :ref:`int` column, :ref:`int` button_idx, :ref:`Texture` button **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell_mode` **(** :ref:`int` column, :ref:`int` mode **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_checked` **(** :ref:`int` column, :ref:`bool` checked **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collapsed` **(** :ref:`bool` enable **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_as_button` **(** :ref:`int` column, :ref:`bool` enable **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_bg_color` **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=null **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_color` **(** :ref:`int` column, :ref:`Color` color **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_draw` **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_folding` **(** :ref:`bool` disable **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_editable` **(** :ref:`int` column, :ref:`bool` enabled **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_right` **(** :ref:`int` column, :ref:`bool` enable **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon` **(** :ref:`int` column, :ref:`Texture` texture **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon_max_width` **(** :ref:`int` column, :ref:`int` width **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon_region` **(** :ref:`int` column, :ref:`Rect2` region **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_metadata` **(** :ref:`int` column, :ref:`Variant` meta **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_range` **(** :ref:`int` column, :ref:`float` value **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_range_config` **(** :ref:`int` column, :ref:`float` min, :ref:`float` max, :ref:`float` step, :ref:`bool` expr=null **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_selectable` **(** :ref:`int` column, :ref:`bool` selectable **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_text` **(** :ref:`int` column, :ref:`String` text **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_text_align` **(** :ref:`int` column, :ref:`int` text_align **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tooltip` **(** :ref:`int` column, :ref:`String` tooltip **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -151,7 +151,7 @@ Member Function Description .. _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="" **)** +- void **add_button** **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=null, :ref:`String` tooltip=null **)** .. _class_TreeItem_clear_custom_bg_color: @@ -207,7 +207,7 @@ Member Function Description .. _class_TreeItem_get_metadata: -- void **get_metadata** **(** :ref:`int` column **)** const +- :ref:`Variant` **get_metadata** **(** :ref:`int` column **)** const .. _class_TreeItem_get_next: @@ -291,7 +291,7 @@ Member Function Description .. _class_TreeItem_remove_child: -- :ref:`TreeItem` **remove_child** **(** :ref:`Object` child **)** +- void **remove_child** **(** :ref:`Object` child **)** .. _class_TreeItem_select: @@ -319,7 +319,7 @@ Member Function Description .. _class_TreeItem_set_custom_bg_color: -- void **set_custom_bg_color** **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=false **)** +- void **set_custom_bg_color** **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=null **)** .. _class_TreeItem_set_custom_color: @@ -363,7 +363,7 @@ Member Function Description .. _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 **)** +- void **set_range_config** **(** :ref:`int` column, :ref:`float` min, :ref:`float` max, :ref:`float` step, :ref:`bool` expr=null **)** .. _class_TreeItem_set_selectable: diff --git a/classes/class_tween.rst b/classes/class_tween.rst index cb0726c30..e9ffab5fc 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -19,9 +19,9 @@ Member Functions ---------------- +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`follow_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_method, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | +| :ref:`bool` | :ref:`follow_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_method, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=null **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`follow_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_property, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | +| :ref:`bool` | :ref:`follow_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_property, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=null **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_runtime` **(** **)** const | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -29,27 +29,27 @@ Member Functions +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_tween_process_mode` **(** **)** const | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_callback` **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=NULL, :ref:`Variant` arg2=NULL, :ref:`Variant` arg3=NULL, :ref:`Variant` arg4=NULL, :ref:`Variant` arg5=NULL **)** | +| :ref:`bool` | :ref:`interpolate_callback` **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_deferred_callback` **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=NULL, :ref:`Variant` arg2=NULL, :ref:`Variant` arg3=NULL, :ref:`Variant` arg4=NULL, :ref:`Variant` arg5=NULL **)** | +| :ref:`bool` | :ref:`interpolate_deferred_callback` **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | +| :ref:`bool` | :ref:`interpolate_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=null **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | +| :ref:`bool` | :ref:`interpolate_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=null **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_active` **(** **)** const | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_repeat` **(** **)** const | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`remove` **(** :ref:`Object` object, :ref:`String` key="" **)** | +| :ref:`bool` | :ref:`remove` **(** :ref:`Object` object, :ref:`String` key=null **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`remove_all` **(** **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`reset` **(** :ref:`Object` object, :ref:`String` key="" **)** | +| :ref:`bool` | :ref:`reset` **(** :ref:`Object` object, :ref:`String` key=null **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`reset_all` **(** **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`resume` **(** :ref:`Object` object, :ref:`String` key="" **)** | +| :ref:`bool` | :ref:`resume` **(** :ref:`Object` object, :ref:`String` key=null **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`resume_all` **(** **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -65,13 +65,13 @@ Member Functions +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`start` **(** **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`stop` **(** :ref:`Object` object, :ref:`String` key="" **)** | +| :ref:`bool` | :ref:`stop` **(** :ref:`Object` object, :ref:`String` key=null **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`stop_all` **(** **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`targeting_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Object` initial, :ref:`String` initial_method, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | +| :ref:`bool` | :ref:`targeting_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Object` initial, :ref:`String` initial_method, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=null **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`targeting_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Object` initial, :ref:`String` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** | +| :ref:`bool` | :ref:`targeting_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Object` initial, :ref:`String` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=null **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`tell` **(** **)** const | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -104,7 +104,7 @@ Numeric Constants - **TRANS_QUINT** = **2** --- Means that the animation is interpolated with a quinary (to the power of 5) function. - **TRANS_QUART** = **3** --- Means that the animation is interpolated with a quartic (to the power of 4) function. - **TRANS_QUAD** = **4** --- Means that the animation is interpolated with a quadratic (to the power of 2) function. -- **TRANS_EXPO** = **5** --- Means that the animation is interpolated with a exponential (some number to the power of x) function. +- **TRANS_EXPO** = **5** --- Means that the animation is interpolated with an exponential (some number to the power of x) function. - **TRANS_ELASTIC** = **6** --- Means that the animation is interpolated with elasticity, wiggling around the edges. - **TRANS_CUBIC** = **7** --- Means that the animation is interpolated with a cubic (to the power of 3) function. - **TRANS_CIRC** = **8** --- Means that the animation is interpolated with a function using square roots. @@ -137,7 +137,7 @@ Member Function Description .. _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:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** +- :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:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=null **)** Follow ``method`` of ``object`` and apply the returned value on ``target_method`` of ``target``, beginning from ``initial_val`` for ``duration`` seconds, ``delay`` later. Methods are animated by calling them with consequitive values. @@ -145,7 +145,7 @@ Follow ``method`` of ``object`` and apply the returned value on ``target_method` .. _class_Tween_follow_property: -- :ref:`bool` **follow_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_property, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** +- :ref:`bool` **follow_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_property, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=null **)** Follow ``property`` of ``object`` and apply it on ``target_property`` of ``target``, beginning from ``initial_val`` for ``duration`` seconds, ``delay`` seconds later. Note that ``target:target_property`` would equal ``object:property`` at the end of the tween. @@ -171,19 +171,19 @@ Returns the process mode that has been set from editor GUI or :ref:`set_tween_pr .. _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 **)** +- :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 **)** Call ``callback`` of ``object`` after ``duration``. ``arg1``-``arg5`` are arguments to be passed to the 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 **)** +- :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 **)** Call ``callback`` of ``object`` after ``duration`` on the main thread (similar to methog Object.call_deferred). [codearg1``-``arg5`` are arguments to be passed to the callback. .. _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:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** +- :ref:`bool` **interpolate_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=null **)** Animate ``method`` of ``object`` from ``initial_val`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. Methods are animated by calling them with consecuitive values. @@ -191,7 +191,7 @@ Animate ``method`` of ``object`` from ``initial_val`` to ``final_val`` for ``dur .. _class_Tween_interpolate_property: -- :ref:`bool` **interpolate_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** +- :ref:`bool` **interpolate_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=null **)** Animate ``property`` of ``object`` from ``initial_val`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. @@ -211,7 +211,7 @@ Returns true if repeat has been set from editor GUI or :ref:`set_repeat` **remove** **(** :ref:`Object` object, :ref:`String` key="" **)** +- :ref:`bool` **remove** **(** :ref:`Object` object, :ref:`String` key=null **)** Stop animating and completely remove a tween, given its object and property/method pair. Passing empty String as key will remove all tweens for given object. @@ -223,7 +223,7 @@ Stop animating and completely remove all tweens. .. _class_Tween_reset: -- :ref:`bool` **reset** **(** :ref:`Object` object, :ref:`String` key="" **)** +- :ref:`bool` **reset** **(** :ref:`Object` object, :ref:`String` key=null **)** Resets a tween to the initial value (the one given, not the one before the tween), given its object and property/method pair. Passing empty String as key will reset all tweens for given object. @@ -235,7 +235,7 @@ Resets all tweens to their initial values (the ones given, not those before the .. _class_Tween_resume: -- :ref:`bool` **resume** **(** :ref:`Object` object, :ref:`String` key="" **)** +- :ref:`bool` **resume** **(** :ref:`Object` object, :ref:`String` key=null **)** Continue animating a stopped tween, given its object and property/method pair. Passing empty String as key will resume all tweens for given object. @@ -283,7 +283,7 @@ Start the tween node. You can define tweens both before and after this. .. _class_Tween_stop: -- :ref:`bool` **stop** **(** :ref:`Object` object, :ref:`String` key="" **)** +- :ref:`bool` **stop** **(** :ref:`Object` object, :ref:`String` key=null **)** Stop animating a tween, given its object and property/method pair. Passing empty String as key will stop all tweens for given object. @@ -295,7 +295,7 @@ Stop animating all tweens. .. _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:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** +- :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:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=null **)** Animate ``method`` of ``object`` from the value returned by ``initial.initial_method`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. Methods are animated by calling them with consecuitive values. @@ -303,7 +303,7 @@ Animate ``method`` of ``object`` from the value returned by ``initial.initial_me .. _class_Tween_targeting_property: -- :ref:`bool` **targeting_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Object` initial, :ref:`String` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=0 **)** +- :ref:`bool` **targeting_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Object` initial, :ref:`String` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`int` trans_type, :ref:`int` ease_type, :ref:`float` delay=null **)** Animate ``property`` of ``object`` from the current value of the ``initial_val`` property of ``initial`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. diff --git a/classes/class_undoredo.rst b/classes/class_undoredo.rst index 708ff1e5f..ecd9d76ff 100644 --- a/classes/class_undoredo.rst +++ b/classes/class_undoredo.rst @@ -18,29 +18,29 @@ Helper to manage UndoRedo in the editor or custom tools. Member Functions ---------------- -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_do_method` **(** :ref:`Object` object, :ref:`String` method **)** vararg | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_do_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_do_reference` **(** :ref:`Object` object **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_undo_method` **(** :ref:`Object` object, :ref:`String` method **)** vararg | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_undo_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_undo_reference` **(** :ref:`Object` object **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_history` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`commit_action` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_action` **(** :ref:`String` name, :ref:`int` merge_mode=0 **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_action_name` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_version` **(** **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`add_do_method` **(** :ref:`Object` object, :ref:`String` method **)** vararg | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_do_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_do_reference` **(** :ref:`Object` object **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`add_undo_method` **(** :ref:`Object` object, :ref:`String` method **)** vararg | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_undo_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_undo_reference` **(** :ref:`Object` object **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_history` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`commit_action` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_action` **(** :ref:`String` name, :ref:`int` merge_mode=null **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_action_name` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_version` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -61,7 +61,7 @@ Member Function Description .. _class_UndoRedo_add_do_method: -- void **add_do_method** **(** :ref:`Object` object, :ref:`String` method **)** vararg +- :ref:`Variant` **add_do_method** **(** :ref:`Object` object, :ref:`String` method **)** vararg .. _class_UndoRedo_add_do_property: @@ -77,7 +77,7 @@ Add a 'do' reference that will be erased if the 'do' history is lost. This is us .. _class_UndoRedo_add_undo_method: -- void **add_undo_method** **(** :ref:`Object` object, :ref:`String` method **)** vararg +- :ref:`Variant` **add_undo_method** **(** :ref:`Object` object, :ref:`String` method **)** vararg .. _class_UndoRedo_add_undo_property: @@ -105,7 +105,7 @@ Commit the action. All 'do' methods/properties are called/set when this function .. _class_UndoRedo_create_action: -- void **create_action** **(** :ref:`String` name, :ref:`int` merge_mode=0 **)** +- void **create_action** **(** :ref:`String` name, :ref:`int` merge_mode=null **)** 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`. diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index e0f844eb8..d80f12efd 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -88,6 +88,8 @@ Constructs a new Vector2 from the given x and y. - :ref:`Vector2` **abs** **(** **)** +Returns a new vector with all components in absolute values (i.e. positive). + .. _class_Vector2_angle: - :ref:`float` **angle** **(** **)** @@ -124,6 +126,8 @@ Bounce returns the vector "bounced off" from the given plane, specified by its n - :ref:`Vector2` **clamped** **(** :ref:`float` length **)** +Returns the vector with a maximum length. + .. _class_Vector2_cubic_interpolate: - :ref:`Vector2` **cubic_interpolate** **(** :ref:`Vector2` b, :ref:`Vector2` pre_a, :ref:`Vector2` post_b, :ref:`float` t **)** diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index f4bdfc171..cb9788a48 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -100,7 +100,7 @@ Returns a Vector3 with the given components. - :ref:`Vector3` **abs** **(** **)** -Returns a new vector with all components in absolute values (e.g. positive). +Returns a new vector with all components in absolute values (i.e. positive). .. _class_Vector3_angle_to: diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index aa097e5ae..f119f4b61 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -18,135 +18,137 @@ Creates a sub-view into the screen. Member Functions ---------------- -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World` | :ref:`find_world` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World2D` | :ref:`find_world_2d` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Camera` | :ref:`get_camera` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_canvas_transform` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_clear_on_new_frame` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_debug_draw` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_final_transform` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_global_canvas_transform` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_hdr` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_mouse_position` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_msaa` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_physics_object_picking` **(** **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_render_info` **(** :ref:`int` info **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shadow_atlas_quadrant_subdiv` **(** :ref:`int` quadrant **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shadow_atlas_size` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size_override` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ViewportTexture` | :ref:`get_texture` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_update_mode` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_usage` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_vflip` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_viewport_rid` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_visible_rect` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World` | :ref:`get_world` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`gui_get_drag_data` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gui_has_modal_stack` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_transparent_background` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`input` **(** :ref:`Object` local_event **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_3d_disabled` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_audio_listener` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_audio_listener_2d` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_input_disabled` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_size_override_enabled` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_size_override_stretch_enabled` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_own_world` **(** **)** const | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_audio_listener` **(** :ref:`bool` enable **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_audio_listener_2d` **(** :ref:`bool` enable **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_attach_to_screen_rect` **(** :ref:`Rect2` rect **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_canvas_transform` **(** :ref:`Transform2D` xform **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_clear_on_new_frame` **(** :ref:`bool` enable **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_debug_draw` **(** :ref:`int` debug_draw **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disable_3d` **(** :ref:`bool` disable **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disable_input` **(** :ref:`bool` disable **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_canvas_transform` **(** :ref:`Transform2D` xform **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hdr` **(** :ref:`bool` enable **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_msaa` **(** :ref:`int` msaa **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_physics_object_picking` **(** :ref:`bool` enable **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_atlas_quadrant_subdiv` **(** :ref:`int` quadrant, :ref:`int` subdiv **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_atlas_size` **(** :ref:`int` size **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size_override` **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2(-1, -1), :ref:`Vector2` margin=Vector2(0, 0) **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size_override_stretch` **(** :ref:`bool` enabled **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transparent_background` **(** :ref:`bool` enable **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_update_mode` **(** :ref:`int` mode **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_usage` **(** :ref:`int` usage **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_own_world` **(** :ref:`bool` enable **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vflip` **(** :ref:`bool` enable **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_world` **(** :ref:`World` world **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_world_2d` **(** :ref:`World2D` world_2d **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unhandled_input` **(** :ref:`Object` local_event **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_worlds` **(** **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`warp_mouse` **(** :ref:`Vector2` to_pos **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World` | :ref:`find_world` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World2D` | :ref:`find_world_2d` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Camera` | :ref:`get_camera` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_canvas_transform` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_clear_mode` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_debug_draw` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_final_transform` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_global_canvas_transform` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_hdr` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_mouse_position` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_msaa` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_physics_object_picking` **(** **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_render_info` **(** :ref:`int` info **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_shadow_atlas_quadrant_subdiv` **(** :ref:`int` quadrant **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_shadow_atlas_size` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size_override` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ViewportTexture` | :ref:`get_texture` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_update_mode` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_usage` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_vflip` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_viewport_rid` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_visible_rect` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World` | :ref:`get_world` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`gui_get_drag_data` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`gui_has_modal_stack` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_transparent_background` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`input` **(** :ref:`InputEvent` local_event **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_3d_disabled` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_audio_listener` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_audio_listener_2d` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_input_disabled` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_size_override_enabled` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_size_override_stretch_enabled` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_using_own_world` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_as_audio_listener` **(** :ref:`bool` enable **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_as_audio_listener_2d` **(** :ref:`bool` enable **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_attach_to_screen_rect` **(** :ref:`Rect2` rect **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_canvas_transform` **(** :ref:`Transform2D` xform **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_clear_mode` **(** :ref:`int` mode **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_debug_draw` **(** :ref:`int` debug_draw **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_3d` **(** :ref:`bool` disable **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_input` **(** :ref:`bool` disable **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_canvas_transform` **(** :ref:`Transform2D` xform **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hdr` **(** :ref:`bool` enable **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_msaa` **(** :ref:`int` msaa **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_physics_object_picking` **(** :ref:`bool` enable **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_atlas_quadrant_subdiv` **(** :ref:`int` quadrant, :ref:`int` subdiv **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_atlas_size` **(** :ref:`int` size **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size_override` **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2( -1, -1 ), :ref:`Vector2` margin=null **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size_override_stretch` **(** :ref:`bool` enabled **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transparent_background` **(** :ref:`bool` enable **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_update_mode` **(** :ref:`int` mode **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_usage` **(** :ref:`int` usage **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_arvr` **(** :ref:`bool` use **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_own_world` **(** :ref:`bool` enable **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vflip` **(** :ref:`bool` enable **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_world` **(** :ref:`World` world **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_world_2d` **(** :ref:`World2D` world_2d **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unhandled_input` **(** :ref:`InputEvent` local_event **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_worlds` **(** **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`use_arvr` **(** **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`warp_mouse` **(** :ref:`Vector2` to_pos **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -158,6 +160,7 @@ Emitted when the size of the viewport is changed, whether by :ref:`set_size_over Member Variables ---------------- +- :ref:`bool` **arvr** - :ref:`bool` **audio_listener_enable_2d** - :ref:`bool` **audio_listener_enable_3d** - :ref:`int` **debug_draw** @@ -167,7 +170,7 @@ Member Variables - :ref:`int` **msaa** - :ref:`bool` **own_world** - :ref:`bool` **physics_object_picking** -- :ref:`bool` **render_target_clear_on_new_frame** +- :ref:`int` **render_target_clear_mode** - :ref:`int` **render_target_update_mode** - :ref:`bool` **render_target_v_flip** - :ref:`int` **shadow_atlas_quad_0** @@ -175,7 +178,7 @@ Member Variables - :ref:`int` **shadow_atlas_quad_2** - :ref:`int` **shadow_atlas_quad_3** - :ref:`int` **shadow_atlas_size** -- :ref:`Rect2` **size** +- :ref:`Vector2` **size** - :ref:`bool` **transparent_bg** - :ref:`int` **usage** - :ref:`World` **world** @@ -230,12 +233,6 @@ Finally, viewports can also behave as render targets, in which case they will no Member Function Description --------------------------- -.. _class_Viewport_clear: - -- void **clear** **(** **)** - -Clear the viewport manually. - .. _class_Viewport_find_world: - :ref:`World` **find_world** **(** **)** const @@ -260,11 +257,9 @@ Return the active 3D camera. Get the canvas transform of the viewport. -.. _class_Viewport_get_clear_on_new_frame: +.. _class_Viewport_get_clear_mode: -- :ref:`bool` **get_clear_on_new_frame** **(** **)** const - -Return whether automatic clearing of the render target on each frame is enabled. +- :ref:`int` **get_clear_mode** **(** **)** const .. _class_Viewport_get_debug_draw: @@ -394,7 +389,7 @@ Return whether the viewport lets whatever is behind it to show. .. _class_Viewport_input: -- void **input** **(** :ref:`Object` local_event **)** +- void **input** **(** :ref:`InputEvent` local_event **)** .. _class_Viewport_is_3d_disabled: @@ -458,9 +453,9 @@ Makes the viewport send sounds from 2D emitters to the speakers. Set the canvas transform of the viewport, useful for changing the on-screen positions of all child :ref:`CanvasItem`\ s. This is relative to the global canvas transform of the viewport. -.. _class_Viewport_set_clear_on_new_frame: +.. _class_Viewport_set_clear_mode: -- void **set_clear_on_new_frame** **(** :ref:`bool` enable **)** +- void **set_clear_mode** **(** :ref:`int` mode **)** .. _class_Viewport_set_debug_draw: @@ -512,7 +507,7 @@ Set the size of the viewport. .. _class_Viewport_set_size_override: -- void **set_size_override** **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2(-1, -1), :ref:`Vector2` margin=Vector2(0, 0) **)** +- void **set_size_override** **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2( -1, -1 ), :ref:`Vector2` margin=null **)** Set the size override of the viewport. If the enable parameter is true, it would use the override, otherwise it would use the default size. If the size parameter is equal to ``(-1, -1)``, it won't update the size. @@ -538,6 +533,10 @@ Set when the render target would be updated, using the ``UPDATE\_\*`` constants - void **set_usage** **(** :ref:`int` usage **)** +.. _class_Viewport_set_use_arvr: + +- void **set_use_arvr** **(** :ref:`bool` use **)** + .. _class_Viewport_set_use_own_world: - void **set_use_own_world** **(** :ref:`bool` enable **)** @@ -562,7 +561,7 @@ Change the 3D world of the viewport. .. _class_Viewport_unhandled_input: -- void **unhandled_input** **(** :ref:`Object` local_event **)** +- void **unhandled_input** **(** :ref:`InputEvent` local_event **)** .. _class_Viewport_update_worlds: @@ -570,6 +569,10 @@ Change the 3D world of the viewport. Force update of the 2D and 3D worlds. +.. _class_Viewport_use_arvr: + +- :ref:`bool` **use_arvr** **(** **)** + .. _class_Viewport_warp_mouse: - void **warp_mouse** **(** :ref:`Vector2` to_pos **)** diff --git a/classes/class_visualinstance.rst b/classes/class_visualinstance.rst index fcf1f5e96..3a2bb2c05 100644 --- a/classes/class_visualinstance.rst +++ b/classes/class_visualinstance.rst @@ -8,7 +8,7 @@ VisualInstance **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`Light`, :ref:`ReflectionProbe`, :ref:`Room`, :ref:`GIProbe`, :ref:`Portal`, :ref:`GeometryInstance` +**Inherited By:** :ref:`Light`, :ref:`ReflectionProbe`, :ref:`GIProbe`, :ref:`GeometryInstance` **Category:** Core diff --git a/classes/class_visualscript.rst b/classes/class_visualscript.rst index cc87b0f23..4b88b62ff 100644 --- a/classes/class_visualscript.rst +++ b/classes/class_visualscript.rst @@ -18,91 +18,91 @@ Brief Description Member Functions ---------------- -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_custom_signal` **(** :ref:`String` name **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_function` **(** :ref:`String` name **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_node` **(** :ref:`String` func, :ref:`int` id, :ref:`Object` node, :ref:`Vector2` pos=Vector2(0, 0) **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_variable` **(** :ref:`String` name, :ref:`Variant` default_value=NULL, :ref:`bool` export=false **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`custom_signal_add_argument` **(** :ref:`String` name, :ref:`int` type, :ref:`String` argname, :ref:`int` index=-1 **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`custom_signal_get_argument_count` **(** :ref:`String` name **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`custom_signal_get_argument_name` **(** :ref:`String` name, :ref:`int` argidx **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`custom_signal_get_argument_type` **(** :ref:`String` name, :ref:`int` argidx **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`custom_signal_remove_argument` **(** :ref:`String` argidx, :ref:`int` arg1 **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`custom_signal_set_argument_name` **(** :ref:`String` name, :ref:`int` argidx, :ref:`String` argname **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`custom_signal_set_argument_type` **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` type **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`custom_signal_swap_argument` **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` withidx **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`data_connect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`data_disconnect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_function_node_id` **(** :ref:`String` name **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_function_scroll` **(** :ref:`String` arg0 **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_node` **(** :ref:`String` func, :ref:`int` id **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_node_pos` **(** :ref:`String` func, :ref:`int` id **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_variable_default_value` **(** :ref:`String` name **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_variable_export` **(** :ref:`String` name **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_variable_info` **(** :ref:`String` name **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_custom_signal` **(** :ref:`String` name **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_data_connection` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_function` **(** :ref:`String` name **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node` **(** :ref:`String` func, :ref:`int` id **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_sequence_connection` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_variable` **(** :ref:`String` name **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_custom_signal` **(** :ref:`String` name **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_function` **(** :ref:`String` name **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_node` **(** :ref:`String` func, :ref:`int` id **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_variable` **(** :ref:`String` name **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_custom_signal` **(** :ref:`String` name, :ref:`String` new_name **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_function` **(** :ref:`String` name, :ref:`String` new_name **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_variable` **(** :ref:`String` name, :ref:`String` new_name **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sequence_connect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sequence_disconnect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_function_scroll` **(** :ref:`String` ofs, :ref:`Vector2` arg1 **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_instance_base_type` **(** :ref:`String` type **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_node_pos` **(** :ref:`String` func, :ref:`int` id, :ref:`Vector2` pos **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_variable_default_value` **(** :ref:`String` name, :ref:`Variant` value **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_variable_export` **(** :ref:`String` name, :ref:`bool` enable **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_variable_info` **(** :ref:`String` name, :ref:`Dictionary` value **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_custom_signal` **(** :ref:`String` name **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_function` **(** :ref:`String` name **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_node` **(** :ref:`String` func, :ref:`int` id, :ref:`VisualScriptNode` node, :ref:`Vector2` pos=null **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_variable` **(** :ref:`String` name, :ref:`Variant` default_value=null, :ref:`bool` export=null **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`custom_signal_add_argument` **(** :ref:`String` name, :ref:`int` type, :ref:`String` argname, :ref:`int` index=null **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`custom_signal_get_argument_count` **(** :ref:`String` name **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`custom_signal_get_argument_name` **(** :ref:`String` name, :ref:`int` argidx **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`custom_signal_get_argument_type` **(** :ref:`String` name, :ref:`int` argidx **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`custom_signal_remove_argument` **(** :ref:`String` name, :ref:`int` argidx **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`custom_signal_set_argument_name` **(** :ref:`String` name, :ref:`int` argidx, :ref:`String` argname **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`custom_signal_set_argument_type` **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` type **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`custom_signal_swap_argument` **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` withidx **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`data_connect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`data_disconnect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_function_node_id` **(** :ref:`String` name **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_function_scroll` **(** :ref:`String` name **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`VisualScriptNode` | :ref:`get_node` **(** :ref:`String` func, :ref:`int` id **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_node_pos` **(** :ref:`String` func, :ref:`int` id **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_variable_default_value` **(** :ref:`String` name **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_variable_export` **(** :ref:`String` name **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_variable_info` **(** :ref:`String` name **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_custom_signal` **(** :ref:`String` name **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_data_connection` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_function` **(** :ref:`String` name **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_node` **(** :ref:`String` func, :ref:`int` id **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_sequence_connection` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_variable` **(** :ref:`String` name **)** const | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_custom_signal` **(** :ref:`String` name **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_function` **(** :ref:`String` name **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_node` **(** :ref:`String` func, :ref:`int` id **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_variable` **(** :ref:`String` name **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_custom_signal` **(** :ref:`String` name, :ref:`String` new_name **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_function` **(** :ref:`String` name, :ref:`String` new_name **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_variable` **(** :ref:`String` name, :ref:`String` new_name **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sequence_connect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sequence_disconnect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_function_scroll` **(** :ref:`String` name, :ref:`Vector2` ofs **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_instance_base_type` **(** :ref:`String` type **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_node_pos` **(** :ref:`String` func, :ref:`int` id, :ref:`Vector2` pos **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_variable_default_value` **(** :ref:`String` name, :ref:`Variant` value **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_variable_export` **(** :ref:`String` name, :ref:`bool` enable **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_variable_info` **(** :ref:`String` name, :ref:`Dictionary` value **)** | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -127,15 +127,15 @@ Member Function Description .. _class_VisualScript_add_node: -- void **add_node** **(** :ref:`String` func, :ref:`int` id, :ref:`Object` node, :ref:`Vector2` pos=Vector2(0, 0) **)** +- void **add_node** **(** :ref:`String` func, :ref:`int` id, :ref:`VisualScriptNode` node, :ref:`Vector2` pos=null **)** .. _class_VisualScript_add_variable: -- void **add_variable** **(** :ref:`String` name, :ref:`Variant` default_value=NULL, :ref:`bool` export=false **)** +- void **add_variable** **(** :ref:`String` name, :ref:`Variant` default_value=null, :ref:`bool` export=null **)** .. _class_VisualScript_custom_signal_add_argument: -- void **custom_signal_add_argument** **(** :ref:`String` name, :ref:`int` type, :ref:`String` argname, :ref:`int` index=-1 **)** +- void **custom_signal_add_argument** **(** :ref:`String` name, :ref:`int` type, :ref:`String` argname, :ref:`int` index=null **)** .. _class_VisualScript_custom_signal_get_argument_count: @@ -151,7 +151,7 @@ Member Function Description .. _class_VisualScript_custom_signal_remove_argument: -- void **custom_signal_remove_argument** **(** :ref:`String` argidx, :ref:`int` arg1 **)** +- void **custom_signal_remove_argument** **(** :ref:`String` name, :ref:`int` argidx **)** .. _class_VisualScript_custom_signal_set_argument_name: @@ -179,11 +179,11 @@ Member Function Description .. _class_VisualScript_get_function_scroll: -- :ref:`Vector2` **get_function_scroll** **(** :ref:`String` arg0 **)** const +- :ref:`Vector2` **get_function_scroll** **(** :ref:`String` name **)** const .. _class_VisualScript_get_node: -- :ref:`Object` **get_node** **(** :ref:`String` func, :ref:`int` id **)** const +- :ref:`VisualScriptNode` **get_node** **(** :ref:`String` func, :ref:`int` id **)** const .. _class_VisualScript_get_node_pos: @@ -191,7 +191,7 @@ Member Function Description .. _class_VisualScript_get_variable_default_value: -- void **get_variable_default_value** **(** :ref:`String` name **)** const +- :ref:`Variant` **get_variable_default_value** **(** :ref:`String` name **)** const .. _class_VisualScript_get_variable_export: @@ -263,7 +263,7 @@ Member Function Description .. _class_VisualScript_set_function_scroll: -- void **set_function_scroll** **(** :ref:`String` ofs, :ref:`Vector2` arg1 **)** +- void **set_function_scroll** **(** :ref:`String` name, :ref:`Vector2` ofs **)** .. _class_VisualScript_set_instance_base_type: diff --git a/classes/class_visualscriptbasictypeconstant.rst b/classes/class_visualscriptbasictypeconstant.rst index 93c614548..dea573bf3 100644 --- a/classes/class_visualscriptbasictypeconstant.rst +++ b/classes/class_visualscriptbasictypeconstant.rst @@ -32,7 +32,7 @@ Member Variables ---------------- - :ref:`int` **basic_type** -- :ref:`String` **constant** +- :ref:`String` **constant/constant** Member Function Description --------------------------- diff --git a/classes/class_visualscriptclassconstant.rst b/classes/class_visualscriptclassconstant.rst index f58d55285..f543570b4 100644 --- a/classes/class_visualscriptclassconstant.rst +++ b/classes/class_visualscriptclassconstant.rst @@ -32,7 +32,7 @@ Member Variables ---------------- - :ref:`String` **base_type** -- :ref:`String` **constant** +- :ref:`String` **constant/constant** Member Function Description --------------------------- diff --git a/classes/class_visualscriptconstant.rst b/classes/class_visualscriptconstant.rst index 8a7eb4436..ff9d929f9 100644 --- a/classes/class_visualscriptconstant.rst +++ b/classes/class_visualscriptconstant.rst @@ -32,7 +32,7 @@ Member Variables ---------------- - :ref:`int` **type** -- :ref:`Nil` **value** +- :ref:`Variant` **value** Member Function Description --------------------------- diff --git a/classes/class_visualscriptenginesingleton.rst b/classes/class_visualscriptenginesingleton.rst index 012bcac03..91c7fc569 100644 --- a/classes/class_visualscriptenginesingleton.rst +++ b/classes/class_visualscriptenginesingleton.rst @@ -27,7 +27,7 @@ Member Functions Member Variables ---------------- -- :ref:`String` **constant** +- :ref:`String` **constant/constant** Member Function Description --------------------------- diff --git a/classes/class_visualscriptfunctionstate.rst b/classes/class_visualscriptfunctionstate.rst index ee2f85a8d..af91428db 100644 --- a/classes/class_visualscriptfunctionstate.rst +++ b/classes/class_visualscriptfunctionstate.rst @@ -18,13 +18,13 @@ Brief Description Member Functions ---------------- -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`connect_to_signal` **(** :ref:`Object` obj, :ref:`String` signals, :ref:`Array` args **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid` **(** **)** const | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`resume` **(** :ref:`Array` args=NULL **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`connect_to_signal` **(** :ref:`Object` obj, :ref:`String` signals, :ref:`Array` args **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`resume` **(** :ref:`Array` args=null **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- @@ -39,6 +39,6 @@ Member Function Description .. _class_VisualScriptFunctionState_resume: -- :ref:`Array` **resume** **(** :ref:`Array` args=NULL **)** +- :ref:`Variant` **resume** **(** :ref:`Array` args=null **)** diff --git a/classes/class_visualscriptglobalconstant.rst b/classes/class_visualscriptglobalconstant.rst index aa0a4bc1c..0ad7c8782 100644 --- a/classes/class_visualscriptglobalconstant.rst +++ b/classes/class_visualscriptglobalconstant.rst @@ -27,7 +27,7 @@ Member Functions Member Variables ---------------- -- :ref:`int` **constant** +- :ref:`int` **constant/constant** Member Function Description --------------------------- diff --git a/classes/class_visualscriptmathconstant.rst b/classes/class_visualscriptmathconstant.rst index 4bc4bd271..e057f3c1e 100644 --- a/classes/class_visualscriptmathconstant.rst +++ b/classes/class_visualscriptmathconstant.rst @@ -27,7 +27,7 @@ Member Functions Member Variables ---------------- -- :ref:`int` **constant** +- :ref:`int` **constant/constant** Member Function Description --------------------------- diff --git a/classes/class_visualscriptnode.rst b/classes/class_visualscriptnode.rst index 9bb048bd1..a48eebed3 100644 --- a/classes/class_visualscriptnode.rst +++ b/classes/class_visualscriptnode.rst @@ -8,7 +8,7 @@ VisualScriptNode **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`VisualScriptDeconstruct`, :ref:`VisualScriptLocalVar`, :ref:`VisualScriptSceneNode`, :ref:`VisualScriptBasicTypeConstant`, :ref:`VisualScriptSequence`, :ref:`VisualScriptVariableSet`, :ref:`VisualScriptConstant`, :ref:`VisualScriptReturn`, :ref:`VisualScriptSceneTree`, :ref:`VisualScriptSelf`, :ref:`VisualScriptIndexSet`, :ref:`VisualScriptResourcePath`, :ref:`VisualScriptPropertyGet`, :ref:`VisualScriptVariableGet`, :ref:`VisualScriptInputAction`, :ref:`VisualScriptEmitSignal`, :ref:`VisualScriptTypeCast`, :ref:`VisualScriptGlobalConstant`, :ref:`VisualScriptFunctionCall`, :ref:`VisualScriptPreload`, :ref:`VisualScriptYield`, :ref:`VisualScriptSwitch`, :ref:`VisualScriptBuiltinFunc`, :ref:`VisualScriptClassConstant`, :ref:`VisualScriptEngineSingleton`, :ref:`VisualScriptCondition`, :ref:`VisualScriptOperator`, :ref:`VisualScriptIterator`, :ref:`VisualScriptCustomNode`, :ref:`VisualScriptSubCall`, :ref:`VisualScriptYieldSignal`, :ref:`VisualScriptIndexGet`, :ref:`VisualScriptLocalVarSet`, :ref:`VisualScriptWhile`, :ref:`VisualScriptConstructor`, :ref:`VisualScriptMathConstant`, :ref:`VisualScriptComment`, :ref:`VisualScriptExpression`, :ref:`VisualScriptPropertySet`, :ref:`VisualScriptFunction`, :ref:`VisualScriptSelect` +**Inherited By:** :ref:`VisualScriptDeconstruct`, :ref:`VisualScriptLocalVar`, :ref:`VisualScriptSceneNode`, :ref:`VisualScriptBasicTypeConstant`, :ref:`VisualScriptSequence`, :ref:`VisualScriptVariableSet`, :ref:`VisualScriptConstant`, :ref:`VisualScriptReturn`, :ref:`VisualScriptSceneTree`, :ref:`VisualScriptSelf`, :ref:`VisualScriptIndexSet`, :ref:`VisualScriptResourcePath`, :ref:`VisualScriptPropertyGet`, :ref:`VisualScriptVariableGet`, :ref:`VisualScriptInputAction`, :ref:`VisualScriptEmitSignal`, :ref:`VisualScriptTypeCast`, :ref:`VisualScriptGlobalConstant`, :ref:`VisualScriptFunctionCall`, :ref:`VisualScriptYield`, :ref:`VisualScriptSwitch`, :ref:`VisualScriptBuiltinFunc`, :ref:`VisualScriptClassConstant`, :ref:`VisualScriptEngineSingleton`, :ref:`VisualScriptCondition`, :ref:`VisualScriptOperator`, :ref:`VisualScriptIterator`, :ref:`VisualScriptCustomNode`, :ref:`VisualScriptSubCall`, :ref:`VisualScriptYieldSignal`, :ref:`VisualScriptIndexGet`, :ref:`VisualScriptLocalVarSet`, :ref:`VisualScriptWhile`, :ref:`VisualScriptConstructor`, :ref:`VisualScriptMathConstant`, :ref:`VisualScriptComment`, :ref:`VisualScriptExpression`, :ref:`VisualScriptPropertySet`, :ref:`VisualScriptFunction`, :ref:`VisualScriptPreload`, :ref:`VisualScriptSelect` **Category:** Core diff --git a/classes/class_visualscriptpreload.rst b/classes/class_visualscriptpreload.rst index b0db3cfc4..c7442bef2 100644 --- a/classes/class_visualscriptpreload.rst +++ b/classes/class_visualscriptpreload.rst @@ -18,11 +18,11 @@ Brief Description Member Functions ---------------- -+------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_preload` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_preload` **(** :ref:`Object` resource **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------+ ++----------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`get_preload` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_preload` **(** :ref:`Resource` resource **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -34,10 +34,10 @@ Member Function Description .. _class_VisualScriptPreload_get_preload: -- :ref:`Object` **get_preload** **(** **)** const +- :ref:`Resource` **get_preload** **(** **)** const .. _class_VisualScriptPreload_set_preload: -- void **set_preload** **(** :ref:`Object` resource **)** +- void **set_preload** **(** :ref:`Resource` resource **)** diff --git a/classes/class_visualscriptpropertyset.rst b/classes/class_visualscriptpropertyset.rst index 4b03439d3..753584909 100644 --- a/classes/class_visualscriptpropertyset.rst +++ b/classes/class_visualscriptpropertyset.rst @@ -63,7 +63,7 @@ Member Variables - :ref:`NodePath` **node_path** - :ref:`String` **property** - :ref:`int` **set_mode** -- :ref:`int` **type_cache** +- :ref:`Dictionary` **type_cache** Numeric Constants ----------------- diff --git a/classes/class_visualscriptsubcall.rst b/classes/class_visualscriptsubcall.rst index 2707239ae..c9738eea2 100644 --- a/classes/class_visualscriptsubcall.rst +++ b/classes/class_visualscriptsubcall.rst @@ -18,15 +18,15 @@ Brief Description Member Functions ---------------- -+-------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_subcall` **(** :ref:`Variant` arguments **)** virtual | -+-------+-------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`_subcall` **(** :ref:`Variant` arguments **)** virtual | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_VisualScriptSubCall__subcall: -- void **_subcall** **(** :ref:`Variant` arguments **)** virtual +- :ref:`Variant` **_subcall** **(** :ref:`Variant` arguments **)** virtual diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index ad1bc6dc7..384eba14e 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -18,21 +18,23 @@ Server for anything visible. Member Functions ---------------- -+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`texture_create` **(** **)** | -+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`texture_create_from_image` **(** :ref:`Object` arg0, :ref:`int` arg1=7 **)** | -+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_flags` **(** :ref:`RID` arg0 **)** const | -+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_height` **(** :ref:`RID` arg0 **)** const | -+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_width` **(** :ref:`RID` arg0 **)** const | -+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_flags` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** | -+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_shrink_all_x2_on_set_data` **(** :ref:`bool` shrink **)** | -+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_draw` **(** **)** | ++------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`texture_create` **(** **)** | ++------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`texture_create_from_image` **(** :ref:`Image` image, :ref:`int` flags=null **)** | ++------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`texture_get_flags` **(** :ref:`RID` texture **)** const | ++------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`texture_get_height` **(** :ref:`RID` texture **)** const | ++------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`texture_get_width` **(** :ref:`RID` texture **)** const | ++------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_set_flags` **(** :ref:`RID` texture, :ref:`int` flags **)** | ++------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_set_shrink_all_x2_on_set_data` **(** :ref:`bool` shrink **)** | ++------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -44,29 +46,33 @@ The visual server is completely opaque, the internals are entirely implementatio Member Function Description --------------------------- +.. _class_VisualServer_force_draw: + +- void **force_draw** **(** **)** + .. _class_VisualServer_texture_create: - :ref:`RID` **texture_create** **(** **)** .. _class_VisualServer_texture_create_from_image: -- :ref:`RID` **texture_create_from_image** **(** :ref:`Object` arg0, :ref:`int` arg1=7 **)** +- :ref:`RID` **texture_create_from_image** **(** :ref:`Image` image, :ref:`int` flags=null **)** .. _class_VisualServer_texture_get_flags: -- :ref:`int` **texture_get_flags** **(** :ref:`RID` arg0 **)** const +- :ref:`int` **texture_get_flags** **(** :ref:`RID` texture **)** const .. _class_VisualServer_texture_get_height: -- :ref:`int` **texture_get_height** **(** :ref:`RID` arg0 **)** const +- :ref:`int` **texture_get_height** **(** :ref:`RID` texture **)** const .. _class_VisualServer_texture_get_width: -- :ref:`int` **texture_get_width** **(** :ref:`RID` arg0 **)** const +- :ref:`int` **texture_get_width** **(** :ref:`RID` texture **)** const .. _class_VisualServer_texture_set_flags: -- void **texture_set_flags** **(** :ref:`RID` arg0, :ref:`int` arg1 **)** +- void **texture_set_flags** **(** :ref:`RID` texture, :ref:`int` flags **)** .. _class_VisualServer_texture_set_shrink_all_x2_on_set_data: diff --git a/classes/class_weakref.rst b/classes/class_weakref.rst index 2fe5f898a..2d794e6a4 100644 --- a/classes/class_weakref.rst +++ b/classes/class_weakref.rst @@ -18,9 +18,9 @@ Holds an :ref:`Object`, but does not contribute to the reference c Member Functions ---------------- -+------------------------------+----------------------------------------------------------+ -| :ref:`Object` | :ref:`get_ref` **(** **)** const | -+------------------------------+----------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_ref` **(** **)** const | ++--------------------------------+----------------------------------------------------------+ Description ----------- @@ -32,7 +32,7 @@ Member Function Description .. _class_WeakRef_get_ref: -- :ref:`Object` **get_ref** **(** **)** const +- :ref:`Variant` **get_ref** **(** **)** const Returns the :ref:`Object` this weakref is referring to.