From 6415697d201173ec5d29aabfcc8dea8e1ef836ac Mon Sep 17 00:00:00 2001 From: reduz Date: Sun, 23 Feb 2014 18:07:00 -0300 Subject: [PATCH] fixies --- class_@gdscript.md | 196 +++++++++--------- class_aabb.md | 80 ++++---- class_acceptdialog.md | 36 ++-- class_animatedsprite.md | 28 +-- class_animation.md | 140 ++++++------- class_animationplayer.md | 128 ++++++------ class_animationtreeplayer.md | 116 +++++------ class_area.md | 36 ++-- class_area2d.md | 42 ++-- class_array.md | 72 +++---- class_atlastexture.md | 12 +- class_audioserver.md | 188 ++++++++--------- class_audiostream.md | 48 ++--- class_audiostreamgibberish.md | 32 +-- class_audiostreammpc.md | 8 +- class_audiostreamspeex.md | 8 +- class_basebutton.md | 42 ++-- class_bitmap.md | 14 +- class_bool.md | 6 +- class_boxshape.md | 8 +- class_button.md | 36 ++-- class_buttonarray.md | 46 ++--- class_buttongroup.md | 20 +- class_camera.md | 64 +++--- class_camera2d.md | 78 +++---- class_canvasitem.md | 160 +++++++-------- class_canvaslayer.md | 48 ++--- class_capsuleshape.md | 16 +- class_capsuleshape2d.md | 16 +- class_carbody.md | 32 +-- class_carwheel.md | 36 ++-- class_circleshape2d.md | 8 +- class_collisionobject.md | 22 +- class_collisionobject2d.md | 38 ++-- class_color.md | 38 ++-- class_colorarray.md | 24 +-- class_colorpicker.md | 18 +- class_colorpickerbutton.md | 10 +- class_concavepolygonshape.md | 8 +- class_concavepolygonshape2d.md | 8 +- class_configfile.md | 16 +- class_confirmationdialog.md | 4 +- class_container.md | 10 +- class_control.md | 298 +++++++++++++-------------- class_convexpolygonshape.md | 4 +- class_convexpolygonshape2d.md | 12 +- class_cubemap.md | 22 +- class_curve2d.md | 34 ++-- class_curve3d.md | 38 ++-- class_dampedspringjoint2d.md | 32 +-- class_dictionary.md | 32 +-- class_directionallight.md | 8 +- class_directory.md | 32 +-- class_editablesphere.md | 4 +- class_editorimportplugin.md | 10 +- class_editorplugin.md | 32 +-- class_editorscenepostimport.md | 2 +- class_emptycontrol.md | 4 +- class_environment.md | 16 +- class_eventplayer.md | 54 ++--- class_file.md | 70 +++---- class_filedialog.md | 48 ++--- class_fixedmaterial.md | 48 ++--- class_flurry.md | 6 +- class_followcamera.md | 72 +++---- class_font.md | 56 ++--- class_gdnativeclass.md | 2 +- class_gdscript.md | 2 +- class_geometry.md | 28 +-- class_geometryinstance.md | 22 +- class_globals.md | 38 ++-- class_gridcontainer.md | 4 +- class_gridmap.md | 66 +++--- class_groovejoint2d.md | 16 +- class_httpclient.md | 30 +-- class_image.md | 28 +-- class_imagepathfinder.md | 8 +- class_imagetexture.md | 24 +-- class_input.md | 22 +- class_inputevent.md | 12 +- class_inputeventaction.md | 6 +- class_inputeventjoybutton.md | 6 +- class_inputeventjoymotion.md | 6 +- class_inputeventkey.md | 6 +- class_inputeventmousebutton.md | 6 +- class_inputeventmousemotion.md | 6 +- class_inputeventscreendrag.md | 6 +- class_inputeventscreentouch.md | 6 +- class_int.md | 6 +- class_intarray.md | 24 +-- class_interpolatedcamera.md | 14 +- class_ip.md | 22 +- class_joint2d.md | 20 +- class_label.md | 50 ++--- class_largetexture.md | 12 +- class_light.md | 20 +- class_lineedit.md | 62 +++--- class_lineshape2d.md | 16 +- class_mainloop.md | 2 +- class_marshalls.md | 4 +- class_material.md | 32 +-- class_matrix3.md | 62 +++--- class_matrix32.md | 24 +-- class_menubutton.md | 6 +- class_mesh.md | 64 +++--- class_meshdatatool.md | 76 +++---- class_meshinstance.md | 18 +- class_meshlibrary.md | 40 ++-- class_multimesh.md | 46 ++--- class_multimeshinstance.md | 8 +- class_mutex.md | 6 +- class_nil.md | 56 ++--- class_node.md | 252 +++++++++++------------ class_node2d.md | 34 ++-- class_nodepath.md | 30 +-- class_object.md | 142 ++++++------- class_optionbutton.md | 68 +++---- class_os.md | 156 +++++++------- class_packeddatacontainer.md | 4 +- class_packeddatacontainerref.md | 2 +- class_packedscene.md | 8 +- class_packetpeer.md | 4 +- class_packetpeerstream.md | 4 +- class_parallaxbackground.md | 20 +- class_parallaxlayer.md | 8 +- class_particleattractor2d.md | 24 +-- class_particles.md | 106 +++++----- class_particles2d.md | 82 ++++---- class_particlesystemmaterial.md | 4 +- class_path.md | 4 +- class_path2d.md | 4 +- class_pathfollow.md | 28 +-- class_pathremap.md | 20 +- class_performance.md | 2 +- class_phashtranslation.md | 2 +- class_physics2ddirectbodystate.md | 98 ++++----- class_physics2ddirectspacestate.md | 8 +- class_physics2dserver.md | 146 ++++++------- class_physics2dshapequeryresult.md | 10 +- class_physicsdirectbodystate.md | 52 ++--- class_physicsdirectspacestate.md | 4 +- class_physicsserver.md | 126 ++++++------ class_physicsshapequeryresult.md | 10 +- class_plane.md | 40 ++-- class_planeshape.md | 4 +- class_popup.md | 20 +- class_popupmenu.md | 98 ++++----- class_portal.md | 48 ++--- class_proximitygroup.md | 12 +- class_quad.md | 16 +- class_quat.md | 32 +-- class_range.md | 64 +++--- class_rawarray.md | 16 +- class_raycast.md | 18 +- class_raycast2d.md | 18 +- class_rayshape.md | 4 +- class_rayshape2d.md | 4 +- class_real.md | 6 +- class_realarray.md | 12 +- class_rect2.md | 22 +- class_rectangleshape2d.md | 8 +- class_reference.md | 10 +- class_regex.md | 6 +- class_remotetransform2d.md | 4 +- class_resource.md | 28 +-- class_resourceimportmetadata.md | 20 +- class_resourceinteractiveloader.md | 18 +- class_resourceloader.md | 20 +- class_resourcepreloader.md | 24 +-- class_resourcesaver.md | 8 +- class_richtextlabel.md | 50 ++--- class_rid.md | 4 +- class_rigidbody.md | 66 +++--- class_rigidbody2d.md | 128 ++++++------ class_room.md | 10 +- class_roombounds.md | 12 +- class_sample.md | 56 ++--- class_samplelibrary.md | 24 +-- class_sampleplayer.md | 150 +++++++------- class_sampleplayer2d.md | 44 ++-- class_sceneinteractiveloader.md | 8 +- class_sceneio.md | 6 +- class_scenemainloop.md | 62 +++--- class_scenepreloader.md | 8 +- class_script.md | 24 +-- class_scrollbar.md | 4 +- class_scrollcontainer.md | 16 +- class_segmentshape2d.md | 8 +- class_semaphore.md | 4 +- class_shader.md | 12 +- class_shadermaterial.md | 4 +- class_shape2d.md | 8 +- class_skeleton.md | 64 +++--- class_slider.md | 16 +- class_soundplayer2d.md | 4 +- class_soundroomparams.md | 12 +- class_spatial.md | 46 ++--- class_spatialplayer.md | 4 +- class_spatialsampleplayer.md | 20 +- class_spatialstreamplayer.md | 22 +- class_sphereshape.md | 4 +- class_spinbox.md | 24 +-- class_splitcontainer.md | 20 +- class_sprite.md | 88 ++++---- class_spriteframes.md | 22 +- class_staticbody.md | 12 +- class_staticbody2d.md | 32 +-- class_streampeer.md | 16 +- class_streampeertcp.md | 10 +- class_streamplayer.md | 40 ++-- class_string.md | 158 +++++++-------- class_stringarray.md | 12 +- class_stylebox.md | 28 +-- class_styleboxflat.md | 24 +-- class_styleboximagemask.md | 26 +-- class_styleboxtexture.md | 16 +- class_surfacetool.md | 34 ++-- class_tabcontainer.md | 44 ++-- class_tabs.md | 18 +- class_tcp_server.md | 16 +- class_textedit.md | 142 ++++++------- class_texture.md | 34 ++-- class_texturebutton.md | 24 +-- class_textureframe.md | 12 +- class_textureprogress.md | 12 +- class_theme.md | 54 ++--- class_thread.md | 8 +- class_tilemap.md | 60 +++--- class_tileset.md | 64 +++--- class_timer.md | 38 ++-- class_touchscreenbutton.md | 30 +-- class_transform.md | 34 ++-- class_translation.md | 24 +-- class_translationserver.md | 10 +- class_tree.md | 64 +++--- class_treeitem.md | 96 ++++----- class_unshadedmaterial.md | 12 +- class_vector2.md | 44 ++-- class_vector2array.md | 12 +- class_vector3.md | 54 ++--- class_vector3array.md | 12 +- class_videoplayer.md | 34 ++-- class_videostream.md | 6 +- class_viewport.md | 64 +++--- class_visibilityenabler.md | 4 +- class_visibilityenabler2d.md | 4 +- class_visibilitynotifier.md | 14 +- class_visibilitynotifier2d.md | 14 +- class_visualinstance.md | 6 +- class_visualserver.md | 316 ++++++++++++++--------------- class_windowdialog.md | 12 +- class_world.md | 10 +- class_world2d.md | 6 +- class_worldenvironment.md | 4 +- class_xmlparser.md | 32 +-- 255 files changed, 4459 insertions(+), 4459 deletions(-) diff --git a/class_@gdscript.md b/class_@gdscript.md index 701fb58..5ba818d 100644 --- a/class_@gdscript.md +++ b/class_@gdscript.md @@ -5,59 +5,59 @@ Built-in GDScript functions. ### Member Functions - * [real](class_real) **[`sin`](#sin)** **(** [real](class_real) s **)** - * [real](class_real) **[`cos`](#cos)** **(** [real](class_real) s **)** - * [real](class_real) **[`tan`](#tan)** **(** [real](class_real) s **)** - * [real](class_real) **[`sinh`](#sinh)** **(** [real](class_real) s **)** - * [real](class_real) **[`cosh`](#cosh)** **(** [real](class_real) s **)** - * [real](class_real) **[`tanh`](#tanh)** **(** [real](class_real) s **)** - * [real](class_real) **[`asin`](#asin)** **(** [real](class_real) s **)** - * [real](class_real) **[`acos`](#acos)** **(** [real](class_real) s **)** - * [real](class_real) **[`atan`](#atan)** **(** [real](class_real) s **)** - * [real](class_real) **[`atan2`](#atan2)** **(** [real](class_real) x, [real](class_real) y **)** - * [real](class_real) **[`sqrt`](#sqrt)** **(** [real](class_real) s **)** - * [real](class_real) **[`fmod`](#fmod)** **(** [real](class_real) x, [real](class_real) y **)** - * [real](class_real) **[`fposmod`](#fposmod)** **(** [real](class_real) x, [real](class_real) y **)** - * [real](class_real) **[`floor`](#floor)** **(** [real](class_real) s **)** - * [real](class_real) **[`ceil`](#ceil)** **(** [real](class_real) s **)** - * [real](class_real) **[`round`](#round)** **(** [real](class_real) s **)** - * [real](class_real) **[`abs`](#abs)** **(** [real](class_real) s **)** - * [real](class_real) **[`sign`](#sign)** **(** [real](class_real) s **)** - * [real](class_real) **[`pow`](#pow)** **(** [real](class_real) x, [real](class_real) y **)** - * [real](class_real) **[`log`](#log)** **(** [real](class_real) s **)** - * [real](class_real) **[`exp`](#exp)** **(** [real](class_real) s **)** - * [real](class_real) **[`isnan`](#isnan)** **(** [real](class_real) s **)** - * [real](class_real) **[`isinf`](#isinf)** **(** [real](class_real) s **)** - * [real](class_real) **[`ease`](#ease)** **(** [real](class_real) s, [real](class_real) curve **)** - * [real](class_real) **[`decimals`](#decimals)** **(** [real](class_real) step **)** - * [real](class_real) **[`stepify`](#stepify)** **(** [real](class_real) s, [real](class_real) step **)** - * [real](class_real) **[`lerp`](#lerp)** **(** [real](class_real) a, [real](class_real) b, [real](class_real) c **)** - * [real](class_real) **[`dectime`](#dectime)** **(** [real](class_real) value, [real](class_real) amount, [real](class_real) step **)** - * [Nil](class_nil) **[`randomize`](#randomize)** **(** **)** - * [int](class_int) **[`rand`](#rand)** **(** **)** - * [real](class_real) **[`randf`](#randf)** **(** **)** - * [real](class_real) **[`rand_range`](#rand_range)** **(** [real](class_real) from, [real](class_real) to **)** - * [Array](class_array) **[`rand_seed`](#rand_seed)** **(** [real](class_real) seed **)** - * [real](class_real) **[`deg2rad`](#deg2rad)** **(** [real](class_real) deg **)** - * [real](class_real) **[`rad2deg`](#rad2deg)** **(** [real](class_real) rad **)** - * [real](class_real) **[`linear2db`](#linear2db)** **(** [real](class_real) nrg **)** - * [real](class_real) **[`db2linear`](#db2linear)** **(** [real](class_real) db **)** - * [real](class_real) **[`max`](#max)** **(** [real](class_real) a, [real](class_real) b **)** - * [real](class_real) **[`min`](#min)** **(** [real](class_real) a, [real](class_real) b **)** - * [real](class_real) **[`clamp`](#clamp)** **(** [real](class_real) val, [real](class_real) min, [real](class_real) max **)** - * [int](class_int) **[`nearest_po2`](#nearest_po2)** **(** [int](class_int) val **)** - * [Object](class_object) **[`weakref`](#weakref)** **(** [Object](class_object) obj **)** - * [Object](class_object) **[`convert`](#convert)** **(** var what, [int](class_int) type **)** - * [String](class_string) **[`str`](#str)** **(** var what, var ... **)** - * [String](class_string) **[`str`](#str)** **(** var what, var ... **)** - * [Nil](class_nil) **[`print`](#print)** **(** var what, var ... **)** - * [Nil](class_nil) **[`printt`](#printt)** **(** var what, var ... **)** - * [Nil](class_nil) **[`printerr`](#printerr)** **(** var what, var ... **)** - * [Nil](class_nil) **[`printraw`](#printraw)** **(** var what, var ... **)** - * [Array](class_array) **[`range`](#range)** **(** var ... **)** - * [Dictionary](class_dictionary) **[`inst2dict`](#inst2dict)** **(** [Object](class_object) inst **)** - * [Object](class_object) **[`dict2inst`](#dict2inst)** **(** [Dictionary](class_dictionary) dict **)** - * [Nil](class_nil) **[`print_stack`](#print_stack)** **(** **)** + * [real](class_real) **[sin](#sin)** **(** [real](class_real) s **)** + * [real](class_real) **[cos](#cos)** **(** [real](class_real) s **)** + * [real](class_real) **[tan](#tan)** **(** [real](class_real) s **)** + * [real](class_real) **[sinh](#sinh)** **(** [real](class_real) s **)** + * [real](class_real) **[cosh](#cosh)** **(** [real](class_real) s **)** + * [real](class_real) **[tanh](#tanh)** **(** [real](class_real) s **)** + * [real](class_real) **[asin](#asin)** **(** [real](class_real) s **)** + * [real](class_real) **[acos](#acos)** **(** [real](class_real) s **)** + * [real](class_real) **[atan](#atan)** **(** [real](class_real) s **)** + * [real](class_real) **[atan2](#atan2)** **(** [real](class_real) x, [real](class_real) y **)** + * [real](class_real) **[sqrt](#sqrt)** **(** [real](class_real) s **)** + * [real](class_real) **[fmod](#fmod)** **(** [real](class_real) x, [real](class_real) y **)** + * [real](class_real) **[fposmod](#fposmod)** **(** [real](class_real) x, [real](class_real) y **)** + * [real](class_real) **[floor](#floor)** **(** [real](class_real) s **)** + * [real](class_real) **[ceil](#ceil)** **(** [real](class_real) s **)** + * [real](class_real) **[round](#round)** **(** [real](class_real) s **)** + * [real](class_real) **[abs](#abs)** **(** [real](class_real) s **)** + * [real](class_real) **[sign](#sign)** **(** [real](class_real) s **)** + * [real](class_real) **[pow](#pow)** **(** [real](class_real) x, [real](class_real) y **)** + * [real](class_real) **[log](#log)** **(** [real](class_real) s **)** + * [real](class_real) **[exp](#exp)** **(** [real](class_real) s **)** + * [real](class_real) **[isnan](#isnan)** **(** [real](class_real) s **)** + * [real](class_real) **[isinf](#isinf)** **(** [real](class_real) s **)** + * [real](class_real) **[ease](#ease)** **(** [real](class_real) s, [real](class_real) curve **)** + * [real](class_real) **[decimals](#decimals)** **(** [real](class_real) step **)** + * [real](class_real) **[stepify](#stepify)** **(** [real](class_real) s, [real](class_real) step **)** + * [real](class_real) **[lerp](#lerp)** **(** [real](class_real) a, [real](class_real) b, [real](class_real) c **)** + * [real](class_real) **[dectime](#dectime)** **(** [real](class_real) value, [real](class_real) amount, [real](class_real) step **)** + * [Nil](class_nil) **[randomize](#randomize)** **(** **)** + * [int](class_int) **[rand](#rand)** **(** **)** + * [real](class_real) **[randf](#randf)** **(** **)** + * [real](class_real) **[rand_range](#rand_range)** **(** [real](class_real) from, [real](class_real) to **)** + * [Array](class_array) **[rand_seed](#rand_seed)** **(** [real](class_real) seed **)** + * [real](class_real) **[deg2rad](#deg2rad)** **(** [real](class_real) deg **)** + * [real](class_real) **[rad2deg](#rad2deg)** **(** [real](class_real) rad **)** + * [real](class_real) **[linear2db](#linear2db)** **(** [real](class_real) nrg **)** + * [real](class_real) **[db2linear](#db2linear)** **(** [real](class_real) db **)** + * [real](class_real) **[max](#max)** **(** [real](class_real) a, [real](class_real) b **)** + * [real](class_real) **[min](#min)** **(** [real](class_real) a, [real](class_real) b **)** + * [real](class_real) **[clamp](#clamp)** **(** [real](class_real) val, [real](class_real) min, [real](class_real) max **)** + * [int](class_int) **[nearest_po2](#nearest_po2)** **(** [int](class_int) val **)** + * [Object](class_object) **[weakref](#weakref)** **(** [Object](class_object) obj **)** + * [Object](class_object) **[convert](#convert)** **(** var what, [int](class_int) type **)** + * [String](class_string) **[str](#str)** **(** var what, var ... **)** + * [String](class_string) **[str](#str)** **(** var what, var ... **)** + * [Nil](class_nil) **[print](#print)** **(** var what, var ... **)** + * [Nil](class_nil) **[printt](#printt)** **(** var what, var ... **)** + * [Nil](class_nil) **[printerr](#printerr)** **(** var what, var ... **)** + * [Nil](class_nil) **[printraw](#printraw)** **(** var what, var ... **)** + * [Array](class_array) **[range](#range)** **(** var ... **)** + * [Dictionary](class_dictionary) **[inst2dict](#inst2dict)** **(** [Object](class_object) inst **)** + * [Object](class_object) **[dict2inst](#dict2inst)** **(** [Dictionary](class_dictionary) dict **)** + * [Nil](class_nil) **[print_stack](#print_stack)** **(** **)** ### Description This contains the list of built-in gdscript functions. Mostly math functions and other utilities. Everything else is expanded by objects. @@ -65,226 +65,226 @@ This contains the list of built-in gdscript functions. Mostly math functions and ### Member Function Description #### sin - * [real](class_real) **`sin`** **(** [real](class_real) s **)** + * [real](class_real) **sin** **(** [real](class_real) s **)** Standard sine function. #### cos - * [real](class_real) **`cos`** **(** [real](class_real) s **)** + * [real](class_real) **cos** **(** [real](class_real) s **)** Standard cosine function. #### tan - * [real](class_real) **`tan`** **(** [real](class_real) s **)** + * [real](class_real) **tan** **(** [real](class_real) s **)** Standard tangent function. #### sinh - * [real](class_real) **`sinh`** **(** [real](class_real) s **)** + * [real](class_real) **sinh** **(** [real](class_real) s **)** Hyperbolic sine. #### tanh - * [real](class_real) **`tanh`** **(** [real](class_real) s **)** + * [real](class_real) **tanh** **(** [real](class_real) s **)** Hyperbolic tangent. #### asin - * [real](class_real) **`asin`** **(** [real](class_real) s **)** + * [real](class_real) **asin** **(** [real](class_real) s **)** Arc-sine. #### acos - * [real](class_real) **`acos`** **(** [real](class_real) s **)** + * [real](class_real) **acos** **(** [real](class_real) s **)** Arc-cosine. #### atan - * [real](class_real) **`atan`** **(** [real](class_real) s **)** + * [real](class_real) **atan** **(** [real](class_real) s **)** Arc-tangent. #### atan2 - * [real](class_real) **`atan2`** **(** [real](class_real) x, [real](class_real) y **)** + * [real](class_real) **atan2** **(** [real](class_real) x, [real](class_real) y **)** Arc-tangent that takes a 2D vector as argument, retuns the full -pi to +pi range. #### sqrt - * [real](class_real) **`sqrt`** **(** [real](class_real) s **)** + * [real](class_real) **sqrt** **(** [real](class_real) s **)** Square root. #### fmod - * [real](class_real) **`fmod`** **(** [real](class_real) x, [real](class_real) y **)** + * [real](class_real) **fmod** **(** [real](class_real) x, [real](class_real) y **)** Module (remainder of x/y). #### fposmod - * [real](class_real) **`fposmod`** **(** [real](class_real) x, [real](class_real) y **)** + * [real](class_real) **fposmod** **(** [real](class_real) x, [real](class_real) y **)** Module (remainder of x/y) that wraps equally in positive and negative. #### floor - * [real](class_real) **`floor`** **(** [real](class_real) s **)** + * [real](class_real) **floor** **(** [real](class_real) s **)** Floor (rounds down to nearest integer). #### ceil - * [real](class_real) **`ceil`** **(** [real](class_real) s **)** + * [real](class_real) **ceil** **(** [real](class_real) s **)** Ceiling (rounds up to nearest integer). #### round - * [real](class_real) **`round`** **(** [real](class_real) s **)** + * [real](class_real) **round** **(** [real](class_real) s **)** Round to nearest integer. #### abs - * [real](class_real) **`abs`** **(** [real](class_real) s **)** + * [real](class_real) **abs** **(** [real](class_real) s **)** Remove sign (works for integer and float). #### sign - * [real](class_real) **`sign`** **(** [real](class_real) s **)** + * [real](class_real) **sign** **(** [real](class_real) s **)** Return sign (-1 or +1). #### pow - * [real](class_real) **`pow`** **(** [real](class_real) x, [real](class_real) y **)** + * [real](class_real) **pow** **(** [real](class_real) x, [real](class_real) y **)** Power function, x elevate to y. #### log - * [real](class_real) **`log`** **(** [real](class_real) s **)** + * [real](class_real) **log** **(** [real](class_real) s **)** Natural logarithm. #### exp - * [real](class_real) **`exp`** **(** [real](class_real) s **)** + * [real](class_real) **exp** **(** [real](class_real) s **)** Exponential logarithm. #### isnan - * [real](class_real) **`isnan`** **(** [real](class_real) s **)** + * [real](class_real) **isnan** **(** [real](class_real) s **)** Return true if the float is not a number. #### isinf - * [real](class_real) **`isinf`** **(** [real](class_real) s **)** + * [real](class_real) **isinf** **(** [real](class_real) s **)** Return true if the float is infinite. #### ease - * [real](class_real) **`ease`** **(** [real](class_real) s, [real](class_real) curve **)** + * [real](class_real) **ease** **(** [real](class_real) s, [real](class_real) curve **)** Easing function, based on exponent. 0 is constant, 1 is linear, 0 to 1 is ease-in, 1+ is ease out. Negative values are in-out/out in. #### decimals - * [real](class_real) **`decimals`** **(** [real](class_real) step **)** + * [real](class_real) **decimals** **(** [real](class_real) step **)** Return the amount of decimals in the floating point value. #### stepify - * [real](class_real) **`stepify`** **(** [real](class_real) s, [real](class_real) step **)** + * [real](class_real) **stepify** **(** [real](class_real) s, [real](class_real) step **)** Snap float value to a given step. #### rand - * [int](class_int) **`rand`** **(** **)** + * [int](class_int) **rand** **(** **)** Random value (integer). #### randf - * [real](class_real) **`randf`** **(** **)** + * [real](class_real) **randf** **(** **)** Random value (0 to 1 float). #### rand_range - * [real](class_real) **`rand_range`** **(** [real](class_real) from, [real](class_real) to **)** + * [real](class_real) **rand_range** **(** [real](class_real) from, [real](class_real) to **)** Random range. #### rand_seed - * [Array](class_array) **`rand_seed`** **(** [real](class_real) seed **)** + * [Array](class_array) **rand_seed** **(** [real](class_real) seed **)** random from seed, pass a seed and an array with both number and new seed is returned. #### deg2rad - * [real](class_real) **`deg2rad`** **(** [real](class_real) deg **)** + * [real](class_real) **deg2rad** **(** [real](class_real) deg **)** Convert from degrees to radians. #### rad2deg - * [real](class_real) **`rad2deg`** **(** [real](class_real) rad **)** + * [real](class_real) **rad2deg** **(** [real](class_real) rad **)** Convert from radias to degrees. #### linear2db - * [real](class_real) **`linear2db`** **(** [real](class_real) nrg **)** + * [real](class_real) **linear2db** **(** [real](class_real) nrg **)** Convert from linear energy to decibels (audio). #### db2linear - * [real](class_real) **`db2linear`** **(** [real](class_real) db **)** + * [real](class_real) **db2linear** **(** [real](class_real) db **)** Convert from decibels to linear energy (audio). #### max - * [real](class_real) **`max`** **(** [real](class_real) a, [real](class_real) b **)** + * [real](class_real) **max** **(** [real](class_real) a, [real](class_real) b **)** Return the maximum of two values. #### min - * [real](class_real) **`min`** **(** [real](class_real) a, [real](class_real) b **)** + * [real](class_real) **min** **(** [real](class_real) a, [real](class_real) b **)** Return the minimum of two values. #### clamp - * [real](class_real) **`clamp`** **(** [real](class_real) val, [real](class_real) min, [real](class_real) max **)** + * [real](class_real) **clamp** **(** [real](class_real) val, [real](class_real) min, [real](class_real) max **)** Clamp both values to a range. #### nearest_po2 - * [int](class_int) **`nearest_po2`** **(** [int](class_int) val **)** + * [int](class_int) **nearest_po2** **(** [int](class_int) val **)** Return the nearest larger power of 2 for an integer. #### weakref - * [Object](class_object) **`weakref`** **(** [Object](class_object) obj **)** + * [Object](class_object) **weakref** **(** [Object](class_object) obj **)** Return a weak reference to an object. #### convert - * [Object](class_object) **`convert`** **(** var what, [int](class_int) type **)** + * [Object](class_object) **convert** **(** var what, [int](class_int) type **)** Convert from a type to another in the best way possible. The "type" parameter uses the enum TYPE_* in Global Scope. #### str - * [String](class_string) **`str`** **(** var what, var ... **)** + * [String](class_string) **str** **(** var what, var ... **)** Convert one or more arguments to strings in the best way possible. #### str - * [String](class_string) **`str`** **(** var what, var ... **)** + * [String](class_string) **str** **(** var what, var ... **)** Convert one or more arguments to strings in the best way possible. #### print - * [Nil](class_nil) **`print`** **(** var what, var ... **)** + * [Nil](class_nil) **print** **(** var what, var ... **)** Print one or more arguments to strings in the best way possible to a console line. #### printerr - * [Nil](class_nil) **`printerr`** **(** var what, var ... **)** + * [Nil](class_nil) **printerr** **(** var what, var ... **)** Print one or more arguments to strings in the best way possible to standard error line. #### printraw - * [Nil](class_nil) **`printraw`** **(** var what, var ... **)** + * [Nil](class_nil) **printraw** **(** var what, var ... **)** Print one or more arguments to strings in the best way possible to console. No newline is added at the end. #### range - * [Array](class_array) **`range`** **(** var ... **)** + * [Array](class_array) **range** **(** var ... **)** 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). diff --git a/class_aabb.md b/class_aabb.md index d331fab..008c246 100644 --- a/class_aabb.md +++ b/class_aabb.md @@ -5,26 +5,26 @@ Axis-Aligned Bounding Box. ### Member Functions - * [bool](class_bool) **[`encloses`](#encloses)** **(** [AABB](class_aabb) with **)** - * [AABB](class_aabb) **[`expand`](#expand)** **(** [Vector3](class_vector3) to_point **)** - * [real](class_real) **[`get_area`](#get_area)** **(** **)** - * [Vector3](class_vector3) **[`get_endpoint`](#get_endpoint)** **(** [int](class_int) idx **)** - * [Vector3](class_vector3) **[`get_longest_axis`](#get_longest_axis)** **(** **)** - * [int](class_int) **[`get_longest_axis_index`](#get_longest_axis_index)** **(** **)** - * [real](class_real) **[`get_longest_axis_size`](#get_longest_axis_size)** **(** **)** - * [Vector3](class_vector3) **[`get_shortest_axis`](#get_shortest_axis)** **(** **)** - * [int](class_int) **[`get_shortest_axis_index`](#get_shortest_axis_index)** **(** **)** - * [real](class_real) **[`get_shortest_axis_size`](#get_shortest_axis_size)** **(** **)** - * [Vector3](class_vector3) **[`get_support`](#get_support)** **(** [Vector3](class_vector3) dir **)** - * [AABB](class_aabb) **[`grow`](#grow)** **(** [real](class_real) by **)** - * [bool](class_bool) **[`has_no_area`](#has_no_area)** **(** **)** - * [bool](class_bool) **[`has_no_surface`](#has_no_surface)** **(** **)** - * [bool](class_bool) **[`has_point`](#has_point)** **(** [Vector3](class_vector3) point **)** - * [AABB](class_aabb) **[`intersection`](#intersection)** **(** [AABB](class_aabb) with **)** - * [bool](class_bool) **[`intersects`](#intersects)** **(** [AABB](class_aabb) with **)** - * [bool](class_bool) **[`intersects_plane`](#intersects_plane)** **(** [Plane](class_plane) plane **)** - * [AABB](class_aabb) **[`merge`](#merge)** **(** [AABB](class_aabb) with **)** - * void **[`AABB`](#AABB)** **(** [Vector3](class_vector3) pos, [Vector3](class_vector3) size **)** + * [bool](class_bool) **[encloses](#encloses)** **(** [AABB](class_aabb) with **)** + * [AABB](class_aabb) **[expand](#expand)** **(** [Vector3](class_vector3) to_point **)** + * [real](class_real) **[get_area](#get_area)** **(** **)** + * [Vector3](class_vector3) **[get_endpoint](#get_endpoint)** **(** [int](class_int) idx **)** + * [Vector3](class_vector3) **[get_longest_axis](#get_longest_axis)** **(** **)** + * [int](class_int) **[get_longest_axis_index](#get_longest_axis_index)** **(** **)** + * [real](class_real) **[get_longest_axis_size](#get_longest_axis_size)** **(** **)** + * [Vector3](class_vector3) **[get_shortest_axis](#get_shortest_axis)** **(** **)** + * [int](class_int) **[get_shortest_axis_index](#get_shortest_axis_index)** **(** **)** + * [real](class_real) **[get_shortest_axis_size](#get_shortest_axis_size)** **(** **)** + * [Vector3](class_vector3) **[get_support](#get_support)** **(** [Vector3](class_vector3) dir **)** + * [AABB](class_aabb) **[grow](#grow)** **(** [real](class_real) by **)** + * [bool](class_bool) **[has_no_area](#has_no_area)** **(** **)** + * [bool](class_bool) **[has_no_surface](#has_no_surface)** **(** **)** + * [bool](class_bool) **[has_point](#has_point)** **(** [Vector3](class_vector3) point **)** + * [AABB](class_aabb) **[intersection](#intersection)** **(** [AABB](class_aabb) with **)** + * [bool](class_bool) **[intersects](#intersects)** **(** [AABB](class_aabb) with **)** + * [bool](class_bool) **[intersects_plane](#intersects_plane)** **(** [Plane](class_plane) plane **)** + * [AABB](class_aabb) **[merge](#merge)** **(** [AABB](class_aabb) with **)** + * void **[AABB](#AABB)** **(** [Vector3](class_vector3) pos, [Vector3](class_vector3) size **)** ### Member Variables * [Vector3](class_vector3) **pos** @@ -39,111 +39,111 @@ AABB provides an 3D Axis-Aligned Bounding Box. It consists of a ### Member Function Description #### encloses - * [bool](class_bool) **`encloses`** **(** [AABB](class_aabb) with **)** + * [bool](class_bool) **encloses** **(** [AABB](class_aabb) with **)** Return true if this [AABB](class_aabb) completely encloses another one. #### expand - * [AABB](class_aabb) **`expand`** **(** [Vector3](class_vector3) to_point **)** + * [AABB](class_aabb) **expand** **(** [Vector3](class_vector3) to_point **)** Return this [AABB](class_aabb) expanded to include a given point. #### get_area - * [real](class_real) **`get_area`** **(** **)** + * [real](class_real) **get_area** **(** **)** Get the area inside the [AABB](class_aabb) #### get_endpoint - * [Vector3](class_vector3) **`get_endpoint`** **(** [int](class_int) idx **)** + * [Vector3](class_vector3) **get_endpoint** **(** [int](class_int) idx **)** Get the position of the 8 endpoints of the [AABB](class_aabb) in space. #### get_longest_axis - * [Vector3](class_vector3) **`get_longest_axis`** **(** **)** + * [Vector3](class_vector3) **get_longest_axis** **(** **)** Return the normalized longest axis of the [AABB](class_aabb) #### get_longest_axis_index - * [int](class_int) **`get_longest_axis_index`** **(** **)** + * [int](class_int) **get_longest_axis_index** **(** **)** Return the index of the longest axis of the [AABB](class_aabb) (according to [Vector3](class_vector3)::AXIS* enum). #### get_longest_axis_size - * [real](class_real) **`get_longest_axis_size`** **(** **)** + * [real](class_real) **get_longest_axis_size** **(** **)** Return the scalar length of the longest axis of the [AABB](class_aabb). #### get_shortest_axis - * [Vector3](class_vector3) **`get_shortest_axis`** **(** **)** + * [Vector3](class_vector3) **get_shortest_axis** **(** **)** Return the normalized shortest axis of the [AABB](class_aabb) #### get_shortest_axis_index - * [int](class_int) **`get_shortest_axis_index`** **(** **)** + * [int](class_int) **get_shortest_axis_index** **(** **)** Return the index of the shortest axis of the [AABB](class_aabb) (according to [Vector3](class_vector3)::AXIS* enum). #### get_shortest_axis_size - * [real](class_real) **`get_shortest_axis_size`** **(** **)** + * [real](class_real) **get_shortest_axis_size** **(** **)** Return the scalar length of the shortest axis of the [AABB](class_aabb). #### get_support - * [Vector3](class_vector3) **`get_support`** **(** [Vector3](class_vector3) dir **)** + * [Vector3](class_vector3) **get_support** **(** [Vector3](class_vector3) dir **)** Return the support point in a given direction. This is useful for collision detection algorithms. #### grow - * [AABB](class_aabb) **`grow`** **(** [real](class_real) by **)** + * [AABB](class_aabb) **grow** **(** [real](class_real) by **)** Return a copy of the AABB grown a given a mount of units towards all the sides. #### has_no_area - * [bool](class_bool) **`has_no_area`** **(** **)** + * [bool](class_bool) **has_no_area** **(** **)** Return true if the [AABB](class_aabb) is flat or empty. #### has_no_surface - * [bool](class_bool) **`has_no_surface`** **(** **)** + * [bool](class_bool) **has_no_surface** **(** **)** Return true if the [AABB](class_aabb) is empty. #### has_point - * [bool](class_bool) **`has_point`** **(** [Vector3](class_vector3) point **)** + * [bool](class_bool) **has_point** **(** [Vector3](class_vector3) point **)** Return true if the [AABB](class_aabb) contains a point. #### intersection - * [AABB](class_aabb) **`intersection`** **(** [AABB](class_aabb) with **)** + * [AABB](class_aabb) **intersection** **(** [AABB](class_aabb) with **)** Return the intersection between two [AABB](class_aabb)s. An empty AABB (size 0,0,0) is returned on failure. #### intersects - * [bool](class_bool) **`intersects`** **(** [AABB](class_aabb) with **)** + * [bool](class_bool) **intersects** **(** [AABB](class_aabb) with **)** Return true if the [AABB](class_aabb) overlaps with another. #### intersects_plane - * [bool](class_bool) **`intersects_plane`** **(** [Plane](class_plane) plane **)** + * [bool](class_bool) **intersects_plane** **(** [Plane](class_plane) plane **)** Return true if the AABB is at both sides of a plane. #### merge - * [AABB](class_aabb) **`merge`** **(** [AABB](class_aabb) with **)** + * [AABB](class_aabb) **merge** **(** [AABB](class_aabb) with **)** Combine this [AABB](class_aabb) with another one, a larger one is returned that contains both. #### AABB - * void **`AABB`** **(** [Vector3](class_vector3) pos, [Vector3](class_vector3) size **)** + * void **AABB** **(** [Vector3](class_vector3) pos, [Vector3](class_vector3) size **)** Optional constructor, accepts position and size. diff --git a/class_acceptdialog.md b/class_acceptdialog.md index 1c363f9..9c17b60 100644 --- a/class_acceptdialog.md +++ b/class_acceptdialog.md @@ -6,19 +6,19 @@ Base dialog for user notification. ### Member Functions - * [Object](class_object) **[`get_ok`](#get_ok)** **(** **)** - * [Object](class_object) **[`get_label`](#get_label)** **(** **)** - * void **[`set_hide_on_ok`](#set_hide_on_ok)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`get_hide_on_ok`](#get_hide_on_ok)** **(** **)** const - * [Button](class_button) **[`add_button`](#add_button)** **(** [String](class_string) text="" **)** - * [Button](class_button) **[`add_cancel`](#add_cancel)** **(** [String](class_string) name **)** - * void **[`register_text_enter`](#register_text_enter)** **(** [Object](class_object) line_edit **)** - * void **[`set_text`](#set_text)** **(** [String](class_string) text **)** - * [String](class_string) **[`get_text`](#get_text)** **(** **)** const + * [Object](class_object) **[get_ok](#get_ok)** **(** **)** + * [Object](class_object) **[get_label](#get_label)** **(** **)** + * void **[set_hide_on_ok](#set_hide_on_ok)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[get_hide_on_ok](#get_hide_on_ok)** **(** **)** const + * [Button](class_button) **[add_button](#add_button)** **(** [String](class_string) text="" **)** + * [Button](class_button) **[add_cancel](#add_cancel)** **(** [String](class_string) name **)** + * void **[register_text_enter](#register_text_enter)** **(** [Object](class_object) line_edit **)** + * void **[set_text](#set_text)** **(** [String](class_string) text **)** + * [String](class_string) **[get_text](#get_text)** **(** **)** const ### Signals - * **`confirmed`** **(** **)** - * **`custom_action`** **(** [String](class_string) action **)** + * **confirmed** **(** **)** + * **custom_action** **(** [String](class_string) action **)** ### Description This dialog is useful for small notifications to the user about an @@ -27,39 +27,39 @@ This dialog is useful for small notifications to the user about an ### Member Function Description #### get_ok - * [Object](class_object) **`get_ok`** **(** **)** + * [Object](class_object) **get_ok** **(** **)** Return the OK Button. #### get_label - * [Object](class_object) **`get_label`** **(** **)** + * [Object](class_object) **get_label** **(** **)** Return the label used for built-in text. #### set_hide_on_ok - * void **`set_hide_on_ok`** **(** [bool](class_bool) enabled **)** + * void **set_hide_on_ok** **(** [bool](class_bool) enabled **)** Set whether the dialog is hidden when accepted (default true). #### get_hide_on_ok - * [bool](class_bool) **`get_hide_on_ok`** **(** **)** const + * [bool](class_bool) **get_hide_on_ok** **(** **)** const Return true if the dialog will be hidden when accepted (default true). #### register_text_enter - * void **`register_text_enter`** **(** [Object](class_object) line_edit **)** + * void **register_text_enter** **(** [Object](class_object) line_edit **)** Register a [LineEdit](class_lineedit) in the dialog. When the enter key is pressed, the dialog will be accepted. #### set_text - * void **`set_text`** **(** [String](class_string) text **)** + * void **set_text** **(** [String](class_string) text **)** Set the built-in label text. #### get_text - * [String](class_string) **`get_text`** **(** **)** const + * [String](class_string) **get_text** **(** **)** const Return the built-in label text. diff --git a/class_animatedsprite.md b/class_animatedsprite.md index 166efa0..1c7edcb 100644 --- a/class_animatedsprite.md +++ b/class_animatedsprite.md @@ -6,19 +6,19 @@ ### Member Functions - * void **[`set_sprite_frames`](#set_sprite_frames)** **(** [SpriteFrames](class_spriteframes) sprite_frames **)** - * [SpriteFrames](class_spriteframes) **[`get_sprite_frames`](#get_sprite_frames)** **(** **)** const - * void **[`set_centered`](#set_centered)** **(** [bool](class_bool) centered **)** - * [bool](class_bool) **[`is_centered`](#is_centered)** **(** **)** const - * void **[`set_offset`](#set_offset)** **(** [Vector2](class_vector2) offset **)** - * [Vector2](class_vector2) **[`get_offset`](#get_offset)** **(** **)** const - * void **[`set_flip_h`](#set_flip_h)** **(** [bool](class_bool) flip_h **)** - * [bool](class_bool) **[`is_flipped_h`](#is_flipped_h)** **(** **)** const - * void **[`set_flip_v`](#set_flip_v)** **(** [bool](class_bool) flip_v **)** - * [bool](class_bool) **[`is_flipped_v`](#is_flipped_v)** **(** **)** const - * void **[`set_frame`](#set_frame)** **(** [int](class_int) frame **)** - * [int](class_int) **[`get_frame`](#get_frame)** **(** **)** const - * void **[`set_modulate`](#set_modulate)** **(** [Color](class_color) modulate **)** - * [Color](class_color) **[`get_modulate`](#get_modulate)** **(** **)** const + * void **[set_sprite_frames](#set_sprite_frames)** **(** [SpriteFrames](class_spriteframes) sprite_frames **)** + * [SpriteFrames](class_spriteframes) **[get_sprite_frames](#get_sprite_frames)** **(** **)** const + * void **[set_centered](#set_centered)** **(** [bool](class_bool) centered **)** + * [bool](class_bool) **[is_centered](#is_centered)** **(** **)** const + * void **[set_offset](#set_offset)** **(** [Vector2](class_vector2) offset **)** + * [Vector2](class_vector2) **[get_offset](#get_offset)** **(** **)** const + * void **[set_flip_h](#set_flip_h)** **(** [bool](class_bool) flip_h **)** + * [bool](class_bool) **[is_flipped_h](#is_flipped_h)** **(** **)** const + * void **[set_flip_v](#set_flip_v)** **(** [bool](class_bool) flip_v **)** + * [bool](class_bool) **[is_flipped_v](#is_flipped_v)** **(** **)** const + * void **[set_frame](#set_frame)** **(** [int](class_int) frame **)** + * [int](class_int) **[get_frame](#get_frame)** **(** **)** const + * void **[set_modulate](#set_modulate)** **(** [Color](class_color) modulate **)** + * [Color](class_color) **[get_modulate](#get_modulate)** **(** **)** const ### Member Function Description diff --git a/class_animation.md b/class_animation.md index c4c530b..2847dc0 100644 --- a/class_animation.md +++ b/class_animation.md @@ -6,42 +6,42 @@ Contains data used to animate everything in the engine. ### Member Functions - * [int](class_int) **[`add_track`](#add_track)** **(** [int](class_int) type, [int](class_int) at_pos=-1 **)** - * void **[`remove_track`](#remove_track)** **(** [int](class_int) idx **)** - * [int](class_int) **[`get_track_count`](#get_track_count)** **(** **)** const - * [int](class_int) **[`track_get_type`](#track_get_type)** **(** [int](class_int) idx **)** const - * [NodePath](class_nodepath) **[`track_get_path`](#track_get_path)** **(** [int](class_int) idx **)** const - * void **[`track_set_path`](#track_set_path)** **(** [int](class_int) idx, [NodePath](class_nodepath) path **)** - * [int](class_int) **[`find_track`](#find_track)** **(** [NodePath](class_nodepath) path **)** const - * void **[`track_move_up`](#track_move_up)** **(** [int](class_int) idx **)** - * void **[`track_move_down`](#track_move_down)** **(** [int](class_int) idx **)** - * [int](class_int) **[`transform_track_insert_key`](#transform_track_insert_key)** **(** [int](class_int) idx, [real](class_real) time, [Vector3](class_vector3) loc, [Quat](class_quat) rot, [Vector3](class_vector3) scale **)** - * void **[`track_insert_key`](#track_insert_key)** **(** [int](class_int) idx, [real](class_real) time, var key, [real](class_real) transition=1 **)** - * void **[`track_remove_key`](#track_remove_key)** **(** [int](class_int) idx, [int](class_int) key_idx **)** - * void **[`track_remove_key_at_pos`](#track_remove_key_at_pos)** **(** [int](class_int) idx, [real](class_real) pos **)** - * void **[`track_set_key_value`](#track_set_key_value)** **(** [int](class_int) idx, [int](class_int) key, var value **)** - * void **[`track_set_key_transition`](#track_set_key_transition)** **(** [int](class_int) idx, [int](class_int) key_idx, [real](class_real) transition **)** - * [real](class_real) **[`track_get_key_transition`](#track_get_key_transition)** **(** [int](class_int) idx, [int](class_int) key_idx **)** const - * [int](class_int) **[`track_get_key_count`](#track_get_key_count)** **(** [int](class_int) idx **)** const - * void **[`track_get_key_value`](#track_get_key_value)** **(** [int](class_int) idx, [int](class_int) key_idx **)** const - * [real](class_real) **[`track_get_key_time`](#track_get_key_time)** **(** [int](class_int) idx, [int](class_int) key_idx **)** const - * [int](class_int) **[`track_find_key`](#track_find_key)** **(** [int](class_int) idx, [real](class_real) time, [bool](class_bool) exact=false **)** const - * void **[`track_set_interpolation_type`](#track_set_interpolation_type)** **(** [int](class_int) idx, [int](class_int) interpolation **)** - * [int](class_int) **[`track_get_interpolation_type`](#track_get_interpolation_type)** **(** [int](class_int) idx **)** const - * [Array](class_array) **[`transform_track_interpolate`](#transform_track_interpolate)** **(** [int](class_int) idx, [real](class_real) time_sec **)** const - * void **[`value_track_set_continuous`](#value_track_set_continuous)** **(** [int](class_int) idx, [bool](class_bool) continuous **)** - * [bool](class_bool) **[`value_track_is_continuous`](#value_track_is_continuous)** **(** [int](class_int) idx **)** const - * [IntArray](class_intarray) **[`value_track_get_key_indices`](#value_track_get_key_indices)** **(** [int](class_int) idx, [real](class_real) time_sec, [real](class_real) delta **)** const - * [IntArray](class_intarray) **[`method_track_get_key_indices`](#method_track_get_key_indices)** **(** [int](class_int) idx, [real](class_real) time_sec, [real](class_real) delta **)** const - * [String](class_string) **[`method_track_get_name`](#method_track_get_name)** **(** [int](class_int) idx, [int](class_int) key_idx **)** const - * [Array](class_array) **[`method_track_get_params`](#method_track_get_params)** **(** [int](class_int) idx, [int](class_int) key_idx **)** const - * void **[`set_length`](#set_length)** **(** [real](class_real) time_sec **)** - * [real](class_real) **[`get_length`](#get_length)** **(** **)** const - * void **[`set_loop`](#set_loop)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`has_loop`](#has_loop)** **(** **)** const - * void **[`set_step`](#set_step)** **(** [real](class_real) size_sec **)** - * [real](class_real) **[`get_step`](#get_step)** **(** **)** const - * void **[`clear`](#clear)** **(** **)** + * [int](class_int) **[add_track](#add_track)** **(** [int](class_int) type, [int](class_int) at_pos=-1 **)** + * void **[remove_track](#remove_track)** **(** [int](class_int) idx **)** + * [int](class_int) **[get_track_count](#get_track_count)** **(** **)** const + * [int](class_int) **[track_get_type](#track_get_type)** **(** [int](class_int) idx **)** const + * [NodePath](class_nodepath) **[track_get_path](#track_get_path)** **(** [int](class_int) idx **)** const + * void **[track_set_path](#track_set_path)** **(** [int](class_int) idx, [NodePath](class_nodepath) path **)** + * [int](class_int) **[find_track](#find_track)** **(** [NodePath](class_nodepath) path **)** const + * void **[track_move_up](#track_move_up)** **(** [int](class_int) idx **)** + * void **[track_move_down](#track_move_down)** **(** [int](class_int) idx **)** + * [int](class_int) **[transform_track_insert_key](#transform_track_insert_key)** **(** [int](class_int) idx, [real](class_real) time, [Vector3](class_vector3) loc, [Quat](class_quat) rot, [Vector3](class_vector3) scale **)** + * void **[track_insert_key](#track_insert_key)** **(** [int](class_int) idx, [real](class_real) time, var key, [real](class_real) transition=1 **)** + * void **[track_remove_key](#track_remove_key)** **(** [int](class_int) idx, [int](class_int) key_idx **)** + * void **[track_remove_key_at_pos](#track_remove_key_at_pos)** **(** [int](class_int) idx, [real](class_real) pos **)** + * void **[track_set_key_value](#track_set_key_value)** **(** [int](class_int) idx, [int](class_int) key, var value **)** + * void **[track_set_key_transition](#track_set_key_transition)** **(** [int](class_int) idx, [int](class_int) key_idx, [real](class_real) transition **)** + * [real](class_real) **[track_get_key_transition](#track_get_key_transition)** **(** [int](class_int) idx, [int](class_int) key_idx **)** const + * [int](class_int) **[track_get_key_count](#track_get_key_count)** **(** [int](class_int) idx **)** const + * void **[track_get_key_value](#track_get_key_value)** **(** [int](class_int) idx, [int](class_int) key_idx **)** const + * [real](class_real) **[track_get_key_time](#track_get_key_time)** **(** [int](class_int) idx, [int](class_int) key_idx **)** const + * [int](class_int) **[track_find_key](#track_find_key)** **(** [int](class_int) idx, [real](class_real) time, [bool](class_bool) exact=false **)** const + * void **[track_set_interpolation_type](#track_set_interpolation_type)** **(** [int](class_int) idx, [int](class_int) interpolation **)** + * [int](class_int) **[track_get_interpolation_type](#track_get_interpolation_type)** **(** [int](class_int) idx **)** const + * [Array](class_array) **[transform_track_interpolate](#transform_track_interpolate)** **(** [int](class_int) idx, [real](class_real) time_sec **)** const + * void **[value_track_set_continuous](#value_track_set_continuous)** **(** [int](class_int) idx, [bool](class_bool) continuous **)** + * [bool](class_bool) **[value_track_is_continuous](#value_track_is_continuous)** **(** [int](class_int) idx **)** const + * [IntArray](class_intarray) **[value_track_get_key_indices](#value_track_get_key_indices)** **(** [int](class_int) idx, [real](class_real) time_sec, [real](class_real) delta **)** const + * [IntArray](class_intarray) **[method_track_get_key_indices](#method_track_get_key_indices)** **(** [int](class_int) idx, [real](class_real) time_sec, [real](class_real) delta **)** const + * [String](class_string) **[method_track_get_name](#method_track_get_name)** **(** [int](class_int) idx, [int](class_int) key_idx **)** const + * [Array](class_array) **[method_track_get_params](#method_track_get_params)** **(** [int](class_int) idx, [int](class_int) key_idx **)** const + * void **[set_length](#set_length)** **(** [real](class_real) time_sec **)** + * [real](class_real) **[get_length](#get_length)** **(** **)** const + * void **[set_loop](#set_loop)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[has_loop](#has_loop)** **(** **)** const + * void **[set_step](#set_step)** **(** [real](class_real) size_sec **)** + * [real](class_real) **[get_step](#get_step)** **(** **)** const + * void **[clear](#clear)** **(** **)** ### Numeric Constants * **TYPE_VALUE** = **0** - Value tracks set values in node properties, but only those which can be Interpolated. @@ -58,168 +58,168 @@ An Animation resource contains data used to animate everything in the engine. An ### Member Function Description #### add_track - * [int](class_int) **`add_track`** **(** [int](class_int) type, [int](class_int) at_pos=-1 **)** + * [int](class_int) **add_track** **(** [int](class_int) type, [int](class_int) at_pos=-1 **)** Add a track to the Animation. The track type must be specified as any of the values in te TYPE_* enumeration. #### remove_track - * void **`remove_track`** **(** [int](class_int) idx **)** + * void **remove_track** **(** [int](class_int) idx **)** Remove a track by specifying the track index. #### get_track_count - * [int](class_int) **`get_track_count`** **(** **)** const + * [int](class_int) **get_track_count** **(** **)** const Return the amount of tracks in the animation. #### track_get_type - * [int](class_int) **`track_get_type`** **(** [int](class_int) idx **)** const + * [int](class_int) **track_get_type** **(** [int](class_int) idx **)** const Get the type of a track. #### track_get_path - * [NodePath](class_nodepath) **`track_get_path`** **(** [int](class_int) idx **)** const + * [NodePath](class_nodepath) **track_get_path** **(** [int](class_int) idx **)** const -Get the path of a track. for more information on the path format, see [`track_set_path`](#track_set_path) +Get the path of a track. for more information on the path format, see [track_set_path](#track_set_path) #### track_set_path - * void **`track_set_path`** **(** [int](class_int) idx, [NodePath](class_nodepath) path **)** + * void **track_set_path** **(** [int](class_int) idx, [NodePath](class_nodepath) path **)** Set the path of a track. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by ":". Example: "character/skeleton:ankle" or "character/mesh:transform/local" #### track_move_up - * void **`track_move_up`** **(** [int](class_int) idx **)** + * void **track_move_up** **(** [int](class_int) idx **)** Move a track up. #### track_move_down - * void **`track_move_down`** **(** [int](class_int) idx **)** + * void **track_move_down** **(** [int](class_int) idx **)** Nove a track down. #### transform_track_insert_key - * [int](class_int) **`transform_track_insert_key`** **(** [int](class_int) idx, [real](class_real) time, [Vector3](class_vector3) loc, [Quat](class_quat) rot, [Vector3](class_vector3) scale **)** + * [int](class_int) **transform_track_insert_key** **(** [int](class_int) idx, [real](class_real) time, [Vector3](class_vector3) loc, [Quat](class_quat) rot, [Vector3](class_vector3) scale **)** Insert a transform key for a transform track. #### track_insert_key - * void **`track_insert_key`** **(** [int](class_int) idx, [real](class_real) time, var key, [real](class_real) transition=1 **)** + * void **track_insert_key** **(** [int](class_int) idx, [real](class_real) time, var key, [real](class_real) transition=1 **)** Insert a generic key in a given track. #### track_remove_key - * void **`track_remove_key`** **(** [int](class_int) idx, [int](class_int) key_idx **)** + * void **track_remove_key** **(** [int](class_int) idx, [int](class_int) key_idx **)** Remove a key by index in a given track. #### track_remove_key_at_pos - * void **`track_remove_key_at_pos`** **(** [int](class_int) idx, [real](class_real) pos **)** + * void **track_remove_key_at_pos** **(** [int](class_int) idx, [real](class_real) pos **)** Remove a key by position (seconds) in a given track. #### track_set_key_value - * void **`track_set_key_value`** **(** [int](class_int) idx, [int](class_int) key, var value **)** + * void **track_set_key_value** **(** [int](class_int) idx, [int](class_int) key, var value **)** Set the value of an existing key. #### track_set_key_transition - * void **`track_set_key_transition`** **(** [int](class_int) idx, [int](class_int) key_idx, [real](class_real) transition **)** + * void **track_set_key_transition** **(** [int](class_int) idx, [int](class_int) key_idx, [real](class_real) transition **)** Set the transition curve (easing) for a specific key (see built-in math function "ease"). #### track_get_key_transition - * [real](class_real) **`track_get_key_transition`** **(** [int](class_int) idx, [int](class_int) key_idx **)** const + * [real](class_real) **track_get_key_transition** **(** [int](class_int) idx, [int](class_int) key_idx **)** const Return the transition curve (easing) for a specific key (see built-in math function "ease"). #### track_get_key_count - * [int](class_int) **`track_get_key_count`** **(** [int](class_int) idx **)** const + * [int](class_int) **track_get_key_count** **(** [int](class_int) idx **)** const Return the amount of keys in a given track. #### track_get_key_value - * void **`track_get_key_value`** **(** [int](class_int) idx, [int](class_int) key_idx **)** const + * void **track_get_key_value** **(** [int](class_int) idx, [int](class_int) key_idx **)** const Return the value of a given key in a given track. #### track_get_key_time - * [real](class_real) **`track_get_key_time`** **(** [int](class_int) idx, [int](class_int) key_idx **)** const + * [real](class_real) **track_get_key_time** **(** [int](class_int) idx, [int](class_int) key_idx **)** const Return the time at which the key is located. #### track_find_key - * [int](class_int) **`track_find_key`** **(** [int](class_int) idx, [real](class_real) time, [bool](class_bool) exact=false **)** const + * [int](class_int) **track_find_key** **(** [int](class_int) idx, [real](class_real) time, [bool](class_bool) exact=false **)** const Find the key index by time in a given track. Optionally, only find it if the exact time is given. #### track_set_interpolation_type - * void **`track_set_interpolation_type`** **(** [int](class_int) idx, [int](class_int) interpolation **)** + * void **track_set_interpolation_type** **(** [int](class_int) idx, [int](class_int) interpolation **)** Set the interpolation type of a given track, from the INTERPOLATION_* enum. #### track_get_interpolation_type - * [int](class_int) **`track_get_interpolation_type`** **(** [int](class_int) idx **)** const + * [int](class_int) **track_get_interpolation_type** **(** [int](class_int) idx **)** const Return the interpolation type of a given track, from the INTERPOLATION_* enum. #### transform_track_interpolate - * [Array](class_array) **`transform_track_interpolate`** **(** [int](class_int) idx, [real](class_real) time_sec **)** const + * [Array](class_array) **transform_track_interpolate** **(** [int](class_int) idx, [real](class_real) time_sec **)** const Return the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position ([Vector3](class_vector3)), rotation ([Quat](class_quat)) and scale ([Vector3](class_vector3)). #### value_track_set_continuous - * void **`value_track_set_continuous`** **(** [int](class_int) idx, [bool](class_bool) continuous **)** + * void **value_track_set_continuous** **(** [int](class_int) idx, [bool](class_bool) continuous **)** Enable or disable interpolation for a whole track. By default tracks are interpolated. #### value_track_is_continuous - * [bool](class_bool) **`value_track_is_continuous`** **(** [int](class_int) idx **)** const + * [bool](class_bool) **value_track_is_continuous** **(** [int](class_int) idx **)** const Return wether interpolation is enabled or disabled for a whole track. By default tracks are interpolated. #### value_track_get_key_indices - * [IntArray](class_intarray) **`value_track_get_key_indices`** **(** [int](class_int) idx, [real](class_real) time_sec, [real](class_real) delta **)** const + * [IntArray](class_intarray) **value_track_get_key_indices** **(** [int](class_int) idx, [real](class_real) time_sec, [real](class_real) delta **)** const Return all the key indices of a value track, given a position and delta time. #### method_track_get_key_indices - * [IntArray](class_intarray) **`method_track_get_key_indices`** **(** [int](class_int) idx, [real](class_real) time_sec, [real](class_real) delta **)** const + * [IntArray](class_intarray) **method_track_get_key_indices** **(** [int](class_int) idx, [real](class_real) time_sec, [real](class_real) delta **)** const Return all the key indices of a method track, given a position and delta time. #### method_track_get_name - * [String](class_string) **`method_track_get_name`** **(** [int](class_int) idx, [int](class_int) key_idx **)** const + * [String](class_string) **method_track_get_name** **(** [int](class_int) idx, [int](class_int) key_idx **)** const Return the method name of a method track. #### method_track_get_params - * [Array](class_array) **`method_track_get_params`** **(** [int](class_int) idx, [int](class_int) key_idx **)** const + * [Array](class_array) **method_track_get_params** **(** [int](class_int) idx, [int](class_int) key_idx **)** const Return the arguments values to be called on a method track for a given key in a given track. #### set_length - * void **`set_length`** **(** [real](class_real) time_sec **)** + * void **set_length** **(** [real](class_real) time_sec **)** Set the total length of the animation (in seconds). Note that length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping. #### get_length - * [real](class_real) **`get_length`** **(** **)** const + * [real](class_real) **get_length** **(** **)** const Return the total length of the animation (in seconds). #### set_loop - * void **`set_loop`** **(** [bool](class_bool) enabled **)** + * void **set_loop** **(** [bool](class_bool) enabled **)** Set a flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation. #### has_loop - * [bool](class_bool) **`has_loop`** **(** **)** const + * [bool](class_bool) **has_loop** **(** **)** const Return wether the animation has the loop flag set. #### clear - * void **`clear`** **(** **)** + * void **clear** **(** **)** Clear the animation (clear all tracks and reset all). diff --git a/class_animationplayer.md b/class_animationplayer.md index 3b3c7ed..6dbb763 100644 --- a/class_animationplayer.md +++ b/class_animationplayer.md @@ -6,44 +6,44 @@ Container and player of [Animaton] resources. ### Member Functions - * [int](class_int) **[`add_animation`](#add_animation)** **(** [String](class_string) name, [Animation](class_animation) animation **)** - * void **[`remove_animation`](#remove_animation)** **(** [String](class_string) name **)** - * void **[`rename_animation`](#rename_animation)** **(** [String](class_string) name, [String](class_string) newname **)** - * [bool](class_bool) **[`has_animation`](#has_animation)** **(** [String](class_string) name **)** const - * [Animation](class_animation) **[`get_animation`](#get_animation)** **(** [String](class_string) name **)** const - * [StringArray](class_stringarray) **[`get_animation_list`](#get_animation_list)** **(** **)** const - * void **[`set_blend_time`](#set_blend_time)** **(** [String](class_string) anim_from, [String](class_string) anim_to, [real](class_real) sec **)** - * [real](class_real) **[`get_blend_time`](#get_blend_time)** **(** [String](class_string) anim_from, [String](class_string) anim_to **)** const - * void **[`set_default_blend_time`](#set_default_blend_time)** **(** [real](class_real) sec **)** - * [real](class_real) **[`get_default_blend_time`](#get_default_blend_time)** **(** **)** const - * void **[`play`](#play)** **(** [String](class_string) name="", [real](class_real) custom_blend=-1, [real](class_real) custom_speed=1, [bool](class_bool) from_end=false **)** - * void **[`stop`](#stop)** **(** **)** - * void **[`stop_all`](#stop_all)** **(** **)** - * [bool](class_bool) **[`is_playing`](#is_playing)** **(** **)** const - * void **[`set_current_animation`](#set_current_animation)** **(** [String](class_string) anim **)** - * [String](class_string) **[`get_current_animation`](#get_current_animation)** **(** **)** const - * void **[`queue`](#queue)** **(** [String](class_string) name **)** - * void **[`clear_queue`](#clear_queue)** **(** **)** - * void **[`set_active`](#set_active)** **(** [bool](class_bool) active **)** - * [bool](class_bool) **[`is_active`](#is_active)** **(** **)** const - * void **[`set_speed`](#set_speed)** **(** [real](class_real) speed **)** - * [real](class_real) **[`get_speed`](#get_speed)** **(** **)** const - * void **[`set_autoplay`](#set_autoplay)** **(** [String](class_string) name **)** - * [String](class_string) **[`get_autoplay`](#get_autoplay)** **(** **)** const - * void **[`set_root`](#set_root)** **(** [NodePath](class_nodepath) path **)** - * [NodePath](class_nodepath) **[`get_root`](#get_root)** **(** **)** const - * void **[`seek`](#seek)** **(** [real](class_real) pos_sec, [bool](class_bool) update=false **)** - * [real](class_real) **[`get_pos`](#get_pos)** **(** **)** const - * [String](class_string) **[`find_animation`](#find_animation)** **(** [Animation](class_animation) animation **)** const - * void **[`clear_caches`](#clear_caches)** **(** **)** - * void **[`set_animation_process_mode`](#set_animation_process_mode)** **(** [int](class_int) mode **)** - * [int](class_int) **[`get_animation_process_mode`](#get_animation_process_mode)** **(** **)** const - * [real](class_real) **[`get_current_animation_pos`](#get_current_animation_pos)** **(** **)** const - * [real](class_real) **[`get_current_animation_length`](#get_current_animation_length)** **(** **)** const + * [int](class_int) **[add_animation](#add_animation)** **(** [String](class_string) name, [Animation](class_animation) animation **)** + * void **[remove_animation](#remove_animation)** **(** [String](class_string) name **)** + * void **[rename_animation](#rename_animation)** **(** [String](class_string) name, [String](class_string) newname **)** + * [bool](class_bool) **[has_animation](#has_animation)** **(** [String](class_string) name **)** const + * [Animation](class_animation) **[get_animation](#get_animation)** **(** [String](class_string) name **)** const + * [StringArray](class_stringarray) **[get_animation_list](#get_animation_list)** **(** **)** const + * void **[set_blend_time](#set_blend_time)** **(** [String](class_string) anim_from, [String](class_string) anim_to, [real](class_real) sec **)** + * [real](class_real) **[get_blend_time](#get_blend_time)** **(** [String](class_string) anim_from, [String](class_string) anim_to **)** const + * void **[set_default_blend_time](#set_default_blend_time)** **(** [real](class_real) sec **)** + * [real](class_real) **[get_default_blend_time](#get_default_blend_time)** **(** **)** const + * void **[play](#play)** **(** [String](class_string) name="", [real](class_real) custom_blend=-1, [real](class_real) custom_speed=1, [bool](class_bool) from_end=false **)** + * void **[stop](#stop)** **(** **)** + * void **[stop_all](#stop_all)** **(** **)** + * [bool](class_bool) **[is_playing](#is_playing)** **(** **)** const + * void **[set_current_animation](#set_current_animation)** **(** [String](class_string) anim **)** + * [String](class_string) **[get_current_animation](#get_current_animation)** **(** **)** const + * void **[queue](#queue)** **(** [String](class_string) name **)** + * void **[clear_queue](#clear_queue)** **(** **)** + * void **[set_active](#set_active)** **(** [bool](class_bool) active **)** + * [bool](class_bool) **[is_active](#is_active)** **(** **)** const + * void **[set_speed](#set_speed)** **(** [real](class_real) speed **)** + * [real](class_real) **[get_speed](#get_speed)** **(** **)** const + * void **[set_autoplay](#set_autoplay)** **(** [String](class_string) name **)** + * [String](class_string) **[get_autoplay](#get_autoplay)** **(** **)** const + * void **[set_root](#set_root)** **(** [NodePath](class_nodepath) path **)** + * [NodePath](class_nodepath) **[get_root](#get_root)** **(** **)** const + * void **[seek](#seek)** **(** [real](class_real) pos_sec, [bool](class_bool) update=false **)** + * [real](class_real) **[get_pos](#get_pos)** **(** **)** const + * [String](class_string) **[find_animation](#find_animation)** **(** [Animation](class_animation) animation **)** const + * void **[clear_caches](#clear_caches)** **(** **)** + * void **[set_animation_process_mode](#set_animation_process_mode)** **(** [int](class_int) mode **)** + * [int](class_int) **[get_animation_process_mode](#get_animation_process_mode)** **(** **)** const + * [real](class_real) **[get_current_animation_pos](#get_current_animation_pos)** **(** **)** const + * [real](class_real) **[get_current_animation_length](#get_current_animation_length)** **(** **)** const ### Signals - * **`animation_changed`** **(** [String](class_string) old_name, [String](class_string) new_name **)** - * **`finished`** **(** **)** + * **animation_changed** **(** [String](class_string) old_name, [String](class_string) new_name **)** + * **finished** **(** **)** ### Numeric Constants * **ANIMATION_PROCESS_FIXED** = **0** @@ -55,136 +55,136 @@ An animation player is used for general purpose playback of [Animation](class_an ### Member Function Description #### add_animation - * [int](class_int) **`add_animation`** **(** [String](class_string) name, [Animation](class_animation) animation **)** + * [int](class_int) **add_animation** **(** [String](class_string) name, [Animation](class_animation) animation **)** Add an animation resource to the player, which will be later referenced by the "name" arguemnt. #### remove_animation - * void **`remove_animation`** **(** [String](class_string) name **)** + * void **remove_animation** **(** [String](class_string) name **)** Remove an animation from the player (by supplying the same name used to add it). #### rename_animation - * void **`rename_animation`** **(** [String](class_string) name, [String](class_string) newname **)** + * void **rename_animation** **(** [String](class_string) name, [String](class_string) newname **)** Rename an existing animation. #### has_animation - * [bool](class_bool) **`has_animation`** **(** [String](class_string) name **)** const + * [bool](class_bool) **has_animation** **(** [String](class_string) name **)** const Request wether an [Animation](class_animation) name exist within the player. #### get_animation - * [Animation](class_animation) **`get_animation`** **(** [String](class_string) name **)** const + * [Animation](class_animation) **get_animation** **(** [String](class_string) name **)** const Get an [Animation](class_animation) resource by requesting a name. #### get_animation_list - * [StringArray](class_stringarray) **`get_animation_list`** **(** **)** const + * [StringArray](class_stringarray) **get_animation_list** **(** **)** const Get the list of names of the animations stored in the player. #### set_blend_time - * void **`set_blend_time`** **(** [String](class_string) anim_from, [String](class_string) anim_to, [real](class_real) sec **)** + * void **set_blend_time** **(** [String](class_string) anim_from, [String](class_string) anim_to, [real](class_real) sec **)** Specify a blend time (in seconds) between two animations, referemced by their names. #### get_blend_time - * [real](class_real) **`get_blend_time`** **(** [String](class_string) anim_from, [String](class_string) anim_to **)** const + * [real](class_real) **get_blend_time** **(** [String](class_string) anim_from, [String](class_string) anim_to **)** const Get the blend time between two animations, referemced by their names. #### set_default_blend_time - * void **`set_default_blend_time`** **(** [real](class_real) sec **)** + * void **set_default_blend_time** **(** [real](class_real) sec **)** Set the default blend time between animations. #### get_default_blend_time - * [real](class_real) **`get_default_blend_time`** **(** **)** const + * [real](class_real) **get_default_blend_time** **(** **)** const Return the default blend time between animations. #### stop_all - * void **`stop_all`** **(** **)** + * void **stop_all** **(** **)** Stop playback on all animation channels. #### is_playing - * [bool](class_bool) **`is_playing`** **(** **)** const + * [bool](class_bool) **is_playing** **(** **)** const Return wether an animation chanel is playing (or channel 0 if none is provided). #### set_current_animation - * void **`set_current_animation`** **(** [String](class_string) anim **)** + * void **set_current_animation** **(** [String](class_string) anim **)** Set the current animation (even if no playback occurs). Using set_current_animation() and set_active() are similar to claling play(). #### get_current_animation - * [String](class_string) **`get_current_animation`** **(** **)** const + * [String](class_string) **get_current_animation** **(** **)** const Return the name of the animation being played in a channel (or channel 0 if none is provided). #### queue - * void **`queue`** **(** [String](class_string) name **)** + * void **queue** **(** [String](class_string) name **)** Queue an animation for playback once the current one is done. #### set_active - * void **`set_active`** **(** [bool](class_bool) active **)** + * void **set_active** **(** [bool](class_bool) active **)** Set the player as active (playing) #### is_active - * [bool](class_bool) **`is_active`** **(** **)** const + * [bool](class_bool) **is_active** **(** **)** const Return true if the player is active. #### set_speed - * void **`set_speed`** **(** [real](class_real) speed **)** + * void **set_speed** **(** [real](class_real) speed **)** Set a speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is _1_ (no scaling). #### get_speed - * [real](class_real) **`get_speed`** **(** **)** const + * [real](class_real) **get_speed** **(** **)** const Get the speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is _1_ (no scaling). #### set_autoplay - * void **`set_autoplay`** **(** [String](class_string) name **)** + * void **set_autoplay** **(** [String](class_string) name **)** Set the name of the animation that will be automatically played when the scene is loaded. #### get_autoplay - * [String](class_string) **`get_autoplay`** **(** **)** const + * [String](class_string) **get_autoplay** **(** **)** const Return the name of the animation that will be automatically played when the scene is loaded. #### seek - * void **`seek`** **(** [real](class_real) pos_sec, [bool](class_bool) update=false **)** + * void **seek** **(** [real](class_real) pos_sec, [bool](class_bool) update=false **)** Seek the animation in an animation channel (or channel 0 if none is provided) to a specific position (in seconds). #### get_pos - * [real](class_real) **`get_pos`** **(** **)** const + * [real](class_real) **get_pos** **(** **)** const Return the playback position (in seconds) in an animation channel (or channel 0 if none is provided) #### find_animation - * [String](class_string) **`find_animation`** **(** [Animation](class_animation) animation **)** const + * [String](class_string) **find_animation** **(** [Animation](class_animation) animation **)** const Find an animation name by resource. #### clear_caches - * void **`clear_caches`** **(** **)** + * void **clear_caches** **(** **)** The animation player creates caches for faster access to the nodes it will animate. However, if a specific node is removed, it may not notice it, so clear_caches will force the player to search for the nodes again. #### set_animation_process_mode - * void **`set_animation_process_mode`** **(** [int](class_int) mode **)** + * void **set_animation_process_mode** **(** [int](class_int) mode **)** Set the mode in which the animation player processes. By default, it processes on idle time (framerate dependent), but using fixed time works well for animating static collision bodies in 2D and 3D. See enum ANIMATION_PROCESS_*. #### get_animation_process_mode - * [int](class_int) **`get_animation_process_mode`** **(** **)** const + * [int](class_int) **get_animation_process_mode** **(** **)** const -Return the mode in which the animation player processes. See [`set_animation_process_mode`](#set_animation_process_mode). +Return the mode in which the animation player processes. See [set_animation_process_mode](#set_animation_process_mode). diff --git a/class_animationtreeplayer.md b/class_animationtreeplayer.md index 6c27d26..eb89cee 100644 --- a/class_animationtreeplayer.md +++ b/class_animationtreeplayer.md @@ -6,64 +6,64 @@ ### Member Functions - * void **[`add_node`](#add_node)** **(** [int](class_int) type, [String](class_string) id **)** - * [bool](class_bool) **[`node_exists`](#node_exists)** **(** [String](class_string) node **)** const - * [int](class_int) **[`node_rename`](#node_rename)** **(** [String](class_string) node, [String](class_string) new_name **)** - * [int](class_int) **[`node_get_type`](#node_get_type)** **(** [String](class_string) id **)** const - * [int](class_int) **[`node_get_input_count`](#node_get_input_count)** **(** [String](class_string) id **)** const - * [String](class_string) **[`node_get_input_sourcre`](#node_get_input_sourcre)** **(** [String](class_string) id, [int](class_int) idx **)** const - * void **[`animation_node_set_animation`](#animation_node_set_animation)** **(** [String](class_string) id, [Animation](class_animation) animation **)** - * [Animation](class_animation) **[`animation_node_get_animation`](#animation_node_get_animation)** **(** [String](class_string) id **)** const - * void **[`animation_node_set_master_animation`](#animation_node_set_master_animation)** **(** [String](class_string) id, [String](class_string) source **)** - * [String](class_string) **[`animation_node_get_master_animation`](#animation_node_get_master_animation)** **(** [String](class_string) id **)** const - * void **[`oneshot_node_set_fadein_time`](#oneshot_node_set_fadein_time)** **(** [String](class_string) id, [real](class_real) time_sec **)** - * [real](class_real) **[`oneshot_node_get_fadein_time`](#oneshot_node_get_fadein_time)** **(** [String](class_string) id **)** const - * void **[`oneshot_node_set_fadeout_time`](#oneshot_node_set_fadeout_time)** **(** [String](class_string) id, [real](class_real) time_sec **)** - * [real](class_real) **[`oneshot_node_get_fadeout_time`](#oneshot_node_get_fadeout_time)** **(** [String](class_string) id **)** const - * void **[`oneshot_node_set_autorestart`](#oneshot_node_set_autorestart)** **(** [String](class_string) id, [bool](class_bool) enable **)** - * void **[`oneshot_node_set_autorestart_delay`](#oneshot_node_set_autorestart_delay)** **(** [String](class_string) id, [real](class_real) delay_sec **)** - * void **[`oneshot_node_set_autorestart_random_delay`](#oneshot_node_set_autorestart_random_delay)** **(** [String](class_string) id, [real](class_real) rand_sec **)** - * [bool](class_bool) **[`oneshot_node_has_autorestart`](#oneshot_node_has_autorestart)** **(** [String](class_string) id **)** const - * [real](class_real) **[`oneshot_node_get_autorestart_delay`](#oneshot_node_get_autorestart_delay)** **(** [String](class_string) id **)** const - * [real](class_real) **[`oneshot_node_get_autorestart_random_delay`](#oneshot_node_get_autorestart_random_delay)** **(** [String](class_string) id **)** const - * void **[`oneshot_node_start`](#oneshot_node_start)** **(** [String](class_string) id **)** - * void **[`oneshot_node_stop`](#oneshot_node_stop)** **(** [String](class_string) id **)** - * [bool](class_bool) **[`oneshot_node_is_active`](#oneshot_node_is_active)** **(** [String](class_string) id **)** const - * void **[`oneshot_node_set_filter_path`](#oneshot_node_set_filter_path)** **(** [String](class_string) id, [NodePath](class_nodepath) path, [bool](class_bool) enable **)** - * void **[`mix_node_set_amount`](#mix_node_set_amount)** **(** [String](class_string) id, [real](class_real) ratio **)** - * [real](class_real) **[`mix_node_get_amount`](#mix_node_get_amount)** **(** [String](class_string) id **)** const - * void **[`blend2_node_set_amount`](#blend2_node_set_amount)** **(** [String](class_string) id, [real](class_real) blend **)** - * [real](class_real) **[`blend2_node_get_amount`](#blend2_node_get_amount)** **(** [String](class_string) id **)** const - * void **[`blend2_node_set_filter_path`](#blend2_node_set_filter_path)** **(** [String](class_string) id, [NodePath](class_nodepath) path, [bool](class_bool) enable **)** - * void **[`blend3_node_set_amount`](#blend3_node_set_amount)** **(** [String](class_string) id, [real](class_real) blend **)** - * [real](class_real) **[`blend3_node_get_amount`](#blend3_node_get_amount)** **(** [String](class_string) id **)** const - * void **[`blend4_node_set_amount`](#blend4_node_set_amount)** **(** [String](class_string) id, [Vector2](class_vector2) blend **)** - * [Vector2](class_vector2) **[`blend4_node_get_amount`](#blend4_node_get_amount)** **(** [String](class_string) id **)** const - * void **[`timescale_node_set_scale`](#timescale_node_set_scale)** **(** [String](class_string) id, [real](class_real) scale **)** - * [real](class_real) **[`timescale_node_get_scale`](#timescale_node_get_scale)** **(** [String](class_string) id **)** const - * void **[`timeseek_node_seek`](#timeseek_node_seek)** **(** [String](class_string) id, [real](class_real) pos_sec **)** - * void **[`transition_node_set_input_count`](#transition_node_set_input_count)** **(** [String](class_string) id, [int](class_int) count **)** - * [int](class_int) **[`transition_node_get_input_count`](#transition_node_get_input_count)** **(** [String](class_string) id **)** const - * void **[`transition_node_delete_input`](#transition_node_delete_input)** **(** [String](class_string) id, [int](class_int) input_idx **)** - * void **[`transition_node_set_input_auto_advance`](#transition_node_set_input_auto_advance)** **(** [String](class_string) id, [int](class_int) input_idx, [bool](class_bool) enable **)** - * [bool](class_bool) **[`transition_node_has_input_auto_advance`](#transition_node_has_input_auto_advance)** **(** [String](class_string) id, [int](class_int) input_idx **)** const - * void **[`transition_node_set_xfade_time`](#transition_node_set_xfade_time)** **(** [String](class_string) id, [real](class_real) time_sec **)** - * [real](class_real) **[`transition_node_get_xfade_time`](#transition_node_get_xfade_time)** **(** [String](class_string) id **)** const - * void **[`transition_node_set_current`](#transition_node_set_current)** **(** [String](class_string) id, [int](class_int) input_idx **)** - * [int](class_int) **[`transition_node_get_current`](#transition_node_get_current)** **(** [String](class_string) id **)** const - * void **[`node_set_pos`](#node_set_pos)** **(** [String](class_string) id, [Vector2](class_vector2) screen_pos **)** - * [Vector2](class_vector2) **[`node_get_pos`](#node_get_pos)** **(** [String](class_string) id **)** const - * void **[`remove_node`](#remove_node)** **(** [String](class_string) id **)** - * [int](class_int) **[`connect`](#connect)** **(** [String](class_string) id, [String](class_string) dst_id, [int](class_int) dst_input_idx **)** - * [bool](class_bool) **[`is_connected`](#is_connected)** **(** [String](class_string) id, [String](class_string) dst_id, [int](class_int) dst_input_idx **)** const - * void **[`disconnect`](#disconnect)** **(** [String](class_string) id, [int](class_int) dst_input_idx **)** - * void **[`set_active`](#set_active)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`is_active`](#is_active)** **(** **)** const - * void **[`set_base_path`](#set_base_path)** **(** [NodePath](class_nodepath) path **)** - * [NodePath](class_nodepath) **[`get_base_path`](#get_base_path)** **(** **)** const - * [StringArray](class_stringarray) **[`get_node_list`](#get_node_list)** **(** **)** - * void **[`reset`](#reset)** **(** **)** - * void **[`recompute_caches`](#recompute_caches)** **(** **)** + * void **[add_node](#add_node)** **(** [int](class_int) type, [String](class_string) id **)** + * [bool](class_bool) **[node_exists](#node_exists)** **(** [String](class_string) node **)** const + * [int](class_int) **[node_rename](#node_rename)** **(** [String](class_string) node, [String](class_string) new_name **)** + * [int](class_int) **[node_get_type](#node_get_type)** **(** [String](class_string) id **)** const + * [int](class_int) **[node_get_input_count](#node_get_input_count)** **(** [String](class_string) id **)** const + * [String](class_string) **[node_get_input_sourcre](#node_get_input_sourcre)** **(** [String](class_string) id, [int](class_int) idx **)** const + * void **[animation_node_set_animation](#animation_node_set_animation)** **(** [String](class_string) id, [Animation](class_animation) animation **)** + * [Animation](class_animation) **[animation_node_get_animation](#animation_node_get_animation)** **(** [String](class_string) id **)** const + * void **[animation_node_set_master_animation](#animation_node_set_master_animation)** **(** [String](class_string) id, [String](class_string) source **)** + * [String](class_string) **[animation_node_get_master_animation](#animation_node_get_master_animation)** **(** [String](class_string) id **)** const + * void **[oneshot_node_set_fadein_time](#oneshot_node_set_fadein_time)** **(** [String](class_string) id, [real](class_real) time_sec **)** + * [real](class_real) **[oneshot_node_get_fadein_time](#oneshot_node_get_fadein_time)** **(** [String](class_string) id **)** const + * void **[oneshot_node_set_fadeout_time](#oneshot_node_set_fadeout_time)** **(** [String](class_string) id, [real](class_real) time_sec **)** + * [real](class_real) **[oneshot_node_get_fadeout_time](#oneshot_node_get_fadeout_time)** **(** [String](class_string) id **)** const + * void **[oneshot_node_set_autorestart](#oneshot_node_set_autorestart)** **(** [String](class_string) id, [bool](class_bool) enable **)** + * void **[oneshot_node_set_autorestart_delay](#oneshot_node_set_autorestart_delay)** **(** [String](class_string) id, [real](class_real) delay_sec **)** + * void **[oneshot_node_set_autorestart_random_delay](#oneshot_node_set_autorestart_random_delay)** **(** [String](class_string) id, [real](class_real) rand_sec **)** + * [bool](class_bool) **[oneshot_node_has_autorestart](#oneshot_node_has_autorestart)** **(** [String](class_string) id **)** const + * [real](class_real) **[oneshot_node_get_autorestart_delay](#oneshot_node_get_autorestart_delay)** **(** [String](class_string) id **)** const + * [real](class_real) **[oneshot_node_get_autorestart_random_delay](#oneshot_node_get_autorestart_random_delay)** **(** [String](class_string) id **)** const + * void **[oneshot_node_start](#oneshot_node_start)** **(** [String](class_string) id **)** + * void **[oneshot_node_stop](#oneshot_node_stop)** **(** [String](class_string) id **)** + * [bool](class_bool) **[oneshot_node_is_active](#oneshot_node_is_active)** **(** [String](class_string) id **)** const + * void **[oneshot_node_set_filter_path](#oneshot_node_set_filter_path)** **(** [String](class_string) id, [NodePath](class_nodepath) path, [bool](class_bool) enable **)** + * void **[mix_node_set_amount](#mix_node_set_amount)** **(** [String](class_string) id, [real](class_real) ratio **)** + * [real](class_real) **[mix_node_get_amount](#mix_node_get_amount)** **(** [String](class_string) id **)** const + * void **[blend2_node_set_amount](#blend2_node_set_amount)** **(** [String](class_string) id, [real](class_real) blend **)** + * [real](class_real) **[blend2_node_get_amount](#blend2_node_get_amount)** **(** [String](class_string) id **)** const + * void **[blend2_node_set_filter_path](#blend2_node_set_filter_path)** **(** [String](class_string) id, [NodePath](class_nodepath) path, [bool](class_bool) enable **)** + * void **[blend3_node_set_amount](#blend3_node_set_amount)** **(** [String](class_string) id, [real](class_real) blend **)** + * [real](class_real) **[blend3_node_get_amount](#blend3_node_get_amount)** **(** [String](class_string) id **)** const + * void **[blend4_node_set_amount](#blend4_node_set_amount)** **(** [String](class_string) id, [Vector2](class_vector2) blend **)** + * [Vector2](class_vector2) **[blend4_node_get_amount](#blend4_node_get_amount)** **(** [String](class_string) id **)** const + * void **[timescale_node_set_scale](#timescale_node_set_scale)** **(** [String](class_string) id, [real](class_real) scale **)** + * [real](class_real) **[timescale_node_get_scale](#timescale_node_get_scale)** **(** [String](class_string) id **)** const + * void **[timeseek_node_seek](#timeseek_node_seek)** **(** [String](class_string) id, [real](class_real) pos_sec **)** + * void **[transition_node_set_input_count](#transition_node_set_input_count)** **(** [String](class_string) id, [int](class_int) count **)** + * [int](class_int) **[transition_node_get_input_count](#transition_node_get_input_count)** **(** [String](class_string) id **)** const + * void **[transition_node_delete_input](#transition_node_delete_input)** **(** [String](class_string) id, [int](class_int) input_idx **)** + * void **[transition_node_set_input_auto_advance](#transition_node_set_input_auto_advance)** **(** [String](class_string) id, [int](class_int) input_idx, [bool](class_bool) enable **)** + * [bool](class_bool) **[transition_node_has_input_auto_advance](#transition_node_has_input_auto_advance)** **(** [String](class_string) id, [int](class_int) input_idx **)** const + * void **[transition_node_set_xfade_time](#transition_node_set_xfade_time)** **(** [String](class_string) id, [real](class_real) time_sec **)** + * [real](class_real) **[transition_node_get_xfade_time](#transition_node_get_xfade_time)** **(** [String](class_string) id **)** const + * void **[transition_node_set_current](#transition_node_set_current)** **(** [String](class_string) id, [int](class_int) input_idx **)** + * [int](class_int) **[transition_node_get_current](#transition_node_get_current)** **(** [String](class_string) id **)** const + * void **[node_set_pos](#node_set_pos)** **(** [String](class_string) id, [Vector2](class_vector2) screen_pos **)** + * [Vector2](class_vector2) **[node_get_pos](#node_get_pos)** **(** [String](class_string) id **)** const + * void **[remove_node](#remove_node)** **(** [String](class_string) id **)** + * [int](class_int) **[connect](#connect)** **(** [String](class_string) id, [String](class_string) dst_id, [int](class_int) dst_input_idx **)** + * [bool](class_bool) **[is_connected](#is_connected)** **(** [String](class_string) id, [String](class_string) dst_id, [int](class_int) dst_input_idx **)** const + * void **[disconnect](#disconnect)** **(** [String](class_string) id, [int](class_int) dst_input_idx **)** + * void **[set_active](#set_active)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[is_active](#is_active)** **(** **)** const + * void **[set_base_path](#set_base_path)** **(** [NodePath](class_nodepath) path **)** + * [NodePath](class_nodepath) **[get_base_path](#get_base_path)** **(** **)** const + * [StringArray](class_stringarray) **[get_node_list](#get_node_list)** **(** **)** + * void **[reset](#reset)** **(** **)** + * void **[recompute_caches](#recompute_caches)** **(** **)** ### Numeric Constants * **NODE_OUTPUT** = **0** diff --git a/class_area.md b/class_area.md index 9ebbad5..e9c0184 100644 --- a/class_area.md +++ b/class_area.md @@ -6,25 +6,25 @@ ### Member Functions - * void **[`set_space_override_mode`](#set_space_override_mode)** **(** [int](class_int) enable **)** - * [int](class_int) **[`get_space_override_mode`](#get_space_override_mode)** **(** **)** const - * void **[`set_gravity_is_point`](#set_gravity_is_point)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_gravity_a_point`](#is_gravity_a_point)** **(** **)** const - * void **[`set_gravity_vector`](#set_gravity_vector)** **(** [Vector3](class_vector3) vector **)** - * [Vector3](class_vector3) **[`get_gravity_vector`](#get_gravity_vector)** **(** **)** const - * void **[`set_gravity`](#set_gravity)** **(** [real](class_real) gravity **)** - * [real](class_real) **[`get_gravity`](#get_gravity)** **(** **)** const - * void **[`set_density`](#set_density)** **(** [real](class_real) density **)** - * [real](class_real) **[`get_density`](#get_density)** **(** **)** const - * void **[`set_priority`](#set_priority)** **(** [real](class_real) priority **)** - * [real](class_real) **[`get_priority`](#get_priority)** **(** **)** const - * void **[`set_enable_monitoring`](#set_enable_monitoring)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_monitoring_enabled`](#is_monitoring_enabled)** **(** **)** const + * void **[set_space_override_mode](#set_space_override_mode)** **(** [int](class_int) enable **)** + * [int](class_int) **[get_space_override_mode](#get_space_override_mode)** **(** **)** const + * void **[set_gravity_is_point](#set_gravity_is_point)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_gravity_a_point](#is_gravity_a_point)** **(** **)** const + * void **[set_gravity_vector](#set_gravity_vector)** **(** [Vector3](class_vector3) vector **)** + * [Vector3](class_vector3) **[get_gravity_vector](#get_gravity_vector)** **(** **)** const + * void **[set_gravity](#set_gravity)** **(** [real](class_real) gravity **)** + * [real](class_real) **[get_gravity](#get_gravity)** **(** **)** const + * void **[set_density](#set_density)** **(** [real](class_real) density **)** + * [real](class_real) **[get_density](#get_density)** **(** **)** const + * void **[set_priority](#set_priority)** **(** [real](class_real) priority **)** + * [real](class_real) **[get_priority](#get_priority)** **(** **)** const + * void **[set_enable_monitoring](#set_enable_monitoring)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_monitoring_enabled](#is_monitoring_enabled)** **(** **)** const ### Signals - * **`body_enter`** **(** [Object](class_object) body **)** - * **`body_enter_shape`** **(** [int](class_int) body_id, [Object](class_object) body, [int](class_int) body_shape, [int](class_int) area_shape **)** - * **`body_exit`** **(** [Object](class_object) body **)** - * **`body_exit_shape`** **(** [int](class_int) body_id, [Object](class_object) body, [int](class_int) body_shape, [int](class_int) area_shape **)** + * **body_enter** **(** [Object](class_object) body **)** + * **body_enter_shape** **(** [int](class_int) body_id, [Object](class_object) body, [int](class_int) body_shape, [int](class_int) area_shape **)** + * **body_exit** **(** [Object](class_object) body **)** + * **body_exit_shape** **(** [int](class_int) body_id, [Object](class_object) body, [int](class_int) body_shape, [int](class_int) area_shape **)** ### Member Function Description diff --git a/class_area2d.md b/class_area2d.md index e7ebb59..aa8f635 100644 --- a/class_area2d.md +++ b/class_area2d.md @@ -6,26 +6,26 @@ General purpose area detection and influence for 2D Phisics. ### Member Functions - * void **[`set_space_override_mode`](#set_space_override_mode)** **(** [int](class_int) enable **)** - * [int](class_int) **[`get_space_override_mode`](#get_space_override_mode)** **(** **)** const - * void **[`set_gravity_is_point`](#set_gravity_is_point)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_gravity_a_point`](#is_gravity_a_point)** **(** **)** const - * void **[`set_gravity_vector`](#set_gravity_vector)** **(** [Vector2](class_vector2) vector **)** - * [Vector2](class_vector2) **[`get_gravity_vector`](#get_gravity_vector)** **(** **)** const - * void **[`set_gravity`](#set_gravity)** **(** [real](class_real) gravity **)** - * [real](class_real) **[`get_gravity`](#get_gravity)** **(** **)** const - * void **[`set_density`](#set_density)** **(** [real](class_real) density **)** - * [real](class_real) **[`get_density`](#get_density)** **(** **)** const - * void **[`set_priority`](#set_priority)** **(** [real](class_real) priority **)** - * [real](class_real) **[`get_priority`](#get_priority)** **(** **)** const - * void **[`set_enable_monitoring`](#set_enable_monitoring)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_monitoring_enabled`](#is_monitoring_enabled)** **(** **)** const + * void **[set_space_override_mode](#set_space_override_mode)** **(** [int](class_int) enable **)** + * [int](class_int) **[get_space_override_mode](#get_space_override_mode)** **(** **)** const + * void **[set_gravity_is_point](#set_gravity_is_point)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_gravity_a_point](#is_gravity_a_point)** **(** **)** const + * void **[set_gravity_vector](#set_gravity_vector)** **(** [Vector2](class_vector2) vector **)** + * [Vector2](class_vector2) **[get_gravity_vector](#get_gravity_vector)** **(** **)** const + * void **[set_gravity](#set_gravity)** **(** [real](class_real) gravity **)** + * [real](class_real) **[get_gravity](#get_gravity)** **(** **)** const + * void **[set_density](#set_density)** **(** [real](class_real) density **)** + * [real](class_real) **[get_density](#get_density)** **(** **)** const + * void **[set_priority](#set_priority)** **(** [real](class_real) priority **)** + * [real](class_real) **[get_priority](#get_priority)** **(** **)** const + * void **[set_enable_monitoring](#set_enable_monitoring)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_monitoring_enabled](#is_monitoring_enabled)** **(** **)** const ### Signals - * **`body_enter`** **(** [Object](class_object) body **)** - * **`body_enter_shape`** **(** [int](class_int) body_id, [Object](class_object) body, [int](class_int) body_shape, [int](class_int) area_shape **)** - * **`body_exit`** **(** [Object](class_object) body **)** - * **`body_exit_shape`** **(** [int](class_int) body_id, [Object](class_object) body, [int](class_int) body_shape, [int](class_int) area_shape **)** + * **body_enter** **(** [Object](class_object) body **)** + * **body_enter_shape** **(** [int](class_int) body_id, [Object](class_object) body, [int](class_int) body_shape, [int](class_int) area_shape **)** + * **body_exit** **(** [Object](class_object) body **)** + * **body_exit_shape** **(** [int](class_int) body_id, [Object](class_object) body, [int](class_int) body_shape, [int](class_int) area_shape **)** ### Description General purpose area detection for 2D Phisics. Areas can be used for detection of objects that enter/exit them, as well as overriding space parameters (changing gravity, damping, etc). An Area2D can be set as a children to a RigidBody2D to generate a custom gravity field. For this, use SPACE_OVERRIDE_COMBINE and point gravity at the center of mass. @@ -33,16 +33,16 @@ General purpose area detection for 2D Phisics. Areas can be used for detection o ### Member Function Description #### set_gravity_is_point - * void **`set_gravity_is_point`** **(** [bool](class_bool) enable **)** + * void **set_gravity_is_point** **(** [bool](class_bool) enable **)** When overriding space parameters, areas can have a center of gravity as a point. #### is_gravity_a_point - * [bool](class_bool) **`is_gravity_a_point`** **(** **)** const + * [bool](class_bool) **is_gravity_a_point** **(** **)** const Return if gravity is a point. When overriding space parameters, areas can have a center of gravity as a point. #### set_gravity_vector - * void **`set_gravity_vector`** **(** [Vector2](class_vector2) vector **)** + * void **set_gravity_vector** **(** [Vector2](class_vector2) vector **)** Set gravity vector. If gravity is a point, this will be the attraction center diff --git a/class_array.md b/class_array.md index 8829998..02d708e 100644 --- a/class_array.md +++ b/class_array.md @@ -5,27 +5,27 @@ Generic array datatype. ### Member Functions - * void **[`append`](#append)** **(** var value **)** - * void **[`clear`](#clear)** **(** **)** - * [bool](class_bool) **[`empty`](#empty)** **(** **)** - * void **[`erase`](#erase)** **(** var value **)** - * [int](class_int) **[`find`](#find)** **(** var value **)** - * [int](class_int) **[`hash`](#hash)** **(** **)** - * void **[`insert`](#insert)** **(** [int](class_int) pos, var value **)** - * void **[`invert`](#invert)** **(** **)** - * void **[`push_back`](#push_back)** **(** var value **)** - * void **[`remove`](#remove)** **(** [int](class_int) pos **)** - * void **[`resize`](#resize)** **(** [int](class_int) pos **)** - * [int](class_int) **[`size`](#size)** **(** **)** - * void **[`sort`](#sort)** **(** **)** - * void **[`sort_custom`](#sort_custom)** **(** [Object](class_object) obj, [String](class_string) func **)** - * void **[`Array`](#Array)** **(** [RawArray](class_rawarray) from **)** - * void **[`Array`](#Array)** **(** [IntArray](class_intarray) from **)** - * void **[`Array`](#Array)** **(** [RealArray](class_realarray) from **)** - * void **[`Array`](#Array)** **(** [StringArray](class_stringarray) from **)** - * void **[`Array`](#Array)** **(** [Vector2Array](class_vector2array) from **)** - * void **[`Array`](#Array)** **(** [Vector3Array](class_vector3array) from **)** - * void **[`Array`](#Array)** **(** [ColorArray](class_colorarray) from **)** + * void **[append](#append)** **(** var value **)** + * void **[clear](#clear)** **(** **)** + * [bool](class_bool) **[empty](#empty)** **(** **)** + * void **[erase](#erase)** **(** var value **)** + * [int](class_int) **[find](#find)** **(** var value **)** + * [int](class_int) **[hash](#hash)** **(** **)** + * void **[insert](#insert)** **(** [int](class_int) pos, var value **)** + * void **[invert](#invert)** **(** **)** + * void **[push_back](#push_back)** **(** var value **)** + * void **[remove](#remove)** **(** [int](class_int) pos **)** + * void **[resize](#resize)** **(** [int](class_int) pos **)** + * [int](class_int) **[size](#size)** **(** **)** + * void **[sort](#sort)** **(** **)** + * void **[sort_custom](#sort_custom)** **(** [Object](class_object) obj, [String](class_string) func **)** + * void **[Array](#Array)** **(** [RawArray](class_rawarray) from **)** + * void **[Array](#Array)** **(** [IntArray](class_intarray) from **)** + * void **[Array](#Array)** **(** [RealArray](class_realarray) from **)** + * void **[Array](#Array)** **(** [StringArray](class_stringarray) from **)** + * void **[Array](#Array)** **(** [Vector2Array](class_vector2array) from **)** + * void **[Array](#Array)** **(** [Vector3Array](class_vector3array) from **)** + * void **[Array](#Array)** **(** [ColorArray](class_colorarray) from **)** ### Description Generic array, contains several elements of any type, accessible by numerical index starting at 0. Arrays are always passed by reference. @@ -33,76 +33,76 @@ Generic array, contains several elements of any type, accessible by numerical in ### Member Function Description #### clear - * void **`clear`** **(** **)** + * void **clear** **(** **)** Clear the array (resize to 0). #### empty - * [bool](class_bool) **`empty`** **(** **)** + * [bool](class_bool) **empty** **(** **)** Return true if the array is empty (size==0). #### hash - * [int](class_int) **`hash`** **(** **)** + * [int](class_int) **hash** **(** **)** Return a hashed integer value representing the array contents. #### insert - * void **`insert`** **(** [int](class_int) pos, var value **)** + * void **insert** **(** [int](class_int) pos, var value **)** Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). #### push_back - * void **`push_back`** **(** var value **)** + * void **push_back** **(** var value **)** Append an element at the end of the array. #### remove - * void **`remove`** **(** [int](class_int) pos **)** + * void **remove** **(** [int](class_int) pos **)** Remove an element from the array by index. #### resize - * void **`resize`** **(** [int](class_int) pos **)** + * void **resize** **(** [int](class_int) pos **)** Resize the array to contain a different number of elements. If the array size is smaller, elements are cleared, if bigger, new elements are Null. #### size - * [int](class_int) **`size`** **(** **)** + * [int](class_int) **size** **(** **)** Return the amount of elements in the array. #### Array - * void **`Array`** **(** [RawArray](class_rawarray) from **)** + * void **Array** **(** [RawArray](class_rawarray) from **)** Construct an array from a [RawArray](class_rawarray). #### Array - * void **`Array`** **(** [IntArray](class_intarray) from **)** + * void **Array** **(** [IntArray](class_intarray) from **)** Construct an array from a [RawArray](class_rawarray). #### Array - * void **`Array`** **(** [RealArray](class_realarray) from **)** + * void **Array** **(** [RealArray](class_realarray) from **)** Construct an array from a [RawArray](class_rawarray). #### Array - * void **`Array`** **(** [StringArray](class_stringarray) from **)** + * void **Array** **(** [StringArray](class_stringarray) from **)** Construct an array from a [RawArray](class_rawarray). #### Array - * void **`Array`** **(** [Vector2Array](class_vector2array) from **)** + * void **Array** **(** [Vector2Array](class_vector2array) from **)** Construct an array from a [RawArray](class_rawarray). #### Array - * void **`Array`** **(** [Vector3Array](class_vector3array) from **)** + * void **Array** **(** [Vector3Array](class_vector3array) from **)** Construct an array from a [RawArray](class_rawarray). #### Array - * void **`Array`** **(** [ColorArray](class_colorarray) from **)** + * void **Array** **(** [ColorArray](class_colorarray) from **)** Construct an array from a [RawArray](class_rawarray). diff --git a/class_atlastexture.md b/class_atlastexture.md index 5f44815..a45d731 100644 --- a/class_atlastexture.md +++ b/class_atlastexture.md @@ -6,11 +6,11 @@ ### Member Functions - * void **[`set_atlas`](#set_atlas)** **(** [Texture](class_texture) atlas **)** - * [Texture](class_texture) **[`get_atlas`](#get_atlas)** **(** **)** const - * void **[`set_region`](#set_region)** **(** [Rect2](class_rect2) region **)** - * [Rect2](class_rect2) **[`get_region`](#get_region)** **(** **)** const - * void **[`set_margin`](#set_margin)** **(** [Rect2](class_rect2) margin **)** - * [Rect2](class_rect2) **[`get_margin`](#get_margin)** **(** **)** const + * void **[set_atlas](#set_atlas)** **(** [Texture](class_texture) atlas **)** + * [Texture](class_texture) **[get_atlas](#get_atlas)** **(** **)** const + * void **[set_region](#set_region)** **(** [Rect2](class_rect2) region **)** + * [Rect2](class_rect2) **[get_region](#get_region)** **(** **)** const + * void **[set_margin](#set_margin)** **(** [Rect2](class_rect2) margin **)** + * [Rect2](class_rect2) **[get_margin](#get_margin)** **(** **)** const ### Member Function Description diff --git a/class_audioserver.md b/class_audioserver.md index 7f1cc9a..f587270 100644 --- a/class_audioserver.md +++ b/class_audioserver.md @@ -6,52 +6,52 @@ Server interface for low level audio access. ### Member Functions - * [RID](class_rid) **[`sample_create`](#sample_create)** **(** [int](class_int) format, [bool](class_bool) stereo, [int](class_int) length **)** - * void **[`sample_set_description`](#sample_set_description)** **(** [RID](class_rid) sample, [String](class_string) description **)** - * [String](class_string) **[`sample_get_description`](#sample_get_description)** **(** [RID](class_rid) sample, [String](class_string) arg1 **)** const - * [int](class_int) **[`sample_get_format`](#sample_get_format)** **(** [RID](class_rid) sample **)** const - * [bool](class_bool) **[`sample_is_stereo`](#sample_is_stereo)** **(** [RID](class_rid) sample **)** const - * [int](class_int) **[`sample_get_length`](#sample_get_length)** **(** [RID](class_rid) sample **)** const - * void **[`sample_set_signed_data`](#sample_set_signed_data)** **(** [RID](class_rid) sample, [RealArray](class_realarray) data **)** - * void **[`sample_set_data`](#sample_set_data)** **(** [RID](class_rid) sample, [RawArray](class_rawarray) arg1 **)** - * [RawArray](class_rawarray) **[`sample_get_data`](#sample_get_data)** **(** [RID](class_rid) sample **)** const - * void **[`sample_set_mix_rate`](#sample_set_mix_rate)** **(** [RID](class_rid) sample, [int](class_int) mix_rate **)** - * [int](class_int) **[`sample_get_mix_rate`](#sample_get_mix_rate)** **(** [RID](class_rid) sample **)** const - * void **[`sample_set_loop_format`](#sample_set_loop_format)** **(** [RID](class_rid) sample, [int](class_int) loop_format **)** - * [int](class_int) **[`sample_get_loop_format`](#sample_get_loop_format)** **(** [RID](class_rid) sample **)** const - * void **[`sample_set_loop_begin`](#sample_set_loop_begin)** **(** [RID](class_rid) sample, [int](class_int) pos **)** - * [int](class_int) **[`sample_get_loop_begin`](#sample_get_loop_begin)** **(** [RID](class_rid) sample **)** const - * void **[`sample_set_loop_end`](#sample_set_loop_end)** **(** [RID](class_rid) sample, [int](class_int) pos **)** - * [int](class_int) **[`sample_get_loop_end`](#sample_get_loop_end)** **(** [RID](class_rid) sample **)** const - * [RID](class_rid) **[`voice_create`](#voice_create)** **(** **)** - * void **[`voice_play`](#voice_play)** **(** [RID](class_rid) voice, [RID](class_rid) sample **)** - * void **[`voice_set_volume`](#voice_set_volume)** **(** [RID](class_rid) voice, [real](class_real) volume **)** - * void **[`voice_set_pan`](#voice_set_pan)** **(** [RID](class_rid) voice, [real](class_real) pan, [real](class_real) depth=0, [real](class_real) height=0 **)** - * void **[`voice_set_filter`](#voice_set_filter)** **(** [RID](class_rid) voice, [int](class_int) type, [real](class_real) cutoff, [real](class_real) resonance, [real](class_real) gain=0 **)** - * void **[`voice_set_chorus`](#voice_set_chorus)** **(** [RID](class_rid) voice, [real](class_real) chorus **)** - * void **[`voice_set_reverb`](#voice_set_reverb)** **(** [RID](class_rid) voice, [int](class_int) room, [real](class_real) reverb **)** - * void **[`voice_set_mix_rate`](#voice_set_mix_rate)** **(** [RID](class_rid) voice, [int](class_int) rate **)** - * void **[`voice_set_positional`](#voice_set_positional)** **(** [RID](class_rid) voice, [bool](class_bool) enabled **)** - * [real](class_real) **[`voice_get_volume`](#voice_get_volume)** **(** [RID](class_rid) voice **)** const - * [real](class_real) **[`voice_get_pan`](#voice_get_pan)** **(** [RID](class_rid) voice **)** const - * [real](class_real) **[`voice_get_pan_height`](#voice_get_pan_height)** **(** [RID](class_rid) voice **)** const - * [real](class_real) **[`voice_get_pan_depth`](#voice_get_pan_depth)** **(** [RID](class_rid) voice **)** const - * [int](class_int) **[`voice_get_filter_type`](#voice_get_filter_type)** **(** [RID](class_rid) voice **)** const - * [real](class_real) **[`voice_get_filter_cutoff`](#voice_get_filter_cutoff)** **(** [RID](class_rid) voice **)** const - * [real](class_real) **[`voice_get_filter_resonance`](#voice_get_filter_resonance)** **(** [RID](class_rid) voice **)** const - * [real](class_real) **[`voice_get_chorus`](#voice_get_chorus)** **(** [RID](class_rid) voice **)** const - * [int](class_int) **[`voice_get_reverb_type`](#voice_get_reverb_type)** **(** [RID](class_rid) voice **)** const - * [real](class_real) **[`voice_get_reverb`](#voice_get_reverb)** **(** [RID](class_rid) voice **)** const - * [int](class_int) **[`voice_get_mix_rate`](#voice_get_mix_rate)** **(** [RID](class_rid) voice **)** const - * [bool](class_bool) **[`voice_is_positional`](#voice_is_positional)** **(** [RID](class_rid) voice **)** const - * void **[`voice_stop`](#voice_stop)** **(** [RID](class_rid) voice **)** - * void **[`free`](#free)** **(** [RID](class_rid) rid **)** - * void **[`set_stream_global_volume_scale`](#set_stream_global_volume_scale)** **(** [real](class_real) scale **)** - * [real](class_real) **[`get_stream_global_volume_scale`](#get_stream_global_volume_scale)** **(** **)** const - * void **[`set_fx_global_volume_scale`](#set_fx_global_volume_scale)** **(** [real](class_real) scale **)** - * [real](class_real) **[`get_fx_global_volume_scale`](#get_fx_global_volume_scale)** **(** **)** const - * void **[`set_event_voice_global_volume_scale`](#set_event_voice_global_volume_scale)** **(** [real](class_real) scale **)** - * [real](class_real) **[`get_event_voice_global_volume_scale`](#get_event_voice_global_volume_scale)** **(** **)** const + * [RID](class_rid) **[sample_create](#sample_create)** **(** [int](class_int) format, [bool](class_bool) stereo, [int](class_int) length **)** + * void **[sample_set_description](#sample_set_description)** **(** [RID](class_rid) sample, [String](class_string) description **)** + * [String](class_string) **[sample_get_description](#sample_get_description)** **(** [RID](class_rid) sample, [String](class_string) arg1 **)** const + * [int](class_int) **[sample_get_format](#sample_get_format)** **(** [RID](class_rid) sample **)** const + * [bool](class_bool) **[sample_is_stereo](#sample_is_stereo)** **(** [RID](class_rid) sample **)** const + * [int](class_int) **[sample_get_length](#sample_get_length)** **(** [RID](class_rid) sample **)** const + * void **[sample_set_signed_data](#sample_set_signed_data)** **(** [RID](class_rid) sample, [RealArray](class_realarray) data **)** + * void **[sample_set_data](#sample_set_data)** **(** [RID](class_rid) sample, [RawArray](class_rawarray) arg1 **)** + * [RawArray](class_rawarray) **[sample_get_data](#sample_get_data)** **(** [RID](class_rid) sample **)** const + * void **[sample_set_mix_rate](#sample_set_mix_rate)** **(** [RID](class_rid) sample, [int](class_int) mix_rate **)** + * [int](class_int) **[sample_get_mix_rate](#sample_get_mix_rate)** **(** [RID](class_rid) sample **)** const + * void **[sample_set_loop_format](#sample_set_loop_format)** **(** [RID](class_rid) sample, [int](class_int) loop_format **)** + * [int](class_int) **[sample_get_loop_format](#sample_get_loop_format)** **(** [RID](class_rid) sample **)** const + * void **[sample_set_loop_begin](#sample_set_loop_begin)** **(** [RID](class_rid) sample, [int](class_int) pos **)** + * [int](class_int) **[sample_get_loop_begin](#sample_get_loop_begin)** **(** [RID](class_rid) sample **)** const + * void **[sample_set_loop_end](#sample_set_loop_end)** **(** [RID](class_rid) sample, [int](class_int) pos **)** + * [int](class_int) **[sample_get_loop_end](#sample_get_loop_end)** **(** [RID](class_rid) sample **)** const + * [RID](class_rid) **[voice_create](#voice_create)** **(** **)** + * void **[voice_play](#voice_play)** **(** [RID](class_rid) voice, [RID](class_rid) sample **)** + * void **[voice_set_volume](#voice_set_volume)** **(** [RID](class_rid) voice, [real](class_real) volume **)** + * void **[voice_set_pan](#voice_set_pan)** **(** [RID](class_rid) voice, [real](class_real) pan, [real](class_real) depth=0, [real](class_real) height=0 **)** + * void **[voice_set_filter](#voice_set_filter)** **(** [RID](class_rid) voice, [int](class_int) type, [real](class_real) cutoff, [real](class_real) resonance, [real](class_real) gain=0 **)** + * void **[voice_set_chorus](#voice_set_chorus)** **(** [RID](class_rid) voice, [real](class_real) chorus **)** + * void **[voice_set_reverb](#voice_set_reverb)** **(** [RID](class_rid) voice, [int](class_int) room, [real](class_real) reverb **)** + * void **[voice_set_mix_rate](#voice_set_mix_rate)** **(** [RID](class_rid) voice, [int](class_int) rate **)** + * void **[voice_set_positional](#voice_set_positional)** **(** [RID](class_rid) voice, [bool](class_bool) enabled **)** + * [real](class_real) **[voice_get_volume](#voice_get_volume)** **(** [RID](class_rid) voice **)** const + * [real](class_real) **[voice_get_pan](#voice_get_pan)** **(** [RID](class_rid) voice **)** const + * [real](class_real) **[voice_get_pan_height](#voice_get_pan_height)** **(** [RID](class_rid) voice **)** const + * [real](class_real) **[voice_get_pan_depth](#voice_get_pan_depth)** **(** [RID](class_rid) voice **)** const + * [int](class_int) **[voice_get_filter_type](#voice_get_filter_type)** **(** [RID](class_rid) voice **)** const + * [real](class_real) **[voice_get_filter_cutoff](#voice_get_filter_cutoff)** **(** [RID](class_rid) voice **)** const + * [real](class_real) **[voice_get_filter_resonance](#voice_get_filter_resonance)** **(** [RID](class_rid) voice **)** const + * [real](class_real) **[voice_get_chorus](#voice_get_chorus)** **(** [RID](class_rid) voice **)** const + * [int](class_int) **[voice_get_reverb_type](#voice_get_reverb_type)** **(** [RID](class_rid) voice **)** const + * [real](class_real) **[voice_get_reverb](#voice_get_reverb)** **(** [RID](class_rid) voice **)** const + * [int](class_int) **[voice_get_mix_rate](#voice_get_mix_rate)** **(** [RID](class_rid) voice **)** const + * [bool](class_bool) **[voice_is_positional](#voice_is_positional)** **(** [RID](class_rid) voice **)** const + * void **[voice_stop](#voice_stop)** **(** [RID](class_rid) voice **)** + * void **[free](#free)** **(** [RID](class_rid) rid **)** + * void **[set_stream_global_volume_scale](#set_stream_global_volume_scale)** **(** [real](class_real) scale **)** + * [real](class_real) **[get_stream_global_volume_scale](#get_stream_global_volume_scale)** **(** **)** const + * void **[set_fx_global_volume_scale](#set_fx_global_volume_scale)** **(** [real](class_real) scale **)** + * [real](class_real) **[get_fx_global_volume_scale](#get_fx_global_volume_scale)** **(** **)** const + * void **[set_event_voice_global_volume_scale](#set_event_voice_global_volume_scale)** **(** [real](class_real) scale **)** + * [real](class_real) **[get_event_voice_global_volume_scale](#get_event_voice_global_volume_scale)** **(** **)** const ### Numeric Constants * **SAMPLE_FORMAT_PCM8** = **0** - Sample format is 8 bits, signed. @@ -77,211 +77,211 @@ AudioServer is a low level server interface for audio access. It is"#10;"#9;in c ### Member Function Description #### sample_create - * [RID](class_rid) **`sample_create`** **(** [int](class_int) format, [bool](class_bool) stereo, [int](class_int) length **)** + * [RID](class_rid) **sample_create** **(** [int](class_int) format, [bool](class_bool) stereo, [int](class_int) length **)** Create an audio sample, return a [RID](class_rid) referencing"#10;"#9;"#9;"#9;it. The sample will be created with a given format"#10;"#9;"#9;"#9;(from the SAMPLE_FORMAT_* enum), a total length (in"#10;"#9;"#9;"#9;frames, not samples or bytes), in either stereo or"#10;"#9;"#9;"#9;mono. #### sample_set_description - * void **`sample_set_description`** **(** [RID](class_rid) sample, [String](class_string) description **)** + * void **sample_set_description** **(** [RID](class_rid) sample, [String](class_string) description **)** Set the description of an audio sample. Mainly used"#10;"#9;"#9;"#9;for organization. #### sample_get_description - * [String](class_string) **`sample_get_description`** **(** [RID](class_rid) sample, [String](class_string) arg1 **)** const + * [String](class_string) **sample_get_description** **(** [RID](class_rid) sample, [String](class_string) arg1 **)** const Return the description of an audio sample. Mainly"#10;"#9;"#9;"#9;used for organization. #### sample_get_format - * [int](class_int) **`sample_get_format`** **(** [RID](class_rid) sample **)** const + * [int](class_int) **sample_get_format** **(** [RID](class_rid) sample **)** const Return the format of the audio sample, in the form"#10;"#9;"#9;"#9;of the SAMPLE_FORMAT_* enum. #### sample_is_stereo - * [bool](class_bool) **`sample_is_stereo`** **(** [RID](class_rid) sample **)** const + * [bool](class_bool) **sample_is_stereo** **(** [RID](class_rid) sample **)** const Return wether the sample is stereo (2 channels) #### sample_get_length - * [int](class_int) **`sample_get_length`** **(** [RID](class_rid) sample **)** const + * [int](class_int) **sample_get_length** **(** [RID](class_rid) sample **)** const Return the length in frames of the audio sample (not"#10;"#9;"#9;"#9;samples or bytes). #### sample_set_signed_data - * void **`sample_set_signed_data`** **(** [RID](class_rid) sample, [RealArray](class_realarray) data **)** + * void **sample_set_signed_data** **(** [RID](class_rid) sample, [RealArray](class_realarray) data **)** Set the sample data for a given sample as an array"#10;"#9;"#9;"#9;of floats. The length must be equal to the sample"#10;"#9;"#9;"#9;lenght or an error will be produced. #### sample_set_data - * void **`sample_set_data`** **(** [RID](class_rid) sample, [RawArray](class_rawarray) arg1 **)** + * void **sample_set_data** **(** [RID](class_rid) sample, [RawArray](class_rawarray) arg1 **)** Set the sample data for a given sample as an array"#10;"#9;"#9;"#9;of bytes. The length must be equal to the sample"#10;"#9;"#9;"#9;lenght expected in bytes or an error will be produced. #### sample_get_data - * [RawArray](class_rawarray) **`sample_get_data`** **(** [RID](class_rid) sample **)** const + * [RawArray](class_rawarray) **sample_get_data** **(** [RID](class_rid) sample **)** const Return the sample data as an array of bytes. The"#10;"#9;"#9;"#9;length will be the expected length in bytes. #### sample_set_mix_rate - * void **`sample_set_mix_rate`** **(** [RID](class_rid) sample, [int](class_int) mix_rate **)** + * void **sample_set_mix_rate** **(** [RID](class_rid) sample, [int](class_int) mix_rate **)** Change the default mix rate of a given sample. #### sample_get_mix_rate - * [int](class_int) **`sample_get_mix_rate`** **(** [RID](class_rid) sample **)** const + * [int](class_int) **sample_get_mix_rate** **(** [RID](class_rid) sample **)** const Return the mix rate of the given sample. #### sample_set_loop_format - * void **`sample_set_loop_format`** **(** [RID](class_rid) sample, [int](class_int) loop_format **)** + * void **sample_set_loop_format** **(** [RID](class_rid) sample, [int](class_int) loop_format **)** Set the loop format for a sample from the"#10;"#9;"#9;"#9;SAMPLE_LOOP_* enum. As a warning, Ping Pong loops"#10;"#9;"#9;"#9;may not be available on some hardware-mixing"#10;"#9;"#9;"#9;platforms. #### sample_get_loop_format - * [int](class_int) **`sample_get_loop_format`** **(** [RID](class_rid) sample **)** const + * [int](class_int) **sample_get_loop_format** **(** [RID](class_rid) sample **)** const Return the loop format for a sample, as a value from"#10;"#9;"#9;"#9;the SAMPLE_LOOP_* enum. #### sample_set_loop_begin - * void **`sample_set_loop_begin`** **(** [RID](class_rid) sample, [int](class_int) pos **)** + * void **sample_set_loop_begin** **(** [RID](class_rid) sample, [int](class_int) pos **)** -Set the initial loop point of a sample. Only has"#10;"#9;"#9;"#9;effect if sample loop is enabled. See [`sample_set_loop_format`](#sample_set_loop_format). +Set the initial loop point of a sample. Only has"#10;"#9;"#9;"#9;effect if sample loop is enabled. See [sample_set_loop_format](#sample_set_loop_format). #### sample_get_loop_begin - * [int](class_int) **`sample_get_loop_begin`** **(** [RID](class_rid) sample **)** const + * [int](class_int) **sample_get_loop_begin** **(** [RID](class_rid) sample **)** const -Return the initial loop point of a sample. Only has"#10;"#9;"#9;"#9;effect if sample loop is enabled. See [`sample_set_loop_format`](#sample_set_loop_format). +Return the initial loop point of a sample. Only has"#10;"#9;"#9;"#9;effect if sample loop is enabled. See [sample_set_loop_format](#sample_set_loop_format). #### sample_set_loop_end - * void **`sample_set_loop_end`** **(** [RID](class_rid) sample, [int](class_int) pos **)** + * void **sample_set_loop_end** **(** [RID](class_rid) sample, [int](class_int) pos **)** -Set the final loop point of a sample. Only has"#10;"#9;"#9;"#9;effect if sample loop is enabled. See [`sample_set_loop_format`](#sample_set_loop_format). +Set the final loop point of a sample. Only has"#10;"#9;"#9;"#9;effect if sample loop is enabled. See [sample_set_loop_format](#sample_set_loop_format). #### sample_get_loop_end - * [int](class_int) **`sample_get_loop_end`** **(** [RID](class_rid) sample **)** const + * [int](class_int) **sample_get_loop_end** **(** [RID](class_rid) sample **)** const -Return the final loop point of a sample. Only has"#10;"#9;"#9;"#9;effect if sample loop is enabled. See [`sample_set_loop_format`](#sample_set_loop_format). +Return the final loop point of a sample. Only has"#10;"#9;"#9;"#9;effect if sample loop is enabled. See [sample_set_loop_format](#sample_set_loop_format). #### voice_create - * [RID](class_rid) **`voice_create`** **(** **)** + * [RID](class_rid) **voice_create** **(** **)** -Allocate a voice for playback. Voices are"#10;"#9;"#9;"#9;persistent. A voice can play a single sample at the"#10;"#9;"#9;"#9;same time. See [`sample_create`](#sample_create). +Allocate a voice for playback. Voices are"#10;"#9;"#9;"#9;persistent. A voice can play a single sample at the"#10;"#9;"#9;"#9;same time. See [sample_create](#sample_create). #### voice_play - * void **`voice_play`** **(** [RID](class_rid) voice, [RID](class_rid) sample **)** + * void **voice_play** **(** [RID](class_rid) voice, [RID](class_rid) sample **)** Start playback of a given voice using a given"#10;"#9;"#9;"#9;sample. If the voice was already playing it will be"#10;"#9;"#9;"#9;restarted. #### voice_set_volume - * void **`voice_set_volume`** **(** [RID](class_rid) voice, [real](class_real) volume **)** + * void **voice_set_volume** **(** [RID](class_rid) voice, [real](class_real) volume **)** Change the volume of a currently playing voice."#10;"#9;"#9;"#9;Volume is expressed as linear gain where 0.0 is mute"#10;"#9;"#9;"#9;and 1.0 is default. #### voice_set_pan - * void **`voice_set_pan`** **(** [RID](class_rid) voice, [real](class_real) pan, [real](class_real) depth=0, [real](class_real) height=0 **)** + * void **voice_set_pan** **(** [RID](class_rid) voice, [real](class_real) pan, [real](class_real) depth=0, [real](class_real) height=0 **)** Change the pan of a currently playing voice and,"#10;"#9;"#9;"#9;optionally, the depth and height for a positional/3D"#10;"#9;"#9;"#9;sound. Panning values are expressed within the -1 to"#10;"#9;"#9;"#9;+1 range. #### voice_set_filter - * void **`voice_set_filter`** **(** [RID](class_rid) voice, [int](class_int) type, [real](class_real) cutoff, [real](class_real) resonance, [real](class_real) gain=0 **)** + * void **voice_set_filter** **(** [RID](class_rid) voice, [int](class_int) type, [real](class_real) cutoff, [real](class_real) resonance, [real](class_real) gain=0 **)** Set a resonant filter post processing for the voice."#10;"#9;"#9;"#9;Filter type is a value from the FILTER_* enum. #### voice_set_chorus - * void **`voice_set_chorus`** **(** [RID](class_rid) voice, [real](class_real) chorus **)** + * void **voice_set_chorus** **(** [RID](class_rid) voice, [real](class_real) chorus **)** Set chorus send post processing for the voice (from"#10;"#9;"#9;"#9;0 to 1). #### voice_set_reverb - * void **`voice_set_reverb`** **(** [RID](class_rid) voice, [int](class_int) room, [real](class_real) reverb **)** + * void **voice_set_reverb** **(** [RID](class_rid) voice, [int](class_int) room, [real](class_real) reverb **)** Set the reverb send post processing for the voice (from"#10;"#9;"#9;"#9;0 to 1) and the reverb type, from the REVERB_* enum. #### voice_set_mix_rate - * void **`voice_set_mix_rate`** **(** [RID](class_rid) voice, [int](class_int) rate **)** + * void **voice_set_mix_rate** **(** [RID](class_rid) voice, [int](class_int) rate **)** Set a different playback mix rate for the given"#10;"#9;"#9;"#9;voice. #### voice_set_positional - * void **`voice_set_positional`** **(** [RID](class_rid) voice, [bool](class_bool) enabled **)** + * void **voice_set_positional** **(** [RID](class_rid) voice, [bool](class_bool) enabled **)** Set wether a given voice is positional. This is only"#10;"#9;"#9;"#9;interpreted as a hint and used for backends that may"#10;"#9;"#9;"#9;support binaural encoding. #### voice_get_volume - * [real](class_real) **`voice_get_volume`** **(** [RID](class_rid) voice **)** const + * [real](class_real) **voice_get_volume** **(** [RID](class_rid) voice **)** const Return the current volume for a given voice. #### voice_get_pan - * [real](class_real) **`voice_get_pan`** **(** [RID](class_rid) voice **)** const + * [real](class_real) **voice_get_pan** **(** [RID](class_rid) voice **)** const Return the current pan for a given voice (-1 to +1"#10;"#9;"#9;"#9;range). #### voice_get_pan_height - * [real](class_real) **`voice_get_pan_height`** **(** [RID](class_rid) voice **)** const + * [real](class_real) **voice_get_pan_height** **(** [RID](class_rid) voice **)** const Return the current pan height for a given voice (-1 to +1"#10;"#9;"#9;"#9;range). #### voice_get_pan_depth - * [real](class_real) **`voice_get_pan_depth`** **(** [RID](class_rid) voice **)** const + * [real](class_real) **voice_get_pan_depth** **(** [RID](class_rid) voice **)** const Return the current pan depth for a given voice (-1 to +1"#10;"#9;"#9;"#9;range). #### voice_get_filter_type - * [int](class_int) **`voice_get_filter_type`** **(** [RID](class_rid) voice **)** const + * [int](class_int) **voice_get_filter_type** **(** [RID](class_rid) voice **)** const Return the current selected filter type for a given"#10;"#9;"#9;"#9;voice, from the FILTER_* enum. #### voice_get_filter_cutoff - * [real](class_real) **`voice_get_filter_cutoff`** **(** [RID](class_rid) voice **)** const + * [real](class_real) **voice_get_filter_cutoff** **(** [RID](class_rid) voice **)** const Return the current filter cutoff (in hz) for a given"#10;"#9;"#9;"#9;voice. #### voice_get_filter_resonance - * [real](class_real) **`voice_get_filter_resonance`** **(** [RID](class_rid) voice **)** const + * [real](class_real) **voice_get_filter_resonance** **(** [RID](class_rid) voice **)** const Return the current filter resonance for a given"#10;"#9;"#9;"#9;voice. #### voice_get_chorus - * [real](class_real) **`voice_get_chorus`** **(** [RID](class_rid) voice **)** const + * [real](class_real) **voice_get_chorus** **(** [RID](class_rid) voice **)** const Return the current chorus send for a given"#10;"#9;"#9;"#9;voice (0 to 1). #### voice_get_reverb_type - * [int](class_int) **`voice_get_reverb_type`** **(** [RID](class_rid) voice **)** const + * [int](class_int) **voice_get_reverb_type** **(** [RID](class_rid) voice **)** const Return the current reverb type for a given voice"#10;"#9;"#9;"#9;from the REVERB_* enum. #### voice_get_reverb - * [real](class_real) **`voice_get_reverb`** **(** [RID](class_rid) voice **)** const + * [real](class_real) **voice_get_reverb** **(** [RID](class_rid) voice **)** const Return the current reverb send for a given voice"#10;"#9;"#9;"#9;(0 to 1). #### voice_get_mix_rate - * [int](class_int) **`voice_get_mix_rate`** **(** [RID](class_rid) voice **)** const + * [int](class_int) **voice_get_mix_rate** **(** [RID](class_rid) voice **)** const Return the current mix rate for a given voice. #### voice_is_positional - * [bool](class_bool) **`voice_is_positional`** **(** [RID](class_rid) voice **)** const + * [bool](class_bool) **voice_is_positional** **(** [RID](class_rid) voice **)** const -Return wether the current voice is positional. See"#10;"#9;"#9;"#9;[`voice_set_positional`](#voice_set_positional). +Return wether the current voice is positional. See"#10;"#9;"#9;"#9;[voice_set_positional](#voice_set_positional). #### voice_stop - * void **`voice_stop`** **(** [RID](class_rid) voice **)** + * void **voice_stop** **(** [RID](class_rid) voice **)** Stop a given voice. #### free - * void **`free`** **(** [RID](class_rid) rid **)** + * void **free** **(** [RID](class_rid) rid **)** Free a [RID](class_rid) resource. #### set_stream_global_volume_scale - * void **`set_stream_global_volume_scale`** **(** [real](class_real) scale **)** + * void **set_stream_global_volume_scale** **(** [real](class_real) scale **)** Set global scale for stream playback. Default is 1.0. #### get_stream_global_volume_scale - * [real](class_real) **`get_stream_global_volume_scale`** **(** **)** const + * [real](class_real) **get_stream_global_volume_scale** **(** **)** const Return the global scale for stream playback. diff --git a/class_audiostream.md b/class_audiostream.md index 4a3a18b..9e8ca01 100644 --- a/class_audiostream.md +++ b/class_audiostream.md @@ -6,18 +6,18 @@ Base class for audio streams. ### Member Functions - * void **[`play`](#play)** **(** **)** - * void **[`stop`](#stop)** **(** **)** - * [bool](class_bool) **[`is_playing`](#is_playing)** **(** **)** const - * void **[`set_loop`](#set_loop)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`has_loop`](#has_loop)** **(** **)** const - * [String](class_string) **[`get_stream_name`](#get_stream_name)** **(** **)** const - * [int](class_int) **[`get_loop_count`](#get_loop_count)** **(** **)** const - * void **[`seek_pos`](#seek_pos)** **(** [real](class_real) pos **)** - * [real](class_real) **[`get_pos`](#get_pos)** **(** **)** const - * [real](class_real) **[`get_length`](#get_length)** **(** **)** const - * [int](class_int) **[`get_update_mode`](#get_update_mode)** **(** **)** const - * void **[`update`](#update)** **(** **)** + * void **[play](#play)** **(** **)** + * void **[stop](#stop)** **(** **)** + * [bool](class_bool) **[is_playing](#is_playing)** **(** **)** const + * void **[set_loop](#set_loop)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[has_loop](#has_loop)** **(** **)** const + * [String](class_string) **[get_stream_name](#get_stream_name)** **(** **)** const + * [int](class_int) **[get_loop_count](#get_loop_count)** **(** **)** const + * void **[seek_pos](#seek_pos)** **(** [real](class_real) pos **)** + * [real](class_real) **[get_pos](#get_pos)** **(** **)** const + * [real](class_real) **[get_length](#get_length)** **(** **)** const + * [int](class_int) **[get_update_mode](#get_update_mode)** **(** **)** const + * void **[update](#update)** **(** **)** ### Numeric Constants * **UPDATE_NONE** = **0** - Does not need update, or manual polling. @@ -30,56 +30,56 @@ Base class for audio streams. Audio streams are used for music"#10;"#9;playback, ### Member Function Description #### play - * void **`play`** **(** **)** + * void **play** **(** **)** Start playback of an audio stream. #### stop - * void **`stop`** **(** **)** + * void **stop** **(** **)** Stop playback of an audio stream. #### is_playing - * [bool](class_bool) **`is_playing`** **(** **)** const + * [bool](class_bool) **is_playing** **(** **)** const Return wether the audio stream is currently playing. #### set_loop - * void **`set_loop`** **(** [bool](class_bool) enabled **)** + * void **set_loop** **(** [bool](class_bool) enabled **)** Set the loop hint for the audio stream playback. if"#10;"#9;"#9;"#9;true, audio stream will attempt to loop (restart)"#10;"#9;"#9;"#9;when finished. #### has_loop - * [bool](class_bool) **`has_loop`** **(** **)** const + * [bool](class_bool) **has_loop** **(** **)** const -Return wether the audio stream loops. See [`set_loop`](#set_loop) +Return wether the audio stream loops. See [set_loop](#set_loop) #### get_stream_name - * [String](class_string) **`get_stream_name`** **(** **)** const + * [String](class_string) **get_stream_name** **(** **)** const Return the name of the audio stream. Often the song"#10;"#9;"#9;"#9;title when the stream is music. #### get_loop_count - * [int](class_int) **`get_loop_count`** **(** **)** const + * [int](class_int) **get_loop_count** **(** **)** const Return the amount of times that the stream has"#10;"#9;"#9;"#9;looped (if loop is supported). #### seek_pos - * void **`seek_pos`** **(** [real](class_real) pos **)** + * void **seek_pos** **(** [real](class_real) pos **)** Seek to a certain position (in seconds) in an audio"#10;"#9;"#9;"#9;stream. #### get_pos - * [real](class_real) **`get_pos`** **(** **)** const + * [real](class_real) **get_pos** **(** **)** const Return the current playing position (in seconds) of the audio"#10;"#9;"#9;"#9;stream (if supported). Since this value is updated"#10;"#9;"#9;"#9;internally, it may not be exact or updated"#10;"#9;"#9;"#9;continuosly. Accuracy depends on the sample buffer"#10;"#9;"#9;"#9;size of the audio driver. #### get_update_mode - * [int](class_int) **`get_update_mode`** **(** **)** const + * [int](class_int) **get_update_mode** **(** **)** const Return the type of update that the stream uses. Some"#10;"#9;"#9;"#9;types of stream may need manual polling. #### update - * void **`update`** **(** **)** + * void **update** **(** **)** Manually poll the audio stream (if it is requested"#10;"#9;"#9;"#9;to). diff --git a/class_audiostreamgibberish.md b/class_audiostreamgibberish.md index 5d7be52..586c6e2 100644 --- a/class_audiostreamgibberish.md +++ b/class_audiostreamgibberish.md @@ -6,14 +6,14 @@ Simple gibberish speech stream playback. ### Member Functions - * void **[`set_phonemes`](#set_phonemes)** **(** [Object](class_object) phonemes **)** - * [Object](class_object) **[`get_phonemes`](#get_phonemes)** **(** **)** const - * void **[`set_pitch_scale`](#set_pitch_scale)** **(** [real](class_real) pitch_scale **)** - * [real](class_real) **[`get_pitch_scale`](#get_pitch_scale)** **(** **)** const - * void **[`set_pitch_random_scale`](#set_pitch_random_scale)** **(** [real](class_real) pitch_random_scale **)** - * [real](class_real) **[`get_pitch_random_scale`](#get_pitch_random_scale)** **(** **)** const - * void **[`set_xfade_time`](#set_xfade_time)** **(** [real](class_real) sec **)** - * [real](class_real) **[`get_xfade_time`](#get_xfade_time)** **(** **)** const + * void **[set_phonemes](#set_phonemes)** **(** [Object](class_object) phonemes **)** + * [Object](class_object) **[get_phonemes](#get_phonemes)** **(** **)** const + * void **[set_pitch_scale](#set_pitch_scale)** **(** [real](class_real) pitch_scale **)** + * [real](class_real) **[get_pitch_scale](#get_pitch_scale)** **(** **)** const + * void **[set_pitch_random_scale](#set_pitch_random_scale)** **(** [real](class_real) pitch_random_scale **)** + * [real](class_real) **[get_pitch_random_scale](#get_pitch_random_scale)** **(** **)** const + * void **[set_xfade_time](#set_xfade_time)** **(** [real](class_real) sec **)** + * [real](class_real) **[get_xfade_time](#get_xfade_time)** **(** **)** const ### Description AudioStream used for gibberish playback. It plays randomized phonemes, which can be used to accompany text dialogs. @@ -21,41 +21,41 @@ AudioStream used for gibberish playback. It plays randomized phonemes, which can ### Member Function Description #### set_phonemes - * void **`set_phonemes`** **(** [Object](class_object) phonemes **)** + * void **set_phonemes** **(** [Object](class_object) phonemes **)** Set the phoneme library. #### get_phonemes - * [Object](class_object) **`get_phonemes`** **(** **)** const + * [Object](class_object) **get_phonemes** **(** **)** const Return the phoneme library. #### set_pitch_scale - * void **`set_pitch_scale`** **(** [real](class_real) pitch_scale **)** + * void **set_pitch_scale** **(** [real](class_real) pitch_scale **)** Set pitch scale for the speech. Animating this value holds amusing results. #### get_pitch_scale - * [real](class_real) **`get_pitch_scale`** **(** **)** const + * [real](class_real) **get_pitch_scale** **(** **)** const Return the pitch scale. #### set_pitch_random_scale - * void **`set_pitch_random_scale`** **(** [real](class_real) pitch_random_scale **)** + * void **set_pitch_random_scale** **(** [real](class_real) pitch_random_scale **)** Set the random scaling for the pitch. #### get_pitch_random_scale - * [real](class_real) **`get_pitch_random_scale`** **(** **)** const + * [real](class_real) **get_pitch_random_scale** **(** **)** const Return the pitch random scaling. #### set_xfade_time - * void **`set_xfade_time`** **(** [real](class_real) sec **)** + * void **set_xfade_time** **(** [real](class_real) sec **)** Set the cross-fade time between random phonemes. #### get_xfade_time - * [real](class_real) **`get_xfade_time`** **(** **)** const + * [real](class_real) **get_xfade_time** **(** **)** const Return the cross-fade time between random phonemes. diff --git a/class_audiostreammpc.md b/class_audiostreammpc.md index 434e7e0..3b29b8f 100644 --- a/class_audiostreammpc.md +++ b/class_audiostreammpc.md @@ -6,8 +6,8 @@ MusePack audio stream driver. ### Member Functions - * void **[`set_file`](#set_file)** **(** [String](class_string) name **)** - * [String](class_string) **[`get_file`](#get_file)** **(** **)** const + * void **[set_file](#set_file)** **(** [String](class_string) name **)** + * [String](class_string) **[get_file](#get_file)** **(** **)** const ### Description MusePack audio stream driver. @@ -15,11 +15,11 @@ MusePack audio stream driver. ### Member Function Description #### set_file - * void **`set_file`** **(** [String](class_string) name **)** + * void **set_file** **(** [String](class_string) name **)** Set the file to be played. #### get_file - * [String](class_string) **`get_file`** **(** **)** const + * [String](class_string) **get_file** **(** **)** const Return the file being played. diff --git a/class_audiostreamspeex.md b/class_audiostreamspeex.md index 29d139f..1afa217 100644 --- a/class_audiostreamspeex.md +++ b/class_audiostreamspeex.md @@ -6,8 +6,8 @@ Speex audio stream driver. ### Member Functions - * void **[`set_file`](#set_file)** **(** [String](class_string) file **)** - * [String](class_string) **[`get_file`](#get_file)** **(** **)** const + * void **[set_file](#set_file)** **(** [String](class_string) file **)** + * [String](class_string) **[get_file](#get_file)** **(** **)** const ### Description Speex audio stream driver. Speex is very useful for compressed speech. It allows loading a very large amount of speech in memory at little IO/latency cost. @@ -15,11 +15,11 @@ Speex audio stream driver. Speex is very useful for compressed speech. It allows ### Member Function Description #### set_file - * void **`set_file`** **(** [String](class_string) file **)** + * void **set_file** **(** [String](class_string) file **)** Set the speech file (which is loaded to memory). #### get_file - * [String](class_string) **`get_file`** **(** **)** const + * [String](class_string) **get_file** **(** **)** const Return the speech file. diff --git a/class_basebutton.md b/class_basebutton.md index d65db24..8decc34 100644 --- a/class_basebutton.md +++ b/class_basebutton.md @@ -6,18 +6,18 @@ Provides a base class for different kinds of buttons. ### Member Functions - * void **[`set_pressed`](#set_pressed)** **(** [bool](class_bool) pressed **)** - * [bool](class_bool) **[`is_pressed`](#is_pressed)** **(** **)** const - * void **[`set_toggle_mode`](#set_toggle_mode)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`is_toggle_mode`](#is_toggle_mode)** **(** **)** const - * void **[`set_disabled`](#set_disabled)** **(** [bool](class_bool) disabled **)** - * [bool](class_bool) **[`is_disabled`](#is_disabled)** **(** **)** const - * void **[`set_click_on_press`](#set_click_on_press)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`get_click_on_press`](#get_click_on_press)** **(** **)** const + * void **[set_pressed](#set_pressed)** **(** [bool](class_bool) pressed **)** + * [bool](class_bool) **[is_pressed](#is_pressed)** **(** **)** const + * void **[set_toggle_mode](#set_toggle_mode)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[is_toggle_mode](#is_toggle_mode)** **(** **)** const + * void **[set_disabled](#set_disabled)** **(** [bool](class_bool) disabled **)** + * [bool](class_bool) **[is_disabled](#is_disabled)** **(** **)** const + * void **[set_click_on_press](#set_click_on_press)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[get_click_on_press](#get_click_on_press)** **(** **)** const ### Signals - * **`toggled`** **(** [bool](class_bool) pressed **)** - * **`pressed`** **(** **)** + * **toggled** **(** [bool](class_bool) pressed **)** + * **pressed** **(** **)** ### Description BaseButton is the abstract base class for buttons, so it shouldn't be used directly (It doesnt display anything). Other types of buttons inherit from it. @@ -25,41 +25,41 @@ BaseButton is the abstract base class for buttons, so it shouldn't be used direc ### Member Function Description #### set_pressed - * void **`set_pressed`** **(** [bool](class_bool) pressed **)** + * void **set_pressed** **(** [bool](class_bool) pressed **)** Set the button to pressed state (only if toggle_mode is active). #### is_pressed - * [bool](class_bool) **`is_pressed`** **(** **)** const + * [bool](class_bool) **is_pressed** **(** **)** const Return when the button is pressed (only if toggle_mode is active). #### set_toggle_mode - * void **`set_toggle_mode`** **(** [bool](class_bool) enabled **)** + * void **set_toggle_mode** **(** [bool](class_bool) enabled **)** Set the button toggle_mode property. Toggle mode makes the button flip state between pressed and unpressed each time its area is clicked. #### is_toggle_mode - * [bool](class_bool) **`is_toggle_mode`** **(** **)** const + * [bool](class_bool) **is_toggle_mode** **(** **)** const -Return the toggle_mode property (see [`set_toggle_mode`](#set_toggle_mode)). +Return the toggle_mode property (see [set_toggle_mode](#set_toggle_mode)). #### set_disabled - * void **`set_disabled`** **(** [bool](class_bool) disabled **)** + * void **set_disabled** **(** [bool](class_bool) disabled **)** Set the button into disabled state. When a button is disabled, it can"apos;t be clicked or toggled. #### is_disabled - * [bool](class_bool) **`is_disabled`** **(** **)** const + * [bool](class_bool) **is_disabled** **(** **)** const -Return wether the button is in disabled state (see [`set_disabled`](#set_disabled)). +Return wether the button is in disabled state (see [set_disabled](#set_disabled)). #### set_click_on_press - * void **`set_click_on_press`** **(** [bool](class_bool) enable **)** + * void **set_click_on_press** **(** [bool](class_bool) enable **)** Set the button click_on_press mode. This mode generates click events when a mousebutton or key is just pressed (by default events are generated when the button/keys are released and both press and release occur in the visual area of the Button). #### get_click_on_press - * [bool](class_bool) **`get_click_on_press`** **(** **)** const + * [bool](class_bool) **get_click_on_press** **(** **)** const -Return the state of the click_on_press property (see [`set_click_on_press`](#set_click_on_press)). +Return the state of the click_on_press property (see [set_click_on_press](#set_click_on_press)). diff --git a/class_bitmap.md b/class_bitmap.md index f52e58c..647ac7c 100644 --- a/class_bitmap.md +++ b/class_bitmap.md @@ -6,12 +6,12 @@ ### Member Functions - * void **[`create`](#create)** **(** [Vector2](class_vector2) size **)** - * void **[`create_from_image_alpha`](#create_from_image_alpha)** **(** [Image](class_image) image **)** - * void **[`set_bit`](#set_bit)** **(** [Vector2](class_vector2) pos, [bool](class_bool) bit **)** - * [bool](class_bool) **[`get_bit`](#get_bit)** **(** [Vector2](class_vector2) pos **)** const - * void **[`set_bit_rect`](#set_bit_rect)** **(** [Rect2](class_rect2) p_rect, [bool](class_bool) bit **)** - * [int](class_int) **[`get_true_bit_count`](#get_true_bit_count)** **(** **)** const - * [Vector2](class_vector2) **[`get_size`](#get_size)** **(** **)** const + * void **[create](#create)** **(** [Vector2](class_vector2) size **)** + * void **[create_from_image_alpha](#create_from_image_alpha)** **(** [Image](class_image) image **)** + * void **[set_bit](#set_bit)** **(** [Vector2](class_vector2) pos, [bool](class_bool) bit **)** + * [bool](class_bool) **[get_bit](#get_bit)** **(** [Vector2](class_vector2) pos **)** const + * void **[set_bit_rect](#set_bit_rect)** **(** [Rect2](class_rect2) p_rect, [bool](class_bool) bit **)** + * [int](class_int) **[get_true_bit_count](#get_true_bit_count)** **(** **)** const + * [Vector2](class_vector2) **[get_size](#get_size)** **(** **)** const ### Member Function Description diff --git a/class_bool.md b/class_bool.md index 3e30b1d..4f8efe9 100644 --- a/class_bool.md +++ b/class_bool.md @@ -5,9 +5,9 @@ Boolean built-in type ### Member Functions - * void **[`bool`](#bool)** **(** [int](class_int) from **)** - * void **[`bool`](#bool)** **(** [real](class_real) from **)** - * void **[`bool`](#bool)** **(** [String](class_string) from **)** + * void **[bool](#bool)** **(** [int](class_int) from **)** + * void **[bool](#bool)** **(** [real](class_real) from **)** + * void **[bool](#bool)** **(** [String](class_string) from **)** ### Description Boolean built-in type. diff --git a/class_boxshape.md b/class_boxshape.md index 10e1506..27f921a 100644 --- a/class_boxshape.md +++ b/class_boxshape.md @@ -6,8 +6,8 @@ Box shape resource. ### Member Functions - * void **[`set_extents`](#set_extents)** **(** [Vector3](class_vector3) extents **)** - * [Vector3](class_vector3) **[`get_extents`](#get_extents)** **(** **)** const + * void **[set_extents](#set_extents)** **(** [Vector3](class_vector3) extents **)** + * [Vector3](class_vector3) **[get_extents](#get_extents)** **(** **)** const ### Description Box shape resource, which can be set into a [PhysicsBody](class_physicsbody) or area. @@ -15,11 +15,11 @@ Box shape resource, which can be set into a [PhysicsBody](class_physicsbody) or ### Member Function Description #### set_extents - * void **`set_extents`** **(** [Vector3](class_vector3) extents **)** + * void **set_extents** **(** [Vector3](class_vector3) extents **)** Set the half extents for the shape. #### get_extents - * [Vector3](class_vector3) **`get_extents`** **(** **)** const + * [Vector3](class_vector3) **get_extents** **(** **)** const Return the half extents of the shape. diff --git a/class_button.md b/class_button.md index 92e2512..8d70030 100644 --- a/class_button.md +++ b/class_button.md @@ -6,16 +6,16 @@ Standard themed Button. ### Member Functions - * void **[`set_text`](#set_text)** **(** [String](class_string) text **)** - * [String](class_string) **[`get_text`](#get_text)** **(** **)** const - * void **[`set_button_icon`](#set_button_icon)** **(** [Texture](class_texture) texture **)** - * [Texture](class_texture) **[`get_button_icon`](#get_button_icon)** **(** **)** const - * void **[`set_flat`](#set_flat)** **(** [bool](class_bool) enabled **)** - * void **[`set_clip_text`](#set_clip_text)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`get_clip_text`](#get_clip_text)** **(** **)** const - * void **[`set_text_align`](#set_text_align)** **(** [int](class_int) align **)** - * [int](class_int) **[`get_text_align`](#get_text_align)** **(** **)** const - * [bool](class_bool) **[`is_flat`](#is_flat)** **(** **)** const + * void **[set_text](#set_text)** **(** [String](class_string) text **)** + * [String](class_string) **[get_text](#get_text)** **(** **)** const + * void **[set_button_icon](#set_button_icon)** **(** [Texture](class_texture) texture **)** + * [Texture](class_texture) **[get_button_icon](#get_button_icon)** **(** **)** const + * void **[set_flat](#set_flat)** **(** [bool](class_bool) enabled **)** + * void **[set_clip_text](#set_clip_text)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[get_clip_text](#get_clip_text)** **(** **)** const + * void **[set_text_align](#set_text_align)** **(** [int](class_int) align **)** + * [int](class_int) **[get_text_align](#get_text_align)** **(** **)** const + * [bool](class_bool) **[is_flat](#is_flat)** **(** **)** const ### Description Button is just the standard themed button: [image src="images/button_example.png"/] It can contain text and an icon, and will display them according to the current [Theme](class_theme). @@ -23,31 +23,31 @@ Button is just the standard themed button: [image src="images/button_example.png ### Member Function Description #### set_text - * void **`set_text`** **(** [String](class_string) text **)** + * void **set_text** **(** [String](class_string) text **)** Set the button text, which will be displayed inside the button area. #### get_text - * [String](class_string) **`get_text`** **(** **)** const + * [String](class_string) **get_text** **(** **)** const Return the button text. #### set_flat - * void **`set_flat`** **(** [bool](class_bool) enabled **)** + * void **set_flat** **(** [bool](class_bool) enabled **)** Set the _flat_ property of a Button. Flat buttons don"apos;t display decoration unless hoevered or pressed. #### set_clip_text - * void **`set_clip_text`** **(** [bool](class_bool) enabled **)** + * void **set_clip_text** **(** [bool](class_bool) enabled **)** Set the _clip_text_ property of a Button. When this property is enabled, text that is too large to fit the button is clipped, when disabled (default) the Button will always be wide enough to hold the text. #### get_clip_text - * [bool](class_bool) **`get_clip_text`** **(** **)** const + * [bool](class_bool) **get_clip_text** **(** **)** const -Return the state of the _clip_text_ property (see [`set_clip_text`](#set_clip_text)) +Return the state of the _clip_text_ property (see [set_clip_text](#set_clip_text)) #### is_flat - * [bool](class_bool) **`is_flat`** **(** **)** const + * [bool](class_bool) **is_flat** **(** **)** const -Return the state of the _flat_ property (see [`set_flat`](#set_flat)) +Return the state of the _flat_ property (see [set_flat](#set_flat)) diff --git a/class_buttonarray.md b/class_buttonarray.md index 6eadc76..a1145d3 100644 --- a/class_buttonarray.md +++ b/class_buttonarray.md @@ -6,21 +6,21 @@ Array of Buttons. ### Member Functions - * void **[`add_button`](#add_button)** **(** [String](class_string) text **)** - * void **[`add_icon_button`](#add_icon_button)** **(** [Object](class_object) icon, [String](class_string) text="" **)** - * void **[`set_button_text`](#set_button_text)** **(** [int](class_int) button, [String](class_string) text **)** - * void **[`set_button_icon`](#set_button_icon)** **(** [int](class_int) button, [Object](class_object) icon **)** - * [String](class_string) **[`get_button_text`](#get_button_text)** **(** [int](class_int) button **)** const - * [Object](class_object) **[`get_button_icon`](#get_button_icon)** **(** [int](class_int) button **)** const - * [int](class_int) **[`get_button_count`](#get_button_count)** **(** **)** const - * [int](class_int) **[`get_selected`](#get_selected)** **(** **)** const - * [int](class_int) **[`get_hovered`](#get_hovered)** **(** **)** const - * void **[`set_selected`](#set_selected)** **(** [int](class_int) button **)** - * void **[`erase_button`](#erase_button)** **(** [int](class_int) button **)** - * void **[`clear`](#clear)** **(** **)** + * void **[add_button](#add_button)** **(** [String](class_string) text **)** + * void **[add_icon_button](#add_icon_button)** **(** [Object](class_object) icon, [String](class_string) text="" **)** + * void **[set_button_text](#set_button_text)** **(** [int](class_int) button, [String](class_string) text **)** + * void **[set_button_icon](#set_button_icon)** **(** [int](class_int) button, [Object](class_object) icon **)** + * [String](class_string) **[get_button_text](#get_button_text)** **(** [int](class_int) button **)** const + * [Object](class_object) **[get_button_icon](#get_button_icon)** **(** [int](class_int) button **)** const + * [int](class_int) **[get_button_count](#get_button_count)** **(** **)** const + * [int](class_int) **[get_selected](#get_selected)** **(** **)** const + * [int](class_int) **[get_hovered](#get_hovered)** **(** **)** const + * void **[set_selected](#set_selected)** **(** [int](class_int) button **)** + * void **[erase_button](#erase_button)** **(** [int](class_int) button **)** + * void **[clear](#clear)** **(** **)** ### Signals - * **`button_selected`** **(** [int](class_int) button **)** + * **button_selected** **(** [int](class_int) button **)** ### Numeric Constants * **ALIGN_BEGIN** = **0** - Align buttons at the begining. @@ -35,51 +35,51 @@ Array of Buttons. A Button array is useful to have an array of buttons laid out ### Member Function Description #### add_button - * void **`add_button`** **(** [String](class_string) text **)** + * void **add_button** **(** [String](class_string) text **)** Add a new button. #### set_button_icon - * void **`set_button_icon`** **(** [int](class_int) button, [Object](class_object) icon **)** + * void **set_button_icon** **(** [int](class_int) button, [Object](class_object) icon **)** Set the icon of an existing button. #### get_button_text - * [String](class_string) **`get_button_text`** **(** [int](class_int) button **)** const + * [String](class_string) **get_button_text** **(** [int](class_int) button **)** const Return the text of an existing button. #### get_button_icon - * [Object](class_object) **`get_button_icon`** **(** [int](class_int) button **)** const + * [Object](class_object) **get_button_icon** **(** [int](class_int) button **)** const Return the icon of an existing button. #### get_button_count - * [int](class_int) **`get_button_count`** **(** **)** const + * [int](class_int) **get_button_count** **(** **)** const Return the amount of buttons in the array. #### get_selected - * [int](class_int) **`get_selected`** **(** **)** const + * [int](class_int) **get_selected** **(** **)** const Return the currently selected button in the array. #### get_hovered - * [int](class_int) **`get_hovered`** **(** **)** const + * [int](class_int) **get_hovered** **(** **)** const Return the currently hovered button in the array. #### set_selected - * void **`set_selected`** **(** [int](class_int) button **)** + * void **set_selected** **(** [int](class_int) button **)** Sekect a button in the array. #### erase_button - * void **`erase_button`** **(** [int](class_int) button **)** + * void **erase_button** **(** [int](class_int) button **)** Remove a button in the array, by index. #### clear - * void **`clear`** **(** **)** + * void **clear** **(** **)** Clear the button array. diff --git a/class_buttongroup.md b/class_buttongroup.md index 18f0f48..42a172f 100644 --- a/class_buttongroup.md +++ b/class_buttongroup.md @@ -6,11 +6,11 @@ Group of Buttons. ### Member Functions - * [BaseButton](class_basebutton) **[`get_pressed_button`](#get_pressed_button)** **(** **)** const - * [int](class_int) **[`get_pressed_button_index`](#get_pressed_button_index)** **(** **)** const - * [BaseButton](class_basebutton) **[`get_focused_button`](#get_focused_button)** **(** **)** const - * [Array](class_array) **[`get_button_list`](#get_button_list)** **(** **)** const - * void **[`set_pressed_button`](#set_pressed_button)** **(** [BaseButton](class_basebutton) button **)** + * [BaseButton](class_basebutton) **[get_pressed_button](#get_pressed_button)** **(** **)** const + * [int](class_int) **[get_pressed_button_index](#get_pressed_button_index)** **(** **)** const + * [BaseButton](class_basebutton) **[get_focused_button](#get_focused_button)** **(** **)** const + * [Array](class_array) **[get_button_list](#get_button_list)** **(** **)** const + * void **[set_pressed_button](#set_pressed_button)** **(** [BaseButton](class_basebutton) button **)** ### Description Group of [Button](class_button)s. All direct and indirect children buttons become radios. Only one allows being pressed. @@ -18,26 +18,26 @@ Group of [Button](class_button)s. All direct and indirect children buttons becom ### Member Function Description #### get_pressed_button - * [BaseButton](class_basebutton) **`get_pressed_button`** **(** **)** const + * [BaseButton](class_basebutton) **get_pressed_button** **(** **)** const Return the pressed button. #### get_pressed_button_index - * [int](class_int) **`get_pressed_button_index`** **(** **)** const + * [int](class_int) **get_pressed_button_index** **(** **)** const Return the index of the pressed button (by tree order). #### get_focused_button - * [BaseButton](class_basebutton) **`get_focused_button`** **(** **)** const + * [BaseButton](class_basebutton) **get_focused_button** **(** **)** const Return the focused button. #### get_button_list - * [Array](class_array) **`get_button_list`** **(** **)** const + * [Array](class_array) **get_button_list** **(** **)** const Return the list of all the buttons in the group. #### set_pressed_button - * void **`set_pressed_button`** **(** [BaseButton](class_basebutton) button **)** + * void **set_pressed_button** **(** [BaseButton](class_basebutton) button **)** Set the button to be pressed. diff --git a/class_camera.md b/class_camera.md index 6b22462..0c49852 100644 --- a/class_camera.md +++ b/class_camera.md @@ -6,30 +6,30 @@ Camera node, displays from a point of view. ### Member Functions - * [Vector3](class_vector3) **[`project_ray_normal`](#project_ray_normal)** **(** [Vector2](class_vector2) screen_point **)** const - * [Vector3](class_vector3) **[`project_local_ray_normal`](#project_local_ray_normal)** **(** [Vector2](class_vector2) screen_point **)** const - * [Vector3](class_vector3) **[`project_ray_origin`](#project_ray_origin)** **(** [Vector2](class_vector2) screen_point **)** const - * [Vector2](class_vector2) **[`unproject_position`](#unproject_position)** **(** [Vector3](class_vector3) world_point **)** const - * [Vector3](class_vector3) **[`project_position`](#project_position)** **(** [Vector2](class_vector2) screen_point **)** const - * void **[`set_perspective`](#set_perspective)** **(** [real](class_real) fov, [real](class_real) z_near, [real](class_real) z_far **)** - * void **[`set_orthogonal`](#set_orthogonal)** **(** [real](class_real) size, [real](class_real) z_near, [real](class_real) z_far **)** - * void **[`make_current`](#make_current)** **(** **)** - * void **[`clear_current`](#clear_current)** **(** **)** - * [bool](class_bool) **[`is_current`](#is_current)** **(** **)** const - * [Transform](class_transform) **[`get_camera_transform`](#get_camera_transform)** **(** **)** const - * [real](class_real) **[`get_fov`](#get_fov)** **(** **)** const - * [real](class_real) **[`get_size`](#get_size)** **(** **)** const - * [real](class_real) **[`get_zfar`](#get_zfar)** **(** **)** const - * [real](class_real) **[`get_znear`](#get_znear)** **(** **)** const - * [int](class_int) **[`get_projection`](#get_projection)** **(** **)** const - * void **[`set_visible_layers`](#set_visible_layers)** **(** [int](class_int) mask **)** - * [int](class_int) **[`get_visible_layers`](#get_visible_layers)** **(** **)** const - * void **[`look_at`](#look_at)** **(** [Vector3](class_vector3) target, [Vector3](class_vector3) up **)** - * void **[`look_at_from_pos`](#look_at_from_pos)** **(** [Vector3](class_vector3) pos, [Vector3](class_vector3) target, [Vector3](class_vector3) up **)** - * void **[`set_environment`](#set_environment)** **(** [Environment](class_environment) env **)** - * [Environment](class_environment) **[`get_environment`](#get_environment)** **(** **)** const - * void **[`set_use_vertical_aspect`](#set_use_vertical_aspect)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_using_vertical_aspect`](#is_using_vertical_aspect)** **(** **)** const + * [Vector3](class_vector3) **[project_ray_normal](#project_ray_normal)** **(** [Vector2](class_vector2) screen_point **)** const + * [Vector3](class_vector3) **[project_local_ray_normal](#project_local_ray_normal)** **(** [Vector2](class_vector2) screen_point **)** const + * [Vector3](class_vector3) **[project_ray_origin](#project_ray_origin)** **(** [Vector2](class_vector2) screen_point **)** const + * [Vector2](class_vector2) **[unproject_position](#unproject_position)** **(** [Vector3](class_vector3) world_point **)** const + * [Vector3](class_vector3) **[project_position](#project_position)** **(** [Vector2](class_vector2) screen_point **)** const + * void **[set_perspective](#set_perspective)** **(** [real](class_real) fov, [real](class_real) z_near, [real](class_real) z_far **)** + * void **[set_orthogonal](#set_orthogonal)** **(** [real](class_real) size, [real](class_real) z_near, [real](class_real) z_far **)** + * void **[make_current](#make_current)** **(** **)** + * void **[clear_current](#clear_current)** **(** **)** + * [bool](class_bool) **[is_current](#is_current)** **(** **)** const + * [Transform](class_transform) **[get_camera_transform](#get_camera_transform)** **(** **)** const + * [real](class_real) **[get_fov](#get_fov)** **(** **)** const + * [real](class_real) **[get_size](#get_size)** **(** **)** const + * [real](class_real) **[get_zfar](#get_zfar)** **(** **)** const + * [real](class_real) **[get_znear](#get_znear)** **(** **)** const + * [int](class_int) **[get_projection](#get_projection)** **(** **)** const + * void **[set_visible_layers](#set_visible_layers)** **(** [int](class_int) mask **)** + * [int](class_int) **[get_visible_layers](#get_visible_layers)** **(** **)** const + * void **[look_at](#look_at)** **(** [Vector3](class_vector3) target, [Vector3](class_vector3) up **)** + * void **[look_at_from_pos](#look_at_from_pos)** **(** [Vector3](class_vector3) pos, [Vector3](class_vector3) target, [Vector3](class_vector3) up **)** + * void **[set_environment](#set_environment)** **(** [Environment](class_environment) env **)** + * [Environment](class_environment) **[get_environment](#get_environment)** **(** **)** const + * void **[set_use_vertical_aspect](#set_use_vertical_aspect)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_using_vertical_aspect](#is_using_vertical_aspect)** **(** **)** const ### Numeric Constants * **PROJECTION_PERSPECTIVE** = **0** - Perspective Projection (object's size on the screen becomes smaller when far away). @@ -41,41 +41,41 @@ Camera is a special node that displays what is visible from its current location ### Member Function Description #### project_ray_normal - * [Vector3](class_vector3) **`project_ray_normal`** **(** [Vector2](class_vector2) screen_point **)** const + * [Vector3](class_vector3) **project_ray_normal** **(** [Vector2](class_vector2) screen_point **)** const Return a normal vector in worldspace, that is the result of projecting a point on the [Viewport](class_viewport) rectangle by the camera proyection. This is useful for casting rays in the form of (origin,normal) for object intersection or picking. #### project_ray_origin - * [Vector3](class_vector3) **`project_ray_origin`** **(** [Vector2](class_vector2) screen_point **)** const + * [Vector3](class_vector3) **project_ray_origin** **(** [Vector2](class_vector2) screen_point **)** const Return a 3D position in worldspace, that is the result of projecting a point on the [Viewport](class_viewport) rectangle by the camera proyection. This is useful for casting rays in the form of (origin,normal) for object intersection or picking. #### unproject_position - * [Vector2](class_vector2) **`unproject_position`** **(** [Vector3](class_vector3) world_point **)** const + * [Vector2](class_vector2) **unproject_position** **(** [Vector3](class_vector3) world_point **)** const Return how a 3D point in worldpsace maps to a 2D coordinate in the [Viewport](class_viewport) rectangle. #### set_perspective - * void **`set_perspective`** **(** [real](class_real) fov, [real](class_real) z_near, [real](class_real) z_far **)** + * void **set_perspective** **(** [real](class_real) fov, [real](class_real) z_near, [real](class_real) z_far **)** Set the camera projection to perspective mode, by specifying a _FOV_ Y angle in degrees (FOV means Field of View), and the _near_ and _far_ clip planes in worldspace units. #### set_orthogonal - * void **`set_orthogonal`** **(** [real](class_real) size, [real](class_real) z_near, [real](class_real) z_far **)** + * void **set_orthogonal** **(** [real](class_real) size, [real](class_real) z_near, [real](class_real) z_far **)** Set the camera projection to orthogonal mode, by specifying a"#10;"#9;"#9;"#9;width and the _near_ and _far_ clip planes in worldspace units. (As a hint, 2D games often use this projection, with values specified in pixels) #### make_current - * void **`make_current`** **(** **)** + * void **make_current** **(** **)** Make this camera the current Camera for the [Viewport](class_viewport) (see class description). If the Camera Node is outside the scene tree, it will attempt to become current once it"apos;s added. #### is_current - * [bool](class_bool) **`is_current`** **(** **)** const + * [bool](class_bool) **is_current** **(** **)** const Return wether the Camera is the current one in the [Viewport](class_viewport), or plans to become current (if outside the scene tree). #### get_camera_transform - * [Transform](class_transform) **`get_camera_transform`** **(** **)** const + * [Transform](class_transform) **get_camera_transform** **(** **)** const Get the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the [Node](class_node) transform. diff --git a/class_camera2d.md b/class_camera2d.md index db43c67..b99c0cc 100644 --- a/class_camera2d.md +++ b/class_camera2d.md @@ -6,31 +6,31 @@ Camera node for 2D scenes. ### Member Functions - * void **[`set_offset`](#set_offset)** **(** [Vector2](class_vector2) offset **)** - * [Vector2](class_vector2) **[`get_offset`](#get_offset)** **(** **)** const - * void **[`set_centered`](#set_centered)** **(** [bool](class_bool) centered **)** - * [bool](class_bool) **[`is_centered`](#is_centered)** **(** **)** const - * void **[`make_current`](#make_current)** **(** **)** - * [bool](class_bool) **[`is_current`](#is_current)** **(** **)** const - * void **[`set_limit`](#set_limit)** **(** [int](class_int) margin, [int](class_int) limit **)** - * [int](class_int) **[`get_limit`](#get_limit)** **(** [int](class_int) margin **)** const - * void **[`set_v_drag_enabled`](#set_v_drag_enabled)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`is_v_drag_enabled`](#is_v_drag_enabled)** **(** **)** const - * void **[`set_h_drag_enabled`](#set_h_drag_enabled)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`is_h_drag_enabled`](#is_h_drag_enabled)** **(** **)** const - * void **[`set_v_offset`](#set_v_offset)** **(** [real](class_real) ofs **)** - * [real](class_real) **[`get_v_offset`](#get_v_offset)** **(** **)** const - * void **[`set_h_offset`](#set_h_offset)** **(** [real](class_real) ofs **)** - * [real](class_real) **[`get_h_offset`](#get_h_offset)** **(** **)** const - * void **[`set_drag_margin`](#set_drag_margin)** **(** [int](class_int) margin, [real](class_real) drag_margin **)** - * [real](class_real) **[`get_drag_margin`](#get_drag_margin)** **(** [int](class_int) margin **)** const - * [Vector2](class_vector2) **[`get_camera_pos`](#get_camera_pos)** **(** **)** const - * [Vector2](class_vector2) **[`get_camera_screen_center`](#get_camera_screen_center)** **(** **)** const - * void **[`set_zoom`](#set_zoom)** **(** [Vector2](class_vector2) arg0 **)** - * [Vector2](class_vector2) **[`get_zoom`](#get_zoom)** **(** **)** const - * void **[`set_follow_smoothing`](#set_follow_smoothing)** **(** [real](class_real) follow_smoothing **)** - * [real](class_real) **[`get_follow_smoothing`](#get_follow_smoothing)** **(** **)** const - * void **[`force_update_scroll`](#force_update_scroll)** **(** **)** + * void **[set_offset](#set_offset)** **(** [Vector2](class_vector2) offset **)** + * [Vector2](class_vector2) **[get_offset](#get_offset)** **(** **)** const + * void **[set_centered](#set_centered)** **(** [bool](class_bool) centered **)** + * [bool](class_bool) **[is_centered](#is_centered)** **(** **)** const + * void **[make_current](#make_current)** **(** **)** + * [bool](class_bool) **[is_current](#is_current)** **(** **)** const + * void **[set_limit](#set_limit)** **(** [int](class_int) margin, [int](class_int) limit **)** + * [int](class_int) **[get_limit](#get_limit)** **(** [int](class_int) margin **)** const + * void **[set_v_drag_enabled](#set_v_drag_enabled)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[is_v_drag_enabled](#is_v_drag_enabled)** **(** **)** const + * void **[set_h_drag_enabled](#set_h_drag_enabled)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[is_h_drag_enabled](#is_h_drag_enabled)** **(** **)** const + * void **[set_v_offset](#set_v_offset)** **(** [real](class_real) ofs **)** + * [real](class_real) **[get_v_offset](#get_v_offset)** **(** **)** const + * void **[set_h_offset](#set_h_offset)** **(** [real](class_real) ofs **)** + * [real](class_real) **[get_h_offset](#get_h_offset)** **(** **)** const + * void **[set_drag_margin](#set_drag_margin)** **(** [int](class_int) margin, [real](class_real) drag_margin **)** + * [real](class_real) **[get_drag_margin](#get_drag_margin)** **(** [int](class_int) margin **)** const + * [Vector2](class_vector2) **[get_camera_pos](#get_camera_pos)** **(** **)** const + * [Vector2](class_vector2) **[get_camera_screen_center](#get_camera_screen_center)** **(** **)** const + * void **[set_zoom](#set_zoom)** **(** [Vector2](class_vector2) arg0 **)** + * [Vector2](class_vector2) **[get_zoom](#get_zoom)** **(** **)** const + * void **[set_follow_smoothing](#set_follow_smoothing)** **(** [real](class_real) follow_smoothing **)** + * [real](class_real) **[get_follow_smoothing](#get_follow_smoothing)** **(** **)** const + * void **[force_update_scroll](#force_update_scroll)** **(** **)** ### Description Camera node for 2D scenes. It forces the screen (current layer) to scroll following this node. This makes it easier (and faster) to program scrollable scenes than manually changing the position of [CanvasItem](class_canvasitem) based nodes. @@ -43,62 +43,62 @@ Camera node for 2D scenes. It forces the screen (current layer) to scroll follow ### Member Function Description #### set_offset - * void **`set_offset`** **(** [Vector2](class_vector2) offset **)** + * void **set_offset** **(** [Vector2](class_vector2) offset **)** Set the scroll offset. Useful for looking around or camera shake animations. #### get_offset - * [Vector2](class_vector2) **`get_offset`** **(** **)** const + * [Vector2](class_vector2) **get_offset** **(** **)** const Return the scroll offset. #### set_centered - * void **`set_centered`** **(** [bool](class_bool) centered **)** + * void **set_centered** **(** [bool](class_bool) centered **)** Set to true if the camera is at the center of the screen (default: true). #### is_centered - * [bool](class_bool) **`is_centered`** **(** **)** const + * [bool](class_bool) **is_centered** **(** **)** const Return true if the camera is at the center of the screen (default: true). #### make_current - * void **`make_current`** **(** **)** + * void **make_current** **(** **)** Make this the current 2D camera for the scene (viewport and layer), in case there's many cameras in the scene. #### is_current - * [bool](class_bool) **`is_current`** **(** **)** const + * [bool](class_bool) **is_current** **(** **)** const -Return true of this is the current camera (see [Camera2D.`make_current`](camera2d#make_current)). +Return true of this is the current camera (see [Camera2D.make_current](camera2d#make_current)). #### set_limit - * void **`set_limit`** **(** [int](class_int) margin, [int](class_int) limit **)** + * void **set_limit** **(** [int](class_int) margin, [int](class_int) limit **)** Set the scrolling limit in pixels #### get_limit - * [int](class_int) **`get_limit`** **(** [int](class_int) margin **)** const + * [int](class_int) **get_limit** **(** [int](class_int) margin **)** const Return the scrolling limit in pixels #### set_drag_margin - * void **`set_drag_margin`** **(** [int](class_int) margin, [real](class_real) drag_margin **)** + * void **set_drag_margin** **(** [int](class_int) margin, [real](class_real) drag_margin **)** Set the margins needed to drag the camera (relative to the screen size). Margin uses the MARGIN_* enum. Drag margins of 0,0,0,0 will keep the camera at the center of the screen, while drag margins of 1,1,1,1 will only move when the camera is at the edges. #### get_drag_margin - * [real](class_real) **`get_drag_margin`** **(** [int](class_int) margin **)** const + * [real](class_real) **get_drag_margin** **(** [int](class_int) margin **)** const -Return the margins needed to drag the camera (see [`set_drag_margin`](#set_drag_margin)). +Return the margins needed to drag the camera (see [set_drag_margin](#set_drag_margin)). #### get_camera_pos - * [Vector2](class_vector2) **`get_camera_pos`** **(** **)** const + * [Vector2](class_vector2) **get_camera_pos** **(** **)** const Return the camera position. #### force_update_scroll - * void **`force_update_scroll`** **(** **)** + * void **force_update_scroll** **(** **)** Force the camera to update scroll immediately. diff --git a/class_canvasitem.md b/class_canvasitem.md index 15cb40c..24241f0 100644 --- a/class_canvasitem.md +++ b/class_canvasitem.md @@ -6,54 +6,54 @@ Base class of anything 2D. ### Member Functions - * void **[`_draw`](#_draw)** **(** **)** virtual - * void **[`edit_set_state`](#edit_set_state)** **(** var state **)** - * void **[`edit_get`](#edit_get)** **(** **)** const - * void **[`edit_set_rect`](#edit_set_rect)** **(** [Rect2](class_rect2) rect **)** - * void **[`edit_rotate`](#edit_rotate)** **(** [real](class_real) degrees **)** - * [Rect2](class_rect2) **[`get_item_rect`](#get_item_rect)** **(** **)** const - * [RID](class_rid) **[`get_canvas_item`](#get_canvas_item)** **(** **)** const - * [bool](class_bool) **[`is_visible`](#is_visible)** **(** **)** const - * [bool](class_bool) **[`is_hidden`](#is_hidden)** **(** **)** const - * void **[`show`](#show)** **(** **)** - * void **[`hide`](#hide)** **(** **)** - * void **[`update`](#update)** **(** **)** - * void **[`set_as_toplevel`](#set_as_toplevel)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_set_as_toplevel`](#is_set_as_toplevel)** **(** **)** const - * void **[`set_blend_mode`](#set_blend_mode)** **(** [int](class_int) blend_mode **)** - * [int](class_int) **[`get_blend_mode`](#get_blend_mode)** **(** **)** const - * void **[`set_opacity`](#set_opacity)** **(** [real](class_real) opacity **)** - * [real](class_real) **[`get_opacity`](#get_opacity)** **(** **)** const - * void **[`set_self_opacity`](#set_self_opacity)** **(** [real](class_real) self_opacity **)** - * [real](class_real) **[`get_self_opacity`](#get_self_opacity)** **(** **)** const - * void **[`set_on_top`](#set_on_top)** **(** [bool](class_bool) on_top **)** - * [bool](class_bool) **[`is_on_top`](#is_on_top)** **(** **)** const - * void **[`draw_line`](#draw_line)** **(** [Vector2](class_vector2) from, [Vector2](class_vector2) to, [Color](class_color) color, [real](class_real) width=1 **)** - * void **[`draw_rect`](#draw_rect)** **(** [Rect2](class_rect2) rect, [Color](class_color) color **)** - * void **[`draw_circle`](#draw_circle)** **(** [Vector2](class_vector2) pos, [real](class_real) radius, [Color](class_color) color **)** - * void **[`draw_texture`](#draw_texture)** **(** [Texture](class_texture) texture, [Vector2](class_vector2) pos **)** - * void **[`draw_texture_rect`](#draw_texture_rect)** **(** [Texture](class_texture) texture, [Rect2](class_rect2) rect, [bool](class_bool) tile=false, [Color](class_color) modulate=Color(1,1,1,1) **)** - * void **[`draw_texture_rect_region`](#draw_texture_rect_region)** **(** [Texture](class_texture) texture, [Rect2](class_rect2) rect, [Rect2](class_rect2) src_rect, [Color](class_color) modulate=Color(1,1,1,1) **)** - * void **[`draw_style_box`](#draw_style_box)** **(** [StyleBox](class_stylebox) style_box, [Rect2](class_rect2) rect **)** - * void **[`draw_primitive`](#draw_primitive)** **(** [Vector2Array](class_vector2array) points, [ColorArray](class_colorarray) colors, [Vector2Array](class_vector2array) uvs=Array(), [Texture](class_texture) texture=Object(), [real](class_real) width=1 **)** - * void **[`draw_polygon`](#draw_polygon)** **(** [Vector2Array](class_vector2array) points, [ColorArray](class_colorarray) colors, [Vector2Array](class_vector2array) uvs, [Texture](class_texture) texture=Array(), [real](class_real) arg4=Object() **)** - * void **[`draw_colored_polygon`](#draw_colored_polygon)** **(** [Vector2Array](class_vector2array) points, [ColorArray](class_colorarray) color, [Vector2Array](class_vector2array) uvs, [Texture](class_texture) texture=Array(), [real](class_real) arg4=Object() **)** - * void **[`draw_string`](#draw_string)** **(** [Font](class_font) font, [Vector2](class_vector2) pos, [String](class_string) text, [Color](class_color) modulate=Color(1,1,1,1), [int](class_int) clip_w=-1 **)** - * [real](class_real) **[`draw_char`](#draw_char)** **(** [Font](class_font) font, [Vector2](class_vector2) pos, [String](class_string) char, [String](class_string) next, [Color](class_color) modulate=Color(1,1,1,1) **)** - * void **[`draw_set_transform`](#draw_set_transform)** **(** [Vector2](class_vector2) pos, [real](class_real) rot, [Vector2](class_vector2) scale **)** - * [Matrix32](class_matrix32) **[`get_transform`](#get_transform)** **(** **)** const - * [Matrix32](class_matrix32) **[`get_global_transform`](#get_global_transform)** **(** **)** const - * [Matrix32](class_matrix32) **[`get_viewport_transform`](#get_viewport_transform)** **(** **)** const - * [Rect2](class_rect2) **[`get_viewport_rect`](#get_viewport_rect)** **(** **)** const - * [RID](class_rid) **[`get_canvas`](#get_canvas)** **(** **)** const - * [Object](class_object) **[`get_world_2d`](#get_world_2d)** **(** **)** const - * [Object](class_object) **[`get_viewport`](#get_viewport)** **(** **)** const + * void **[_draw](#_draw)** **(** **)** virtual + * void **[edit_set_state](#edit_set_state)** **(** var state **)** + * void **[edit_get](#edit_get)** **(** **)** const + * void **[edit_set_rect](#edit_set_rect)** **(** [Rect2](class_rect2) rect **)** + * void **[edit_rotate](#edit_rotate)** **(** [real](class_real) degrees **)** + * [Rect2](class_rect2) **[get_item_rect](#get_item_rect)** **(** **)** const + * [RID](class_rid) **[get_canvas_item](#get_canvas_item)** **(** **)** const + * [bool](class_bool) **[is_visible](#is_visible)** **(** **)** const + * [bool](class_bool) **[is_hidden](#is_hidden)** **(** **)** const + * void **[show](#show)** **(** **)** + * void **[hide](#hide)** **(** **)** + * void **[update](#update)** **(** **)** + * void **[set_as_toplevel](#set_as_toplevel)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_set_as_toplevel](#is_set_as_toplevel)** **(** **)** const + * void **[set_blend_mode](#set_blend_mode)** **(** [int](class_int) blend_mode **)** + * [int](class_int) **[get_blend_mode](#get_blend_mode)** **(** **)** const + * void **[set_opacity](#set_opacity)** **(** [real](class_real) opacity **)** + * [real](class_real) **[get_opacity](#get_opacity)** **(** **)** const + * void **[set_self_opacity](#set_self_opacity)** **(** [real](class_real) self_opacity **)** + * [real](class_real) **[get_self_opacity](#get_self_opacity)** **(** **)** const + * void **[set_on_top](#set_on_top)** **(** [bool](class_bool) on_top **)** + * [bool](class_bool) **[is_on_top](#is_on_top)** **(** **)** const + * void **[draw_line](#draw_line)** **(** [Vector2](class_vector2) from, [Vector2](class_vector2) to, [Color](class_color) color, [real](class_real) width=1 **)** + * void **[draw_rect](#draw_rect)** **(** [Rect2](class_rect2) rect, [Color](class_color) color **)** + * void **[draw_circle](#draw_circle)** **(** [Vector2](class_vector2) pos, [real](class_real) radius, [Color](class_color) color **)** + * void **[draw_texture](#draw_texture)** **(** [Texture](class_texture) texture, [Vector2](class_vector2) pos **)** + * void **[draw_texture_rect](#draw_texture_rect)** **(** [Texture](class_texture) texture, [Rect2](class_rect2) rect, [bool](class_bool) tile=false, [Color](class_color) modulate=Color(1,1,1,1) **)** + * void **[draw_texture_rect_region](#draw_texture_rect_region)** **(** [Texture](class_texture) texture, [Rect2](class_rect2) rect, [Rect2](class_rect2) src_rect, [Color](class_color) modulate=Color(1,1,1,1) **)** + * void **[draw_style_box](#draw_style_box)** **(** [StyleBox](class_stylebox) style_box, [Rect2](class_rect2) rect **)** + * void **[draw_primitive](#draw_primitive)** **(** [Vector2Array](class_vector2array) points, [ColorArray](class_colorarray) colors, [Vector2Array](class_vector2array) uvs=Array(), [Texture](class_texture) texture=Object(), [real](class_real) width=1 **)** + * void **[draw_polygon](#draw_polygon)** **(** [Vector2Array](class_vector2array) points, [ColorArray](class_colorarray) colors, [Vector2Array](class_vector2array) uvs, [Texture](class_texture) texture=Array(), [real](class_real) arg4=Object() **)** + * void **[draw_colored_polygon](#draw_colored_polygon)** **(** [Vector2Array](class_vector2array) points, [ColorArray](class_colorarray) color, [Vector2Array](class_vector2array) uvs, [Texture](class_texture) texture=Array(), [real](class_real) arg4=Object() **)** + * void **[draw_string](#draw_string)** **(** [Font](class_font) font, [Vector2](class_vector2) pos, [String](class_string) text, [Color](class_color) modulate=Color(1,1,1,1), [int](class_int) clip_w=-1 **)** + * [real](class_real) **[draw_char](#draw_char)** **(** [Font](class_font) font, [Vector2](class_vector2) pos, [String](class_string) char, [String](class_string) next, [Color](class_color) modulate=Color(1,1,1,1) **)** + * void **[draw_set_transform](#draw_set_transform)** **(** [Vector2](class_vector2) pos, [real](class_real) rot, [Vector2](class_vector2) scale **)** + * [Matrix32](class_matrix32) **[get_transform](#get_transform)** **(** **)** const + * [Matrix32](class_matrix32) **[get_global_transform](#get_global_transform)** **(** **)** const + * [Matrix32](class_matrix32) **[get_viewport_transform](#get_viewport_transform)** **(** **)** const + * [Rect2](class_rect2) **[get_viewport_rect](#get_viewport_rect)** **(** **)** const + * [RID](class_rid) **[get_canvas](#get_canvas)** **(** **)** const + * [Object](class_object) **[get_worldθd](#get_world_2d)** **(** **)** const + * [Object](class_object) **[get_viewport](#get_viewport)** **(** **)** const ### Signals - * **`item_rect_changed`** **(** **)** - * **`draw`** **(** **)** - * **`visibility_changed`** **(** **)** - * **`hide`** **(** **)** + * **item_rect_changed** **(** **)** + * **draw** **(** **)** + * **visibility_changed** **(** **)** + * **hide** **(** **)** ### Numeric Constants * **BLEND_MODE_MIX** = **0** - Mix blending mode. @@ -76,161 +76,161 @@ Base class of anything 2D. Canvas items are laid out in a tree and children inhe ### Member Function Description #### _draw - * void **`_draw`** **(** **)** virtual + * void **_draw** **(** **)** virtual Called (if exists) to draw the canvas item. #### edit_set_state - * void **`edit_set_state`** **(** var state **)** + * void **edit_set_state** **(** var state **)** Used for editing, returns an opaque value represeting the transform state. #### edit_rotate - * void **`edit_rotate`** **(** [real](class_real) degrees **)** + * void **edit_rotate** **(** [real](class_real) degrees **)** Used for editing, handle rotation. #### get_item_rect - * [Rect2](class_rect2) **`get_item_rect`** **(** **)** const + * [Rect2](class_rect2) **get_item_rect** **(** **)** const Return a rect containing the editable contents of the item. #### get_canvas_item - * [RID](class_rid) **`get_canvas_item`** **(** **)** const + * [RID](class_rid) **get_canvas_item** **(** **)** const Return the canvas item RID used by [VisualServer](class_visualserver) for this item. #### is_visible - * [bool](class_bool) **`is_visible`** **(** **)** const + * [bool](class_bool) **is_visible** **(** **)** const Return true if this CanvasItem is visible. It may be invisible because itself or a parent canvas item is hidden. #### is_hidden - * [bool](class_bool) **`is_hidden`** **(** **)** const + * [bool](class_bool) **is_hidden** **(** **)** const -Return true if this CanvasItem is hidden. Note that the CanvasItem may not be visible, but as long as it's not hidden ([`hide`](#hide) called) the function will return false. +Return true if this CanvasItem is hidden. Note that the CanvasItem may not be visible, but as long as it's not hidden ([hide](#hide) called) the function will return false. #### show - * void **`show`** **(** **)** + * void **show** **(** **)** Show the CanvasItem currently hidden. #### hide - * void **`hide`** **(** **)** + * void **hide** **(** **)** Hide the CanvasItem currently visible. #### update - * void **`update`** **(** **)** + * void **update** **(** **)** Queue the CanvasItem for update. NOTIFICATION_DRAW will be called on idle time to request redraw. #### set_as_toplevel - * void **`set_as_toplevel`** **(** [bool](class_bool) enable **)** + * void **set_as_toplevel** **(** [bool](class_bool) enable **)** Set as toplevel. This means that it will not inherit transform from parent canvas items. #### is_set_as_toplevel - * [bool](class_bool) **`is_set_as_toplevel`** **(** **)** const + * [bool](class_bool) **is_set_as_toplevel** **(** **)** const -Return if set as toplevel. See [`set_as_toplevel`](#set_as_toplevel)/ +Return if set as toplevel. See [set_as_toplevel](#set_as_toplevel)/ #### set_blend_mode - * void **`set_blend_mode`** **(** [int](class_int) blend_mode **)** + * void **set_blend_mode** **(** [int](class_int) blend_mode **)** Set the blending mode from enum BLEND_MODE_*. #### get_blend_mode - * [int](class_int) **`get_blend_mode`** **(** **)** const + * [int](class_int) **get_blend_mode** **(** **)** const Return the current blending mode from enum BLEND_MODE_*. #### set_opacity - * void **`set_opacity`** **(** [real](class_real) opacity **)** + * void **set_opacity** **(** [real](class_real) opacity **)** Set canvas item opacity. This will affect the canvas item and all the children. #### get_opacity - * [real](class_real) **`get_opacity`** **(** **)** const + * [real](class_real) **get_opacity** **(** **)** const Return the canvas item opacity. This affects the canvas item and all the children. #### get_self_opacity - * [real](class_real) **`get_self_opacity`** **(** **)** const + * [real](class_real) **get_self_opacity** **(** **)** const Set canvas item self-opacity. This does not affect the opacity of children items. #### set_on_top - * void **`set_on_top`** **(** [bool](class_bool) on_top **)** + * void **set_on_top** **(** [bool](class_bool) on_top **)** Set canvas item as drawing over the parent canvas item (default: true). #### is_on_top - * [bool](class_bool) **`is_on_top`** **(** **)** const + * [bool](class_bool) **is_on_top** **(** **)** const Return if the canvas item is drawing over the parent canvas item (default: true). #### draw_line - * void **`draw_line`** **(** [Vector2](class_vector2) from, [Vector2](class_vector2) to, [Color](class_color) color, [real](class_real) width=1 **)** + * void **draw_line** **(** [Vector2](class_vector2) from, [Vector2](class_vector2) to, [Color](class_color) color, [real](class_real) width=1 **)** Draw a line from a 2D point to another, with a given color and width. #### draw_rect - * void **`draw_rect`** **(** [Rect2](class_rect2) rect, [Color](class_color) color **)** + * void **draw_rect** **(** [Rect2](class_rect2) rect, [Color](class_color) color **)** Draw a colored rectangle. #### draw_circle - * void **`draw_circle`** **(** [Vector2](class_vector2) pos, [real](class_real) radius, [Color](class_color) color **)** + * void **draw_circle** **(** [Vector2](class_vector2) pos, [real](class_real) radius, [Color](class_color) color **)** Draw a colored circle. #### draw_texture - * void **`draw_texture`** **(** [Texture](class_texture) texture, [Vector2](class_vector2) pos **)** + * void **draw_texture** **(** [Texture](class_texture) texture, [Vector2](class_vector2) pos **)** Draw a texture at a given position. #### draw_texture_rect - * void **`draw_texture_rect`** **(** [Texture](class_texture) texture, [Rect2](class_rect2) rect, [bool](class_bool) tile=false, [Color](class_color) modulate=Color(1,1,1,1) **)** + * void **draw_texture_rect** **(** [Texture](class_texture) texture, [Rect2](class_rect2) rect, [bool](class_bool) tile=false, [Color](class_color) modulate=Color(1,1,1,1) **)** Draw a textured rectangle at a given position, optionally modulated by a color. #### draw_texture_rect_region - * void **`draw_texture_rect_region`** **(** [Texture](class_texture) texture, [Rect2](class_rect2) rect, [Rect2](class_rect2) src_rect, [Color](class_color) modulate=Color(1,1,1,1) **)** + * void **draw_texture_rect_region** **(** [Texture](class_texture) texture, [Rect2](class_rect2) rect, [Rect2](class_rect2) src_rect, [Color](class_color) modulate=Color(1,1,1,1) **)** Draw a textured rectangle region at a given position, optionally modulated by a color. #### draw_style_box - * void **`draw_style_box`** **(** [StyleBox](class_stylebox) style_box, [Rect2](class_rect2) rect **)** + * void **draw_style_box** **(** [StyleBox](class_stylebox) style_box, [Rect2](class_rect2) rect **)** Draw a styled rectangle. #### draw_primitive - * void **`draw_primitive`** **(** [Vector2Array](class_vector2array) points, [ColorArray](class_colorarray) colors, [Vector2Array](class_vector2array) uvs=Array(), [Texture](class_texture) texture=Object(), [real](class_real) width=1 **)** + * void **draw_primitive** **(** [Vector2Array](class_vector2array) points, [ColorArray](class_colorarray) colors, [Vector2Array](class_vector2array) uvs=Array(), [Texture](class_texture) texture=Object(), [real](class_real) width=1 **)** 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. #### draw_polygon - * void **`draw_polygon`** **(** [Vector2Array](class_vector2array) points, [ColorArray](class_colorarray) colors, [Vector2Array](class_vector2array) uvs, [Texture](class_texture) texture=Array(), [real](class_real) arg4=Object() **)** + * void **draw_polygon** **(** [Vector2Array](class_vector2array) points, [ColorArray](class_colorarray) colors, [Vector2Array](class_vector2array) uvs, [Texture](class_texture) texture=Array(), [real](class_real) arg4=Object() **)** Draw a polygon of any amount of points, convex or concave. #### draw_colored_polygon - * void **`draw_colored_polygon`** **(** [Vector2Array](class_vector2array) points, [ColorArray](class_colorarray) color, [Vector2Array](class_vector2array) uvs, [Texture](class_texture) texture=Array(), [real](class_real) arg4=Object() **)** + * void **draw_colored_polygon** **(** [Vector2Array](class_vector2array) points, [ColorArray](class_colorarray) color, [Vector2Array](class_vector2array) uvs, [Texture](class_texture) texture=Array(), [real](class_real) arg4=Object() **)** Draw a colored polygon of any amount of points, convex or concave. #### draw_string - * void **`draw_string`** **(** [Font](class_font) font, [Vector2](class_vector2) pos, [String](class_string) text, [Color](class_color) modulate=Color(1,1,1,1), [int](class_int) clip_w=-1 **)** + * void **draw_string** **(** [Font](class_font) font, [Vector2](class_vector2) pos, [String](class_string) text, [Color](class_color) modulate=Color(1,1,1,1), [int](class_int) clip_w=-1 **)** Draw a string using a custom font. #### draw_char - * [real](class_real) **`draw_char`** **(** [Font](class_font) font, [Vector2](class_vector2) pos, [String](class_string) char, [String](class_string) next, [Color](class_color) modulate=Color(1,1,1,1) **)** + * [real](class_real) **draw_char** **(** [Font](class_font) font, [Vector2](class_vector2) pos, [String](class_string) char, [String](class_string) next, [Color](class_color) modulate=Color(1,1,1,1) **)** Draw a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char. #### draw_set_transform - * void **`draw_set_transform`** **(** [Vector2](class_vector2) pos, [real](class_real) rot, [Vector2](class_vector2) scale **)** + * void **draw_set_transform** **(** [Vector2](class_vector2) pos, [real](class_real) rot, [Vector2](class_vector2) scale **)** Set a custom transform for drawing. Anything drawn afterwards will be transformed by this. diff --git a/class_canvaslayer.md b/class_canvaslayer.md index d8d872b..1760a59 100644 --- a/class_canvaslayer.md +++ b/class_canvaslayer.md @@ -6,18 +6,18 @@ Canvas Item layer. ### Member Functions - * void **[`set_layer`](#set_layer)** **(** [int](class_int) layer **)** - * [int](class_int) **[`get_layer`](#get_layer)** **(** **)** const - * void **[`set_transform`](#set_transform)** **(** [Matrix32](class_matrix32) transform **)** - * [Matrix32](class_matrix32) **[`get_transform`](#get_transform)** **(** **)** const - * void **[`set_offset`](#set_offset)** **(** [Vector2](class_vector2) offset **)** - * [Vector2](class_vector2) **[`get_offset`](#get_offset)** **(** **)** const - * void **[`set_rotation`](#set_rotation)** **(** [real](class_real) rotation **)** - * [real](class_real) **[`get_rotation`](#get_rotation)** **(** **)** const - * void **[`set_scale`](#set_scale)** **(** [Vector2](class_vector2) scale **)** - * [Vector2](class_vector2) **[`get_scale`](#get_scale)** **(** **)** const - * Canvas **[`get_world_2d`](#get_world_2d)** **(** **)** const - * [RID](class_rid) **[`get_viewport`](#get_viewport)** **(** **)** const + * void **[set_layer](#set_layer)** **(** [int](class_int) layer **)** + * [int](class_int) **[get_layer](#get_layer)** **(** **)** const + * void **[set_transform](#set_transform)** **(** [Matrix32](class_matrix32) transform **)** + * [Matrix32](class_matrix32) **[get_transform](#get_transform)** **(** **)** const + * void **[set_offset](#set_offset)** **(** [Vector2](class_vector2) offset **)** + * [Vector2](class_vector2) **[get_offset](#get_offset)** **(** **)** const + * void **[set_rotation](#set_rotation)** **(** [real](class_real) rotation **)** + * [real](class_real) **[get_rotation](#get_rotation)** **(** **)** const + * void **[set_scale](#set_scale)** **(** [Vector2](class_vector2) scale **)** + * [Vector2](class_vector2) **[get_scale](#get_scale)** **(** **)** const + * Canvas **[get_worldθd](#get_world_2d)** **(** **)** const + * [RID](class_rid) **[get_viewport](#get_viewport)** **(** **)** const ### Description Canvas Item layer. [CanvasItem](class_canvasitem) nodes that are direct or indirect children of a [CanvasLayer](class_canvaslayer) will be drawn in that layer. The layer is a numeric index that defines the draw order. The default 2D scene renders with index 0, so a [CanvasLayer](class_canvaslayer) with index -1 will be drawn below, and one with index 1 will be drawn above. This is very useful for HUDs (in layer 1+ or above), or backgrounds (in layer -1 or below). @@ -25,61 +25,61 @@ Canvas Item layer. [CanvasItem](class_canvasitem) nodes that are direct or indir ### Member Function Description #### set_layer - * void **`set_layer`** **(** [int](class_int) layer **)** + * void **set_layer** **(** [int](class_int) layer **)** Set the layer index, determines the draw order, a lower value will be below a higher one. #### get_layer - * [int](class_int) **`get_layer`** **(** **)** const + * [int](class_int) **get_layer** **(** **)** const Return the layer index, determines the draw order, a lower value will be below a higher one. #### set_transform - * void **`set_transform`** **(** [Matrix32](class_matrix32) transform **)** + * void **set_transform** **(** [Matrix32](class_matrix32) transform **)** Set the base transform for this layer. #### get_transform - * [Matrix32](class_matrix32) **`get_transform`** **(** **)** const + * [Matrix32](class_matrix32) **get_transform** **(** **)** const Return the base transform for this layer. #### set_offset - * void **`set_offset`** **(** [Vector2](class_vector2) offset **)** + * void **set_offset** **(** [Vector2](class_vector2) offset **)** Set the base offset for this layer (helper). #### get_offset - * [Vector2](class_vector2) **`get_offset`** **(** **)** const + * [Vector2](class_vector2) **get_offset** **(** **)** const Return the base offset for this layer (helper). #### set_rotation - * void **`set_rotation`** **(** [real](class_real) rotation **)** + * void **set_rotation** **(** [real](class_real) rotation **)** Set the base rotation for this layer (helper). #### get_rotation - * [real](class_real) **`get_rotation`** **(** **)** const + * [real](class_real) **get_rotation** **(** **)** const Return the base rotation for this layer (helper). #### set_scale - * void **`set_scale`** **(** [Vector2](class_vector2) scale **)** + * void **set_scale** **(** [Vector2](class_vector2) scale **)** Set the base scale for this layer (helper). #### get_scale - * [Vector2](class_vector2) **`get_scale`** **(** **)** const + * [Vector2](class_vector2) **get_scale** **(** **)** const Return the base scale for this layer (helper). #### get_world_2d - * Canvas **`get_world_2d`** **(** **)** const + * Canvas **get_worldθd** **(** **)** const Return the [World2D](class_world2d) used by this layer. #### get_viewport - * [RID](class_rid) **`get_viewport`** **(** **)** const + * [RID](class_rid) **get_viewport** **(** **)** const Return the viewport RID for this layer. diff --git a/class_capsuleshape.md b/class_capsuleshape.md index 0501735..3a1f1e3 100644 --- a/class_capsuleshape.md +++ b/class_capsuleshape.md @@ -6,10 +6,10 @@ Capsule shape resource. ### Member Functions - * void **[`set_radius`](#set_radius)** **(** [real](class_real) radius **)** - * [real](class_real) **[`get_radius`](#get_radius)** **(** **)** const - * void **[`set_height`](#set_height)** **(** [real](class_real) height **)** - * [real](class_real) **[`get_height`](#get_height)** **(** **)** const + * void **[set_radius](#set_radius)** **(** [real](class_real) radius **)** + * [real](class_real) **[get_radius](#get_radius)** **(** **)** const + * void **[set_height](#set_height)** **(** [real](class_real) height **)** + * [real](class_real) **[get_height](#get_height)** **(** **)** const ### Description Capsule shape resource, which can be set into a [PhysicsBody](class_physicsbody) or area. @@ -17,21 +17,21 @@ Capsule shape resource, which can be set into a [PhysicsBody](class_physicsbody) ### Member Function Description #### set_radius - * void **`set_radius`** **(** [real](class_real) radius **)** + * void **set_radius** **(** [real](class_real) radius **)** Set the capsule radius. #### get_radius - * [real](class_real) **`get_radius`** **(** **)** const + * [real](class_real) **get_radius** **(** **)** const Return the capsule radius. #### set_height - * void **`set_height`** **(** [real](class_real) height **)** + * void **set_height** **(** [real](class_real) height **)** Set the capsule height. #### get_height - * [real](class_real) **`get_height`** **(** **)** const + * [real](class_real) **get_height** **(** **)** const Return the capsule height. diff --git a/class_capsuleshape2d.md b/class_capsuleshape2d.md index 23bf43b..577ee97 100644 --- a/class_capsuleshape2d.md +++ b/class_capsuleshape2d.md @@ -6,10 +6,10 @@ Capsule 2D shape resource for physics. ### Member Functions - * void **[`set_radius`](#set_radius)** **(** [real](class_real) radius **)** - * [real](class_real) **[`get_radius`](#get_radius)** **(** **)** const - * void **[`set_height`](#set_height)** **(** [real](class_real) height **)** - * [real](class_real) **[`get_height`](#get_height)** **(** **)** const + * void **[set_radius](#set_radius)** **(** [real](class_real) radius **)** + * [real](class_real) **[get_radius](#get_radius)** **(** **)** const + * void **[set_height](#set_height)** **(** [real](class_real) height **)** + * [real](class_real) **[get_height](#get_height)** **(** **)** const ### Description Capsule 2D shape resource for physics. A capsule (or sometimes called "pill") is like a line grown in all directions. It has a radius and a height, and is often useful for modelling biped characters. @@ -17,21 +17,21 @@ Capsule 2D shape resource for physics. A capsule (or sometimes called "pill") is ### Member Function Description #### set_radius - * void **`set_radius`** **(** [real](class_real) radius **)** + * void **set_radius** **(** [real](class_real) radius **)** Radius of the [CapsuleShape2D](class_capsuleshape2d). #### get_radius - * [real](class_real) **`get_radius`** **(** **)** const + * [real](class_real) **get_radius** **(** **)** const Return the radius of the [CapsuleShape2D](class_capsuleshape2d). #### set_height - * void **`set_height`** **(** [real](class_real) height **)** + * void **set_height** **(** [real](class_real) height **)** Height of the [CapsuleShape2D](class_capsuleshape2d). #### get_height - * [real](class_real) **`get_height`** **(** **)** const + * [real](class_real) **get_height** **(** **)** const Return the height of the [CapsuleShape2D](class_capsuleshape2d). diff --git a/class_carbody.md b/class_carbody.md index 3ed3a48..fe62b7f 100644 --- a/class_carbody.md +++ b/class_carbody.md @@ -6,21 +6,21 @@ ### Member Functions - * void **[`set_max_steer_angle`](#set_max_steer_angle)** **(** [real](class_real) value **)** - * void **[`set_steer_rate`](#set_steer_rate)** **(** [real](class_real) rate **)** - * void **[`set_drive_torque`](#set_drive_torque)** **(** [real](class_real) value **)** - * [real](class_real) **[`get_max_steer_angle`](#get_max_steer_angle)** **(** **)** const - * [real](class_real) **[`get_steer_rate`](#get_steer_rate)** **(** **)** const - * [real](class_real) **[`get_drive_torque`](#get_drive_torque)** **(** **)** const - * void **[`set_target_steering`](#set_target_steering)** **(** [real](class_real) amount **)** - * void **[`set_target_accelerate`](#set_target_accelerate)** **(** [real](class_real) amount **)** - * void **[`set_hand_brake`](#set_hand_brake)** **(** [real](class_real) amount **)** - * [real](class_real) **[`get_target_steering`](#get_target_steering)** **(** **)** const - * [real](class_real) **[`get_target_accelerate`](#get_target_accelerate)** **(** **)** const - * [real](class_real) **[`get_hand_brake`](#get_hand_brake)** **(** **)** const - * void **[`set_mass`](#set_mass)** **(** [real](class_real) mass **)** - * [real](class_real) **[`get_mass`](#get_mass)** **(** **)** const - * void **[`set_friction`](#set_friction)** **(** [real](class_real) friction **)** - * [real](class_real) **[`get_friction`](#get_friction)** **(** **)** const + * void **[set_max_steer_angle](#set_max_steer_angle)** **(** [real](class_real) value **)** + * void **[set_steer_rate](#set_steer_rate)** **(** [real](class_real) rate **)** + * void **[set_drive_torque](#set_drive_torque)** **(** [real](class_real) value **)** + * [real](class_real) **[get_max_steer_angle](#get_max_steer_angle)** **(** **)** const + * [real](class_real) **[get_steer_rate](#get_steer_rate)** **(** **)** const + * [real](class_real) **[get_drive_torque](#get_drive_torque)** **(** **)** const + * void **[set_target_steering](#set_target_steering)** **(** [real](class_real) amount **)** + * void **[set_target_accelerate](#set_target_accelerate)** **(** [real](class_real) amount **)** + * void **[set_hand_brake](#set_hand_brake)** **(** [real](class_real) amount **)** + * [real](class_real) **[get_target_steering](#get_target_steering)** **(** **)** const + * [real](class_real) **[get_target_accelerate](#get_target_accelerate)** **(** **)** const + * [real](class_real) **[get_hand_brake](#get_hand_brake)** **(** **)** const + * void **[set_mass](#set_mass)** **(** [real](class_real) mass **)** + * [real](class_real) **[get_mass](#get_mass)** **(** **)** const + * void **[set_friction](#set_friction)** **(** [real](class_real) friction **)** + * [real](class_real) **[get_friction](#get_friction)** **(** **)** const ### Member Function Description diff --git a/class_carwheel.md b/class_carwheel.md index e1b78f9..4c5c33b 100644 --- a/class_carwheel.md +++ b/class_carwheel.md @@ -6,23 +6,23 @@ ### Member Functions - * void **[`set_side_friction`](#set_side_friction)** **(** [real](class_real) friction **)** - * void **[`set_forward_friction`](#set_forward_friction)** **(** [real](class_real) friction **)** - * void **[`set_travel`](#set_travel)** **(** [real](class_real) distance **)** - * void **[`set_radius`](#set_radius)** **(** [real](class_real) radius **)** - * void **[`set_resting_frac`](#set_resting_frac)** **(** [real](class_real) frac **)** - * void **[`set_damping_frac`](#set_damping_frac)** **(** [real](class_real) frac **)** - * void **[`set_num_rays`](#set_num_rays)** **(** [real](class_real) amount **)** - * [real](class_real) **[`get_side_friction`](#get_side_friction)** **(** **)** const - * [real](class_real) **[`get_forward_friction`](#get_forward_friction)** **(** **)** const - * [real](class_real) **[`get_travel`](#get_travel)** **(** **)** const - * [real](class_real) **[`get_radius`](#get_radius)** **(** **)** const - * [real](class_real) **[`get_resting_frac`](#get_resting_frac)** **(** **)** const - * [real](class_real) **[`get_damping_frac`](#get_damping_frac)** **(** **)** const - * [int](class_int) **[`get_num_rays`](#get_num_rays)** **(** **)** const - * void **[`set_type_drive`](#set_type_drive)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_type_drive`](#is_type_drive)** **(** **)** const - * void **[`set_type_steer`](#set_type_steer)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_type_steer`](#is_type_steer)** **(** **)** const + * void **[set_side_friction](#set_side_friction)** **(** [real](class_real) friction **)** + * void **[set_forward_friction](#set_forward_friction)** **(** [real](class_real) friction **)** + * void **[set_travel](#set_travel)** **(** [real](class_real) distance **)** + * void **[set_radius](#set_radius)** **(** [real](class_real) radius **)** + * void **[set_resting_frac](#set_resting_frac)** **(** [real](class_real) frac **)** + * void **[set_damping_frac](#set_damping_frac)** **(** [real](class_real) frac **)** + * void **[set_num_rays](#set_num_rays)** **(** [real](class_real) amount **)** + * [real](class_real) **[get_side_friction](#get_side_friction)** **(** **)** const + * [real](class_real) **[get_forward_friction](#get_forward_friction)** **(** **)** const + * [real](class_real) **[get_travel](#get_travel)** **(** **)** const + * [real](class_real) **[get_radius](#get_radius)** **(** **)** const + * [real](class_real) **[get_resting_frac](#get_resting_frac)** **(** **)** const + * [real](class_real) **[get_damping_frac](#get_damping_frac)** **(** **)** const + * [int](class_int) **[get_num_rays](#get_num_rays)** **(** **)** const + * void **[set_type_drive](#set_type_drive)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_type_drive](#is_type_drive)** **(** **)** const + * void **[set_type_steer](#set_type_steer)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_type_steer](#is_type_steer)** **(** **)** const ### Member Function Description diff --git a/class_circleshape2d.md b/class_circleshape2d.md index f423315..e457e10 100644 --- a/class_circleshape2d.md +++ b/class_circleshape2d.md @@ -6,8 +6,8 @@ Circular Shape for 2D Physics. ### Member Functions - * void **[`set_radius`](#set_radius)** **(** [real](class_real) radius **)** - * [real](class_real) **[`get_radius`](#get_radius)** **(** **)** const + * void **[set_radius](#set_radius)** **(** [real](class_real) radius **)** + * [real](class_real) **[get_radius](#get_radius)** **(** **)** const ### Description Circular Shape for 2D Physics. This shape is useful for modelling balls or small characters and it's collision detection with everything else is very fast. @@ -15,11 +15,11 @@ Circular Shape for 2D Physics. This shape is useful for modelling balls or small ### Member Function Description #### set_radius - * void **`set_radius`** **(** [real](class_real) radius **)** + * void **set_radius** **(** [real](class_real) radius **)** Set the radius of the circle shape; #### get_radius - * [real](class_real) **`get_radius`** **(** **)** const + * [real](class_real) **get_radius** **(** **)** const Return the radius of the circle shape. diff --git a/class_collisionobject.md b/class_collisionobject.md index 7b153e6..5587501 100644 --- a/class_collisionobject.md +++ b/class_collisionobject.md @@ -6,16 +6,16 @@ ### Member Functions - * void **[`add_shape`](#add_shape)** **(** [Shape](class_shape) shape, [Transform](class_transform) transform=Transform() **)** - * [int](class_int) **[`get_shape_count`](#get_shape_count)** **(** **)** const - * void **[`set_shape`](#set_shape)** **(** [int](class_int) shape_idx, [Shape](class_shape) shape **)** - * void **[`set_shape_transform`](#set_shape_transform)** **(** [int](class_int) shape_idx, [Transform](class_transform) transform **)** - * void **[`set_shape_as_trigger`](#set_shape_as_trigger)** **(** [int](class_int) shape_idx, [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_shape_set_as_trigger`](#is_shape_set_as_trigger)** **(** [int](class_int) shape_idx **)** const - * [Shape](class_shape) **[`get_shape`](#get_shape)** **(** [int](class_int) shape_idx **)** const - * [Transform](class_transform) **[`get_shape_transform`](#get_shape_transform)** **(** [int](class_int) shape_idx **)** const - * void **[`remove_shape`](#remove_shape)** **(** [int](class_int) shape_idx **)** - * void **[`clear_shapes`](#clear_shapes)** **(** **)** - * [RID](class_rid) **[`get_rid`](#get_rid)** **(** **)** const + * void **[add_shape](#add_shape)** **(** [Shape](class_shape) shape, [Transform](class_transform) transform=Transform() **)** + * [int](class_int) **[get_shape_count](#get_shape_count)** **(** **)** const + * void **[set_shape](#set_shape)** **(** [int](class_int) shape_idx, [Shape](class_shape) shape **)** + * void **[set_shape_transform](#set_shape_transform)** **(** [int](class_int) shape_idx, [Transform](class_transform) transform **)** + * void **[set_shape_as_trigger](#set_shape_as_trigger)** **(** [int](class_int) shape_idx, [bool](class_bool) enable **)** + * [bool](class_bool) **[is_shape_set_as_trigger](#is_shape_set_as_trigger)** **(** [int](class_int) shape_idx **)** const + * [Shape](class_shape) **[get_shape](#get_shape)** **(** [int](class_int) shape_idx **)** const + * [Transform](class_transform) **[get_shape_transform](#get_shape_transform)** **(** [int](class_int) shape_idx **)** const + * void **[remove_shape](#remove_shape)** **(** [int](class_int) shape_idx **)** + * void **[clear_shapes](#clear_shapes)** **(** **)** + * [RID](class_rid) **[get_rid](#get_rid)** **(** **)** const ### Member Function Description diff --git a/class_collisionobject2d.md b/class_collisionobject2d.md index 12e977a..0eff739 100644 --- a/class_collisionobject2d.md +++ b/class_collisionobject2d.md @@ -6,17 +6,17 @@ Base node for 2D collisionables. ### Member Functions - * void **[`add_shape`](#add_shape)** **(** [Shape2D](class_shape2d) shape, [Matrix32](class_matrix32) transform=1,0, 0,1, 0,0 **)** - * [int](class_int) **[`get_shape_count`](#get_shape_count)** **(** **)** const - * void **[`set_shape`](#set_shape)** **(** [int](class_int) shape_idx, [Shape](class_shape) shape **)** - * void **[`set_shape_transform`](#set_shape_transform)** **(** [int](class_int) shape_idx, [Matrix32](class_matrix32) transform **)** - * void **[`set_shape_as_trigger`](#set_shape_as_trigger)** **(** [int](class_int) shape_idx, [bool](class_bool) enable **)** - * [Shape2D](class_shape2d) **[`get_shape`](#get_shape)** **(** [int](class_int) shape_idx **)** const - * [Matrix32](class_matrix32) **[`get_shape_transform`](#get_shape_transform)** **(** [int](class_int) shape_idx **)** const - * [bool](class_bool) **[`is_shape_set_as_trigger`](#is_shape_set_as_trigger)** **(** [int](class_int) shape_idx **)** const - * void **[`remove_shape`](#remove_shape)** **(** [int](class_int) shape_idx **)** - * void **[`clear_shapes`](#clear_shapes)** **(** **)** - * [RID](class_rid) **[`get_rid`](#get_rid)** **(** **)** const + * void **[add_shape](#add_shape)** **(** [Shape2D](class_shape2d) shape, [Matrix32](class_matrix32) transform=1,0, 0,1, 0,0 **)** + * [int](class_int) **[get_shape_count](#get_shape_count)** **(** **)** const + * void **[set_shape](#set_shape)** **(** [int](class_int) shape_idx, [Shape](class_shape) shape **)** + * void **[set_shape_transform](#set_shape_transform)** **(** [int](class_int) shape_idx, [Matrix32](class_matrix32) transform **)** + * void **[set_shape_as_trigger](#set_shape_as_trigger)** **(** [int](class_int) shape_idx, [bool](class_bool) enable **)** + * [Shape2D](class_shape2d) **[get_shape](#get_shape)** **(** [int](class_int) shape_idx **)** const + * [Matrix32](class_matrix32) **[get_shape_transform](#get_shape_transform)** **(** [int](class_int) shape_idx **)** const + * [bool](class_bool) **[is_shape_set_as_trigger](#is_shape_set_as_trigger)** **(** [int](class_int) shape_idx **)** const + * void **[remove_shape](#remove_shape)** **(** [int](class_int) shape_idx **)** + * void **[clear_shapes](#clear_shapes)** **(** **)** + * [RID](class_rid) **[get_rid](#get_rid)** **(** **)** const ### Description CollisionObject2D is the base class for 2D physics collisionables. They can hold any number of 2D collision shapes. Usually, they are edited by placing CollisionBody2D and CollisionPolygon2D nodes as children. Such nodes are for reference ant not present outside the editor, so code should use the regular shape API. @@ -24,41 +24,41 @@ CollisionObject2D is the base class for 2D physics collisionables. They can hold ### Member Function Description #### add_shape - * void **`add_shape`** **(** [Shape2D](class_shape2d) shape, [Matrix32](class_matrix32) transform=1,0, 0,1, 0,0 **)** + * void **add_shape** **(** [Shape2D](class_shape2d) shape, [Matrix32](class_matrix32) transform=1,0, 0,1, 0,0 **)** Add a [Shape2D](class_shape2d) to the collision body, with a given custom transform. #### get_shape_count - * [int](class_int) **`get_shape_count`** **(** **)** const + * [int](class_int) **get_shape_count** **(** **)** const Return the amount of shapes in the collision body. #### set_shape - * void **`set_shape`** **(** [int](class_int) shape_idx, [Shape](class_shape) shape **)** + * void **set_shape** **(** [int](class_int) shape_idx, [Shape](class_shape) shape **)** Change a shape in the collision body. #### set_shape_transform - * void **`set_shape_transform`** **(** [int](class_int) shape_idx, [Matrix32](class_matrix32) transform **)** + * void **set_shape_transform** **(** [int](class_int) shape_idx, [Matrix32](class_matrix32) transform **)** Change the shape transform in the collision body. #### get_shape - * [Shape2D](class_shape2d) **`get_shape`** **(** [int](class_int) shape_idx **)** const + * [Shape2D](class_shape2d) **get_shape** **(** [int](class_int) shape_idx **)** const Return the shape in the given index. #### get_shape_transform - * [Matrix32](class_matrix32) **`get_shape_transform`** **(** [int](class_int) shape_idx **)** const + * [Matrix32](class_matrix32) **get_shape_transform** **(** [int](class_int) shape_idx **)** const Return the shape transform in the given index. #### remove_shape - * void **`remove_shape`** **(** [int](class_int) shape_idx **)** + * void **remove_shape** **(** [int](class_int) shape_idx **)** Remove the shape in the given index. #### clear_shapes - * void **`clear_shapes`** **(** **)** + * void **clear_shapes** **(** **)** Remove all shapes. diff --git a/class_color.md b/class_color.md index 6aca95d..fbbeb90 100644 --- a/class_color.md +++ b/class_color.md @@ -5,16 +5,16 @@ Color in RGBA format. ### Member Functions - * [Color](class_color) **[`blend`](#blend)** **(** [Color](class_color) over **)** - * [Color](class_color) **[`contrasted`](#contrasted)** **(** **)** - * [real](class_real) **[`gray`](#gray)** **(** **)** - * [Color](class_color) **[`inverted`](#inverted)** **(** **)** - * [Color](class_color) **[`linear_interpolate`](#linear_interpolate)** **(** [Color](class_color) b, [real](class_real) t **)** - * [int](class_int) **[`to_32`](#to_32)** **(** **)** - * [int](class_int) **[`to_ARGB32`](#to_ARGB32)** **(** **)** - * [String](class_string) **[`to_html`](#to_html)** **(** [bool](class_bool) with_alpha=True **)** - * void **[`Color`](#Color)** **(** [real](class_real) r, [real](class_real) g, [real](class_real) b, [real](class_real) a **)** - * void **[`Color`](#Color)** **(** [real](class_real) r, [real](class_real) g, [real](class_real) b **)** + * [Color](class_color) **[blend](#blend)** **(** [Color](class_color) over **)** + * [Color](class_color) **[contrasted](#contrasted)** **(** **)** + * [real](class_real) **[gray](#gray)** **(** **)** + * [Color](class_color) **[inverted](#inverted)** **(** **)** + * [Color](class_color) **[linear_interpolate](#linear_interpolate)** **(** [Color](class_color) b, [real](class_real) t **)** + * [int](class_int) **[to┼](#to_32)** **(** **)** + * [int](class_int) **[to_ARGB32](#to_ARGB32)** **(** **)** + * [String](class_string) **[to_html](#to_html)** **(** [bool](class_bool) with_alpha=True **)** + * void **[Color](#Color)** **(** [real](class_real) r, [real](class_real) g, [real](class_real) b, [real](class_real) a **)** + * void **[Color](#Color)** **(** [real](class_real) r, [real](class_real) g, [real](class_real) b **)** ### Member Variables * [real](class_real) **r** @@ -31,46 +31,46 @@ A color is represented as red, green and blue (r,g,b) components. Additionally, ### Member Function Description #### contrasted - * [Color](class_color) **`contrasted`** **(** **)** + * [Color](class_color) **contrasted** **(** **)** Return the most contrasting color with this one. #### gray - * [real](class_real) **`gray`** **(** **)** + * [real](class_real) **gray** **(** **)** Convert the color to gray. #### inverted - * [Color](class_color) **`inverted`** **(** **)** + * [Color](class_color) **inverted** **(** **)** Return the inverted color (1-r, 1-g, 1-b, 1-a). #### linear_interpolate - * [Color](class_color) **`linear_interpolate`** **(** [Color](class_color) b, [real](class_real) t **)** + * [Color](class_color) **linear_interpolate** **(** [Color](class_color) b, [real](class_real) t **)** Return the linear interpolation with another color. #### to_32 - * [int](class_int) **`to_32`** **(** **)** + * [int](class_int) **to┼** **(** **)** Convert the color to a 32 its integer (each byte represets a RGBA). #### to_ARGB32 - * [int](class_int) **`to_ARGB32`** **(** **)** + * [int](class_int) **to_ARGB32** **(** **)** Convert color to ARGB32, more compatible with DirectX. #### to_html - * [String](class_string) **`to_html`** **(** [bool](class_bool) with_alpha=True **)** + * [String](class_string) **to_html** **(** [bool](class_bool) with_alpha=True **)** Return the HTML hexadecimal color string. #### Color - * void **`Color`** **(** [real](class_real) r, [real](class_real) g, [real](class_real) b, [real](class_real) a **)** + * void **Color** **(** [real](class_real) r, [real](class_real) g, [real](class_real) b, [real](class_real) a **)** Construct the color from an RGBA profile. #### Color - * void **`Color`** **(** [real](class_real) r, [real](class_real) g, [real](class_real) b **)** + * void **Color** **(** [real](class_real) r, [real](class_real) g, [real](class_real) b **)** Construct the color from an RGBA profile. diff --git a/class_colorarray.md b/class_colorarray.md index 425d9fc..e6d8f39 100644 --- a/class_colorarray.md +++ b/class_colorarray.md @@ -5,12 +5,12 @@ Array of Colors ### Member Functions - * [Color](class_color) **[`get`](#get)** **(** [int](class_int) idx **)** - * void **[`push_back`](#push_back)** **(** [Color](class_color) color **)** - * void **[`resize`](#resize)** **(** [int](class_int) idx **)** - * void **[`set`](#set)** **(** [int](class_int) idx, [Color](class_color) color **)** - * [int](class_int) **[`size`](#size)** **(** **)** - * void **[`ColorArray`](#ColorArray)** **(** [Array](class_array) from **)** + * [Color](class_color) **[get](#get)** **(** [int](class_int) idx **)** + * void **[push_back](#push_back)** **(** [Color](class_color) color **)** + * void **[resize](#resize)** **(** [int](class_int) idx **)** + * void **[set](#set)** **(** [int](class_int) idx, [Color](class_color) color **)** + * [int](class_int) **[size](#size)** **(** **)** + * void **[ColorArray](#ColorArray)** **(** [Array](class_array) from **)** ### Description Array of Color, can only contains colors. Optimized for memory usage, cant fragment the memory. @@ -18,31 +18,31 @@ Array of Color, can only contains colors. Optimized for memory usage, cant fragm ### Member Function Description #### get - * [Color](class_color) **`get`** **(** [int](class_int) idx **)** + * [Color](class_color) **get** **(** [int](class_int) idx **)** Get an index in the array. #### push_back - * void **`push_back`** **(** [Color](class_color) color **)** + * void **push_back** **(** [Color](class_color) color **)** Append a value to the array. #### resize - * void **`resize`** **(** [int](class_int) idx **)** + * void **resize** **(** [int](class_int) idx **)** Resize the array. #### set - * void **`set`** **(** [int](class_int) idx, [Color](class_color) color **)** + * void **set** **(** [int](class_int) idx, [Color](class_color) color **)** Set an index in the array. #### size - * [int](class_int) **`size`** **(** **)** + * [int](class_int) **size** **(** **)** Return the array size. #### ColorArray - * void **`ColorArray`** **(** [Array](class_array) from **)** + * void **ColorArray** **(** [Array](class_array) from **)** Create from a generic array. diff --git a/class_colorpicker.md b/class_colorpicker.md index 23a2fa3..0e19c2e 100644 --- a/class_colorpicker.md +++ b/class_colorpicker.md @@ -6,15 +6,15 @@ Color picker control. ### Member Functions - * void **[`set_color`](#set_color)** **(** [Color](class_color) color **)** - * [Color](class_color) **[`get_color`](#get_color)** **(** **)** const - * void **[`set_mode`](#set_mode)** **(** [int](class_int) mode **)** - * [int](class_int) **[`get_mode`](#get_mode)** **(** **)** const - * void **[`set_edit_alpha`](#set_edit_alpha)** **(** [bool](class_bool) show **)** - * [bool](class_bool) **[`is_editing_alpha`](#is_editing_alpha)** **(** **)** const + * void **[set_color](#set_color)** **(** [Color](class_color) color **)** + * [Color](class_color) **[get_color](#get_color)** **(** **)** const + * void **[set_mode](#set_mode)** **(** [int](class_int) mode **)** + * [int](class_int) **[get_mode](#get_mode)** **(** **)** const + * void **[set_edit_alpha](#set_edit_alpha)** **(** [bool](class_bool) show **)** + * [bool](class_bool) **[is_editing_alpha](#is_editing_alpha)** **(** **)** const ### Signals - * **`color_changed`** **(** [Color](class_color) color **)** + * **color_changed** **(** [Color](class_color) color **)** ### Description This is a simple color picker [Control](class_control). It's useful for selecting a color from an RGB/RGBA colorspace. @@ -22,11 +22,11 @@ This is a simple color picker [Control](class_control). It's useful for selectin ### Member Function Description #### set_color - * void **`set_color`** **(** [Color](class_color) color **)** + * void **set_color** **(** [Color](class_color) color **)** Select the current color. #### get_color - * [Color](class_color) **`get_color`** **(** **)** const + * [Color](class_color) **get_color** **(** **)** const Return the current (edited) color. diff --git a/class_colorpickerbutton.md b/class_colorpickerbutton.md index 5d90d99..c1de282 100644 --- a/class_colorpickerbutton.md +++ b/class_colorpickerbutton.md @@ -6,12 +6,12 @@ ### Member Functions - * void **[`set_color`](#set_color)** **(** [Color](class_color) color **)** - * [Color](class_color) **[`get_color`](#get_color)** **(** **)** const - * void **[`set_edit_alpha`](#set_edit_alpha)** **(** [bool](class_bool) show **)** - * [bool](class_bool) **[`is_editing_alpha`](#is_editing_alpha)** **(** **)** const + * void **[set_color](#set_color)** **(** [Color](class_color) color **)** + * [Color](class_color) **[get_color](#get_color)** **(** **)** const + * void **[set_edit_alpha](#set_edit_alpha)** **(** [bool](class_bool) show **)** + * [bool](class_bool) **[is_editing_alpha](#is_editing_alpha)** **(** **)** const ### Signals - * **`color_changed`** **(** [Color](class_color) color **)** + * **color_changed** **(** [Color](class_color) color **)** ### Member Function Description diff --git a/class_concavepolygonshape.md b/class_concavepolygonshape.md index 8e18028..43e7078 100644 --- a/class_concavepolygonshape.md +++ b/class_concavepolygonshape.md @@ -6,8 +6,8 @@ Concave polygon shape. ### Member Functions - * void **[`set_faces`](#set_faces)** **(** [Vector3Array](class_vector3array) faces **)** - * [Vector3Array](class_vector3array) **[`get_faces`](#get_faces)** **(** **)** const + * void **[set_faces](#set_faces)** **(** [Vector3Array](class_vector3array) faces **)** + * [Vector3Array](class_vector3array) **[get_faces](#get_faces)** **(** **)** const ### Description Concave polygon shape resource, which can be set into a [PhysicsBody](class_physicsbody) or area."#10; This shape is created by feeding a list of triangles. @@ -15,11 +15,11 @@ Concave polygon shape resource, which can be set into a [PhysicsBody](class_phys ### Member Function Description #### set_faces - * void **`set_faces`** **(** [Vector3Array](class_vector3array) faces **)** + * void **set_faces** **(** [Vector3Array](class_vector3array) faces **)** Set the faces (an array of triangles). #### get_faces - * [Vector3Array](class_vector3array) **`get_faces`** **(** **)** const + * [Vector3Array](class_vector3array) **get_faces** **(** **)** const Return the faces (an array of triangles). diff --git a/class_concavepolygonshape2d.md b/class_concavepolygonshape2d.md index f367276..3ad4fd8 100644 --- a/class_concavepolygonshape2d.md +++ b/class_concavepolygonshape2d.md @@ -6,8 +6,8 @@ Concave polygon 2D shape resource for physics. ### Member Functions - * void **[`set_segments`](#set_segments)** **(** [Vector2Array](class_vector2array) segments **)** - * [Vector2Array](class_vector2array) **[`get_segments`](#get_segments)** **(** **)** const + * void **[set_segments](#set_segments)** **(** [Vector2Array](class_vector2array) segments **)** + * [Vector2Array](class_vector2array) **[get_segments](#get_segments)** **(** **)** const ### Description Concave polygon 2D shape resource for physics. It is made out of segments and is very optimal for complex polygonal concave collisions. It is really not advised to use for RigidBody nodes. A CollisionPolygon2D in convex decomposition mode (solids) or several convex objects are advised for that instead. Otherwise, a concave polygon 2D shape is better for static collisions. @@ -15,11 +15,11 @@ Concave polygon 2D shape resource for physics. It is made out of segments and is ### Member Function Description #### set_segments - * void **`set_segments`** **(** [Vector2Array](class_vector2array) segments **)** + * void **set_segments** **(** [Vector2Array](class_vector2array) segments **)** Set the array of segments. #### get_segments - * [Vector2Array](class_vector2array) **`get_segments`** **(** **)** const + * [Vector2Array](class_vector2array) **get_segments** **(** **)** const Return the array of segments. diff --git a/class_configfile.md b/class_configfile.md index 5d2c288..9382d15 100644 --- a/class_configfile.md +++ b/class_configfile.md @@ -6,13 +6,13 @@ ### Member Functions - * void **[`set_value`](#set_value)** **(** [String](class_string) section, [String](class_string) key, var value **)** - * void **[`get_value`](#get_value)** **(** [String](class_string) section, [String](class_string) key **)** const - * [bool](class_bool) **[`has_section`](#has_section)** **(** [String](class_string) section **)** const - * [bool](class_bool) **[`has_section_key`](#has_section_key)** **(** [String](class_string) section, [String](class_string) key **)** const - * [StringArray](class_stringarray) **[`get_sections`](#get_sections)** **(** **)** const - * [StringArray](class_stringarray) **[`get_section_keys`](#get_section_keys)** **(** [String](class_string) arg0 **)** const - * [int](class_int) **[`load`](#load)** **(** [String](class_string) path **)** - * [int](class_int) **[`save`](#save)** **(** [String](class_string) path **)** + * void **[set_value](#set_value)** **(** [String](class_string) section, [String](class_string) key, var value **)** + * void **[get_value](#get_value)** **(** [String](class_string) section, [String](class_string) key **)** const + * [bool](class_bool) **[has_section](#has_section)** **(** [String](class_string) section **)** const + * [bool](class_bool) **[has_section_key](#has_section_key)** **(** [String](class_string) section, [String](class_string) key **)** const + * [StringArray](class_stringarray) **[get_sections](#get_sections)** **(** **)** const + * [StringArray](class_stringarray) **[get_section_keys](#get_section_keys)** **(** [String](class_string) arg0 **)** const + * [int](class_int) **[load](#load)** **(** [String](class_string) path **)** + * [int](class_int) **[save](#save)** **(** [String](class_string) path **)** ### Member Function Description diff --git a/class_confirmationdialog.md b/class_confirmationdialog.md index ea23b0a..5b4c101 100644 --- a/class_confirmationdialog.md +++ b/class_confirmationdialog.md @@ -6,7 +6,7 @@ Dialog for confirmation of actions. ### Member Functions - * [Button](class_button) **[`get_cancel`](#get_cancel)** **(** **)** + * [Button](class_button) **[get_cancel](#get_cancel)** **(** **)** ### Description Dialog for confirmation of actions. This dialog inherits from [AcceptDialog](class_acceptdialog), but has by default an OK and Cancel buton (in host OS order). @@ -14,6 +14,6 @@ Dialog for confirmation of actions. This dialog inherits from [AcceptDialog](cla ### Member Function Description #### get_cancel - * [Button](class_button) **`get_cancel`** **(** **)** + * [Button](class_button) **get_cancel** **(** **)** Return the cancel button. diff --git a/class_container.md b/class_container.md index bd5395c..0c30374 100644 --- a/class_container.md +++ b/class_container.md @@ -6,11 +6,11 @@ Base node for containers. ### Member Functions - * void **[`queue_sort`](#queue_sort)** **(** **)** - * void **[`fit_child_in_rect`](#fit_child_in_rect)** **(** [Control](class_control) child, [Rect2](class_rect2) rect **)** + * void **[queue_sort](#queue_sort)** **(** **)** + * void **[fit_child_in_rect](#fit_child_in_rect)** **(** [Control](class_control) child, [Rect2](class_rect2) rect **)** ### Signals - * **`sort_children`** **(** **)** + * **sort_children** **(** **)** ### Numeric Constants * **NOTIFICATION_SORT_CHILDREN** = **50** - Notification for when sorting the children, it must be obeyed immediately. @@ -22,11 +22,11 @@ Base node for conainers. A [Container](class_container) contains other controls ### Member Function Description #### queue_sort - * void **`queue_sort`** **(** **)** + * void **queue_sort** **(** **)** Queue resort of the contained children. This is called automatically anyway, but can be called upon request. #### fit_child_in_rect - * void **`fit_child_in_rect`** **(** [Control](class_control) child, [Rect2](class_rect2) rect **)** + * void **fit_child_in_rect** **(** [Control](class_control) child, [Rect2](class_rect2) rect **)** Fit a child control in a given rect. This is mainly a helper for creating custom container classes. diff --git a/class_control.md b/class_control.md index 2172585..4f7dffc 100644 --- a/class_control.md +++ b/class_control.md @@ -6,86 +6,86 @@ Control is the base node for all the GUI components. ### Member Functions - * void **[`_input_event`](#_input_event)** **(** [InputEvent](class_inputevent) event **)** virtual - * [bool](class_bool) **[`can_drop_data`](#can_drop_data)** **(** [Vector2](class_vector2) pos, var data **)** virtual - * void **[`drop_data`](#drop_data)** **(** [Vector2](class_vector2) pos, var data **)** virtual - * [Object](class_object) **[`get_drag_data`](#get_drag_data)** **(** [Vector2](class_vector2) pos **)** virtual - * [Vector2](class_vector2) **[`get_minimum_size`](#get_minimum_size)** **(** **)** virtual - * void **[`accept_event`](#accept_event)** **(** **)** - * [Vector2](class_vector2) **[`get_minimum_size`](#get_minimum_size)** **(** **)** const - * [Vector2](class_vector2) **[`get_combined_minimum_size`](#get_combined_minimum_size)** **(** **)** const - * [bool](class_bool) **[`is_window`](#is_window)** **(** **)** const - * [Object](class_object) **[`get_window`](#get_window)** **(** **)** const - * void **[`set_anchor`](#set_anchor)** **(** [int](class_int) margin, [int](class_int) anchor_mode **)** - * [int](class_int) **[`get_anchor`](#get_anchor)** **(** [int](class_int) margin **)** const - * void **[`set_margin`](#set_margin)** **(** [int](class_int) margin, [real](class_real) offset **)** - * void **[`set_anchor_and_margin`](#set_anchor_and_margin)** **(** [int](class_int) margin, [int](class_int) anchor_mode, [real](class_real) offset **)** - * void **[`set_begin`](#set_begin)** **(** [Vector2](class_vector2) pos **)** - * void **[`set_end`](#set_end)** **(** [Vector2](class_vector2) pos **)** - * void **[`set_pos`](#set_pos)** **(** [Vector2](class_vector2) pos **)** - * void **[`set_size`](#set_size)** **(** [Vector2](class_vector2) size **)** - * void **[`set_custom_minimum_size`](#set_custom_minimum_size)** **(** [Vector2](class_vector2) size **)** - * void **[`set_global_pos`](#set_global_pos)** **(** [Vector2](class_vector2) pos **)** - * [real](class_real) **[`get_margin`](#get_margin)** **(** [int](class_int) margin **)** const - * [Vector2](class_vector2) **[`get_begin`](#get_begin)** **(** **)** const - * [Vector2](class_vector2) **[`get_end`](#get_end)** **(** **)** const - * [Vector2](class_vector2) **[`get_pos`](#get_pos)** **(** **)** const - * [Vector2](class_vector2) **[`get_size`](#get_size)** **(** **)** const - * [Vector2](class_vector2) **[`get_custom_minimum_size`](#get_custom_minimum_size)** **(** **)** const - * [Vector2](class_vector2) **[`get_parent_area_size`](#get_parent_area_size)** **(** **)** const - * [Vector2](class_vector2) **[`get_global_pos`](#get_global_pos)** **(** **)** const - * [Rect2](class_rect2) **[`get_rect`](#get_rect)** **(** **)** const - * [Rect2](class_rect2) **[`get_global_rect`](#get_global_rect)** **(** **)** const - * void **[`set_area_as_parent_rect`](#set_area_as_parent_rect)** **(** [int](class_int) margin=0 **)** - * void **[`show_modal`](#show_modal)** **(** [bool](class_bool) exclusive=false **)** - * void **[`set_focus_mode`](#set_focus_mode)** **(** [int](class_int) mode **)** - * [bool](class_bool) **[`has_focus`](#has_focus)** **(** **)** const - * void **[`grab_focus`](#grab_focus)** **(** **)** - * void **[`release_focus`](#release_focus)** **(** **)** - * [Control](class_control) **[`get_focus_owner`](#get_focus_owner)** **(** **)** const - * void **[`set_h_size_flags`](#set_h_size_flags)** **(** [int](class_int) flags **)** - * [int](class_int) **[`get_h_size_flags`](#get_h_size_flags)** **(** **)** const - * void **[`set_stretch_ratio`](#set_stretch_ratio)** **(** [real](class_real) ratio **)** - * [real](class_real) **[`get_stretch_ratio`](#get_stretch_ratio)** **(** **)** const - * void **[`set_v_size_flags`](#set_v_size_flags)** **(** [int](class_int) flags **)** - * [int](class_int) **[`get_v_size_flags`](#get_v_size_flags)** **(** **)** const - * void **[`set_theme`](#set_theme)** **(** [Theme](class_theme) theme **)** - * [Theme](class_theme) **[`get_theme`](#get_theme)** **(** **)** const - * void **[`add_icon_override`](#add_icon_override)** **(** [String](class_string) name, [Texture](class_texture) texture **)** - * void **[`add_style_override`](#add_style_override)** **(** [String](class_string) name, [StyleBox](class_stylebox) stylebox **)** - * void **[`add_font_override`](#add_font_override)** **(** [String](class_string) name, [Font](class_font) font **)** - * void **[`add_color_override`](#add_color_override)** **(** [String](class_string) name, [Color](class_color) color **)** - * void **[`add_constant_override`](#add_constant_override)** **(** [String](class_string) name, [int](class_int) constant **)** - * [Texture](class_texture) **[`get_icon`](#get_icon)** **(** [String](class_string) name, [String](class_string) type="" **)** const - * [StyleBox](class_stylebox) **[`get_stylebox`](#get_stylebox)** **(** [String](class_string) name, [String](class_string) type="" **)** const - * [Font](class_font) **[`get_font`](#get_font)** **(** [String](class_string) name, [String](class_string) type="" **)** const - * [Color](class_color) **[`get_color`](#get_color)** **(** [String](class_string) name, [String](class_string) type="" **)** const - * [int](class_int) **[`get_constant`](#get_constant)** **(** [String](class_string) name, [String](class_string) type="" **)** const - * [Control](class_control) **[`get_parent_control`](#get_parent_control)** **(** **)** const - * void **[`set_tooltip`](#set_tooltip)** **(** [String](class_string) tooltip **)** - * [String](class_string) **[`get_tooltip`](#get_tooltip)** **(** [Vector2](class_vector2) atpos=Vector2(0,0) **)** const - * void **[`set_default_cursor_shape`](#set_default_cursor_shape)** **(** [int](class_int) shape **)** - * [int](class_int) **[`get_default_cursor_shape`](#get_default_cursor_shape)** **(** **)** const - * [int](class_int) **[`get_cursor_shape`](#get_cursor_shape)** **(** [Vector2](class_vector2) pos=Vector2(0,0) **)** const - * void **[`set_focus_neighbour`](#set_focus_neighbour)** **(** [int](class_int) margin, [NodePath](class_nodepath) neighbour **)** - * [NodePath](class_nodepath) **[`get_focus_neighbour`](#get_focus_neighbour)** **(** [int](class_int) margin **)** const - * void **[`set_ignore_mouse`](#set_ignore_mouse)** **(** [bool](class_bool) ignore **)** - * [bool](class_bool) **[`is_ignoring_mouse`](#is_ignoring_mouse)** **(** **)** const - * void **[`force_drag`](#force_drag)** **(** var data, [Object](class_object) preview **)** - * void **[`set_stop_mouse`](#set_stop_mouse)** **(** [bool](class_bool) stop **)** - * [bool](class_bool) **[`is_stopping_mouse`](#is_stopping_mouse)** **(** **)** const - * void **[`grab_click_focus`](#grab_click_focus)** **(** **)** - * void **[`set_drag_preview`](#set_drag_preview)** **(** [Control](class_control) control **)** + * void **[_input_event](#_input_event)** **(** [InputEvent](class_inputevent) event **)** virtual + * [bool](class_bool) **[can_drop_data](#can_drop_data)** **(** [Vector2](class_vector2) pos, var data **)** virtual + * void **[drop_data](#drop_data)** **(** [Vector2](class_vector2) pos, var data **)** virtual + * [Object](class_object) **[get_drag_data](#get_drag_data)** **(** [Vector2](class_vector2) pos **)** virtual + * [Vector2](class_vector2) **[get_minimum_size](#get_minimum_size)** **(** **)** virtual + * void **[accept_event](#accept_event)** **(** **)** + * [Vector2](class_vector2) **[get_minimum_size](#get_minimum_size)** **(** **)** const + * [Vector2](class_vector2) **[get_combined_minimum_size](#get_combined_minimum_size)** **(** **)** const + * [bool](class_bool) **[is_window](#is_window)** **(** **)** const + * [Object](class_object) **[get_window](#get_window)** **(** **)** const + * void **[set_anchor](#set_anchor)** **(** [int](class_int) margin, [int](class_int) anchor_mode **)** + * [int](class_int) **[get_anchor](#get_anchor)** **(** [int](class_int) margin **)** const + * void **[set_margin](#set_margin)** **(** [int](class_int) margin, [real](class_real) offset **)** + * void **[set_anchor_and_margin](#set_anchor_and_margin)** **(** [int](class_int) margin, [int](class_int) anchor_mode, [real](class_real) offset **)** + * void **[set_begin](#set_begin)** **(** [Vector2](class_vector2) pos **)** + * void **[set_end](#set_end)** **(** [Vector2](class_vector2) pos **)** + * void **[set_pos](#set_pos)** **(** [Vector2](class_vector2) pos **)** + * void **[set_size](#set_size)** **(** [Vector2](class_vector2) size **)** + * void **[set_custom_minimum_size](#set_custom_minimum_size)** **(** [Vector2](class_vector2) size **)** + * void **[set_global_pos](#set_global_pos)** **(** [Vector2](class_vector2) pos **)** + * [real](class_real) **[get_margin](#get_margin)** **(** [int](class_int) margin **)** const + * [Vector2](class_vector2) **[get_begin](#get_begin)** **(** **)** const + * [Vector2](class_vector2) **[get_end](#get_end)** **(** **)** const + * [Vector2](class_vector2) **[get_pos](#get_pos)** **(** **)** const + * [Vector2](class_vector2) **[get_size](#get_size)** **(** **)** const + * [Vector2](class_vector2) **[get_custom_minimum_size](#get_custom_minimum_size)** **(** **)** const + * [Vector2](class_vector2) **[get_parent_area_size](#get_parent_area_size)** **(** **)** const + * [Vector2](class_vector2) **[get_global_pos](#get_global_pos)** **(** **)** const + * [Rect2](class_rect2) **[get_rect](#get_rect)** **(** **)** const + * [Rect2](class_rect2) **[get_global_rect](#get_global_rect)** **(** **)** const + * void **[set_area_as_parent_rect](#set_area_as_parent_rect)** **(** [int](class_int) margin=0 **)** + * void **[show_modal](#show_modal)** **(** [bool](class_bool) exclusive=false **)** + * void **[set_focus_mode](#set_focus_mode)** **(** [int](class_int) mode **)** + * [bool](class_bool) **[has_focus](#has_focus)** **(** **)** const + * void **[grab_focus](#grab_focus)** **(** **)** + * void **[release_focus](#release_focus)** **(** **)** + * [Control](class_control) **[get_focus_owner](#get_focus_owner)** **(** **)** const + * void **[set_h_size_flags](#set_h_size_flags)** **(** [int](class_int) flags **)** + * [int](class_int) **[get_h_size_flags](#get_h_size_flags)** **(** **)** const + * void **[set_stretch_ratio](#set_stretch_ratio)** **(** [real](class_real) ratio **)** + * [real](class_real) **[get_stretch_ratio](#get_stretch_ratio)** **(** **)** const + * void **[set_v_size_flags](#set_v_size_flags)** **(** [int](class_int) flags **)** + * [int](class_int) **[get_v_size_flags](#get_v_size_flags)** **(** **)** const + * void **[set_theme](#set_theme)** **(** [Theme](class_theme) theme **)** + * [Theme](class_theme) **[get_theme](#get_theme)** **(** **)** const + * void **[add_icon_override](#add_icon_override)** **(** [String](class_string) name, [Texture](class_texture) texture **)** + * void **[add_style_override](#add_style_override)** **(** [String](class_string) name, [StyleBox](class_stylebox) stylebox **)** + * void **[add_font_override](#add_font_override)** **(** [String](class_string) name, [Font](class_font) font **)** + * void **[add_color_override](#add_color_override)** **(** [String](class_string) name, [Color](class_color) color **)** + * void **[add_constant_override](#add_constant_override)** **(** [String](class_string) name, [int](class_int) constant **)** + * [Texture](class_texture) **[get_icon](#get_icon)** **(** [String](class_string) name, [String](class_string) type="" **)** const + * [StyleBox](class_stylebox) **[get_stylebox](#get_stylebox)** **(** [String](class_string) name, [String](class_string) type="" **)** const + * [Font](class_font) **[get_font](#get_font)** **(** [String](class_string) name, [String](class_string) type="" **)** const + * [Color](class_color) **[get_color](#get_color)** **(** [String](class_string) name, [String](class_string) type="" **)** const + * [int](class_int) **[get_constant](#get_constant)** **(** [String](class_string) name, [String](class_string) type="" **)** const + * [Control](class_control) **[get_parent_control](#get_parent_control)** **(** **)** const + * void **[set_tooltip](#set_tooltip)** **(** [String](class_string) tooltip **)** + * [String](class_string) **[get_tooltip](#get_tooltip)** **(** [Vector2](class_vector2) atpos=Vector2(0,0) **)** const + * void **[set_default_cursor_shape](#set_default_cursor_shape)** **(** [int](class_int) shape **)** + * [int](class_int) **[get_default_cursor_shape](#get_default_cursor_shape)** **(** **)** const + * [int](class_int) **[get_cursor_shape](#get_cursor_shape)** **(** [Vector2](class_vector2) pos=Vector2(0,0) **)** const + * void **[set_focus_neighbour](#set_focus_neighbour)** **(** [int](class_int) margin, [NodePath](class_nodepath) neighbour **)** + * [NodePath](class_nodepath) **[get_focus_neighbour](#get_focus_neighbour)** **(** [int](class_int) margin **)** const + * void **[set_ignore_mouse](#set_ignore_mouse)** **(** [bool](class_bool) ignore **)** + * [bool](class_bool) **[is_ignoring_mouse](#is_ignoring_mouse)** **(** **)** const + * void **[force_drag](#force_drag)** **(** var data, [Object](class_object) preview **)** + * void **[set_stop_mouse](#set_stop_mouse)** **(** [bool](class_bool) stop **)** + * [bool](class_bool) **[is_stopping_mouse](#is_stopping_mouse)** **(** **)** const + * void **[grab_click_focus](#grab_click_focus)** **(** **)** + * void **[set_drag_preview](#set_drag_preview)** **(** [Control](class_control) control **)** ### Signals - * **`focus_enter`** **(** **)** - * **`mouse_enter`** **(** **)** - * **`resized`** **(** **)** - * **`minimum_size_changed`** **(** **)** - * **`size_flags_changed`** **(** **)** - * **`focus_exit`** **(** **)** - * **`input_event`** **(** **)** - * **`mouse_exit`** **(** **)** + * **focus_enter** **(** **)** + * **mouse_enter** **(** **)** + * **resized** **(** **)** + * **minimum_size_changed** **(** **)** + * **size_flags_changed** **(** **)** + * **focus_exit** **(** **)** + * **input_event** **(** **)** + * **mouse_exit** **(** **)** ### Numeric Constants * **ANCHOR_BEGIN** = **0** - X is relative to MARGIN_LEFT, Y is relative to MARGIN_TOP, @@ -126,259 +126,259 @@ Control is the base node for all the GUI components. Control is the base class Node for all the GUI components. Every GUI component inherits from it, directly or indirectly. In this way, sections of the scene tree made of contiguous control nodes, become user interfaces. Controls are relative to the parent position and size by using anchors and margins. This ensures that they can adapt easily in most situation to changing dialog and screen sizes. When more flexibility is desired, [Container](class_container) derived nodes can be used. Anchors work by defining which margin do they follow, and a value relative to it. Allowed anchoring modes are ANCHOR_BEGIN, where the margin is relative to the top or left margins of the parent (in pixels), ANCHOR_END for the right and bottom margins of the parent and ANCHOR_RATIO, which is a ratio from 0 to 1 in the parent range. - Input device events ([InputEvent](class_inputevent)) are first sent to the root controls via the [Node.`_input`](node#_input), which distribute it through the tree, then delivers them to the adequate one (under cursor or keyboard focus based) by calling [Node._input_event]. There is no need to enable input processing on controls to receive such events. To ensure that no one else will receive the event (not even [Node.`_unhandled_input`](node#_unhandled_input)), the control can accept it by calling [`accept_event`](#accept_event). - Only one control can hold the keyboard focus (receiving keyboard events), for that the control must define the focus mode with [`set_focus_mode`](#set_focus_mode). Focus is lost when another control gains it, or the current focus owner is hidden. - It is sometimes desired for a control to ignore mouse/pointer events. This is often the case when placing other controls on top of a button, in such cases. Calling [`set_ignore_mouse`](#set_ignore_mouse) enables this function. + Input device events ([InputEvent](class_inputevent)) are first sent to the root controls via the [Node._input](node#_input), which distribute it through the tree, then delivers them to the adequate one (under cursor or keyboard focus based) by calling [Node._input_event]. There is no need to enable input processing on controls to receive such events. To ensure that no one else will receive the event (not even [Node._unhandled_input](node#_unhandled_input)), the control can accept it by calling [accept_event](#accept_event). + Only one control can hold the keyboard focus (receiving keyboard events), for that the control must define the focus mode with [set_focus_mode](#set_focus_mode). Focus is lost when another control gains it, or the current focus owner is hidden. + It is sometimes desired for a control to ignore mouse/pointer events. This is often the case when placing other controls on top of a button, in such cases. Calling [set_ignore_mouse](#set_ignore_mouse) enables this function. Finally, controls are skinned according to a [Theme](class_theme). Setting a [Theme](class_theme) on a control will propagate all the skinning down the tree. Optionally, skinning can be overrided per each control by calling the add_*_override functions, or from the editor. ### Member Function Description #### _input_event - * void **`_input_event`** **(** [InputEvent](class_inputevent) event **)** virtual + * void **_input_event** **(** [InputEvent](class_inputevent) event **)** virtual Called when an input event reaches the control. #### get_minimum_size - * [Vector2](class_vector2) **`get_minimum_size`** **(** **)** virtual + * [Vector2](class_vector2) **get_minimum_size** **(** **)** virtual Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size. #### accept_event - * void **`accept_event`** **(** **)** + * void **accept_event** **(** **)** -Handles the event, no other control will receive it and it will not be sent to nodes waiting on [Node.`_unhandled_input`](node#_unhandled_input) or [Node.`_unhandled_key_input`](node#_unhandled_key_input). +Handles the event, no other control will receive it and it will not be sent to nodes waiting on [Node._unhandled_input](node#_unhandled_input) or [Node._unhandled_key_input](node#_unhandled_key_input). #### get_minimum_size - * [Vector2](class_vector2) **`get_minimum_size`** **(** **)** const + * [Vector2](class_vector2) **get_minimum_size** **(** **)** const Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size. #### is_window - * [bool](class_bool) **`is_window`** **(** **)** const + * [bool](class_bool) **is_window** **(** **)** const Return wether this control is a _window_. Controls are considered windows when their parent [Node](class_node) is not a Control. #### get_window - * [Object](class_object) **`get_window`** **(** **)** const + * [Object](class_object) **get_window** **(** **)** const -Return the _window_ for this control, ascending the scene tree (see [`is_window`](#is_window)). +Return the _window_ for this control, ascending the scene tree (see [is_window](#is_window)). #### set_anchor - * void **`set_anchor`** **(** [int](class_int) margin, [int](class_int) anchor_mode **)** + * void **set_anchor** **(** [int](class_int) margin, [int](class_int) anchor_mode **)** -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 previos anchor mode to the new one, so margin offsets ([`set_margin`](#set_margin)) must be done after setting anchors, or at the same time ([`set_anchor_and_margin`](#set_anchor_and_margin)). +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 previos anchor mode to the new one, so margin offsets ([set_margin](#set_margin)) must be done after setting anchors, or at the same time ([set_anchor_and_margin](#set_anchor_and_margin)). #### get_anchor - * [int](class_int) **`get_anchor`** **(** [int](class_int) margin **)** const + * [int](class_int) **get_anchor** **(** [int](class_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). #### set_margin - * void **`set_margin`** **(** [int](class_int) margin, [real](class_real) offset **)** + * void **set_margin** **(** [int](class_int) margin, [real](class_real) offset **)** Set a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being set depends on the anchor mode. #### set_anchor_and_margin - * void **`set_anchor_and_margin`** **(** [int](class_int) margin, [int](class_int) anchor_mode, [real](class_real) offset **)** + * void **set_anchor_and_margin** **(** [int](class_int) margin, [int](class_int) anchor_mode, [real](class_real) offset **)** -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 [`set_anchor`](#set_anchor) and [`set_margin`](#set_margin)). +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 [set_anchor](#set_anchor) and [set_margin](#set_margin)). #### set_begin - * void **`set_begin`** **(** [Vector2](class_vector2) pos **)** + * void **set_begin** **(** [Vector2](class_vector2) pos **)** -Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [`set_margin`](#set_margin)). +Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [set_margin](#set_margin)). #### set_end - * void **`set_end`** **(** [Vector2](class_vector2) pos **)** + * void **set_end** **(** [Vector2](class_vector2) pos **)** -Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see [`set_margin`](#set_margin)). +Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see [set_margin](#set_margin)). #### set_pos - * void **`set_pos`** **(** [Vector2](class_vector2) pos **)** + * void **set_pos** **(** [Vector2](class_vector2) pos **)** -Move the Control to a new position, relative to the top-left corner of the parent Control, changing all margins if needed and without changing current anchor mode. This is a helper (see [`set_margin`](#set_margin)). +Move the Control to a new position, relative to the top-left corner of the parent Control, changing all margins if needed and without changing current anchor mode. This is a helper (see [set_margin](#set_margin)). #### set_size - * void **`set_size`** **(** [Vector2](class_vector2) size **)** + * void **set_size** **(** [Vector2](class_vector2) size **)** -Changes MARGIN_RIGHT and MARGIN_BOTTOM to fit a given size. This is a helper (see [`set_margin`](#set_margin)). +Changes MARGIN_RIGHT and MARGIN_BOTTOM to fit a given size. This is a helper (see [set_margin](#set_margin)). #### set_global_pos - * void **`set_global_pos`** **(** [Vector2](class_vector2) pos **)** + * void **set_global_pos** **(** [Vector2](class_vector2) pos **)** -Move the Control to a new position, relative to the top-left corner of the _window_ Control, and without changing current anchor mode. (see [`set_margin`](#set_margin)). +Move the Control to a new position, relative to the top-left corner of the _window_ Control, and without changing current anchor mode. (see [set_margin](#set_margin)). #### get_margin - * [real](class_real) **`get_margin`** **(** [int](class_int) margin **)** const + * [real](class_real) **get_margin** **(** [int](class_int) margin **)** const Return a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being returned depends on the anchor mode. #### get_end - * [Vector2](class_vector2) **`get_end`** **(** **)** const + * [Vector2](class_vector2) **get_end** **(** **)** const -Returns MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [`set_margin`](#set_margin)). +Returns MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [set_margin](#set_margin)). #### get_pos - * [Vector2](class_vector2) **`get_pos`** **(** **)** const + * [Vector2](class_vector2) **get_pos** **(** **)** const Returns the Control position, relative to the top-left corner of the parent Control and independly of the anchor mode. #### get_size - * [Vector2](class_vector2) **`get_size`** **(** **)** const + * [Vector2](class_vector2) **get_size** **(** **)** const -Returns the size of the Control, computed from all margins, however the size returned will **never be smaller than the minimum size reported by [`get_minimum_size`](#get_minimum_size)**. This means that even if end position of the Control rectangle is smaller than the begin position, the Control will still display and interact correctly. (see description, [`get_minimum_size`](#get_minimum_size), [`set_margin`](#set_margin), [`set_anchor`](#set_anchor)). +Returns the size of the Control, computed from all margins, however the size returned will **never be smaller than the minimum size reported by [get_minimum_size](#get_minimum_size)**. This means that even if end position of the Control rectangle is smaller than the begin position, the Control will still display and interact correctly. (see description, [get_minimum_size](#get_minimum_size), [set_margin](#set_margin), [set_anchor](#set_anchor)). #### get_global_pos - * [Vector2](class_vector2) **`get_global_pos`** **(** **)** const + * [Vector2](class_vector2) **get_global_pos** **(** **)** const Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode. #### get_rect - * [Rect2](class_rect2) **`get_rect`** **(** **)** const + * [Rect2](class_rect2) **get_rect** **(** **)** const -Return position and size of the Control, relative to the top-left corner of the parent Control. This is a helper (see [`get_pos`](#get_pos),[`get_size`](#get_size)). +Return position and size of the Control, relative to the top-left corner of the parent Control. This is a helper (see [get_pos](#get_pos),[get_size](#get_size)). #### get_global_rect - * [Rect2](class_rect2) **`get_global_rect`** **(** **)** const + * [Rect2](class_rect2) **get_global_rect** **(** **)** const -Return position and size of the Control, relative to the top-left corner of the _window_ Control. This is a helper (see [`get_global_pos`](#get_global_pos),[`get_size`](#get_size)). +Return position and size of the Control, relative to the top-left corner of the _window_ Control. This is a helper (see [get_global_pos](#get_global_pos),[get_size](#get_size)). #### set_area_as_parent_rect - * void **`set_area_as_parent_rect`** **(** [int](class_int) margin=0 **)** + * void **set_area_as_parent_rect** **(** [int](class_int) margin=0 **)** -Change all margins and anchors, so this Control always takes up the same area as the parent Control. This is a helper (see [`set_anchor`](#set_anchor),[`set_margin`](#set_margin)). +Change all margins and anchors, so this Control always takes up the same area as the parent Control. This is a helper (see [set_anchor](#set_anchor),[set_margin](#set_margin)). #### show_modal - * void **`show_modal`** **(** [bool](class_bool) exclusive=false **)** + * void **show_modal** **(** [bool](class_bool) exclusive=false **)** -Display a Control as modal. Control must be a subwindow (see [`set_as_subwindow`](#set_as_subwindow)). Modal controls capture the input signals until closed or the area outside them is accessed. When a modal control loses focus, or the ESC key is pressed, they automatically hide. Modal controls are used extensively for popup dialogs and menus. +Display a Control as modal. Control must be a subwindow (see [set_as_subwindow](#set_as_subwindow)). Modal controls capture the input signals until closed or the area outside them is accessed. When a modal control loses focus, or the ESC key is pressed, they automatically hide. Modal controls are used extensively for popup dialogs and menus. #### set_focus_mode - * void **`set_focus_mode`** **(** [int](class_int) mode **)** + * void **set_focus_mode** **(** [int](class_int) mode **)** Set the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL). Only one Control can be focused at the same time, and it will receive keyboard signals. #### has_focus - * [bool](class_bool) **`has_focus`** **(** **)** const + * [bool](class_bool) **has_focus** **(** **)** const -Return wether the Control is the current focused control (see [`set_focus_mode`](#set_focus_mode)). +Return wether the Control is the current focused control (see [set_focus_mode](#set_focus_mode)). #### grab_focus - * void **`grab_focus`** **(** **)** + * void **grab_focus** **(** **)** -Steal the focus from another control and become the focused control (see [`set_focus_mode`](#set_focus_mode)). +Steal the focus from another control and become the focused control (see [set_focus_mode](#set_focus_mode)). #### release_focus - * void **`release_focus`** **(** **)** + * void **release_focus** **(** **)** Give up the focus, no other control will be able to receive keyboard input. #### get_focus_owner - * [Control](class_control) **`get_focus_owner`** **(** **)** const + * [Control](class_control) **get_focus_owner** **(** **)** const Return which control is owning the keyboard focus, or null if no one. #### set_h_size_flags - * void **`set_h_size_flags`** **(** [int](class_int) flags **)** + * void **set_h_size_flags** **(** [int](class_int) flags **)** Hint for containers, set horizontal positioning flags. #### get_h_size_flags - * [int](class_int) **`get_h_size_flags`** **(** **)** const + * [int](class_int) **get_h_size_flags** **(** **)** const Hint for containers, return horizontal positioning flags. #### set_stretch_ratio - * void **`set_stretch_ratio`** **(** [real](class_real) ratio **)** + * void **set_stretch_ratio** **(** [real](class_real) ratio **)** Hint for containers, set the stretch ratio. This value is relative to other stretch ratio, so if this control has 2 and another has 1, this one will be twice as big. #### get_stretch_ratio - * [real](class_real) **`get_stretch_ratio`** **(** **)** const + * [real](class_real) **get_stretch_ratio** **(** **)** const Hint for containers, return the stretch ratio. This value is relative to other stretch ratio, so if this control has 2 and another has 1, this one will be twice as big. #### set_v_size_flags - * void **`set_v_size_flags`** **(** [int](class_int) flags **)** + * void **set_v_size_flags** **(** [int](class_int) flags **)** Hint for containers, set vertical positioning flags. #### get_v_size_flags - * [int](class_int) **`get_v_size_flags`** **(** **)** const + * [int](class_int) **get_v_size_flags** **(** **)** const Hint for containers, return vertical positioning flags. #### set_theme - * void **`set_theme`** **(** [Theme](class_theme) theme **)** + * void **set_theme** **(** [Theme](class_theme) theme **)** Override whole the [Theme](class_theme) for this Control and all its children controls. #### get_theme - * [Theme](class_theme) **`get_theme`** **(** **)** const + * [Theme](class_theme) **get_theme** **(** **)** const -Return a [Theme](class_theme) override, if one exists (see [`set_theme`](#set_theme)). +Return a [Theme](class_theme) override, if one exists (see [set_theme](#set_theme)). #### add_icon_override - * void **`add_icon_override`** **(** [String](class_string) name, [Texture](class_texture) texture **)** + * void **add_icon_override** **(** [String](class_string) name, [Texture](class_texture) texture **)** Override a single icon ([Texture](class_texture)) in the theme of this Control. If texture is empty, override is cleared. #### add_style_override - * void **`add_style_override`** **(** [String](class_string) name, [StyleBox](class_stylebox) stylebox **)** + * void **add_style_override** **(** [String](class_string) name, [StyleBox](class_stylebox) stylebox **)** Override a single stylebox ([Stylebox]) in the theme of this Control. If stylebox is empty, override is cleared. #### add_font_override - * void **`add_font_override`** **(** [String](class_string) name, [Font](class_font) font **)** + * void **add_font_override** **(** [String](class_string) name, [Font](class_font) font **)** Override a single font (font) in the theme of this Control. If font is empty, override is cleared. #### add_constant_override - * void **`add_constant_override`** **(** [String](class_string) name, [int](class_int) constant **)** + * void **add_constant_override** **(** [String](class_string) name, [int](class_int) constant **)** Override a single constant (integer) in the theme of this Control. If constant equals Theme.INVALID_CONSTANT, override is cleared. #### set_tooltip - * void **`set_tooltip`** **(** [String](class_string) tooltip **)** + * void **set_tooltip** **(** [String](class_string) tooltip **)** Set a tooltip, which will appear when the cursor is resting over this control. #### get_tooltip - * [String](class_string) **`get_tooltip`** **(** [Vector2](class_vector2) atpos=Vector2(0,0) **)** const + * [String](class_string) **get_tooltip** **(** [Vector2](class_vector2) atpos=Vector2(0,0) **)** const Return the tooltip, which will appear when the cursor is resting over this control. #### set_default_cursor_shape - * void **`set_default_cursor_shape`** **(** [int](class_int) shape **)** + * void **set_default_cursor_shape** **(** [int](class_int) shape **)** Set the default cursor shape for this control. See enum CURSOR_* for the list of shapes. #### get_default_cursor_shape - * [int](class_int) **`get_default_cursor_shape`** **(** **)** const + * [int](class_int) **get_default_cursor_shape** **(** **)** const Return the default cursor shape for this control. See enum CURSOR_* for the list of shapes. #### get_cursor_shape - * [int](class_int) **`get_cursor_shape`** **(** [Vector2](class_vector2) pos=Vector2(0,0) **)** const + * [int](class_int) **get_cursor_shape** **(** [Vector2](class_vector2) pos=Vector2(0,0) **)** const Return the cursor shape at a certain position in the control. #### set_focus_neighbour - * void **`set_focus_neighbour`** **(** [int](class_int) margin, [NodePath](class_nodepath) neighbour **)** + * void **set_focus_neighbour** **(** [int](class_int) margin, [NodePath](class_nodepath) neighbour **)** Force a neighbour for moving the input focus to. When pressing TAB or directional/joypad directions focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function. #### get_focus_neighbour - * [NodePath](class_nodepath) **`get_focus_neighbour`** **(** [int](class_int) margin **)** const + * [NodePath](class_nodepath) **get_focus_neighbour** **(** [int](class_int) margin **)** const Return the forced neighbour for moving the input focus to. When pressing TAB or directional/joypad directions focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function. #### set_ignore_mouse - * void **`set_ignore_mouse`** **(** [bool](class_bool) ignore **)** + * void **set_ignore_mouse** **(** [bool](class_bool) ignore **)** Ignore mouse events on this control (even touchpad events send mouse events). #### is_ignoring_mouse - * [bool](class_bool) **`is_ignoring_mouse`** **(** **)** const + * [bool](class_bool) **is_ignoring_mouse** **(** **)** const Return if the control is ignoring mouse events (even touchpad events send mouse events). diff --git a/class_convexpolygonshape.md b/class_convexpolygonshape.md index 4f909bf..21eb573 100644 --- a/class_convexpolygonshape.md +++ b/class_convexpolygonshape.md @@ -6,8 +6,8 @@ Convex Polygon Shape ### Member Functions - * void **[`set_points`](#set_points)** **(** [Vector3Array](class_vector3array) points **)** - * [Vector3Array](class_vector3array) **[`get_points`](#get_points)** **(** **)** const + * void **[set_points](#set_points)** **(** [Vector3Array](class_vector3array) points **)** + * [Vector3Array](class_vector3array) **[get_points](#get_points)** **(** **)** const ### Description Convex polygon shape resource, which can be set into a [PhysicsBody](class_physicsbody) or area. diff --git a/class_convexpolygonshape2d.md b/class_convexpolygonshape2d.md index c91541f..f5aad49 100644 --- a/class_convexpolygonshape2d.md +++ b/class_convexpolygonshape2d.md @@ -6,9 +6,9 @@ Convex Polygon Shape for 2D physics ### Member Functions - * void **[`set_point_cloud`](#set_point_cloud)** **(** [Vector2Array](class_vector2array) point_cloud **)** - * void **[`set_points`](#set_points)** **(** [Vector2Array](class_vector2array) points **)** - * [Vector2Array](class_vector2array) **[`get_points`](#get_points)** **(** **)** const + * void **[set_point_cloud](#set_point_cloud)** **(** [Vector2Array](class_vector2array) point_cloud **)** + * void **[set_points](#set_points)** **(** [Vector2Array](class_vector2array) points **)** + * [Vector2Array](class_vector2array) **[get_points](#get_points)** **(** **)** const ### Description Convex Polygon Shape for 2D physics. @@ -16,16 +16,16 @@ Convex Polygon Shape for 2D physics. ### Member Function Description #### set_point_cloud - * void **`set_point_cloud`** **(** [Vector2Array](class_vector2array) point_cloud **)** + * void **set_point_cloud** **(** [Vector2Array](class_vector2array) point_cloud **)** Create the point set from a point cloud. The resulting convex hull will be set as the shape. #### set_points - * void **`set_points`** **(** [Vector2Array](class_vector2array) points **)** + * void **set_points** **(** [Vector2Array](class_vector2array) points **)** Set a list of points in either clockwise or counter clockwise order, forming a convex polygon. #### get_points - * [Vector2Array](class_vector2array) **`get_points`** **(** **)** const + * [Vector2Array](class_vector2array) **get_points** **(** **)** const Return a list of points in either clockwise or counter clockwise order, forming a convex polygon. diff --git a/class_cubemap.md b/class_cubemap.md index 7ff1909..88c7c05 100644 --- a/class_cubemap.md +++ b/class_cubemap.md @@ -6,17 +6,17 @@ ### Member Functions - * [int](class_int) **[`get_width`](#get_width)** **(** **)** const - * [int](class_int) **[`get_height`](#get_height)** **(** **)** const - * [RID](class_rid) **[`get_rid`](#get_rid)** **(** **)** const - * void **[`set_flags`](#set_flags)** **(** [int](class_int) flags **)** - * [int](class_int) **[`get_flags`](#get_flags)** **(** **)** const - * void **[`set_side`](#set_side)** **(** [int](class_int) side, [Image](class_image) image **)** - * [Image](class_image) **[`get_side`](#get_side)** **(** [int](class_int) side **)** const - * void **[`set_storage`](#set_storage)** **(** [int](class_int) mode **)** - * [int](class_int) **[`get_storage`](#get_storage)** **(** **)** const - * void **[`set_lossy_storage_quality`](#set_lossy_storage_quality)** **(** [real](class_real) quality **)** - * [real](class_real) **[`get_lossy_storage_quality`](#get_lossy_storage_quality)** **(** **)** const + * [int](class_int) **[get_width](#get_width)** **(** **)** const + * [int](class_int) **[get_height](#get_height)** **(** **)** const + * [RID](class_rid) **[get_rid](#get_rid)** **(** **)** const + * void **[set_flags](#set_flags)** **(** [int](class_int) flags **)** + * [int](class_int) **[get_flags](#get_flags)** **(** **)** const + * void **[set_side](#set_side)** **(** [int](class_int) side, [Image](class_image) image **)** + * [Image](class_image) **[get_side](#get_side)** **(** [int](class_int) side **)** const + * void **[set_storage](#set_storage)** **(** [int](class_int) mode **)** + * [int](class_int) **[get_storage](#get_storage)** **(** **)** const + * void **[set_lossy_storage_quality](#set_lossy_storage_quality)** **(** [real](class_real) quality **)** + * [real](class_real) **[get_lossy_storage_quality](#get_lossy_storage_quality)** **(** **)** const ### Numeric Constants * **STORAGE_RAW** = **0** diff --git a/class_curve2d.md b/class_curve2d.md index fa8e014..acb7805 100644 --- a/class_curve2d.md +++ b/class_curve2d.md @@ -6,22 +6,22 @@ ### Member Functions - * [int](class_int) **[`get_point_count`](#get_point_count)** **(** **)** const - * void **[`add_point`](#add_point)** **(** [Vector2](class_vector2) pos, [Vector2](class_vector2) in=Vector2(0,0), [Vector2](class_vector2) out=Vector2(0,0) **)** - * void **[`set_point_pos`](#set_point_pos)** **(** [int](class_int) idx, [Vector2](class_vector2) pos **)** - * [Vector2](class_vector2) **[`get_point_pos`](#get_point_pos)** **(** [int](class_int) idx **)** const - * void **[`set_point_in`](#set_point_in)** **(** [int](class_int) idx, [Vector2](class_vector2) pos **)** - * [Vector2](class_vector2) **[`get_point_in`](#get_point_in)** **(** [int](class_int) idx **)** const - * void **[`set_point_out`](#set_point_out)** **(** [int](class_int) idx, [Vector2](class_vector2) pos **)** - * [Vector2](class_vector2) **[`get_point_out`](#get_point_out)** **(** [int](class_int) idx **)** const - * void **[`remove_point`](#remove_point)** **(** [int](class_int) idx **)** - * [Vector2](class_vector2) **[`interpolate`](#interpolate)** **(** [int](class_int) idx, [real](class_real) t **)** const - * [Vector2Array](class_vector2array) **[`bake`](#bake)** **(** [int](class_int) subdivs=10 **)** const - * void **[`set_points_in`](#set_points_in)** **(** [Vector2Array](class_vector2array) arg0 **)** - * void **[`set_points_out`](#set_points_out)** **(** [Vector2Array](class_vector2array) arg0 **)** - * void **[`set_points_pos`](#set_points_pos)** **(** [Vector2Array](class_vector2array) arg0 **)** - * [Vector2Array](class_vector2array) **[`get_points_in`](#get_points_in)** **(** **)** const - * [Vector2Array](class_vector2array) **[`get_points_out`](#get_points_out)** **(** **)** const - * [Vector2Array](class_vector2array) **[`get_points_pos`](#get_points_pos)** **(** **)** const + * [int](class_int) **[get_point_count](#get_point_count)** **(** **)** const + * void **[add_point](#add_point)** **(** [Vector2](class_vector2) pos, [Vector2](class_vector2) in=Vector2(0,0), [Vector2](class_vector2) out=Vector2(0,0) **)** + * void **[set_point_pos](#set_point_pos)** **(** [int](class_int) idx, [Vector2](class_vector2) pos **)** + * [Vector2](class_vector2) **[get_point_pos](#get_point_pos)** **(** [int](class_int) idx **)** const + * void **[set_point_in](#set_point_in)** **(** [int](class_int) idx, [Vector2](class_vector2) pos **)** + * [Vector2](class_vector2) **[get_point_in](#get_point_in)** **(** [int](class_int) idx **)** const + * void **[set_point_out](#set_point_out)** **(** [int](class_int) idx, [Vector2](class_vector2) pos **)** + * [Vector2](class_vector2) **[get_point_out](#get_point_out)** **(** [int](class_int) idx **)** const + * void **[remove_point](#remove_point)** **(** [int](class_int) idx **)** + * [Vector2](class_vector2) **[interpolate](#interpolate)** **(** [int](class_int) idx, [real](class_real) t **)** const + * [Vector2Array](class_vector2array) **[bake](#bake)** **(** [int](class_int) subdivs=10 **)** const + * void **[set_points_in](#set_points_in)** **(** [Vector2Array](class_vector2array) arg0 **)** + * void **[set_points_out](#set_points_out)** **(** [Vector2Array](class_vector2array) arg0 **)** + * void **[set_points_pos](#set_points_pos)** **(** [Vector2Array](class_vector2array) arg0 **)** + * [Vector2Array](class_vector2array) **[get_points_in](#get_points_in)** **(** **)** const + * [Vector2Array](class_vector2array) **[get_points_out](#get_points_out)** **(** **)** const + * [Vector2Array](class_vector2array) **[get_points_pos](#get_points_pos)** **(** **)** const ### Member Function Description diff --git a/class_curve3d.md b/class_curve3d.md index fd52efd..c9676e2 100644 --- a/class_curve3d.md +++ b/class_curve3d.md @@ -6,24 +6,24 @@ ### Member Functions - * [int](class_int) **[`get_point_count`](#get_point_count)** **(** **)** const - * void **[`add_point`](#add_point)** **(** [Vector3](class_vector3) pos, [Vector3](class_vector3) in=Vector3(0, 0, 0), [Vector3](class_vector3) out=Vector3(0, 0, 0), [int](class_int) atpos=-1 **)** - * void **[`set_point_pos`](#set_point_pos)** **(** [int](class_int) idx, [Vector3](class_vector3) pos **)** - * [Vector3](class_vector3) **[`get_point_pos`](#get_point_pos)** **(** [int](class_int) idx **)** const - * void **[`set_point_tilt`](#set_point_tilt)** **(** [int](class_int) idx, [real](class_real) tilt **)** - * [real](class_real) **[`get_point_tilt`](#get_point_tilt)** **(** [int](class_int) idx **)** const - * void **[`set_point_in`](#set_point_in)** **(** [int](class_int) idx, [Vector3](class_vector3) pos **)** - * [Vector3](class_vector3) **[`get_point_in`](#get_point_in)** **(** [int](class_int) idx **)** const - * void **[`set_point_out`](#set_point_out)** **(** [int](class_int) idx, [Vector3](class_vector3) pos **)** - * [Vector3](class_vector3) **[`get_point_out`](#get_point_out)** **(** [int](class_int) idx **)** const - * void **[`remove_point`](#remove_point)** **(** [int](class_int) idx **)** - * [Vector3](class_vector3) **[`interpolate`](#interpolate)** **(** [int](class_int) idx, [real](class_real) t **)** const - * [Vector3](class_vector3) **[`interpolatef`](#interpolatef)** **(** [real](class_real) fofs **)** const - * void **[`set_bake_interval`](#set_bake_interval)** **(** [real](class_real) distance **)** - * [real](class_real) **[`get_bake_interval`](#get_bake_interval)** **(** **)** const - * [real](class_real) **[`get_baked_length`](#get_baked_length)** **(** **)** const - * [Vector3](class_vector3) **[`interpolate_baked`](#interpolate_baked)** **(** [real](class_real) offset, [bool](class_bool) cubic=false **)** const - * [Vector3Array](class_vector3array) **[`get_baked_points`](#get_baked_points)** **(** **)** const - * [RealArray](class_realarray) **[`get_baked_tilts`](#get_baked_tilts)** **(** **)** const + * [int](class_int) **[get_point_count](#get_point_count)** **(** **)** const + * void **[add_point](#add_point)** **(** [Vector3](class_vector3) pos, [Vector3](class_vector3) in=Vector3(0, 0, 0), [Vector3](class_vector3) out=Vector3(0, 0, 0), [int](class_int) atpos=-1 **)** + * void **[set_point_pos](#set_point_pos)** **(** [int](class_int) idx, [Vector3](class_vector3) pos **)** + * [Vector3](class_vector3) **[get_point_pos](#get_point_pos)** **(** [int](class_int) idx **)** const + * void **[set_point_tilt](#set_point_tilt)** **(** [int](class_int) idx, [real](class_real) tilt **)** + * [real](class_real) **[get_point_tilt](#get_point_tilt)** **(** [int](class_int) idx **)** const + * void **[set_point_in](#set_point_in)** **(** [int](class_int) idx, [Vector3](class_vector3) pos **)** + * [Vector3](class_vector3) **[get_point_in](#get_point_in)** **(** [int](class_int) idx **)** const + * void **[set_point_out](#set_point_out)** **(** [int](class_int) idx, [Vector3](class_vector3) pos **)** + * [Vector3](class_vector3) **[get_point_out](#get_point_out)** **(** [int](class_int) idx **)** const + * void **[remove_point](#remove_point)** **(** [int](class_int) idx **)** + * [Vector3](class_vector3) **[interpolate](#interpolate)** **(** [int](class_int) idx, [real](class_real) t **)** const + * [Vector3](class_vector3) **[interpolatef](#interpolatef)** **(** [real](class_real) fofs **)** const + * void **[set_bake_interval](#set_bake_interval)** **(** [real](class_real) distance **)** + * [real](class_real) **[get_bake_interval](#get_bake_interval)** **(** **)** const + * [real](class_real) **[get_baked_length](#get_baked_length)** **(** **)** const + * [Vector3](class_vector3) **[interpolate_baked](#interpolate_baked)** **(** [real](class_real) offset, [bool](class_bool) cubic=false **)** const + * [Vector3Array](class_vector3array) **[get_baked_points](#get_baked_points)** **(** **)** const + * [RealArray](class_realarray) **[get_baked_tilts](#get_baked_tilts)** **(** **)** const ### Member Function Description diff --git a/class_dampedspringjoint2d.md b/class_dampedspringjoint2d.md index 704ed80..fe56e54 100644 --- a/class_dampedspringjoint2d.md +++ b/class_dampedspringjoint2d.md @@ -6,14 +6,14 @@ Damped sprint constraint for 2D physics. ### Member Functions - * void **[`set_length`](#set_length)** **(** [real](class_real) length **)** - * [real](class_real) **[`get_length`](#get_length)** **(** **)** const - * void **[`set_rest_length`](#set_rest_length)** **(** [real](class_real) rest_length **)** - * [real](class_real) **[`get_rest_length`](#get_rest_length)** **(** **)** const - * void **[`set_stiffness`](#set_stiffness)** **(** [real](class_real) stiffness **)** - * [real](class_real) **[`get_stiffness`](#get_stiffness)** **(** **)** const - * void **[`set_damping`](#set_damping)** **(** [real](class_real) damping **)** - * [real](class_real) **[`get_damping`](#get_damping)** **(** **)** const + * void **[set_length](#set_length)** **(** [real](class_real) length **)** + * [real](class_real) **[get_length](#get_length)** **(** **)** const + * void **[set_rest_length](#set_rest_length)** **(** [real](class_real) rest_length **)** + * [real](class_real) **[get_rest_length](#get_rest_length)** **(** **)** const + * void **[set_stiffness](#set_stiffness)** **(** [real](class_real) stiffness **)** + * [real](class_real) **[get_stiffness](#get_stiffness)** **(** **)** const + * void **[set_damping](#set_damping)** **(** [real](class_real) damping **)** + * [real](class_real) **[get_damping](#get_damping)** **(** **)** const ### Description Damped sprint constraint for 2D physics. This resembles a sprint joint that always want to go back to a given length. @@ -21,41 +21,41 @@ Damped sprint constraint for 2D physics. This resembles a sprint joint that alwa ### Member Function Description #### set_length - * void **`set_length`** **(** [real](class_real) length **)** + * void **set_length** **(** [real](class_real) length **)** Set the maximum length of the sprint joint. #### get_length - * [real](class_real) **`get_length`** **(** **)** const + * [real](class_real) **get_length** **(** **)** const Return the maximum length of the sprint joint. #### set_rest_length - * void **`set_rest_length`** **(** [real](class_real) rest_length **)** + * void **set_rest_length** **(** [real](class_real) rest_length **)** Set the resting length of the sprint joint. The joint will always try to go to back this length when pulled apart. #### get_rest_length - * [real](class_real) **`get_rest_length`** **(** **)** const + * [real](class_real) **get_rest_length** **(** **)** const Return the resting length of the sprint joint. The joint will always try to go to back this length when pulled apart. #### set_stiffness - * void **`set_stiffness`** **(** [real](class_real) stiffness **)** + * void **set_stiffness** **(** [real](class_real) stiffness **)** Set the stiffness of the spring joint. #### get_stiffness - * [real](class_real) **`get_stiffness`** **(** **)** const + * [real](class_real) **get_stiffness** **(** **)** const Return the stiffness of the spring joint. #### set_damping - * void **`set_damping`** **(** [real](class_real) damping **)** + * void **set_damping** **(** [real](class_real) damping **)** Set the damping of the spring joint. #### get_damping - * [real](class_real) **`get_damping`** **(** **)** const + * [real](class_real) **get_damping** **(** **)** const Return the damping of the spring joint. diff --git a/class_dictionary.md b/class_dictionary.md index 4a2758e..b94c3f9 100644 --- a/class_dictionary.md +++ b/class_dictionary.md @@ -5,15 +5,15 @@ Dictionary type. ### Member Functions - * void **[`clear`](#clear)** **(** **)** - * [bool](class_bool) **[`empty`](#empty)** **(** **)** - * void **[`erase`](#erase)** **(** var value **)** - * [bool](class_bool) **[`has`](#has)** **(** var value **)** - * [int](class_int) **[`hash`](#hash)** **(** **)** - * [Array](class_array) **[`keys`](#keys)** **(** **)** - * [int](class_int) **[`parse_json`](#parse_json)** **(** [String](class_string) json **)** - * [int](class_int) **[`size`](#size)** **(** **)** - * [String](class_string) **[`to_json`](#to_json)** **(** **)** + * void **[clear](#clear)** **(** **)** + * [bool](class_bool) **[empty](#empty)** **(** **)** + * void **[erase](#erase)** **(** var value **)** + * [bool](class_bool) **[has](#has)** **(** var value **)** + * [int](class_int) **[hash](#hash)** **(** **)** + * [Array](class_array) **[keys](#keys)** **(** **)** + * [int](class_int) **[parse_json](#parse_json)** **(** [String](class_string) json **)** + * [int](class_int) **[size](#size)** **(** **)** + * [String](class_string) **[to_json](#to_json)** **(** **)** ### Description Dictionary type. Associative container which contains values referenced by unique keys. Dictionaries are always passed by reference. @@ -21,36 +21,36 @@ Dictionary type. Associative container which contains values referenced by uniqu ### Member Function Description #### clear - * void **`clear`** **(** **)** + * void **clear** **(** **)** Clear the dictionary, removing all key/value pairs. #### empty - * [bool](class_bool) **`empty`** **(** **)** + * [bool](class_bool) **empty** **(** **)** Return true if the dictionary is empty. #### erase - * void **`erase`** **(** var value **)** + * void **erase** **(** var value **)** Erase a dictionary key/value pair by key. #### has - * [bool](class_bool) **`has`** **(** var value **)** + * [bool](class_bool) **has** **(** var value **)** Return true if the dictionary has a given key. #### hash - * [int](class_int) **`hash`** **(** **)** + * [int](class_int) **hash** **(** **)** Return a hashed integer value representing the dictionary contents. #### keys - * [Array](class_array) **`keys`** **(** **)** + * [Array](class_array) **keys** **(** **)** Return the list of keys in the dictionary. #### size - * [int](class_int) **`size`** **(** **)** + * [int](class_int) **size** **(** **)** Return the size of the dictionary (in pairs). diff --git a/class_directionallight.md b/class_directionallight.md index bd0a06f..e5e81e6 100644 --- a/class_directionallight.md +++ b/class_directionallight.md @@ -6,10 +6,10 @@ Directional Light, such as the Sun or the Moon. ### Member Functions - * void **[`set_shadow_mode`](#set_shadow_mode)** **(** [int](class_int) mode **)** - * [int](class_int) **[`get_shadow_mode`](#get_shadow_mode)** **(** **)** const - * void **[`set_shadow_param`](#set_shadow_param)** **(** [int](class_int) param, [real](class_real) value **)** - * [real](class_real) **[`get_shadow_param`](#get_shadow_param)** **(** [int](class_int) param **)** const + * void **[set_shadow_mode](#set_shadow_mode)** **(** [int](class_int) mode **)** + * [int](class_int) **[get_shadow_mode](#get_shadow_mode)** **(** **)** const + * void **[set_shadow_param](#set_shadow_param)** **(** [int](class_int) param, [real](class_real) value **)** + * [real](class_real) **[get_shadow_param](#get_shadow_param)** **(** [int](class_int) param **)** const ### Numeric Constants * **SHADOW_ORTHOGONAL** = **0** diff --git a/class_directory.md b/class_directory.md index c7abe6f..134b3be 100644 --- a/class_directory.md +++ b/class_directory.md @@ -6,21 +6,21 @@ ### Member Functions - * [int](class_int) **[`open`](#open)** **(** [String](class_string) path **)** - * [bool](class_bool) **[`list_dir_begin`](#list_dir_begin)** **(** **)** - * [String](class_string) **[`get_next`](#get_next)** **(** **)** - * [bool](class_bool) **[`current_is_dir`](#current_is_dir)** **(** **)** const - * void **[`list_dir_end`](#list_dir_end)** **(** **)** - * [int](class_int) **[`get_drive_count`](#get_drive_count)** **(** **)** - * [String](class_string) **[`get_drive`](#get_drive)** **(** [int](class_int) idx **)** - * [int](class_int) **[`change_dir`](#change_dir)** **(** [String](class_string) todir **)** - * [String](class_string) **[`get_current_dir`](#get_current_dir)** **(** **)** - * [int](class_int) **[`make_dir`](#make_dir)** **(** [String](class_string) name **)** - * [int](class_int) **[`make_dir_recursive`](#make_dir_recursive)** **(** [String](class_string) name **)** - * [bool](class_bool) **[`file_exists`](#file_exists)** **(** [String](class_string) name **)** - * [int](class_int) **[`get_space_left`](#get_space_left)** **(** **)** - * [int](class_int) **[`copy`](#copy)** **(** [String](class_string) from, [String](class_string) to **)** - * [int](class_int) **[`rename`](#rename)** **(** [String](class_string) from, [String](class_string) to **)** - * [int](class_int) **[`remove`](#remove)** **(** [String](class_string) file **)** + * [int](class_int) **[open](#open)** **(** [String](class_string) path **)** + * [bool](class_bool) **[list_dir_begin](#list_dir_begin)** **(** **)** + * [String](class_string) **[get_next](#get_next)** **(** **)** + * [bool](class_bool) **[current_is_dir](#current_is_dir)** **(** **)** const + * void **[list_dir_end](#list_dir_end)** **(** **)** + * [int](class_int) **[get_drive_count](#get_drive_count)** **(** **)** + * [String](class_string) **[get_drive](#get_drive)** **(** [int](class_int) idx **)** + * [int](class_int) **[change_dir](#change_dir)** **(** [String](class_string) todir **)** + * [String](class_string) **[get_current_dir](#get_current_dir)** **(** **)** + * [int](class_int) **[make_dir](#make_dir)** **(** [String](class_string) name **)** + * [int](class_int) **[make_dir_recursive](#make_dir_recursive)** **(** [String](class_string) name **)** + * [bool](class_bool) **[file_exists](#file_exists)** **(** [String](class_string) name **)** + * [int](class_int) **[get_space_left](#get_space_left)** **(** **)** + * [int](class_int) **[copy](#copy)** **(** [String](class_string) from, [String](class_string) to **)** + * [int](class_int) **[rename](#rename)** **(** [String](class_string) from, [String](class_string) to **)** + * [int](class_int) **[remove](#remove)** **(** [String](class_string) file **)** ### Member Function Description diff --git a/class_editablesphere.md b/class_editablesphere.md index 31255bb..0b8c8f1 100644 --- a/class_editablesphere.md +++ b/class_editablesphere.md @@ -6,7 +6,7 @@ ### Member Functions - * void **[`set_radius`](#set_radius)** **(** [real](class_real) radius **)** - * [real](class_real) **[`get_radius`](#get_radius)** **(** **)** const + * void **[set_radius](#set_radius)** **(** [real](class_real) radius **)** + * [real](class_real) **[get_radius](#get_radius)** **(** **)** const ### Member Function Description diff --git a/class_editorimportplugin.md b/class_editorimportplugin.md index d6b738c..e523951 100644 --- a/class_editorimportplugin.md +++ b/class_editorimportplugin.md @@ -6,10 +6,10 @@ ### Member Functions - * [RawArray](class_rawarray) **[`custom_export`](#custom_export)** **(** [String](class_string) path **)** virtual - * [String](class_string) **[`get_name`](#get_name)** **(** **)** virtual - * [String](class_string) **[`get_visible_name`](#get_visible_name)** **(** **)** virtual - * [int](class_int) **[`import`](#import)** **(** [String](class_string) path, ResourceImportMetaData from **)** virtual - * void **[`import_dialog`](#import_dialog)** **(** [String](class_string) from **)** virtual + * [RawArray](class_rawarray) **[custom_export](#custom_export)** **(** [String](class_string) path **)** virtual + * [String](class_string) **[get_name](#get_name)** **(** **)** virtual + * [String](class_string) **[get_visible_name](#get_visible_name)** **(** **)** virtual + * [int](class_int) **[import](#import)** **(** [String](class_string) path, ResourceImportMetaData from **)** virtual + * void **[import_dialog](#import_dialog)** **(** [String](class_string) from **)** virtual ### Member Function Description diff --git a/class_editorplugin.md b/class_editorplugin.md index 77056d0..20b9479 100644 --- a/class_editorplugin.md +++ b/class_editorplugin.md @@ -6,22 +6,22 @@ ### Member Functions - * void **[`apply_changes`](#apply_changes)** **(** **)** virtual - * void **[`clear`](#clear)** **(** **)** virtual - * void **[`edit`](#edit)** **(** [Object](class_object) object **)** virtual - * [bool](class_bool) **[`forward_input_event`](#forward_input_event)** **(** [InputEvent](class_inputevent) event **)** virtual - * [bool](class_bool) **[`forward_spatial_input_event`](#forward_spatial_input_event)** **(** [Camera](class_camera) camera, [InputEvent](class_inputevent) event **)** virtual - * [StringArray](class_stringarray) **[`get_breakpoints`](#get_breakpoints)** **(** **)** virtual - * [String](class_string) **[`get_name`](#get_name)** **(** **)** virtual - * [Dictionary](class_dictionary) **[`get_state`](#get_state)** **(** **)** virtual - * [bool](class_bool) **[`handles`](#handles)** **(** [Object](class_object) object **)** virtual - * [bool](class_bool) **[`has_main_screen`](#has_main_screen)** **(** **)** virtual - * void **[`make_visible`](#make_visible)** **(** [bool](class_bool) visible **)** virtual - * void **[`set_state`](#set_state)** **(** [Dictionary](class_dictionary) state **)** virtual - * [Object](class_object) **[`get_undo_redo`](#get_undo_redo)** **(** **)** - * void **[`add_custom_control`](#add_custom_control)** **(** [int](class_int) container, [Object](class_object) control **)** - * void **[`add_custom_type`](#add_custom_type)** **(** [String](class_string) type, [String](class_string) base, [Script](class_script) script, [Texture](class_texture) icon **)** - * void **[`remove_custom_type`](#remove_custom_type)** **(** [String](class_string) type **)** + * void **[apply_changes](#apply_changes)** **(** **)** virtual + * void **[clear](#clear)** **(** **)** virtual + * void **[edit](#edit)** **(** [Object](class_object) object **)** virtual + * [bool](class_bool) **[forward_input_event](#forward_input_event)** **(** [InputEvent](class_inputevent) event **)** virtual + * [bool](class_bool) **[forward_spatial_input_event](#forward_spatial_input_event)** **(** [Camera](class_camera) camera, [InputEvent](class_inputevent) event **)** virtual + * [StringArray](class_stringarray) **[get_breakpoints](#get_breakpoints)** **(** **)** virtual + * [String](class_string) **[get_name](#get_name)** **(** **)** virtual + * [Dictionary](class_dictionary) **[get_state](#get_state)** **(** **)** virtual + * [bool](class_bool) **[handles](#handles)** **(** [Object](class_object) object **)** virtual + * [bool](class_bool) **[has_main_screen](#has_main_screen)** **(** **)** virtual + * void **[make_visible](#make_visible)** **(** [bool](class_bool) visible **)** virtual + * void **[set_state](#set_state)** **(** [Dictionary](class_dictionary) state **)** virtual + * [Object](class_object) **[get_undo_redo](#get_undo_redo)** **(** **)** + * void **[add_custom_control](#add_custom_control)** **(** [int](class_int) container, [Object](class_object) control **)** + * void **[add_custom_type](#add_custom_type)** **(** [String](class_string) type, [String](class_string) base, [Script](class_script) script, [Texture](class_texture) icon **)** + * void **[remove_custom_type](#remove_custom_type)** **(** [String](class_string) type **)** ### Numeric Constants * **CONTAINER_TOOLBAR** = **0** diff --git a/class_editorscenepostimport.md b/class_editorscenepostimport.md index 1b54266..335fef8 100644 --- a/class_editorscenepostimport.md +++ b/class_editorscenepostimport.md @@ -6,6 +6,6 @@ ### Member Functions - * void **[`post_import`](#post_import)** **(** [Object](class_object) scene **)** virtual + * void **[post_import](#post_import)** **(** [Object](class_object) scene **)** virtual ### Member Function Description diff --git a/class_emptycontrol.md b/class_emptycontrol.md index f8cda0d..9a57041 100644 --- a/class_emptycontrol.md +++ b/class_emptycontrol.md @@ -6,7 +6,7 @@ ### Member Functions - * void **[`set_minsize`](#set_minsize)** **(** [Vector2](class_vector2) minsize **)** - * [Vector2](class_vector2) **[`get_minsize`](#get_minsize)** **(** **)** const + * void **[set_minsize](#set_minsize)** **(** [Vector2](class_vector2) minsize **)** + * [Vector2](class_vector2) **[get_minsize](#get_minsize)** **(** **)** const ### Member Function Description diff --git a/class_environment.md b/class_environment.md index 003dfdf..d431dc7 100644 --- a/class_environment.md +++ b/class_environment.md @@ -6,14 +6,14 @@ ### Member Functions - * void **[`set_background`](#set_background)** **(** [int](class_int) bgmode **)** - * [int](class_int) **[`get_background`](#get_background)** **(** **)** const - * void **[`set_background_param`](#set_background_param)** **(** [int](class_int) param, var value **)** - * void **[`get_background_param`](#get_background_param)** **(** [int](class_int) param **)** const - * void **[`set_enable_fx`](#set_enable_fx)** **(** [int](class_int) effect, [bool](class_bool) enabled **)** - * [bool](class_bool) **[`is_fx_enabled`](#is_fx_enabled)** **(** [int](class_int) effect **)** const - * void **[`fx_set_param`](#fx_set_param)** **(** [int](class_int) param, var value **)** - * void **[`fx_get_param`](#fx_get_param)** **(** [int](class_int) param **)** const + * void **[set_background](#set_background)** **(** [int](class_int) bgmode **)** + * [int](class_int) **[get_background](#get_background)** **(** **)** const + * void **[set_background_param](#set_background_param)** **(** [int](class_int) param, var value **)** + * void **[get_background_param](#get_background_param)** **(** [int](class_int) param **)** const + * void **[set_enable_fx](#set_enable_fx)** **(** [int](class_int) effect, [bool](class_bool) enabled **)** + * [bool](class_bool) **[is_fx_enabled](#is_fx_enabled)** **(** [int](class_int) effect **)** const + * void **[fx_set_param](#fx_set_param)** **(** [int](class_int) param, var value **)** + * void **[fx_get_param](#fx_get_param)** **(** [int](class_int) param **)** const ### Numeric Constants * **BG_KEEP** = **0** diff --git a/class_eventplayer.md b/class_eventplayer.md index 43f7d97..e78bb80 100644 --- a/class_eventplayer.md +++ b/class_eventplayer.md @@ -6,32 +6,32 @@ ### Member Functions - * void **[`set_stream`](#set_stream)** **(** Stream stream **)** - * Stream **[`get_stream`](#get_stream)** **(** **)** const - * void **[`play`](#play)** **(** **)** - * void **[`stop`](#stop)** **(** **)** - * [bool](class_bool) **[`is_playing`](#is_playing)** **(** **)** const - * void **[`set_paused`](#set_paused)** **(** [bool](class_bool) paused **)** - * [bool](class_bool) **[`is_paused`](#is_paused)** **(** **)** const - * void **[`set_loop`](#set_loop)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`has_loop`](#has_loop)** **(** **)** const - * void **[`set_volume`](#set_volume)** **(** [real](class_real) volume **)** - * [real](class_real) **[`get_volume`](#get_volume)** **(** **)** const - * void **[`set_pitch_scale`](#set_pitch_scale)** **(** [real](class_real) pitch_scale **)** - * [real](class_real) **[`get_pitch_scale`](#get_pitch_scale)** **(** **)** const - * void **[`set_tempo_scale`](#set_tempo_scale)** **(** [real](class_real) tempo_scale **)** - * [real](class_real) **[`get_tempo_scale`](#get_tempo_scale)** **(** **)** const - * void **[`set_volume_db`](#set_volume_db)** **(** [real](class_real) db **)** - * [real](class_real) **[`get_volume_db`](#get_volume_db)** **(** **)** const - * [String](class_string) **[`get_stream_name`](#get_stream_name)** **(** **)** const - * [int](class_int) **[`get_loop_count`](#get_loop_count)** **(** **)** const - * [real](class_real) **[`get_pos`](#get_pos)** **(** **)** const - * void **[`seek_pos`](#seek_pos)** **(** [real](class_real) time **)** - * void **[`set_autoplay`](#set_autoplay)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`has_autoplay`](#has_autoplay)** **(** **)** const - * void **[`set_channel_volume`](#set_channel_volume)** **(** [int](class_int) idx, [real](class_real) channel_volume **)** - * [real](class_real) **[`get_channel_volumeidx`](#get_channel_volumeidx)** **(** [int](class_int) arg0 **)** const - * [real](class_real) **[`get_length`](#get_length)** **(** **)** const - * [real](class_real) **[`get_channel_last_note_time`](#get_channel_last_note_time)** **(** [int](class_int) arg0 **)** const + * void **[set_stream](#set_stream)** **(** Stream stream **)** + * Stream **[get_stream](#get_stream)** **(** **)** const + * void **[play](#play)** **(** **)** + * void **[stop](#stop)** **(** **)** + * [bool](class_bool) **[is_playing](#is_playing)** **(** **)** const + * void **[set_paused](#set_paused)** **(** [bool](class_bool) paused **)** + * [bool](class_bool) **[is_paused](#is_paused)** **(** **)** const + * void **[set_loop](#set_loop)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[has_loop](#has_loop)** **(** **)** const + * void **[set_volume](#set_volume)** **(** [real](class_real) volume **)** + * [real](class_real) **[get_volume](#get_volume)** **(** **)** const + * void **[set_pitch_scale](#set_pitch_scale)** **(** [real](class_real) pitch_scale **)** + * [real](class_real) **[get_pitch_scale](#get_pitch_scale)** **(** **)** const + * void **[set_tempo_scale](#set_tempo_scale)** **(** [real](class_real) tempo_scale **)** + * [real](class_real) **[get_tempo_scale](#get_tempo_scale)** **(** **)** const + * void **[set_volume_db](#set_volume_db)** **(** [real](class_real) db **)** + * [real](class_real) **[get_volume_db](#get_volume_db)** **(** **)** const + * [String](class_string) **[get_stream_name](#get_stream_name)** **(** **)** const + * [int](class_int) **[get_loop_count](#get_loop_count)** **(** **)** const + * [real](class_real) **[get_pos](#get_pos)** **(** **)** const + * void **[seek_pos](#seek_pos)** **(** [real](class_real) time **)** + * void **[set_autoplay](#set_autoplay)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[has_autoplay](#has_autoplay)** **(** **)** const + * void **[set_channel_volume](#set_channel_volume)** **(** [int](class_int) idx, [real](class_real) channel_volume **)** + * [real](class_real) **[get_channel_volumeidx](#get_channel_volumeidx)** **(** [int](class_int) arg0 **)** const + * [real](class_real) **[get_length](#get_length)** **(** **)** const + * [real](class_real) **[get_channel_last_note_time](#get_channel_last_note_time)** **(** [int](class_int) arg0 **)** const ### Member Function Description diff --git a/class_file.md b/class_file.md index e07f694..2946c74 100644 --- a/class_file.md +++ b/class_file.md @@ -6,41 +6,41 @@ ### Member Functions - * [int](class_int) **[`open`](#open)** **(** [String](class_string) path, [int](class_int) flags **)** - * void **[`close`](#close)** **(** **)** - * [bool](class_bool) **[`is_open`](#is_open)** **(** **)** const - * void **[`seek`](#seek)** **(** [int](class_int) pos **)** - * void **[`seek_end`](#seek_end)** **(** [int](class_int) pos=0 **)** - * [int](class_int) **[`get_pos`](#get_pos)** **(** **)** const - * [int](class_int) **[`get_len`](#get_len)** **(** **)** const - * [bool](class_bool) **[`eof_reached`](#eof_reached)** **(** **)** const - * [int](class_int) **[`get_8`](#get_8)** **(** **)** const - * [int](class_int) **[`get_16`](#get_16)** **(** **)** const - * [int](class_int) **[`get_32`](#get_32)** **(** **)** const - * [int](class_int) **[`get_64`](#get_64)** **(** **)** const - * [real](class_real) **[`get_float`](#get_float)** **(** **)** const - * [real](class_real) **[`get_double`](#get_double)** **(** **)** const - * [real](class_real) **[`get_real`](#get_real)** **(** **)** const - * [RawArray](class_rawarray) **[`get_buffer`](#get_buffer)** **(** [int](class_int) len **)** const - * [String](class_string) **[`get_line`](#get_line)** **(** **)** const - * [String](class_string) **[`get_as_text`](#get_as_text)** **(** **)** const - * [bool](class_bool) **[`get_endian_swap`](#get_endian_swap)** **(** **)** - * void **[`set_endian_swap`](#set_endian_swap)** **(** [bool](class_bool) enable **)** - * [int](class_int) **[`get_error`](#get_error)** **(** **)** const - * void **[`get_var`](#get_var)** **(** **)** const - * [StringArray](class_stringarray) **[`get_csv_line`](#get_csv_line)** **(** **)** const - * void **[`store_8`](#store_8)** **(** [int](class_int) value **)** - * void **[`store_16`](#store_16)** **(** [int](class_int) value **)** - * void **[`store_32`](#store_32)** **(** [int](class_int) value **)** - * void **[`store_64`](#store_64)** **(** [int](class_int) value **)** - * void **[`store_float`](#store_float)** **(** [real](class_real) value **)** - * void **[`store_double`](#store_double)** **(** [real](class_real) value **)** - * void **[`store_real`](#store_real)** **(** [real](class_real) value **)** - * void **[`store_buffer`](#store_buffer)** **(** [RawArray](class_rawarray) buffer **)** - * void **[`store_line`](#store_line)** **(** [String](class_string) line **)** - * void **[`store_string`](#store_string)** **(** [String](class_string) string **)** - * void **[`store_var`](#store_var)** **(** var value **)** - * [bool](class_bool) **[`file_exists`](#file_exists)** **(** [String](class_string) path **)** const + * [int](class_int) **[open](#open)** **(** [String](class_string) path, [int](class_int) flags **)** + * void **[close](#close)** **(** **)** + * [bool](class_bool) **[is_open](#is_open)** **(** **)** const + * void **[seek](#seek)** **(** [int](class_int) pos **)** + * void **[seek_end](#seek_end)** **(** [int](class_int) pos=0 **)** + * [int](class_int) **[get_pos](#get_pos)** **(** **)** const + * [int](class_int) **[get_len](#get_len)** **(** **)** const + * [bool](class_bool) **[eof_reached](#eof_reached)** **(** **)** const + * [int](class_int) **[getξ](#get_8)** **(** **)** const + * [int](class_int) **[get┬](#get_16)** **(** **)** const + * [int](class_int) **[get┼](#get_32)** **(** **)** const + * [int](class_int) **[get╜](#get_64)** **(** **)** const + * [real](class_real) **[get_float](#get_float)** **(** **)** const + * [real](class_real) **[get_double](#get_double)** **(** **)** const + * [real](class_real) **[get_real](#get_real)** **(** **)** const + * [RawArray](class_rawarray) **[get_buffer](#get_buffer)** **(** [int](class_int) len **)** const + * [String](class_string) **[get_line](#get_line)** **(** **)** const + * [String](class_string) **[get_as_text](#get_as_text)** **(** **)** const + * [bool](class_bool) **[get_endian_swap](#get_endian_swap)** **(** **)** + * void **[set_endian_swap](#set_endian_swap)** **(** [bool](class_bool) enable **)** + * [int](class_int) **[get_error](#get_error)** **(** **)** const + * void **[get_var](#get_var)** **(** **)** const + * [StringArray](class_stringarray) **[get_csv_line](#get_csv_line)** **(** **)** const + * void **[storeξ](#store_8)** **(** [int](class_int) value **)** + * void **[store┬](#store_16)** **(** [int](class_int) value **)** + * void **[store┼](#store_32)** **(** [int](class_int) value **)** + * void **[store╜](#store_64)** **(** [int](class_int) value **)** + * void **[store_float](#store_float)** **(** [real](class_real) value **)** + * void **[store_double](#store_double)** **(** [real](class_real) value **)** + * void **[store_real](#store_real)** **(** [real](class_real) value **)** + * void **[store_buffer](#store_buffer)** **(** [RawArray](class_rawarray) buffer **)** + * void **[store_line](#store_line)** **(** [String](class_string) line **)** + * void **[store_string](#store_string)** **(** [String](class_string) string **)** + * void **[store_var](#store_var)** **(** var value **)** + * [bool](class_bool) **[file_exists](#file_exists)** **(** [String](class_string) path **)** const ### Numeric Constants * **READ** = **1** diff --git a/class_filedialog.md b/class_filedialog.md index 4456ad3..a752687 100644 --- a/class_filedialog.md +++ b/class_filedialog.md @@ -6,25 +6,25 @@ Dialog for selecting files or directories in the filesystem. ### Member Functions - * void **[`clear_filters`](#clear_filters)** **(** **)** - * void **[`add_filter`](#add_filter)** **(** [String](class_string) filter **)** - * [String](class_string) **[`get_current_dir`](#get_current_dir)** **(** **)** const - * [String](class_string) **[`get_current_file`](#get_current_file)** **(** **)** const - * [String](class_string) **[`get_current_path`](#get_current_path)** **(** **)** const - * void **[`set_current_dir`](#set_current_dir)** **(** [String](class_string) dir **)** - * void **[`set_current_file`](#set_current_file)** **(** [String](class_string) file **)** - * void **[`set_current_path`](#set_current_path)** **(** [String](class_string) path **)** - * void **[`set_mode`](#set_mode)** **(** [int](class_int) mode **)** - * [int](class_int) **[`get_mode`](#get_mode)** **(** **)** const - * [VBoxContainer](class_vboxcontainer) **[`get_vbox`](#get_vbox)** **(** **)** - * void **[`set_access`](#set_access)** **(** [int](class_int) access **)** - * [int](class_int) **[`get_access`](#get_access)** **(** **)** const - * void **[`invalidate`](#invalidate)** **(** **)** + * void **[clear_filters](#clear_filters)** **(** **)** + * void **[add_filter](#add_filter)** **(** [String](class_string) filter **)** + * [String](class_string) **[get_current_dir](#get_current_dir)** **(** **)** const + * [String](class_string) **[get_current_file](#get_current_file)** **(** **)** const + * [String](class_string) **[get_current_path](#get_current_path)** **(** **)** const + * void **[set_current_dir](#set_current_dir)** **(** [String](class_string) dir **)** + * void **[set_current_file](#set_current_file)** **(** [String](class_string) file **)** + * void **[set_current_path](#set_current_path)** **(** [String](class_string) path **)** + * void **[set_mode](#set_mode)** **(** [int](class_int) mode **)** + * [int](class_int) **[get_mode](#get_mode)** **(** **)** const + * [VBoxContainer](class_vboxcontainer) **[get_vbox](#get_vbox)** **(** **)** + * void **[set_access](#set_access)** **(** [int](class_int) access **)** + * [int](class_int) **[get_access](#get_access)** **(** **)** const + * void **[invalidate](#invalidate)** **(** **)** ### Signals - * **`files_selected`** **(** [StringArray](class_stringarray) paths **)** - * **`dir_selected`** **(** [String](class_string) dir **)** - * **`file_selected`** **(** [String](class_string) path **)** + * **files_selected** **(** [StringArray](class_stringarray) paths **)** + * **dir_selected** **(** [String](class_string) dir **)** + * **file_selected** **(** [String](class_string) path **)** ### Numeric Constants * **MODE_OPEN_FILE** = **0** - Editor will not allow to select unexisting files. @@ -41,36 +41,36 @@ FileDialog is a preset dialog used to choose files and directories in the filesy ### Member Function Description #### clear_filters - * void **`clear_filters`** **(** **)** + * void **clear_filters** **(** **)** Clear all the added filters in the dialog. #### add_filter - * void **`add_filter`** **(** [String](class_string) filter **)** + * void **add_filter** **(** [String](class_string) filter **)** Add a custom filter. Filter format is: "mask ; description", example (C++): dialog-"lt;add_filter("*.png ; PNG Images"); #### get_current_dir - * [String](class_string) **`get_current_dir`** **(** **)** const + * [String](class_string) **get_current_dir** **(** **)** const Get the current working directory of the file dialog. #### get_current_file - * [String](class_string) **`get_current_file`** **(** **)** const + * [String](class_string) **get_current_file** **(** **)** const Get the current selected file of the file dialog (empty if none). #### get_current_path - * [String](class_string) **`get_current_path`** **(** **)** const + * [String](class_string) **get_current_path** **(** **)** const Get the current selected path (directory and file) of the file dialog (empty if none). #### set_mode - * void **`set_mode`** **(** [int](class_int) mode **)** + * void **set_mode** **(** [int](class_int) mode **)** Set the file dialog mode from the MODE_* enum. #### get_mode - * [int](class_int) **`get_mode`** **(** **)** const + * [int](class_int) **get_mode** **(** **)** const Get the file dialog mode from the MODE_* enum. diff --git a/class_fixedmaterial.md b/class_fixedmaterial.md index 5c5e4d2..b4bce61 100644 --- a/class_fixedmaterial.md +++ b/class_fixedmaterial.md @@ -6,20 +6,20 @@ Simple Material with a fixed parameter set. ### Member Functions - * void **[`set_parameter`](#set_parameter)** **(** [int](class_int) param, var value **)** - * void **[`get_parameter`](#get_parameter)** **(** [int](class_int) param **)** const - * void **[`set_texture`](#set_texture)** **(** [int](class_int) param, [Texture](class_texture) texture **)** - * [Texture](class_texture) **[`get_texture`](#get_texture)** **(** [int](class_int) param **)** const - * void **[`set_texcoord_mode`](#set_texcoord_mode)** **(** [int](class_int) param, [int](class_int) mode **)** - * [int](class_int) **[`get_texcoord_mode`](#get_texcoord_mode)** **(** [int](class_int) param **)** const - * void **[`set_fixed_flag`](#set_fixed_flag)** **(** [int](class_int) flag, [bool](class_bool) value **)** - * [bool](class_bool) **[`get_fixed_flag`](#get_fixed_flag)** **(** [int](class_int) flag **)** const - * void **[`set_uv_transform`](#set_uv_transform)** **(** [Transform](class_transform) transform **)** - * [Transform](class_transform) **[`get_uv_transform`](#get_uv_transform)** **(** **)** const - * void **[`set_point_size`](#set_point_size)** **(** [real](class_real) size **)** - * [real](class_real) **[`get_point_size`](#get_point_size)** **(** **)** const - * void **[`set_detail_blend_mode`](#set_detail_blend_mode)** **(** [int](class_int) mode **)** - * [int](class_int) **[`get_detail_blend_mode`](#get_detail_blend_mode)** **(** **)** const + * void **[set_parameter](#set_parameter)** **(** [int](class_int) param, var value **)** + * void **[get_parameter](#get_parameter)** **(** [int](class_int) param **)** const + * void **[set_texture](#set_texture)** **(** [int](class_int) param, [Texture](class_texture) texture **)** + * [Texture](class_texture) **[get_texture](#get_texture)** **(** [int](class_int) param **)** const + * void **[set_texcoord_mode](#set_texcoord_mode)** **(** [int](class_int) param, [int](class_int) mode **)** + * [int](class_int) **[get_texcoord_mode](#get_texcoord_mode)** **(** [int](class_int) param **)** const + * void **[set_fixed_flag](#set_fixed_flag)** **(** [int](class_int) flag, [bool](class_bool) value **)** + * [bool](class_bool) **[get_fixed_flag](#get_fixed_flag)** **(** [int](class_int) flag **)** const + * void **[set_uv_transform](#set_uv_transform)** **(** [Transform](class_transform) transform **)** + * [Transform](class_transform) **[get_uv_transform](#get_uv_transform)** **(** **)** const + * void **[set_point_size](#set_point_size)** **(** [real](class_real) size **)** + * [real](class_real) **[get_point_size](#get_point_size)** **(** **)** const + * void **[set_detail_blend_mode](#set_detail_blend_mode)** **(** [int](class_int) mode **)** + * [int](class_int) **[get_detail_blend_mode](#get_detail_blend_mode)** **(** **)** const ### Numeric Constants * **PARAM_DIFFUSE** = **0** - Diffuse Lighting (light scattered from surface). @@ -45,41 +45,41 @@ FixedMaterial is a simple type of material [Resource](class_resource), which con ### Member Function Description #### set_parameter - * void **`set_parameter`** **(** [int](class_int) param, var value **)** + * void **set_parameter** **(** [int](class_int) param, var value **)** Set a parameter, parameters are defined in the PARAM_* enum. The type of each parameter may change, so it"apos;s best to check the enum. #### get_parameter - * void **`get_parameter`** **(** [int](class_int) param **)** const + * void **get_parameter** **(** [int](class_int) param **)** const Return a parameter, parameters are defined in the PARAM_* enum. The type of each parameter may change, so it"apos;s best to check the enum. #### set_texture - * void **`set_texture`** **(** [int](class_int) param, [Texture](class_texture) texture **)** + * void **set_texture** **(** [int](class_int) param, [Texture](class_texture) texture **)** -Set a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see [`set_texcoord_mode`](#set_texcoord_mode)). +Set a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see [set_texcoord_mode](#set_texcoord_mode)). #### get_texture - * [Texture](class_texture) **`get_texture`** **(** [int](class_int) param **)** const + * [Texture](class_texture) **get_texture** **(** [int](class_int) param **)** const -Return a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see [`set_texcoord_mode`](#set_texcoord_mode)). +Return a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see [set_texcoord_mode](#set_texcoord_mode)). #### set_texcoord_mode - * void **`set_texcoord_mode`** **(** [int](class_int) param, [int](class_int) mode **)** + * void **set_texcoord_mode** **(** [int](class_int) param, [int](class_int) mode **)** Set the texture coordinate mode. Each texture param (from the PARAM_* enum) has one. It defines how the textures are mapped to the object. #### get_texcoord_mode - * [int](class_int) **`get_texcoord_mode`** **(** [int](class_int) param **)** const + * [int](class_int) **get_texcoord_mode** **(** [int](class_int) param **)** const Return the texture coordinate mode. Each texture param (from the PARAM_* enum) has one. It defines how the textures are mapped to the object. #### set_uv_transform - * void **`set_uv_transform`** **(** [Transform](class_transform) transform **)** + * void **set_uv_transform** **(** [Transform](class_transform) transform **)** Sets a special transform used to post-transform UV coordinates of the uv_xfrom tecoord mode: TEXCOORD_UV_TRANSFORM #### get_uv_transform - * [Transform](class_transform) **`get_uv_transform`** **(** **)** const + * [Transform](class_transform) **get_uv_transform** **(** **)** const Returns the special transform used to post-transform UV coordinates of the uv_xfrom tecoord mode: TEXCOORD_UV_TRANSFORM diff --git a/class_flurry.md b/class_flurry.md index 717735a..ac2005e 100644 --- a/class_flurry.md +++ b/class_flurry.md @@ -6,8 +6,8 @@ ### Member Functions - * void **[`log_event`](#log_event)** **(** [String](class_string) name, [Dictionary](class_dictionary) params **)** - * void **[`log_timed_event`](#log_timed_event)** **(** [String](class_string) name, [Dictionary](class_dictionary) params **)** - * void **[`end_timed_event`](#end_timed_event)** **(** [String](class_string) name **)** + * void **[log_event](#log_event)** **(** [String](class_string) name, [Dictionary](class_dictionary) params **)** + * void **[log_timed_event](#log_timed_event)** **(** [String](class_string) name, [Dictionary](class_dictionary) params **)** + * void **[end_timed_event](#end_timed_event)** **(** [String](class_string) name **)** ### Member Function Description diff --git a/class_followcamera.md b/class_followcamera.md index 2b6d663..cf00808 100644 --- a/class_followcamera.md +++ b/class_followcamera.md @@ -6,41 +6,41 @@ ### Member Functions - * void **[`set_orbit`](#set_orbit)** **(** [Vector2](class_vector2) orbit **)** - * [Vector2](class_vector2) **[`get_orbit`](#get_orbit)** **(** **)** const - * void **[`set_orbit_x`](#set_orbit_x)** **(** [real](class_real) x **)** - * void **[`set_orbit_y`](#set_orbit_y)** **(** [real](class_real) y **)** - * void **[`set_min_orbit_x`](#set_min_orbit_x)** **(** [real](class_real) x **)** - * [real](class_real) **[`get_min_orbit_x`](#get_min_orbit_x)** **(** **)** const - * void **[`set_max_orbit_x`](#set_max_orbit_x)** **(** [real](class_real) x **)** - * [real](class_real) **[`get_max_orbit_x`](#get_max_orbit_x)** **(** **)** const - * void **[`set_height`](#set_height)** **(** [real](class_real) height **)** - * [real](class_real) **[`get_height`](#get_height)** **(** **)** const - * void **[`set_inclination`](#set_inclination)** **(** [real](class_real) inclination **)** - * [real](class_real) **[`get_inclination`](#get_inclination)** **(** **)** const - * void **[`rotate_orbit`](#rotate_orbit)** **(** [Vector2](class_vector2) arg0 **)** - * void **[`set_distance`](#set_distance)** **(** [real](class_real) distance **)** - * [real](class_real) **[`get_distance`](#get_distance)** **(** **)** const - * void **[`set_max_distance`](#set_max_distance)** **(** [real](class_real) max_distance **)** - * [real](class_real) **[`get_max_distance`](#get_max_distance)** **(** **)** const - * void **[`set_min_distance`](#set_min_distance)** **(** [real](class_real) min_distance **)** - * [real](class_real) **[`get_min_distance`](#get_min_distance)** **(** **)** const - * void **[`set_clip`](#set_clip)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`has_clip`](#has_clip)** **(** **)** const - * void **[`set_autoturn`](#set_autoturn)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`has_autoturn`](#has_autoturn)** **(** **)** const - * void **[`set_autoturn_tolerance`](#set_autoturn_tolerance)** **(** [real](class_real) degrees **)** - * [real](class_real) **[`get_autoturn_tolerance`](#get_autoturn_tolerance)** **(** **)** const - * void **[`set_autoturn_speed`](#set_autoturn_speed)** **(** [real](class_real) speed **)** - * [real](class_real) **[`get_autoturn_speed`](#get_autoturn_speed)** **(** **)** const - * void **[`set_smoothing`](#set_smoothing)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`has_smoothing`](#has_smoothing)** **(** **)** const - * void **[`set_rotation_smoothing`](#set_rotation_smoothing)** **(** [real](class_real) amount **)** - * [real](class_real) **[`get_rotation_smoothing`](#get_rotation_smoothing)** **(** **)** const - * void **[`set_translation_smoothing`](#set_translation_smoothing)** **(** [real](class_real) amount **)** - * [real](class_real) **[`get_translation_smoothing`](#get_translation_smoothing)** **(** **)** const - * void **[`set_use_lookat_target`](#set_use_lookat_target)** **(** [bool](class_bool) use, [Vector3](class_vector3) lookat=Vector3(0, 0, 0) **)** - * void **[`set_up_vector`](#set_up_vector)** **(** [Vector3](class_vector3) vector **)** - * [Vector3](class_vector3) **[`get_up_vector`](#get_up_vector)** **(** **)** const + * void **[set_orbit](#set_orbit)** **(** [Vector2](class_vector2) orbit **)** + * [Vector2](class_vector2) **[get_orbit](#get_orbit)** **(** **)** const + * void **[set_orbit_x](#set_orbit_x)** **(** [real](class_real) x **)** + * void **[set_orbit_y](#set_orbit_y)** **(** [real](class_real) y **)** + * void **[set_min_orbit_x](#set_min_orbit_x)** **(** [real](class_real) x **)** + * [real](class_real) **[get_min_orbit_x](#get_min_orbit_x)** **(** **)** const + * void **[set_max_orbit_x](#set_max_orbit_x)** **(** [real](class_real) x **)** + * [real](class_real) **[get_max_orbit_x](#get_max_orbit_x)** **(** **)** const + * void **[set_height](#set_height)** **(** [real](class_real) height **)** + * [real](class_real) **[get_height](#get_height)** **(** **)** const + * void **[set_inclination](#set_inclination)** **(** [real](class_real) inclination **)** + * [real](class_real) **[get_inclination](#get_inclination)** **(** **)** const + * void **[rotate_orbit](#rotate_orbit)** **(** [Vector2](class_vector2) arg0 **)** + * void **[set_distance](#set_distance)** **(** [real](class_real) distance **)** + * [real](class_real) **[get_distance](#get_distance)** **(** **)** const + * void **[set_max_distance](#set_max_distance)** **(** [real](class_real) max_distance **)** + * [real](class_real) **[get_max_distance](#get_max_distance)** **(** **)** const + * void **[set_min_distance](#set_min_distance)** **(** [real](class_real) min_distance **)** + * [real](class_real) **[get_min_distance](#get_min_distance)** **(** **)** const + * void **[set_clip](#set_clip)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[has_clip](#has_clip)** **(** **)** const + * void **[set_autoturn](#set_autoturn)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[has_autoturn](#has_autoturn)** **(** **)** const + * void **[set_autoturn_tolerance](#set_autoturn_tolerance)** **(** [real](class_real) degrees **)** + * [real](class_real) **[get_autoturn_tolerance](#get_autoturn_tolerance)** **(** **)** const + * void **[set_autoturn_speed](#set_autoturn_speed)** **(** [real](class_real) speed **)** + * [real](class_real) **[get_autoturn_speed](#get_autoturn_speed)** **(** **)** const + * void **[set_smoothing](#set_smoothing)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[has_smoothing](#has_smoothing)** **(** **)** const + * void **[set_rotation_smoothing](#set_rotation_smoothing)** **(** [real](class_real) amount **)** + * [real](class_real) **[get_rotation_smoothing](#get_rotation_smoothing)** **(** **)** const + * void **[set_translation_smoothing](#set_translation_smoothing)** **(** [real](class_real) amount **)** + * [real](class_real) **[get_translation_smoothing](#get_translation_smoothing)** **(** **)** const + * void **[set_use_lookat_target](#set_use_lookat_target)** **(** [bool](class_bool) use, [Vector3](class_vector3) lookat=Vector3(0, 0, 0) **)** + * void **[set_up_vector](#set_up_vector)** **(** [Vector3](class_vector3) vector **)** + * [Vector3](class_vector3) **[get_up_vector](#get_up_vector)** **(** **)** const ### Member Function Description diff --git a/class_font.md b/class_font.md index 2898797..0ad7c37 100644 --- a/class_font.md +++ b/class_font.md @@ -6,20 +6,20 @@ Internationalized font and text drawing support. ### Member Functions - * void **[`set_height`](#set_height)** **(** [real](class_real) px **)** - * [real](class_real) **[`get_height`](#get_height)** **(** **)** const - * void **[`set_ascent`](#set_ascent)** **(** [real](class_real) px **)** - * [real](class_real) **[`get_ascent`](#get_ascent)** **(** **)** const - * [real](class_real) **[`get_descent`](#get_descent)** **(** **)** const - * void **[`add_kerning_pair`](#add_kerning_pair)** **(** [int](class_int) char_a, [int](class_int) char_b, [int](class_int) kerning **)** - * [int](class_int) **[`get_kerning_pair`](#get_kerning_pair)** **(** [int](class_int) arg0, [int](class_int) arg1 **)** const - * void **[`add_texture`](#add_texture)** **(** [Texture](class_texture) texture **)** - * void **[`add_char`](#add_char)** **(** [int](class_int) character, [int](class_int) texture, [Rect2](class_rect2) rect, [Vector2](class_vector2) align=Vector2(0,0), [real](class_real) advance=-1 **)** - * [Vector2](class_vector2) **[`get_char_size`](#get_char_size)** **(** [int](class_int) char, [int](class_int) next=0 **)** const - * [Vector2](class_vector2) **[`get_string_size`](#get_string_size)** **(** [String](class_string) string **)** const - * void **[`clear`](#clear)** **(** **)** - * void **[`draw`](#draw)** **(** [RID](class_rid) canvas_item, [Vector2](class_vector2) pos, [String](class_string) string, [Color](class_color) modulate=Color(1,1,1,1), [int](class_int) clip_w=-1 **)** const - * [real](class_real) **[`draw_char`](#draw_char)** **(** [RID](class_rid) canvas_item, [Vector2](class_vector2) pos, [int](class_int) char, [int](class_int) next=-1, [Color](class_color) modulate=Color(1,1,1,1) **)** const + * void **[set_height](#set_height)** **(** [real](class_real) px **)** + * [real](class_real) **[get_height](#get_height)** **(** **)** const + * void **[set_ascent](#set_ascent)** **(** [real](class_real) px **)** + * [real](class_real) **[get_ascent](#get_ascent)** **(** **)** const + * [real](class_real) **[get_descent](#get_descent)** **(** **)** const + * void **[add_kerning_pair](#add_kerning_pair)** **(** [int](class_int) char_a, [int](class_int) char_b, [int](class_int) kerning **)** + * [int](class_int) **[get_kerning_pair](#get_kerning_pair)** **(** [int](class_int) arg0, [int](class_int) arg1 **)** const + * void **[add_texture](#add_texture)** **(** [Texture](class_texture) texture **)** + * void **[add_char](#add_char)** **(** [int](class_int) character, [int](class_int) texture, [Rect2](class_rect2) rect, [Vector2](class_vector2) align=Vector2(0,0), [real](class_real) advance=-1 **)** + * [Vector2](class_vector2) **[get_char_size](#get_char_size)** **(** [int](class_int) char, [int](class_int) next=0 **)** const + * [Vector2](class_vector2) **[get_string_size](#get_string_size)** **(** [String](class_string) string **)** const + * void **[clear](#clear)** **(** **)** + * void **[draw](#draw)** **(** [RID](class_rid) canvas_item, [Vector2](class_vector2) pos, [String](class_string) string, [Color](class_color) modulate=Color(1,1,1,1), [int](class_int) clip_w=-1 **)** const + * [real](class_real) **[draw_char](#draw_char)** **(** [RID](class_rid) canvas_item, [Vector2](class_vector2) pos, [int](class_int) char, [int](class_int) next=-1, [Color](class_color) modulate=Color(1,1,1,1) **)** const ### 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. @@ -27,71 +27,71 @@ Font contains an unicode compatible character set, as well as the ability to dra ### Member Function Description #### set_height - * void **`set_height`** **(** [real](class_real) px **)** + * void **set_height** **(** [real](class_real) px **)** Set the total font height (ascent plus descent) in pixels. #### get_height - * [real](class_real) **`get_height`** **(** **)** const + * [real](class_real) **get_height** **(** **)** const Return the total font height (ascent plus descent) in pixels. #### set_ascent - * void **`set_ascent`** **(** [real](class_real) px **)** + * void **set_ascent** **(** [real](class_real) px **)** Set the font ascent (number of pixels above the baseline). #### get_ascent - * [real](class_real) **`get_ascent`** **(** **)** const + * [real](class_real) **get_ascent** **(** **)** const Return the font ascent (number of pixels above the baseline). #### get_descent - * [real](class_real) **`get_descent`** **(** **)** const + * [real](class_real) **get_descent** **(** **)** const Return the font descent (number of pixels below the baseline). #### add_kerning_pair - * void **`add_kerning_pair`** **(** [int](class_int) char_a, [int](class_int) char_b, [int](class_int) kerning **)** + * void **add_kerning_pair** **(** [int](class_int) char_a, [int](class_int) char_b, [int](class_int) kerning **)** Add a kerning pair to the [Font](class_font) as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character. #### get_kerning_pair - * [int](class_int) **`get_kerning_pair`** **(** [int](class_int) arg0, [int](class_int) arg1 **)** const + * [int](class_int) **get_kerning_pair** **(** [int](class_int) arg0, [int](class_int) arg1 **)** const Return a kerning pair as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character. #### add_texture - * void **`add_texture`** **(** [Texture](class_texture) texture **)** + * void **add_texture** **(** [Texture](class_texture) texture **)** Add a texture to the [Font](class_font). #### add_char - * void **`add_char`** **(** [int](class_int) character, [int](class_int) texture, [Rect2](class_rect2) rect, [Vector2](class_vector2) align=Vector2(0,0), [real](class_real) advance=-1 **)** + * void **add_char** **(** [int](class_int) character, [int](class_int) texture, [Rect2](class_rect2) rect, [Vector2](class_vector2) align=Vector2(0,0), [real](class_real) advance=-1 **)** 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. #### get_char_size - * [Vector2](class_vector2) **`get_char_size`** **(** [int](class_int) char, [int](class_int) next=0 **)** const + * [Vector2](class_vector2) **get_char_size** **(** [int](class_int) char, [int](class_int) next=0 **)** const Return the size of a character, optionally taking kerning into account if the next character is provided. #### get_string_size - * [Vector2](class_vector2) **`get_string_size`** **(** [String](class_string) string **)** const + * [Vector2](class_vector2) **get_string_size** **(** [String](class_string) string **)** const Return the size of a string, taking kerning and advance into account. #### clear - * void **`clear`** **(** **)** + * void **clear** **(** **)** Clear all the font data. #### draw - * void **`draw`** **(** [RID](class_rid) canvas_item, [Vector2](class_vector2) pos, [String](class_string) string, [Color](class_color) modulate=Color(1,1,1,1), [int](class_int) clip_w=-1 **)** const + * void **draw** **(** [RID](class_rid) canvas_item, [Vector2](class_vector2) pos, [String](class_string) string, [Color](class_color) modulate=Color(1,1,1,1), [int](class_int) clip_w=-1 **)** 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 te baseline, not the top. To draw from the top, _ascent_ must be added to the Y axis. #### draw_char - * [real](class_real) **`draw_char`** **(** [RID](class_rid) canvas_item, [Vector2](class_vector2) pos, [int](class_int) char, [int](class_int) next=-1, [Color](class_color) modulate=Color(1,1,1,1) **)** const + * [real](class_real) **draw_char** **(** [RID](class_rid) canvas_item, [Vector2](class_vector2) pos, [int](class_int) char, [int](class_int) next=-1, [Color](class_color) modulate=Color(1,1,1,1) **)** 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 apassed. clipping the width. "pos" specifies te 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/class_gdnativeclass.md b/class_gdnativeclass.md index 1c8549d..1507666 100644 --- a/class_gdnativeclass.md +++ b/class_gdnativeclass.md @@ -6,6 +6,6 @@ ### Member Functions - * void **[`new`](#new)** **(** **)** + * void **[new](#new)** **(** **)** ### Member Function Description diff --git a/class_gdscript.md b/class_gdscript.md index f82cc2b..d63e7a4 100644 --- a/class_gdscript.md +++ b/class_gdscript.md @@ -6,6 +6,6 @@ ### Member Functions - * void **[`new`](#new)** **(** **)** + * void **[new](#new)** **(** **)** ### Member Function Description diff --git a/class_geometry.md b/class_geometry.md index b4f9dba..bb407fa 100644 --- a/class_geometry.md +++ b/class_geometry.md @@ -6,19 +6,19 @@ ### Member Functions - * [Array](class_array) **[`build_box_planes`](#build_box_planes)** **(** [Vector3](class_vector3) extents **)** - * [Array](class_array) **[`build_cylinder_planes`](#build_cylinder_planes)** **(** [real](class_real) radius, [real](class_real) height, [int](class_int) sides, [int](class_int) axis=2 **)** - * [Array](class_array) **[`build_capsule_planes`](#build_capsule_planes)** **(** [real](class_real) radius, [real](class_real) height, [int](class_int) sides, [int](class_int) lats, [int](class_int) axis=2 **)** - * [real](class_real) **[`segment_intersects_circle`](#segment_intersects_circle)** **(** [Vector2](class_vector2) segment_from, [Vector2](class_vector2) segment_to, [Vector2](class_vector2) circle_pos, [real](class_real) circle_radius **)** - * void **[`segment_intersects_segment_2d`](#segment_intersects_segment_2d)** **(** [Vector2](class_vector2) from_a, [Vector2](class_vector2) to_a, [Vector2](class_vector2) from_b, [Vector2](class_vector2) to_b **)** - * [Vector2Array](class_vector2array) **[`get_closest_points_between_segments_2d`](#get_closest_points_between_segments_2d)** **(** [Vector2](class_vector2) p1, [Vector2](class_vector2) q1, [Vector2](class_vector2) p2, [Vector2](class_vector2) q2 **)** - * [Vector3Array](class_vector3array) **[`get_closest_points_between_segments`](#get_closest_points_between_segments)** **(** [Vector3](class_vector3) p1, [Vector3](class_vector3) p2, [Vector3](class_vector3) q1, [Vector3](class_vector3) q2 **)** - * [Vector3](class_vector3) **[`get_closest_point_to_segment`](#get_closest_point_to_segment)** **(** [Vector3](class_vector3) point, [Vector3](class_vector3) s1, [Vector3](class_vector3) s2 **)** - * void **[`ray_intersects_triangle`](#ray_intersects_triangle)** **(** [Vector3](class_vector3) from, [Vector3](class_vector3) dir, [Vector3](class_vector3) a, [Vector3](class_vector3) b, [Vector3](class_vector3) c **)** - * void **[`segment_intersects_triangle`](#segment_intersects_triangle)** **(** [Vector3](class_vector3) from, [Vector3](class_vector3) to, [Vector3](class_vector3) a, [Vector3](class_vector3) b, [Vector3](class_vector3) c **)** - * [Vector3Array](class_vector3array) **[`segment_intersects_sphere`](#segment_intersects_sphere)** **(** [Vector3](class_vector3) from, [Vector3](class_vector3) to, [Vector3](class_vector3) spos, [real](class_real) sradius **)** - * [Vector3Array](class_vector3array) **[`segment_intersects_cylinder`](#segment_intersects_cylinder)** **(** [Vector3](class_vector3) from, [Vector3](class_vector3) to, [real](class_real) height, [real](class_real) radius **)** - * [Vector3Array](class_vector3array) **[`segment_intersects_convex`](#segment_intersects_convex)** **(** [Vector3](class_vector3) from, [Vector3](class_vector3) to, [Array](class_array) planes **)** - * [IntArray](class_intarray) **[`triangulate_polygon`](#triangulate_polygon)** **(** [Vector2Array](class_vector2array) polygon **)** + * [Array](class_array) **[build_box_planes](#build_box_planes)** **(** [Vector3](class_vector3) extents **)** + * [Array](class_array) **[build_cylinder_planes](#build_cylinder_planes)** **(** [real](class_real) radius, [real](class_real) height, [int](class_int) sides, [int](class_int) axis=2 **)** + * [Array](class_array) **[build_capsule_planes](#build_capsule_planes)** **(** [real](class_real) radius, [real](class_real) height, [int](class_int) sides, [int](class_int) lats, [int](class_int) axis=2 **)** + * [real](class_real) **[segment_intersects_circle](#segment_intersects_circle)** **(** [Vector2](class_vector2) segment_from, [Vector2](class_vector2) segment_to, [Vector2](class_vector2) circle_pos, [real](class_real) circle_radius **)** + * void **[segment_intersects_segmentθd](#segment_intersects_segment_2d)** **(** [Vector2](class_vector2) from_a, [Vector2](class_vector2) to_a, [Vector2](class_vector2) from_b, [Vector2](class_vector2) to_b **)** + * [Vector2Array](class_vector2array) **[get_closest_points_between_segmentsθd](#get_closest_points_between_segments_2d)** **(** [Vector2](class_vector2) p1, [Vector2](class_vector2) q1, [Vector2](class_vector2) p2, [Vector2](class_vector2) q2 **)** + * [Vector3Array](class_vector3array) **[get_closest_points_between_segments](#get_closest_points_between_segments)** **(** [Vector3](class_vector3) p1, [Vector3](class_vector3) p2, [Vector3](class_vector3) q1, [Vector3](class_vector3) q2 **)** + * [Vector3](class_vector3) **[get_closest_point_to_segment](#get_closest_point_to_segment)** **(** [Vector3](class_vector3) point, [Vector3](class_vector3) s1, [Vector3](class_vector3) s2 **)** + * void **[ray_intersects_triangle](#ray_intersects_triangle)** **(** [Vector3](class_vector3) from, [Vector3](class_vector3) dir, [Vector3](class_vector3) a, [Vector3](class_vector3) b, [Vector3](class_vector3) c **)** + * void **[segment_intersects_triangle](#segment_intersects_triangle)** **(** [Vector3](class_vector3) from, [Vector3](class_vector3) to, [Vector3](class_vector3) a, [Vector3](class_vector3) b, [Vector3](class_vector3) c **)** + * [Vector3Array](class_vector3array) **[segment_intersects_sphere](#segment_intersects_sphere)** **(** [Vector3](class_vector3) from, [Vector3](class_vector3) to, [Vector3](class_vector3) spos, [real](class_real) sradius **)** + * [Vector3Array](class_vector3array) **[segment_intersects_cylinder](#segment_intersects_cylinder)** **(** [Vector3](class_vector3) from, [Vector3](class_vector3) to, [real](class_real) height, [real](class_real) radius **)** + * [Vector3Array](class_vector3array) **[segment_intersects_convex](#segment_intersects_convex)** **(** [Vector3](class_vector3) from, [Vector3](class_vector3) to, [Array](class_array) planes **)** + * [IntArray](class_intarray) **[triangulate_polygon](#triangulate_polygon)** **(** [Vector2Array](class_vector2array) polygon **)** ### Member Function Description diff --git a/class_geometryinstance.md b/class_geometryinstance.md index 4834145..e030a86 100644 --- a/class_geometryinstance.md +++ b/class_geometryinstance.md @@ -6,17 +6,17 @@ Base node for geometry based visual instances. ### Member Functions - * void **[`set_material_override`](#set_material_override)** **(** [Object](class_object) material **)** - * [Object](class_object) **[`get_material_override`](#get_material_override)** **(** **)** const - * void **[`set_flag`](#set_flag)** **(** [int](class_int) flag, [bool](class_bool) value **)** - * [bool](class_bool) **[`get_flag`](#get_flag)** **(** [int](class_int) flag **)** const - * void **[`set_draw_range_begin`](#set_draw_range_begin)** **(** [real](class_real) mode **)** - * [real](class_real) **[`get_draw_range_begin`](#get_draw_range_begin)** **(** **)** const - * void **[`set_draw_range_end`](#set_draw_range_end)** **(** [real](class_real) mode **)** - * [real](class_real) **[`get_draw_range_end`](#get_draw_range_end)** **(** **)** const + * void **[set_material_override](#set_material_override)** **(** [Object](class_object) material **)** + * [Object](class_object) **[get_material_override](#get_material_override)** **(** **)** const + * void **[set_flag](#set_flag)** **(** [int](class_int) flag, [bool](class_bool) value **)** + * [bool](class_bool) **[get_flag](#get_flag)** **(** [int](class_int) flag **)** const + * void **[set_draw_range_begin](#set_draw_range_begin)** **(** [real](class_real) mode **)** + * [real](class_real) **[get_draw_range_begin](#get_draw_range_begin)** **(** **)** const + * void **[set_draw_range_end](#set_draw_range_end)** **(** [real](class_real) mode **)** + * [real](class_real) **[get_draw_range_end](#get_draw_range_end)** **(** **)** const ### Signals - * **`visibility_changed`** **(** **)** + * **visibility_changed** **(** **)** ### Numeric Constants * **FLAG_VISIBLE** = **0** @@ -34,11 +34,11 @@ Base node for geometry based visual instances. Shares some common functionality ### Member Function Description #### set_material_override - * void **`set_material_override`** **(** [Object](class_object) material **)** + * void **set_material_override** **(** [Object](class_object) material **)** Set the material override for the whole geometry. #### get_material_override - * [Object](class_object) **`get_material_override`** **(** **)** const + * [Object](class_object) **get_material_override** **(** **)** const Return the material override for the whole geometry. diff --git a/class_globals.md b/class_globals.md index e7bc928..a3c83dc 100644 --- a/class_globals.md +++ b/class_globals.md @@ -6,17 +6,17 @@ Contains global variables accessible from everywhere. ### Member Functions - * [bool](class_bool) **[`has`](#has)** **(** [String](class_string) name **)** const - * void **[`set_order`](#set_order)** **(** [String](class_string) name, [int](class_int) pos **)** - * [int](class_int) **[`get_order`](#get_order)** **(** [String](class_string) name **)** const - * void **[`set_persisting`](#set_persisting)** **(** [String](class_string) name, [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_persisting`](#is_persisting)** **(** [String](class_string) name **)** const - * void **[`clear`](#clear)** **(** [String](class_string) name **)** - * [String](class_string) **[`localize_path`](#localize_path)** **(** [String](class_string) path **)** const - * [String](class_string) **[`globalize_path`](#globalize_path)** **(** [String](class_string) path **)** const - * [int](class_int) **[`save`](#save)** **(** **)** - * [bool](class_bool) **[`has_singleton`](#has_singleton)** **(** [String](class_string) arg0 **)** const - * [Object](class_object) **[`get_singleton`](#get_singleton)** **(** [String](class_string) arg0 **)** const + * [bool](class_bool) **[has](#has)** **(** [String](class_string) name **)** const + * void **[set_order](#set_order)** **(** [String](class_string) name, [int](class_int) pos **)** + * [int](class_int) **[get_order](#get_order)** **(** [String](class_string) name **)** const + * void **[set_persisting](#set_persisting)** **(** [String](class_string) name, [bool](class_bool) enable **)** + * [bool](class_bool) **[is_persisting](#is_persisting)** **(** [String](class_string) name **)** const + * void **[clear](#clear)** **(** [String](class_string) name **)** + * [String](class_string) **[localize_path](#localize_path)** **(** [String](class_string) path **)** const + * [String](class_string) **[globalize_path](#globalize_path)** **(** [String](class_string) path **)** const + * [int](class_int) **[save](#save)** **(** **)** + * [bool](class_bool) **[has_singleton](#has_singleton)** **(** [String](class_string) arg0 **)** const + * [Object](class_object) **[get_singleton](#get_singleton)** **(** [String](class_string) arg0 **)** const ### Description Contains global variables accessible from everywhere. Use the normal [Object](class_object) API, such as "Globals.get(variable)", "Globals.set(variable,value)" or "Globals.has(variable)" to access them. Variables stored in engine.cfg are also loaded into globals, making this object very useful for reading custom game configuration options. @@ -24,41 +24,41 @@ Contains global variables accessible from everywhere. Use the normal [Object](cl ### Member Function Description #### has - * [bool](class_bool) **`has`** **(** [String](class_string) name **)** const + * [bool](class_bool) **has** **(** [String](class_string) name **)** const Return true if a configuration value is present. #### set_order - * void **`set_order`** **(** [String](class_string) name, [int](class_int) pos **)** + * void **set_order** **(** [String](class_string) name, [int](class_int) pos **)** Set the order of a configuration value (influences when saved to the config file). #### get_order - * [int](class_int) **`get_order`** **(** [String](class_string) name **)** const + * [int](class_int) **get_order** **(** [String](class_string) name **)** const Return the order of a configuration value (influences when saved to the config file). #### set_persisting - * void **`set_persisting`** **(** [String](class_string) name, [bool](class_bool) enable **)** + * void **set_persisting** **(** [String](class_string) name, [bool](class_bool) enable **)** If set to true, this value can be saved to the configuration file. This is useful for editors. #### is_persisting - * [bool](class_bool) **`is_persisting`** **(** [String](class_string) name **)** const + * [bool](class_bool) **is_persisting** **(** [String](class_string) name **)** const If returns true, this value can be saved to the configuration file. This is useful for editors. #### clear - * void **`clear`** **(** [String](class_string) name **)** + * void **clear** **(** [String](class_string) name **)** Clear the whole configuration (not recommended, may break things). #### localize_path - * [String](class_string) **`localize_path`** **(** [String](class_string) path **)** const + * [String](class_string) **localize_path** **(** [String](class_string) path **)** const Convert a path to a localized path (res:// path). #### globalize_path - * [String](class_string) **`globalize_path`** **(** [String](class_string) path **)** const + * [String](class_string) **globalize_path** **(** [String](class_string) path **)** const Convert a localized path (res://) to a full native OS path. diff --git a/class_gridcontainer.md b/class_gridcontainer.md index 85d38a5..954978e 100644 --- a/class_gridcontainer.md +++ b/class_gridcontainer.md @@ -6,7 +6,7 @@ ### Member Functions - * void **[`set_columns`](#set_columns)** **(** [int](class_int) columns **)** - * [int](class_int) **[`get_columns`](#get_columns)** **(** **)** const + * void **[set_columns](#set_columns)** **(** [int](class_int) columns **)** + * [int](class_int) **[get_columns](#get_columns)** **(** **)** const ### Member Function Description diff --git a/class_gridmap.md b/class_gridmap.md index ce854cb..2e29361 100644 --- a/class_gridmap.md +++ b/class_gridmap.md @@ -6,39 +6,39 @@ ### Member Functions - * void **[`set_theme`](#set_theme)** **(** [MeshLibrary](class_meshlibrary) theme **)** - * [MeshLibrary](class_meshlibrary) **[`get_theme`](#get_theme)** **(** **)** const - * void **[`set_bake`](#set_bake)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_baking_enabled`](#is_baking_enabled)** **(** **)** const - * void **[`set_cell_size`](#set_cell_size)** **(** [real](class_real) size **)** - * [real](class_real) **[`get_cell_size`](#get_cell_size)** **(** **)** const - * void **[`set_octant_size`](#set_octant_size)** **(** [int](class_int) size **)** - * [int](class_int) **[`get_octant_size`](#get_octant_size)** **(** **)** const - * void **[`set_cell_item`](#set_cell_item)** **(** [int](class_int) x, [int](class_int) y, [int](class_int) z, [int](class_int) item, [int](class_int) orientation=0 **)** - * [int](class_int) **[`get_cell_item`](#get_cell_item)** **(** [int](class_int) x, [int](class_int) y, [int](class_int) z **)** const - * [int](class_int) **[`get_cell_item_orientation`](#get_cell_item_orientation)** **(** [int](class_int) x, [int](class_int) y, [int](class_int) z **)** const - * void **[`resource_changed`](#resource_changed)** **(** [Object](class_object) arg0 **)** - * void **[`set_center_x`](#set_center_x)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`get_center_x`](#get_center_x)** **(** **)** const - * void **[`set_center_y`](#set_center_y)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`get_center_y`](#get_center_y)** **(** **)** const - * void **[`set_center_z`](#set_center_z)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`get_center_z`](#get_center_z)** **(** **)** const - * void **[`set_clip`](#set_clip)** **(** [bool](class_bool) enabled, [bool](class_bool) clipabove=true, [int](class_int) floor=0, [int](class_int) axis=0 **)** - * [int](class_int) **[`crate_area`](#crate_area)** **(** [int](class_int) id, [AABB](class_aabb) area **)** - * [AABB](class_aabb) **[`area_get_bounds`](#area_get_bounds)** **(** [int](class_int) area **)** const - * void **[`area_set_exterior_portal`](#area_set_exterior_portal)** **(** [int](class_int) area, [bool](class_bool) enable **)** - * void **[`area_set_name`](#area_set_name)** **(** [int](class_int) area, [String](class_string) name **)** - * [String](class_string) **[`area_get_name`](#area_get_name)** **(** [int](class_int) area **)** const - * [bool](class_bool) **[`area_is_exterior_portal`](#area_is_exterior_portal)** **(** [int](class_int) area **)** const - * void **[`area_set_portal_disable_distance`](#area_set_portal_disable_distance)** **(** [int](class_int) area, [real](class_real) distance **)** - * [real](class_real) **[`area_get_portal_disable_distance`](#area_get_portal_disable_distance)** **(** [int](class_int) area **)** const - * void **[`area_set_portal_disable_color`](#area_set_portal_disable_color)** **(** [int](class_int) area, [Color](class_color) color **)** - * [Color](class_color) **[`area_get_portal_disable_color`](#area_get_portal_disable_color)** **(** [int](class_int) area **)** const - * void **[`erase_area`](#erase_area)** **(** [int](class_int) area **)** - * [int](class_int) **[`get_unused_area_id`](#get_unused_area_id)** **(** **)** const - * void **[`bake_geometry`](#bake_geometry)** **(** **)** - * void **[`clear`](#clear)** **(** **)** + * void **[set_theme](#set_theme)** **(** [MeshLibrary](class_meshlibrary) theme **)** + * [MeshLibrary](class_meshlibrary) **[get_theme](#get_theme)** **(** **)** const + * void **[set_bake](#set_bake)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_baking_enabled](#is_baking_enabled)** **(** **)** const + * void **[set_cell_size](#set_cell_size)** **(** [real](class_real) size **)** + * [real](class_real) **[get_cell_size](#get_cell_size)** **(** **)** const + * void **[set_octant_size](#set_octant_size)** **(** [int](class_int) size **)** + * [int](class_int) **[get_octant_size](#get_octant_size)** **(** **)** const + * void **[set_cell_item](#set_cell_item)** **(** [int](class_int) x, [int](class_int) y, [int](class_int) z, [int](class_int) item, [int](class_int) orientation=0 **)** + * [int](class_int) **[get_cell_item](#get_cell_item)** **(** [int](class_int) x, [int](class_int) y, [int](class_int) z **)** const + * [int](class_int) **[get_cell_item_orientation](#get_cell_item_orientation)** **(** [int](class_int) x, [int](class_int) y, [int](class_int) z **)** const + * void **[resource_changed](#resource_changed)** **(** [Object](class_object) arg0 **)** + * void **[set_center_x](#set_center_x)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[get_center_x](#get_center_x)** **(** **)** const + * void **[set_center_y](#set_center_y)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[get_center_y](#get_center_y)** **(** **)** const + * void **[set_center_z](#set_center_z)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[get_center_z](#get_center_z)** **(** **)** const + * void **[set_clip](#set_clip)** **(** [bool](class_bool) enabled, [bool](class_bool) clipabove=true, [int](class_int) floor=0, [int](class_int) axis=0 **)** + * [int](class_int) **[crate_area](#crate_area)** **(** [int](class_int) id, [AABB](class_aabb) area **)** + * [AABB](class_aabb) **[area_get_bounds](#area_get_bounds)** **(** [int](class_int) area **)** const + * void **[area_set_exterior_portal](#area_set_exterior_portal)** **(** [int](class_int) area, [bool](class_bool) enable **)** + * void **[area_set_name](#area_set_name)** **(** [int](class_int) area, [String](class_string) name **)** + * [String](class_string) **[area_get_name](#area_get_name)** **(** [int](class_int) area **)** const + * [bool](class_bool) **[area_is_exterior_portal](#area_is_exterior_portal)** **(** [int](class_int) area **)** const + * void **[area_set_portal_disable_distance](#area_set_portal_disable_distance)** **(** [int](class_int) area, [real](class_real) distance **)** + * [real](class_real) **[area_get_portal_disable_distance](#area_get_portal_disable_distance)** **(** [int](class_int) area **)** const + * void **[area_set_portal_disable_color](#area_set_portal_disable_color)** **(** [int](class_int) area, [Color](class_color) color **)** + * [Color](class_color) **[area_get_portal_disable_color](#area_get_portal_disable_color)** **(** [int](class_int) area **)** const + * void **[erase_area](#erase_area)** **(** [int](class_int) area **)** + * [int](class_int) **[get_unused_area_id](#get_unused_area_id)** **(** **)** const + * void **[bake_geometry](#bake_geometry)** **(** **)** + * void **[clear](#clear)** **(** **)** ### Numeric Constants * **INVALID_CELL_ITEM** = **-1** diff --git a/class_groovejoint2d.md b/class_groovejoint2d.md index 9c9360d..8cfb27e 100644 --- a/class_groovejoint2d.md +++ b/class_groovejoint2d.md @@ -6,10 +6,10 @@ Groove constraint for 2D physics. ### Member Functions - * void **[`set_length`](#set_length)** **(** [real](class_real) length **)** - * [real](class_real) **[`get_length`](#get_length)** **(** **)** const - * void **[`set_initial_offset`](#set_initial_offset)** **(** [real](class_real) offset **)** - * [real](class_real) **[`get_initial_offset`](#get_initial_offset)** **(** **)** const + * void **[set_length](#set_length)** **(** [real](class_real) length **)** + * [real](class_real) **[get_length](#get_length)** **(** **)** const + * void **[set_initial_offset](#set_initial_offset)** **(** [real](class_real) offset **)** + * [real](class_real) **[get_initial_offset](#get_initial_offset)** **(** **)** const ### Description Groove constraint for 2D physics. This is useful for making a body "slide" through a segment placed in another. @@ -17,21 +17,21 @@ Groove constraint for 2D physics. This is useful for making a body "slide" throu ### Member Function Description #### set_length - * void **`set_length`** **(** [real](class_real) length **)** + * void **set_length** **(** [real](class_real) length **)** Set the length of the groove. #### get_length - * [real](class_real) **`get_length`** **(** **)** const + * [real](class_real) **get_length** **(** **)** const Return the length of the groove. #### set_initial_offset - * void **`set_initial_offset`** **(** [real](class_real) offset **)** + * void **set_initial_offset** **(** [real](class_real) offset **)** Set the initial offset of the groove on body A. #### get_initial_offset - * [real](class_real) **`get_initial_offset`** **(** **)** const + * [real](class_real) **get_initial_offset** **(** **)** const Set the final offset of the groove on body A. diff --git a/class_httpclient.md b/class_httpclient.md index b794c57..49904de 100644 --- a/class_httpclient.md +++ b/class_httpclient.md @@ -6,21 +6,21 @@ ### Member Functions - * [int](class_int) **[`connect`](#connect)** **(** [String](class_string) host, [int](class_int) port **)** - * void **[`set_connection`](#set_connection)** **(** [StreamPeer](class_streampeer) connection **)** - * [int](class_int) **[`request`](#request)** **(** [int](class_int) method, [String](class_string) url, [StringArray](class_stringarray) headers, [String](class_string) body="" **)** - * [int](class_int) **[`send_body_text`](#send_body_text)** **(** [String](class_string) body **)** - * [int](class_int) **[`send_body_data`](#send_body_data)** **(** [RawArray](class_rawarray) body **)** - * void **[`close`](#close)** **(** **)** - * [bool](class_bool) **[`has_response`](#has_response)** **(** **)** const - * [bool](class_bool) **[`is_response_chunked`](#is_response_chunked)** **(** **)** const - * [int](class_int) **[`get_response_code`](#get_response_code)** **(** **)** const - * [StringArray](class_stringarray) **[`get_response_headers`](#get_response_headers)** **(** **)** - * [Dictionary](class_dictionary) **[`get_response_headers_as_dictionary`](#get_response_headers_as_dictionary)** **(** **)** - * [int](class_int) **[`get_response_body_length`](#get_response_body_length)** **(** **)** const - * [RawArray](class_rawarray) **[`read_response_body_chunk`](#read_response_body_chunk)** **(** **)** - * [int](class_int) **[`get_status`](#get_status)** **(** **)** const - * [int](class_int) **[`poll`](#poll)** **(** **)** + * [int](class_int) **[connect](#connect)** **(** [String](class_string) host, [int](class_int) port **)** + * void **[set_connection](#set_connection)** **(** [StreamPeer](class_streampeer) connection **)** + * [int](class_int) **[request](#request)** **(** [int](class_int) method, [String](class_string) url, [StringArray](class_stringarray) headers, [String](class_string) body="" **)** + * [int](class_int) **[send_body_text](#send_body_text)** **(** [String](class_string) body **)** + * [int](class_int) **[send_body_data](#send_body_data)** **(** [RawArray](class_rawarray) body **)** + * void **[close](#close)** **(** **)** + * [bool](class_bool) **[has_response](#has_response)** **(** **)** const + * [bool](class_bool) **[is_response_chunked](#is_response_chunked)** **(** **)** const + * [int](class_int) **[get_response_code](#get_response_code)** **(** **)** const + * [StringArray](class_stringarray) **[get_response_headers](#get_response_headers)** **(** **)** + * [Dictionary](class_dictionary) **[get_response_headers_as_dictionary](#get_response_headers_as_dictionary)** **(** **)** + * [int](class_int) **[get_response_body_length](#get_response_body_length)** **(** **)** const + * [RawArray](class_rawarray) **[read_response_body_chunk](#read_response_body_chunk)** **(** **)** + * [int](class_int) **[get_status](#get_status)** **(** **)** const + * [int](class_int) **[poll](#poll)** **(** **)** ### Numeric Constants * **METHOD_GET** = **0** diff --git a/class_image.md b/class_image.md index 3dde32f..49d1b84 100644 --- a/class_image.md +++ b/class_image.md @@ -5,20 +5,20 @@ Image datatype. ### Member Functions - * void **[`blit_rect`](#blit_rect)** **(** [Image](class_image) src, [Rect2](class_rect2) src_rect, [Vector2](class_vector2) dest=0 **)** - * void **[`brush_transfer`](#brush_transfer)** **(** [Image](class_image) src, [Image](class_image) brush, [Vector2](class_vector2) pos=0 **)** - * [Image](class_image) **[`brushed`](#brushed)** **(** [Image](class_image) src, [Image](class_image) brush, [Vector2](class_vector2) pos=0 **)** - * [Image](class_image) **[`compressed`](#compressed)** **(** [int](class_int) format=0 **)** - * [bool](class_bool) **[`empty`](#empty)** **(** **)** - * [RawArray](class_rawarray) **[`get_data`](#get_data)** **(** **)** - * [int](class_int) **[`get_format`](#get_format)** **(** **)** - * [int](class_int) **[`get_height`](#get_height)** **(** **)** - * [Color](class_color) **[`get_pixel`](#get_pixel)** **(** [int](class_int) x, [int](class_int) y, [int](class_int) mipmap_level=0 **)** - * [Image](class_image) **[`get_rect`](#get_rect)** **(** [Rect2](class_rect2) area=0 **)** - * [Rect2](class_rect2) **[`get_used_rect`](#get_used_rect)** **(** **)** - * [int](class_int) **[`get_width`](#get_width)** **(** **)** - * [int](class_int) **[`load`](#load)** **(** [String](class_string) path=0 **)** - * [Image](class_image) **[`resized`](#resized)** **(** [int](class_int) x, [int](class_int) y, [int](class_int) interpolation=1 **)** + * void **[blit_rect](#blit_rect)** **(** [Image](class_image) src, [Rect2](class_rect2) src_rect, [Vector2](class_vector2) dest=0 **)** + * void **[brush_transfer](#brush_transfer)** **(** [Image](class_image) src, [Image](class_image) brush, [Vector2](class_vector2) pos=0 **)** + * [Image](class_image) **[brushed](#brushed)** **(** [Image](class_image) src, [Image](class_image) brush, [Vector2](class_vector2) pos=0 **)** + * [Image](class_image) **[compressed](#compressed)** **(** [int](class_int) format=0 **)** + * [bool](class_bool) **[empty](#empty)** **(** **)** + * [RawArray](class_rawarray) **[get_data](#get_data)** **(** **)** + * [int](class_int) **[get_format](#get_format)** **(** **)** + * [int](class_int) **[get_height](#get_height)** **(** **)** + * [Color](class_color) **[get_pixel](#get_pixel)** **(** [int](class_int) x, [int](class_int) y, [int](class_int) mipmap_level=0 **)** + * [Image](class_image) **[get_rect](#get_rect)** **(** [Rect2](class_rect2) area=0 **)** + * [Rect2](class_rect2) **[get_used_rect](#get_used_rect)** **(** **)** + * [int](class_int) **[get_width](#get_width)** **(** **)** + * [int](class_int) **[load](#load)** **(** [String](class_string) path=0 **)** + * [Image](class_image) **[resized](#resized)** **(** [int](class_int) x, [int](class_int) y, [int](class_int) interpolation=1 **)** ### Numeric Constants * **COMPRESS_BC** = **0** diff --git a/class_imagepathfinder.md b/class_imagepathfinder.md index 42dab1b..2af18cf 100644 --- a/class_imagepathfinder.md +++ b/class_imagepathfinder.md @@ -6,9 +6,9 @@ ### Member Functions - * [Vector2Array](class_vector2array) **[`find_path`](#find_path)** **(** [Vector2](class_vector2) from, [Vector2](class_vector2) to, [bool](class_bool) optimize=false **)** - * [Vector2](class_vector2) **[`get_size`](#get_size)** **(** **)** const - * [bool](class_bool) **[`is_solid`](#is_solid)** **(** [Vector2](class_vector2) pos **)** - * void **[`create_from_image_alpha`](#create_from_image_alpha)** **(** [Image](class_image) arg0 **)** + * [Vector2Array](class_vector2array) **[find_path](#find_path)** **(** [Vector2](class_vector2) from, [Vector2](class_vector2) to, [bool](class_bool) optimize=false **)** + * [Vector2](class_vector2) **[get_size](#get_size)** **(** **)** const + * [bool](class_bool) **[is_solid](#is_solid)** **(** [Vector2](class_vector2) pos **)** + * void **[create_from_image_alpha](#create_from_image_alpha)** **(** [Image](class_image) arg0 **)** ### Member Function Description diff --git a/class_imagetexture.md b/class_imagetexture.md index faf8c23..4f6d1fa 100644 --- a/class_imagetexture.md +++ b/class_imagetexture.md @@ -6,18 +6,18 @@ ### Member Functions - * void **[`create`](#create)** **(** [int](class_int) width, [int](class_int) height, [int](class_int) format, [int](class_int) flags=7 **)** - * void **[`create_from_image`](#create_from_image)** **(** [Image](class_image) image, [int](class_int) flags=7 **)** - * [int](class_int) **[`get_format`](#get_format)** **(** **)** const - * void **[`load`](#load)** **(** [String](class_string) path **)** - * void **[`set_data`](#set_data)** **(** [Image](class_image) image **)** - * [Image](class_image) **[`get_data`](#get_data)** **(** **)** const - * void **[`set_storage`](#set_storage)** **(** [int](class_int) mode **)** - * [int](class_int) **[`get_storage`](#get_storage)** **(** **)** const - * void **[`set_lossy_storage_quality`](#set_lossy_storage_quality)** **(** [real](class_real) quality **)** - * [real](class_real) **[`get_lossy_storage_quality`](#get_lossy_storage_quality)** **(** **)** const - * void **[`fix_alpha_edges`](#fix_alpha_edges)** **(** **)** - * void **[`set_size_override`](#set_size_override)** **(** [Vector2](class_vector2) size **)** + * void **[create](#create)** **(** [int](class_int) width, [int](class_int) height, [int](class_int) format, [int](class_int) flags=7 **)** + * void **[create_from_image](#create_from_image)** **(** [Image](class_image) image, [int](class_int) flags=7 **)** + * [int](class_int) **[get_format](#get_format)** **(** **)** const + * void **[load](#load)** **(** [String](class_string) path **)** + * void **[set_data](#set_data)** **(** [Image](class_image) image **)** + * [Image](class_image) **[get_data](#get_data)** **(** **)** const + * void **[set_storage](#set_storage)** **(** [int](class_int) mode **)** + * [int](class_int) **[get_storage](#get_storage)** **(** **)** const + * void **[set_lossy_storage_quality](#set_lossy_storage_quality)** **(** [real](class_real) quality **)** + * [real](class_real) **[get_lossy_storage_quality](#get_lossy_storage_quality)** **(** **)** const + * void **[fix_alpha_edges](#fix_alpha_edges)** **(** **)** + * void **[set_size_override](#set_size_override)** **(** [Vector2](class_vector2) size **)** ### Numeric Constants * **STORAGE_RAW** = **0** diff --git a/class_input.md b/class_input.md index e539095..a081035 100644 --- a/class_input.md +++ b/class_input.md @@ -6,16 +6,16 @@ ### Member Functions - * [bool](class_bool) **[`is_key_pressed`](#is_key_pressed)** **(** [int](class_int) scancode **)** - * [bool](class_bool) **[`is_mouse_button_pressed`](#is_mouse_button_pressed)** **(** [int](class_int) button **)** - * [bool](class_bool) **[`is_joy_button_pressed`](#is_joy_button_pressed)** **(** [int](class_int) device, [int](class_int) button **)** - * [bool](class_bool) **[`is_action_pressed`](#is_action_pressed)** **(** [String](class_string) action **)** - * [real](class_real) **[`get_joy_axis`](#get_joy_axis)** **(** [int](class_int) device, [int](class_int) axis **)** - * [Vector3](class_vector3) **[`get_accelerometer`](#get_accelerometer)** **(** **)** - * [Vector2](class_vector2) **[`get_mouse_pos`](#get_mouse_pos)** **(** **)** const - * [Vector2](class_vector2) **[`get_mouse_speed`](#get_mouse_speed)** **(** **)** const - * void **[`set_mouse_mode`](#set_mouse_mode)** **(** [int](class_int) mode **)** - * [int](class_int) **[`get_mouse_mode`](#get_mouse_mode)** **(** **)** const + * [bool](class_bool) **[is_key_pressed](#is_key_pressed)** **(** [int](class_int) scancode **)** + * [bool](class_bool) **[is_mouse_button_pressed](#is_mouse_button_pressed)** **(** [int](class_int) button **)** + * [bool](class_bool) **[is_joy_button_pressed](#is_joy_button_pressed)** **(** [int](class_int) device, [int](class_int) button **)** + * [bool](class_bool) **[is_action_pressed](#is_action_pressed)** **(** [String](class_string) action **)** + * [real](class_real) **[get_joy_axis](#get_joy_axis)** **(** [int](class_int) device, [int](class_int) axis **)** + * [Vector3](class_vector3) **[get_accelerometer](#get_accelerometer)** **(** **)** + * [Vector2](class_vector2) **[get_mouse_pos](#get_mouse_pos)** **(** **)** const + * [Vector2](class_vector2) **[get_mouse_speed](#get_mouse_speed)** **(** **)** const + * void **[set_mouse_mode](#set_mouse_mode)** **(** [int](class_int) mode **)** + * [int](class_int) **[get_mouse_mode](#get_mouse_mode)** **(** **)** const ### Numeric Constants * **MOUSE_MODE_VISIBLE** = **0** @@ -25,7 +25,7 @@ ### Member Function Description #### get_mouse_pos - * [Vector2](class_vector2) **`get_mouse_pos`** **(** **)** const + * [Vector2](class_vector2) **get_mouse_pos** **(** **)** const Return the global, unscaled, screen pointer coordinates. If the 2D viewport has been scaled, it may not work well diff --git a/class_inputevent.md b/class_inputevent.md index fd7d342..e408c08 100644 --- a/class_inputevent.md +++ b/class_inputevent.md @@ -5,9 +5,9 @@ Built-in input event data. ### Member Functions - * [bool](class_bool) **[`is_action`](#is_action)** **(** [String](class_string) action **)** - * [bool](class_bool) **[`is_echo`](#is_echo)** **(** **)** - * [bool](class_bool) **[`is_pressed`](#is_pressed)** **(** **)** + * [bool](class_bool) **[is_action](#is_action)** **(** [String](class_string) action **)** + * [bool](class_bool) **[is_echo](#is_echo)** **(** **)** + * [bool](class_bool) **[is_pressed](#is_pressed)** **(** **)** ### Member Variables * [int](class_int) **type** @@ -31,16 +31,16 @@ Built-in input event data. InputEvent is a built-in engine datatype, given that ### Member Function Description #### is_action - * [bool](class_bool) **`is_action`** **(** [String](class_string) action **)** + * [bool](class_bool) **is_action** **(** [String](class_string) action **)** Return if this input event matches a pre-defined action, no matter the type. #### is_echo - * [bool](class_bool) **`is_echo`** **(** **)** + * [bool](class_bool) **is_echo** **(** **)** Return if this input event is an echo event (usually for key events). #### is_pressed - * [bool](class_bool) **`is_pressed`** **(** **)** + * [bool](class_bool) **is_pressed** **(** **)** Return if this input event is pressed (for key, mouse, joy button or screen press events). diff --git a/class_inputeventaction.md b/class_inputeventaction.md index 8d25efd..fb08a23 100644 --- a/class_inputeventaction.md +++ b/class_inputeventaction.md @@ -5,9 +5,9 @@ ### Member Functions - * [bool](class_bool) **[`is_action`](#is_action)** **(** [String](class_string) action **)** - * [bool](class_bool) **[`is_echo`](#is_echo)** **(** **)** - * [bool](class_bool) **[`is_pressed`](#is_pressed)** **(** **)** + * [bool](class_bool) **[is_action](#is_action)** **(** [String](class_string) action **)** + * [bool](class_bool) **[is_echo](#is_echo)** **(** **)** + * [bool](class_bool) **[is_pressed](#is_pressed)** **(** **)** ### Member Variables * [int](class_int) **type** diff --git a/class_inputeventjoybutton.md b/class_inputeventjoybutton.md index 75c5f5a..a04a04d 100644 --- a/class_inputeventjoybutton.md +++ b/class_inputeventjoybutton.md @@ -5,9 +5,9 @@ ### Member Functions - * [bool](class_bool) **[`is_action`](#is_action)** **(** [String](class_string) action **)** - * [bool](class_bool) **[`is_echo`](#is_echo)** **(** **)** - * [bool](class_bool) **[`is_pressed`](#is_pressed)** **(** **)** + * [bool](class_bool) **[is_action](#is_action)** **(** [String](class_string) action **)** + * [bool](class_bool) **[is_echo](#is_echo)** **(** **)** + * [bool](class_bool) **[is_pressed](#is_pressed)** **(** **)** ### Member Variables * [int](class_int) **type** diff --git a/class_inputeventjoymotion.md b/class_inputeventjoymotion.md index 4b7b56f..f4083de 100644 --- a/class_inputeventjoymotion.md +++ b/class_inputeventjoymotion.md @@ -5,9 +5,9 @@ ### Member Functions - * [bool](class_bool) **[`is_action`](#is_action)** **(** [String](class_string) action **)** - * [bool](class_bool) **[`is_echo`](#is_echo)** **(** **)** - * [bool](class_bool) **[`is_pressed`](#is_pressed)** **(** **)** + * [bool](class_bool) **[is_action](#is_action)** **(** [String](class_string) action **)** + * [bool](class_bool) **[is_echo](#is_echo)** **(** **)** + * [bool](class_bool) **[is_pressed](#is_pressed)** **(** **)** ### Member Variables * [int](class_int) **type** diff --git a/class_inputeventkey.md b/class_inputeventkey.md index 66141fe..ca5fac2 100644 --- a/class_inputeventkey.md +++ b/class_inputeventkey.md @@ -5,9 +5,9 @@ ### Member Functions - * [bool](class_bool) **[`is_action`](#is_action)** **(** [String](class_string) action **)** - * [bool](class_bool) **[`is_echo`](#is_echo)** **(** **)** - * [bool](class_bool) **[`is_pressed`](#is_pressed)** **(** **)** + * [bool](class_bool) **[is_action](#is_action)** **(** [String](class_string) action **)** + * [bool](class_bool) **[is_echo](#is_echo)** **(** **)** + * [bool](class_bool) **[is_pressed](#is_pressed)** **(** **)** ### Member Variables * [int](class_int) **type** diff --git a/class_inputeventmousebutton.md b/class_inputeventmousebutton.md index e9bfab6..f77ac49 100644 --- a/class_inputeventmousebutton.md +++ b/class_inputeventmousebutton.md @@ -5,9 +5,9 @@ ### Member Functions - * [bool](class_bool) **[`is_action`](#is_action)** **(** [String](class_string) action **)** - * [bool](class_bool) **[`is_echo`](#is_echo)** **(** **)** - * [bool](class_bool) **[`is_pressed`](#is_pressed)** **(** **)** + * [bool](class_bool) **[is_action](#is_action)** **(** [String](class_string) action **)** + * [bool](class_bool) **[is_echo](#is_echo)** **(** **)** + * [bool](class_bool) **[is_pressed](#is_pressed)** **(** **)** ### Member Variables * [int](class_int) **type** diff --git a/class_inputeventmousemotion.md b/class_inputeventmousemotion.md index 55dfa5b..1227759 100644 --- a/class_inputeventmousemotion.md +++ b/class_inputeventmousemotion.md @@ -5,9 +5,9 @@ ### Member Functions - * [bool](class_bool) **[`is_action`](#is_action)** **(** [String](class_string) action **)** - * [bool](class_bool) **[`is_echo`](#is_echo)** **(** **)** - * [bool](class_bool) **[`is_pressed`](#is_pressed)** **(** **)** + * [bool](class_bool) **[is_action](#is_action)** **(** [String](class_string) action **)** + * [bool](class_bool) **[is_echo](#is_echo)** **(** **)** + * [bool](class_bool) **[is_pressed](#is_pressed)** **(** **)** ### Member Variables * [int](class_int) **type** diff --git a/class_inputeventscreendrag.md b/class_inputeventscreendrag.md index d2cba90..f1c6061 100644 --- a/class_inputeventscreendrag.md +++ b/class_inputeventscreendrag.md @@ -5,9 +5,9 @@ ### Member Functions - * [bool](class_bool) **[`is_action`](#is_action)** **(** [String](class_string) action **)** - * [bool](class_bool) **[`is_echo`](#is_echo)** **(** **)** - * [bool](class_bool) **[`is_pressed`](#is_pressed)** **(** **)** + * [bool](class_bool) **[is_action](#is_action)** **(** [String](class_string) action **)** + * [bool](class_bool) **[is_echo](#is_echo)** **(** **)** + * [bool](class_bool) **[is_pressed](#is_pressed)** **(** **)** ### Member Variables * [int](class_int) **type** diff --git a/class_inputeventscreentouch.md b/class_inputeventscreentouch.md index ee829a5..eba67ca 100644 --- a/class_inputeventscreentouch.md +++ b/class_inputeventscreentouch.md @@ -5,9 +5,9 @@ ### Member Functions - * [bool](class_bool) **[`is_action`](#is_action)** **(** [String](class_string) action **)** - * [bool](class_bool) **[`is_echo`](#is_echo)** **(** **)** - * [bool](class_bool) **[`is_pressed`](#is_pressed)** **(** **)** + * [bool](class_bool) **[is_action](#is_action)** **(** [String](class_string) action **)** + * [bool](class_bool) **[is_echo](#is_echo)** **(** **)** + * [bool](class_bool) **[is_pressed](#is_pressed)** **(** **)** ### Member Variables * [int](class_int) **type** diff --git a/class_int.md b/class_int.md index 07015f3..bb32fd5 100644 --- a/class_int.md +++ b/class_int.md @@ -5,9 +5,9 @@ Integer built-in type. ### Member Functions - * void **[`int`](#int)** **(** [bool](class_bool) from **)** - * void **[`int`](#int)** **(** [real](class_real) from **)** - * void **[`int`](#int)** **(** [String](class_string) from **)** + * void **[int](#int)** **(** [bool](class_bool) from **)** + * void **[int](#int)** **(** [real](class_real) from **)** + * void **[int](#int)** **(** [String](class_string) from **)** ### Description Integer built-in type. diff --git a/class_intarray.md b/class_intarray.md index a8b627b..76e5fa7 100644 --- a/class_intarray.md +++ b/class_intarray.md @@ -5,12 +5,12 @@ Integer Array . ### Member Functions - * [int](class_int) **[`get`](#get)** **(** [int](class_int) idx **)** - * void **[`push_back`](#push_back)** **(** [int](class_int) integer **)** - * void **[`resize`](#resize)** **(** [int](class_int) idx **)** - * void **[`set`](#set)** **(** [int](class_int) idx, [int](class_int) integer **)** - * [int](class_int) **[`size`](#size)** **(** **)** - * void **[`IntArray`](#IntArray)** **(** [Array](class_array) from **)** + * [int](class_int) **[get](#get)** **(** [int](class_int) idx **)** + * void **[push_back](#push_back)** **(** [int](class_int) integer **)** + * void **[resize](#resize)** **(** [int](class_int) idx **)** + * void **[set](#set)** **(** [int](class_int) idx, [int](class_int) integer **)** + * [int](class_int) **[size](#size)** **(** **)** + * void **[IntArray](#IntArray)** **(** [Array](class_array) from **)** ### Description Integer Array. Array of integers. Can only contain integers. Optimized for memory usage, cant fragment the memory. @@ -18,31 +18,31 @@ Integer Array. Array of integers. Can only contain integers. Optimized for memor ### Member Function Description #### get - * [int](class_int) **`get`** **(** [int](class_int) idx **)** + * [int](class_int) **get** **(** [int](class_int) idx **)** Get an index in the array. #### push_back - * void **`push_back`** **(** [int](class_int) integer **)** + * void **push_back** **(** [int](class_int) integer **)** Append a value to the array. #### resize - * void **`resize`** **(** [int](class_int) idx **)** + * void **resize** **(** [int](class_int) idx **)** Resize the array. #### set - * void **`set`** **(** [int](class_int) idx, [int](class_int) integer **)** + * void **set** **(** [int](class_int) idx, [int](class_int) integer **)** Set an index in the array. #### size - * [int](class_int) **`size`** **(** **)** + * [int](class_int) **size** **(** **)** Return the array size. #### IntArray - * void **`IntArray`** **(** [Array](class_array) from **)** + * void **IntArray** **(** [Array](class_array) from **)** Create from a generic array. diff --git a/class_interpolatedcamera.md b/class_interpolatedcamera.md index e5bab36..46592f8 100644 --- a/class_interpolatedcamera.md +++ b/class_interpolatedcamera.md @@ -6,12 +6,12 @@ ### Member Functions - * void **[`set_target_path`](#set_target_path)** **(** [NodePath](class_nodepath) target_path **)** - * [NodePath](class_nodepath) **[`get_target_path`](#get_target_path)** **(** **)** const - * void **[`set_target`](#set_target)** **(** [Object](class_object) target **)** - * void **[`set_speed`](#set_speed)** **(** [real](class_real) speed **)** - * [real](class_real) **[`get_speed`](#get_speed)** **(** **)** const - * void **[`set_interpolation_enabled`](#set_interpolation_enabled)** **(** [bool](class_bool) target_path **)** - * [bool](class_bool) **[`is_interpolation_enabled`](#is_interpolation_enabled)** **(** **)** const + * void **[set_target_path](#set_target_path)** **(** [NodePath](class_nodepath) target_path **)** + * [NodePath](class_nodepath) **[get_target_path](#get_target_path)** **(** **)** const + * void **[set_target](#set_target)** **(** [Object](class_object) target **)** + * void **[set_speed](#set_speed)** **(** [real](class_real) speed **)** + * [real](class_real) **[get_speed](#get_speed)** **(** **)** const + * void **[set_interpolation_enabled](#set_interpolation_enabled)** **(** [bool](class_bool) target_path **)** + * [bool](class_bool) **[is_interpolation_enabled](#is_interpolation_enabled)** **(** **)** const ### Member Function Description diff --git a/class_ip.md b/class_ip.md index 17e133f..d6ed0a5 100644 --- a/class_ip.md +++ b/class_ip.md @@ -6,11 +6,11 @@ IP Protocol support functions. ### Member Functions - * [String](class_string) **[`resolve_hostname`](#resolve_hostname)** **(** [String](class_string) host **)** - * [int](class_int) **[`resolve_hostname_queue_item`](#resolve_hostname_queue_item)** **(** [String](class_string) host **)** - * [int](class_int) **[`get_resolve_item_status`](#get_resolve_item_status)** **(** [int](class_int) id **)** const - * [String](class_string) **[`get_resolve_item_address`](#get_resolve_item_address)** **(** [int](class_int) id **)** const - * void **[`erase_resolve_item`](#erase_resolve_item)** **(** [int](class_int) id **)** + * [String](class_string) **[resolve_hostname](#resolve_hostname)** **(** [String](class_string) host **)** + * [int](class_int) **[resolve_hostname_queue_item](#resolve_hostname_queue_item)** **(** [String](class_string) host **)** + * [int](class_int) **[get_resolve_item_status](#get_resolve_item_status)** **(** [int](class_int) id **)** const + * [String](class_string) **[get_resolve_item_address](#get_resolve_item_address)** **(** [int](class_int) id **)** const + * void **[erase_resolve_item](#erase_resolve_item)** **(** [int](class_int) id **)** ### Numeric Constants * **RESOLVER_STATUS_NONE** = **0** @@ -26,26 +26,26 @@ IP contains some support functions for the IPv4 protocol. TCP/IP support is in d ### Member Function Description #### resolve_hostname - * [String](class_string) **`resolve_hostname`** **(** [String](class_string) host **)** + * [String](class_string) **resolve_hostname** **(** [String](class_string) host **)** Resolve a given hostname, blocking. Resolved hostname is returned as an IP. #### resolve_hostname_queue_item - * [int](class_int) **`resolve_hostname_queue_item`** **(** [String](class_string) host **)** + * [int](class_int) **resolve_hostname_queue_item** **(** [String](class_string) host **)** Create a queue item for resolving a given hostname. The queue ID is returned, or RESOLVER_INVALID_ID on error. #### get_resolve_item_status - * [int](class_int) **`get_resolve_item_status`** **(** [int](class_int) id **)** const + * [int](class_int) **get_resolve_item_status** **(** [int](class_int) id **)** const Return the status of hostname queued for resolving, given it"apos;s queue ID. Returned status can be any of the RESOLVER_STATUS_* enumeration. #### get_resolve_item_address - * [String](class_string) **`get_resolve_item_address`** **(** [int](class_int) id **)** const + * [String](class_string) **get_resolve_item_address** **(** [int](class_int) id **)** const -Return a resolved item address, or an empty string if an error happened or resolution didn"apos;t happen yet (see [`get_resolve_item_status`](#get_resolve_item_status)). +Return a resolved item address, or an empty string if an error happened or resolution didn"apos;t happen yet (see [get_resolve_item_status](#get_resolve_item_status)). #### erase_resolve_item - * void **`erase_resolve_item`** **(** [int](class_int) id **)** + * void **erase_resolve_item** **(** [int](class_int) id **)** Erase a queue ID, removing it from the queue if needed. This should be used after a queue is completed to free it and enable more queries to happen. diff --git a/class_joint2d.md b/class_joint2d.md index 6c51d96..4d1247e 100644 --- a/class_joint2d.md +++ b/class_joint2d.md @@ -6,12 +6,12 @@ Base node for all joint constraints in 2D phyisics. ### Member Functions - * void **[`set_node_a`](#set_node_a)** **(** [NodePath](class_nodepath) node **)** - * [NodePath](class_nodepath) **[`get_node_a`](#get_node_a)** **(** **)** const - * void **[`set_node_b`](#set_node_b)** **(** [NodePath](class_nodepath) node **)** - * [NodePath](class_nodepath) **[`get_node_b`](#get_node_b)** **(** **)** const - * void **[`set_bias`](#set_bias)** **(** [real](class_real) bias **)** - * [real](class_real) **[`get_bias`](#get_bias)** **(** **)** const + * void **[set_node_a](#set_node_a)** **(** [NodePath](class_nodepath) node **)** + * [NodePath](class_nodepath) **[get_node_a](#get_node_a)** **(** **)** const + * void **[set_node_b](#set_node_b)** **(** [NodePath](class_nodepath) node **)** + * [NodePath](class_nodepath) **[get_node_b](#get_node_b)** **(** **)** const + * void **[set_bias](#set_bias)** **(** [real](class_real) bias **)** + * [real](class_real) **[get_bias](#get_bias)** **(** **)** const ### Description Base node for all joint constraints in 2D phyisics. Joints take 2 bodies and apply a custom constraint. @@ -19,21 +19,21 @@ Base node for all joint constraints in 2D phyisics. Joints take 2 bodies and app ### Member Function Description #### set_node_a - * void **`set_node_a`** **(** [NodePath](class_nodepath) node **)** + * void **set_node_a** **(** [NodePath](class_nodepath) node **)** Set the path to the A node for the joint. Must be of type PhysicsBody2D. #### get_node_a - * [NodePath](class_nodepath) **`get_node_a`** **(** **)** const + * [NodePath](class_nodepath) **get_node_a** **(** **)** const Return the path to the A node for the joint. #### set_node_b - * void **`set_node_b`** **(** [NodePath](class_nodepath) node **)** + * void **set_node_b** **(** [NodePath](class_nodepath) node **)** Set the path to the B node for the joint. Must be of type PhysicsBody2D. #### get_node_b - * [NodePath](class_nodepath) **`get_node_b`** **(** **)** const + * [NodePath](class_nodepath) **get_node_b** **(** **)** const Return the path to the B node for the joint. diff --git a/class_label.md b/class_label.md index ddc37bf..bfeafce 100644 --- a/class_label.md +++ b/class_label.md @@ -6,22 +6,22 @@ Control that displays formatted text. ### Member Functions - * void **[`set_align`](#set_align)** **(** [int](class_int) align **)** - * [int](class_int) **[`get_align`](#get_align)** **(** **)** const - * void **[`set_valign`](#set_valign)** **(** [int](class_int) valign **)** - * [int](class_int) **[`get_valign`](#get_valign)** **(** **)** const - * void **[`set_text`](#set_text)** **(** [String](class_string) text **)** - * [String](class_string) **[`get_text`](#get_text)** **(** **)** const - * void **[`set_autowrap`](#set_autowrap)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`has_autowrap`](#has_autowrap)** **(** **)** const - * void **[`set_uppercase`](#set_uppercase)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_uppercase`](#is_uppercase)** **(** **)** const - * [int](class_int) **[`get_line_height`](#get_line_height)** **(** **)** const - * [int](class_int) **[`get_line_count`](#get_line_count)** **(** **)** const - * [int](class_int) **[`get_total_character_count`](#get_total_character_count)** **(** **)** const - * void **[`set_visible_characters`](#set_visible_characters)** **(** [int](class_int) arg0 **)** - * void **[`set_percent_visible`](#set_percent_visible)** **(** [real](class_real) percent_visible **)** - * [real](class_real) **[`get_percent_visible`](#get_percent_visible)** **(** **)** const + * void **[set_align](#set_align)** **(** [int](class_int) align **)** + * [int](class_int) **[get_align](#get_align)** **(** **)** const + * void **[set_valign](#set_valign)** **(** [int](class_int) valign **)** + * [int](class_int) **[get_valign](#get_valign)** **(** **)** const + * void **[set_text](#set_text)** **(** [String](class_string) text **)** + * [String](class_string) **[get_text](#get_text)** **(** **)** const + * void **[set_autowrap](#set_autowrap)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[has_autowrap](#has_autowrap)** **(** **)** const + * void **[set_uppercase](#set_uppercase)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_uppercase](#is_uppercase)** **(** **)** const + * [int](class_int) **[get_line_height](#get_line_height)** **(** **)** const + * [int](class_int) **[get_line_count](#get_line_count)** **(** **)** const + * [int](class_int) **[get_total_character_count](#get_total_character_count)** **(** **)** const + * void **[set_visible_characters](#set_visible_characters)** **(** [int](class_int) arg0 **)** + * void **[set_percent_visible](#set_percent_visible)** **(** [real](class_real) percent_visible **)** + * [real](class_real) **[get_percent_visible](#get_percent_visible)** **(** **)** const ### Numeric Constants * **ALIGN_LEFT** = **0** - Align rows to the left (default). @@ -39,41 +39,41 @@ Label is a control that displays formatted text, optionally autowrapping it to t ### Member Function Description #### set_align - * void **`set_align`** **(** [int](class_int) align **)** + * void **set_align** **(** [int](class_int) align **)** Set the alignmend mode to any of the ALIGN_* enumeration values. #### get_align - * [int](class_int) **`get_align`** **(** **)** const + * [int](class_int) **get_align** **(** **)** const Return the alignmend mode (any of the ALIGN_* enumeration values). #### set_text - * void **`set_text`** **(** [String](class_string) text **)** + * void **set_text** **(** [String](class_string) text **)** Set the label text. Text can contain newlines. #### get_text - * [String](class_string) **`get_text`** **(** **)** const + * [String](class_string) **get_text** **(** **)** const Return the label text. Text can contain newlines. #### set_autowrap - * void **`set_autowrap`** **(** [bool](class_bool) enable **)** + * void **set_autowrap** **(** [bool](class_bool) enable **)** Set _autowrap_ mode. When enabled, autowrap will fit text to the control width, breaking sentences when they exceed the available horizontal space. When disabled, the label minimum width becomes the width of the longest row, and the minimum height large enough to fit all rows. #### has_autowrap - * [bool](class_bool) **`has_autowrap`** **(** **)** const + * [bool](class_bool) **has_autowrap** **(** **)** const -Return the state of the _autowrap_ mode (see [`set_autowrap`](#set_autowrap)). +Return the state of the _autowrap_ mode (see [set_autowrap](#set_autowrap)). #### get_line_height - * [int](class_int) **`get_line_height`** **(** **)** const + * [int](class_int) **get_line_height** **(** **)** const Return the height of a line. #### get_line_count - * [int](class_int) **`get_line_count`** **(** **)** const + * [int](class_int) **get_line_count** **(** **)** const Return the amount of lines. diff --git a/class_largetexture.md b/class_largetexture.md index 1fe7c9e..f264a3f 100644 --- a/class_largetexture.md +++ b/class_largetexture.md @@ -6,11 +6,11 @@ ### Member Functions - * void **[`add_piece`](#add_piece)** **(** [Vector2](class_vector2) ofs, [Texture](class_texture) texture **)** - * void **[`set_size`](#set_size)** **(** [Vector2](class_vector2) size **)** - * void **[`clear`](#clear)** **(** **)** - * [int](class_int) **[`get_piece_count`](#get_piece_count)** **(** **)** const - * [Vector2](class_vector2) **[`get_piece_offset`](#get_piece_offset)** **(** [int](class_int) idx **)** const - * [Texture](class_texture) **[`get_piece_texture`](#get_piece_texture)** **(** [int](class_int) idx **)** const + * void **[add_piece](#add_piece)** **(** [Vector2](class_vector2) ofs, [Texture](class_texture) texture **)** + * void **[set_size](#set_size)** **(** [Vector2](class_vector2) size **)** + * void **[clear](#clear)** **(** **)** + * [int](class_int) **[get_piece_count](#get_piece_count)** **(** **)** const + * [Vector2](class_vector2) **[get_piece_offset](#get_piece_offset)** **(** [int](class_int) idx **)** const + * [Texture](class_texture) **[get_piece_texture](#get_piece_texture)** **(** [int](class_int) idx **)** const ### Member Function Description diff --git a/class_light.md b/class_light.md index 9531dd8..e712d7d 100644 --- a/class_light.md +++ b/class_light.md @@ -6,16 +6,16 @@ Provides a base class for different kinds of light nodes. ### Member Functions - * void **[`set_parameter`](#set_parameter)** **(** [int](class_int) variable, [real](class_real) value **)** - * [real](class_real) **[`get_parameter`](#get_parameter)** **(** [int](class_int) arg0 **)** const - * void **[`set_color`](#set_color)** **(** [int](class_int) color, [Color](class_color) value **)** - * [Color](class_color) **[`get_color`](#get_color)** **(** [int](class_int) arg0 **)** const - * void **[`set_project_shadows`](#set_project_shadows)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`has_project_shadows`](#has_project_shadows)** **(** **)** const - * void **[`set_projector`](#set_projector)** **(** [Texture](class_texture) projector **)** - * [Texture](class_texture) **[`get_projector`](#get_projector)** **(** **)** const - * void **[`set_operator`](#set_operator)** **(** [int](class_int) operator **)** - * [int](class_int) **[`get_operator`](#get_operator)** **(** **)** const + * void **[set_parameter](#set_parameter)** **(** [int](class_int) variable, [real](class_real) value **)** + * [real](class_real) **[get_parameter](#get_parameter)** **(** [int](class_int) arg0 **)** const + * void **[set_color](#set_color)** **(** [int](class_int) color, [Color](class_color) value **)** + * [Color](class_color) **[get_color](#get_color)** **(** [int](class_int) arg0 **)** const + * void **[set_project_shadows](#set_project_shadows)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[has_project_shadows](#has_project_shadows)** **(** **)** const + * void **[set_projector](#set_projector)** **(** [Texture](class_texture) projector **)** + * [Texture](class_texture) **[get_projector](#get_projector)** **(** **)** const + * void **[set_operator](#set_operator)** **(** [int](class_int) operator **)** + * [int](class_int) **[get_operator](#get_operator)** **(** **)** const ### Numeric Constants * **PARAM_RADIUS** = **2** diff --git a/class_lineedit.md b/class_lineedit.md index 056ffa8..35af331 100644 --- a/class_lineedit.md +++ b/class_lineedit.md @@ -6,24 +6,24 @@ Control that provides single line string editing. ### Member Functions - * void **[`clear`](#clear)** **(** **)** - * void **[`select_all`](#select_all)** **(** **)** - * void **[`set_text`](#set_text)** **(** [String](class_string) text **)** - * [String](class_string) **[`get_text`](#get_text)** **(** **)** const - * void **[`set_cursor_pos`](#set_cursor_pos)** **(** [int](class_int) pos **)** - * [int](class_int) **[`get_cursor_pos`](#get_cursor_pos)** **(** **)** const - * void **[`set_max_length`](#set_max_length)** **(** [int](class_int) chars **)** - * [int](class_int) **[`get_max_length`](#get_max_length)** **(** **)** const - * void **[`append_at_cursor`](#append_at_cursor)** **(** [String](class_string) text **)** - * void **[`set_editable`](#set_editable)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`is_editable`](#is_editable)** **(** **)** const - * void **[`set_secret`](#set_secret)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`is_secret`](#is_secret)** **(** **)** const - * [bool](class_bool) **[`select`](#select)** **(** **)** const + * void **[clear](#clear)** **(** **)** + * void **[select_all](#select_all)** **(** **)** + * void **[set_text](#set_text)** **(** [String](class_string) text **)** + * [String](class_string) **[get_text](#get_text)** **(** **)** const + * void **[set_cursor_pos](#set_cursor_pos)** **(** [int](class_int) pos **)** + * [int](class_int) **[get_cursor_pos](#get_cursor_pos)** **(** **)** const + * void **[set_max_length](#set_max_length)** **(** [int](class_int) chars **)** + * [int](class_int) **[get_max_length](#get_max_length)** **(** **)** const + * void **[append_at_cursor](#append_at_cursor)** **(** [String](class_string) text **)** + * void **[set_editable](#set_editable)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[is_editable](#is_editable)** **(** **)** const + * void **[set_secret](#set_secret)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[is_secret](#is_secret)** **(** **)** const + * [bool](class_bool) **[select](#select)** **(** **)** const ### Signals - * **`text_entered`** **(** [String](class_string) text **)** - * **`text_changed`** **(** [String](class_string) text **)** + * **text_entered** **(** [String](class_string) text **)** + * **text_changed** **(** [String](class_string) text **)** ### Description LineEdit provides a single line string editor, used for text fields. @@ -31,66 +31,66 @@ LineEdit provides a single line string editor, used for text fields. ### Member Function Description #### clear - * void **`clear`** **(** **)** + * void **clear** **(** **)** Clear the [LineEdit](class_lineedit) text. #### select_all - * void **`select_all`** **(** **)** + * void **select_all** **(** **)** Select the whole string. #### set_text - * void **`set_text`** **(** [String](class_string) text **)** + * void **set_text** **(** [String](class_string) text **)** Set the text in the [LineEdit](class_lineedit), clearing the existing one and the selection. #### get_text - * [String](class_string) **`get_text`** **(** **)** const + * [String](class_string) **get_text** **(** **)** const Return the text in the [LineEdit](class_lineedit). #### set_cursor_pos - * void **`set_cursor_pos`** **(** [int](class_int) pos **)** + * void **set_cursor_pos** **(** [int](class_int) pos **)** Set the cursor position inside the [LineEdit](class_lineedit), causing it to scroll if needed. #### get_cursor_pos - * [int](class_int) **`get_cursor_pos`** **(** **)** const + * [int](class_int) **get_cursor_pos** **(** **)** const Return the cursor position inside the [LineEdit](class_lineedit). #### set_max_length - * void **`set_max_length`** **(** [int](class_int) chars **)** + * void **set_max_length** **(** [int](class_int) chars **)** Set the maximum amount of characters the [LineEdit](class_lineedit) can edit, and cropping existing text in case it exceeds that limit. Setting 0 removes the limit. #### get_max_length - * [int](class_int) **`get_max_length`** **(** **)** const + * [int](class_int) **get_max_length** **(** **)** const Return the maximum amount of characters the [LineEdit](class_lineedit) can edit. If 0 is returned, no limit exists. #### append_at_cursor - * void **`append_at_cursor`** **(** [String](class_string) text **)** + * void **append_at_cursor** **(** [String](class_string) text **)** Append text at cursor, scrolling the [LineEdit](class_lineedit) when needed. #### set_editable - * void **`set_editable`** **(** [bool](class_bool) enabled **)** + * void **set_editable** **(** [bool](class_bool) enabled **)** Set the _editable_ status of the [LineEdit](class_lineedit). When disabled, existing text can"apos;t be modified and new text can"apos;t be added. #### is_editable - * [bool](class_bool) **`is_editable`** **(** **)** const + * [bool](class_bool) **is_editable** **(** **)** const -Return the _editable_ status of the [LineEdit](class_lineedit) (see [`set_editable`](#set_editable)). +Return the _editable_ status of the [LineEdit](class_lineedit) (see [set_editable](#set_editable)). #### set_secret - * void **`set_secret`** **(** [bool](class_bool) enabled **)** + * void **set_secret** **(** [bool](class_bool) enabled **)** Set the _secret_ status of the [LineEdit](class_lineedit). When enabled, every character is displayed as "*". #### is_secret - * [bool](class_bool) **`is_secret`** **(** **)** const + * [bool](class_bool) **is_secret** **(** **)** const -Return the _secret_ status of the [LineEdit](class_lineedit) (see [`set_secret`](#set_secret)). +Return the _secret_ status of the [LineEdit](class_lineedit) (see [set_secret](#set_secret)). diff --git a/class_lineshape2d.md b/class_lineshape2d.md index 8fe5c80..547e39c 100644 --- a/class_lineshape2d.md +++ b/class_lineshape2d.md @@ -6,10 +6,10 @@ Line shape for 2D collision objects. ### Member Functions - * void **[`set_normal`](#set_normal)** **(** [Vector2](class_vector2) normal **)** - * [Vector2](class_vector2) **[`get_normal`](#get_normal)** **(** **)** const - * void **[`set_d`](#set_d)** **(** [real](class_real) d **)** - * [real](class_real) **[`get_d`](#get_d)** **(** **)** const + * void **[set_normal](#set_normal)** **(** [Vector2](class_vector2) normal **)** + * [Vector2](class_vector2) **[get_normal](#get_normal)** **(** **)** const + * void **[set_d](#set_d)** **(** [real](class_real) d **)** + * [real](class_real) **[get_d](#get_d)** **(** **)** const ### Description Line shape for 2D collision objects. It works like a 2D plane and will not allow any body to go to the negative side. Not recommended for rigid bodies, and usually not recommended for static bodies either because it forces checks against it on every frame. @@ -17,21 +17,21 @@ Line shape for 2D collision objects. It works like a 2D plane and will not allow ### Member Function Description #### set_normal - * void **`set_normal`** **(** [Vector2](class_vector2) normal **)** + * void **set_normal** **(** [Vector2](class_vector2) normal **)** Set the line normal. #### get_normal - * [Vector2](class_vector2) **`get_normal`** **(** **)** const + * [Vector2](class_vector2) **get_normal** **(** **)** const Return the line normal. #### set_d - * void **`set_d`** **(** [real](class_real) d **)** + * void **set_d** **(** [real](class_real) d **)** Set the line distance from the origin. #### get_d - * [real](class_real) **`get_d`** **(** **)** const + * [real](class_real) **get_d** **(** **)** const Return the line distance from the origin. diff --git a/class_mainloop.md b/class_mainloop.md index 60775f2..66acece 100644 --- a/class_mainloop.md +++ b/class_mainloop.md @@ -6,7 +6,7 @@ Main loop is the abstract main loop base class. ### Member Functions - * void **[`input_event`](#input_event)** **(** [InputEvent](class_inputevent) arg0 **)** + * void **[input_event](#input_event)** **(** [InputEvent](class_inputevent) arg0 **)** ### Numeric Constants * **NOTIFICATION_WM_FOCUS_IN** = **5** diff --git a/class_marshalls.md b/class_marshalls.md index db4d44c..a14b1d4 100644 --- a/class_marshalls.md +++ b/class_marshalls.md @@ -6,7 +6,7 @@ ### Member Functions - * [String](class_string) **[`variant_to_base64`](#variant_to_base64)** **(** var variant **)** - * void **[`base64_to_variant`](#base64_to_variant)** **(** [String](class_string) base64_str **)** + * [String](class_string) **[variant_to_base64](#variant_to_base64)** **(** var variant **)** + * void **[base64_to_variant](#base64_to_variant)** **(** [String](class_string) base64_str **)** ### Member Function Description diff --git a/class_material.md b/class_material.md index 1733ea9..cee05b0 100644 --- a/class_material.md +++ b/class_material.md @@ -6,16 +6,16 @@ Abstract base [Resource](class_resource) for coloring and shading geometry. ### Member Functions - * void **[`set_flag`](#set_flag)** **(** [int](class_int) flag, [bool](class_bool) enable **)** - * [bool](class_bool) **[`get_flag`](#get_flag)** **(** [int](class_int) flag **)** const - * void **[`set_hint`](#set_hint)** **(** [int](class_int) hint, [bool](class_bool) enable **)** - * [bool](class_bool) **[`get_hint`](#get_hint)** **(** [int](class_int) hint **)** const - * void **[`set_blend_mode`](#set_blend_mode)** **(** [int](class_int) mode **)** - * [int](class_int) **[`get_blend_mode`](#get_blend_mode)** **(** **)** const - * void **[`set_shade_model`](#set_shade_model)** **(** [int](class_int) model **)** - * [int](class_int) **[`get_shade_model`](#get_shade_model)** **(** **)** const - * void **[`set_line_width`](#set_line_width)** **(** [real](class_real) width **)** - * [real](class_real) **[`get_line_width`](#get_line_width)** **(** **)** const + * void **[set_flag](#set_flag)** **(** [int](class_int) flag, [bool](class_bool) enable **)** + * [bool](class_bool) **[get_flag](#get_flag)** **(** [int](class_int) flag **)** const + * void **[set_hint](#set_hint)** **(** [int](class_int) hint, [bool](class_bool) enable **)** + * [bool](class_bool) **[get_hint](#get_hint)** **(** [int](class_int) hint **)** const + * void **[set_blend_mode](#set_blend_mode)** **(** [int](class_int) mode **)** + * [int](class_int) **[get_blend_mode](#get_blend_mode)** **(** **)** const + * void **[set_shade_model](#set_shade_model)** **(** [int](class_int) model **)** + * [int](class_int) **[get_shade_model](#get_shade_model)** **(** **)** const + * void **[set_line_width](#set_line_width)** **(** [real](class_real) width **)** + * [real](class_real) **[get_line_width](#get_line_width)** **(** **)** const ### Numeric Constants * **FLAG_VISIBLE** = **0** - Geometry is visible when this flag is enabled (default). @@ -49,31 +49,31 @@ Material is a base [Resource](class_resource) used for coloring and shading geom ### Member Function Description #### set_flag - * void **`set_flag`** **(** [int](class_int) flag, [bool](class_bool) enable **)** + * void **set_flag** **(** [int](class_int) flag, [bool](class_bool) enable **)** Set a [Material](class_material) flag, which toggles on or off a behavior when rendering. See enumeration FLAG_* for a list. #### get_flag - * [bool](class_bool) **`get_flag`** **(** [int](class_int) flag **)** const + * [bool](class_bool) **get_flag** **(** [int](class_int) flag **)** const Return a [Material](class_material) flag, which toggles on or off a behavior when rendering. See enumeration FLAG_* for a list. #### set_blend_mode - * void **`set_blend_mode`** **(** [int](class_int) mode **)** + * void **set_blend_mode** **(** [int](class_int) mode **)** Set blend mode for the material, which can be one of BLEND_MODE_MIX (default), BLEND_MODE_ADD, BLEND_MODE_SUB. Keep in mind that only BLEND_MODE_MIX ensures that the material _may_ be opaque, any other blend mode will render with alpha blending enabled in raster-based [VisualServer](class_visualserver) implementations. #### get_blend_mode - * [int](class_int) **`get_blend_mode`** **(** **)** const + * [int](class_int) **get_blend_mode** **(** **)** const Return blend mode for the material, which can be one of BLEND_MODE_MIX (default), BLEND_MODE_ADD, BLEND_MODE_SUB. Keep in mind that only BLEND_MODE_MIX ensures that the material _may_ be opaque, any other blend mode will render with alpha blending enabled in raster-based [VisualServer](class_visualserver) implementations. #### set_line_width - * void **`set_line_width`** **(** [real](class_real) width **)** + * void **set_line_width** **(** [real](class_real) width **)** Set the line width for geometry drawn with FLAG_WIREFRAME enabled, or LINE primitives. Note that not all hardware or VisualServer backends support this (like DirectX). #### get_line_width - * [real](class_real) **`get_line_width`** **(** **)** const + * [real](class_real) **get_line_width** **(** **)** const Return the line width for geometry drawn with FLAG_WIREFRAME enabled, or LINE primitives. Note that not all hardware or VisualServer backends support this (like DirectX). diff --git a/class_matrix3.md b/class_matrix3.md index 21e3b43..aa83c18 100644 --- a/class_matrix3.md +++ b/class_matrix3.md @@ -5,22 +5,22 @@ 3x3 matrix datatype. ### Member Functions - * [real](class_real) **[`determinant`](#determinant)** **(** **)** - * [Vector3](class_vector3) **[`get_euler`](#get_euler)** **(** **)** - * [int](class_int) **[`get_orthogonal_index`](#get_orthogonal_index)** **(** **)** - * [Matrix3](class_matrix3) **[`inverse`](#inverse)** **(** **)** - * [Matrix3](class_matrix3) **[`orthonormalized`](#orthonormalized)** **(** **)** - * [Matrix3](class_matrix3) **[`rotated`](#rotated)** **(** [Vector3](class_vector3) axis, [real](class_real) phi **)** - * [Matrix3](class_matrix3) **[`scaled`](#scaled)** **(** [Vector3](class_vector3) scale **)** - * [real](class_real) **[`tdotx`](#tdotx)** **(** [Vector3](class_vector3) with **)** - * [real](class_real) **[`tdoty`](#tdoty)** **(** [Vector3](class_vector3) with **)** - * [real](class_real) **[`tdotz`](#tdotz)** **(** [Vector3](class_vector3) with **)** - * [Matrix3](class_matrix3) **[`transposed`](#transposed)** **(** **)** - * [Vector3](class_vector3) **[`xform`](#xform)** **(** [Vector3](class_vector3) v **)** - * [Vector3](class_vector3) **[`xform_inv`](#xform_inv)** **(** [Vector3](class_vector3) v **)** - * void **[`Matrix3`](#Matrix3)** **(** [Vector3](class_vector3) x_axis, [Vector3](class_vector3) y_axis, [Vector3](class_vector3) z_axis **)** - * void **[`Matrix3`](#Matrix3)** **(** [Vector3](class_vector3) axis, [real](class_real) phi **)** - * void **[`Matrix3`](#Matrix3)** **(** [Quat](class_quat) from **)** + * [real](class_real) **[determinant](#determinant)** **(** **)** + * [Vector3](class_vector3) **[get_euler](#get_euler)** **(** **)** + * [int](class_int) **[get_orthogonal_index](#get_orthogonal_index)** **(** **)** + * [Matrix3](class_matrix3) **[inverse](#inverse)** **(** **)** + * [Matrix3](class_matrix3) **[orthonormalized](#orthonormalized)** **(** **)** + * [Matrix3](class_matrix3) **[rotated](#rotated)** **(** [Vector3](class_vector3) axis, [real](class_real) phi **)** + * [Matrix3](class_matrix3) **[scaled](#scaled)** **(** [Vector3](class_vector3) scale **)** + * [real](class_real) **[tdotx](#tdotx)** **(** [Vector3](class_vector3) with **)** + * [real](class_real) **[tdoty](#tdoty)** **(** [Vector3](class_vector3) with **)** + * [real](class_real) **[tdotz](#tdotz)** **(** [Vector3](class_vector3) with **)** + * [Matrix3](class_matrix3) **[transposed](#transposed)** **(** **)** + * [Vector3](class_vector3) **[xform](#xform)** **(** [Vector3](class_vector3) v **)** + * [Vector3](class_vector3) **[xform_inv](#xform_inv)** **(** [Vector3](class_vector3) v **)** + * void **[Matrix3](#Matrix3)** **(** [Vector3](class_vector3) x_axis, [Vector3](class_vector3) y_axis, [Vector3](class_vector3) z_axis **)** + * void **[Matrix3](#Matrix3)** **(** [Vector3](class_vector3) axis, [real](class_real) phi **)** + * void **[Matrix3](#Matrix3)** **(** [Quat](class_quat) from **)** ### Member Variables * [Vector3](class_vector3) **x** @@ -33,76 +33,76 @@ ### Member Function Description #### determinant - * [real](class_real) **`determinant`** **(** **)** + * [real](class_real) **determinant** **(** **)** Return the determinant of the matrix. #### get_euler - * [Vector3](class_vector3) **`get_euler`** **(** **)** + * [Vector3](class_vector3) **get_euler** **(** **)** Return euler angles from the matrix. #### inverse - * [Matrix3](class_matrix3) **`inverse`** **(** **)** + * [Matrix3](class_matrix3) **inverse** **(** **)** Return the affine inverse of the matrix. #### orthonormalized - * [Matrix3](class_matrix3) **`orthonormalized`** **(** **)** + * [Matrix3](class_matrix3) **orthonormalized** **(** **)** Return the orthonormalized version of the matrix (useful to call from time to time to avoid rounding error). #### rotated - * [Matrix3](class_matrix3) **`rotated`** **(** [Vector3](class_vector3) axis, [real](class_real) phi **)** + * [Matrix3](class_matrix3) **rotated** **(** [Vector3](class_vector3) axis, [real](class_real) phi **)** Return the rotated version of the matrix, by a given axis and angle. #### scaled - * [Matrix3](class_matrix3) **`scaled`** **(** [Vector3](class_vector3) scale **)** + * [Matrix3](class_matrix3) **scaled** **(** [Vector3](class_vector3) scale **)** Return the scaled version of the matrix, by a 3D scale. #### tdotx - * [real](class_real) **`tdotx`** **(** [Vector3](class_vector3) with **)** + * [real](class_real) **tdotx** **(** [Vector3](class_vector3) with **)** Transposed dot product with the x axis of the matrix. #### tdoty - * [real](class_real) **`tdoty`** **(** [Vector3](class_vector3) with **)** + * [real](class_real) **tdoty** **(** [Vector3](class_vector3) with **)** Transposed dot product with the y axis of the matrix. #### tdotz - * [real](class_real) **`tdotz`** **(** [Vector3](class_vector3) with **)** + * [real](class_real) **tdotz** **(** [Vector3](class_vector3) with **)** Transposed dot product with the z axis of the matrix. #### transposed - * [Matrix3](class_matrix3) **`transposed`** **(** **)** + * [Matrix3](class_matrix3) **transposed** **(** **)** Return the transposed version of the matrix. #### xform - * [Vector3](class_vector3) **`xform`** **(** [Vector3](class_vector3) v **)** + * [Vector3](class_vector3) **xform** **(** [Vector3](class_vector3) v **)** Return a vector transformed by the matrix and return it. #### xform_inv - * [Vector3](class_vector3) **`xform_inv`** **(** [Vector3](class_vector3) v **)** + * [Vector3](class_vector3) **xform_inv** **(** [Vector3](class_vector3) v **)** Return a vector transformed by the transposed matrix and return it. #### Matrix3 - * void **`Matrix3`** **(** [Vector3](class_vector3) x_axis, [Vector3](class_vector3) y_axis, [Vector3](class_vector3) z_axis **)** + * void **Matrix3** **(** [Vector3](class_vector3) x_axis, [Vector3](class_vector3) y_axis, [Vector3](class_vector3) z_axis **)** Create a matrix from 3 axis vectors. #### Matrix3 - * void **`Matrix3`** **(** [Vector3](class_vector3) axis, [real](class_real) phi **)** + * void **Matrix3** **(** [Vector3](class_vector3) axis, [real](class_real) phi **)** Create a matrix from 3 axis vectors. #### Matrix3 - * void **`Matrix3`** **(** [Quat](class_quat) from **)** + * void **Matrix3** **(** [Quat](class_quat) from **)** Create a matrix from 3 axis vectors. diff --git a/class_matrix32.md b/class_matrix32.md index fa22985..98b9353 100644 --- a/class_matrix32.md +++ b/class_matrix32.md @@ -5,18 +5,18 @@ 3x2 Matrix for 2D transforms. ### Member Functions - * [Matrix32](class_matrix32) **[`affine_inverse`](#affine_inverse)** **(** **)** - * [Vector2](class_vector2) **[`get_origin`](#get_origin)** **(** **)** - * [real](class_real) **[`get_rotation`](#get_rotation)** **(** **)** - * [Matrix32](class_matrix32) **[`interpolate_with`](#interpolate_with)** **(** [Matrix32](class_matrix32) m, [real](class_real) c **)** - * [Matrix32](class_matrix32) **[`inverse`](#inverse)** **(** **)** - * [Matrix32](class_matrix32) **[`orthonormalized`](#orthonormalized)** **(** **)** - * [Matrix32](class_matrix32) **[`rotated`](#rotated)** **(** [real](class_real) phi **)** - * [Matrix32](class_matrix32) **[`scaled`](#scaled)** **(** [Vector2](class_vector2) scale **)** - * [Matrix32](class_matrix32) **[`translated`](#translated)** **(** [Vector2](class_vector2) offset **)** - * [Matrix32](class_matrix32) **[`xform`](#xform)** **(** var v **)** - * [Matrix32](class_matrix32) **[`xform_inv`](#xform_inv)** **(** var v **)** - * void **[`Matrix32`](#Matrix32)** **(** [Vector2](class_vector2) x_axis, [Vector2](class_vector2) y_axis, [Vector2](class_vector2) origin **)** + * [Matrix32](class_matrix32) **[affine_inverse](#affine_inverse)** **(** **)** + * [Vector2](class_vector2) **[get_origin](#get_origin)** **(** **)** + * [real](class_real) **[get_rotation](#get_rotation)** **(** **)** + * [Matrix32](class_matrix32) **[interpolate_with](#interpolate_with)** **(** [Matrix32](class_matrix32) m, [real](class_real) c **)** + * [Matrix32](class_matrix32) **[inverse](#inverse)** **(** **)** + * [Matrix32](class_matrix32) **[orthonormalized](#orthonormalized)** **(** **)** + * [Matrix32](class_matrix32) **[rotated](#rotated)** **(** [real](class_real) phi **)** + * [Matrix32](class_matrix32) **[scaled](#scaled)** **(** [Vector2](class_vector2) scale **)** + * [Matrix32](class_matrix32) **[translated](#translated)** **(** [Vector2](class_vector2) offset **)** + * [Matrix32](class_matrix32) **[xform](#xform)** **(** var v **)** + * [Matrix32](class_matrix32) **[xform_inv](#xform_inv)** **(** var v **)** + * void **[Matrix32](#Matrix32)** **(** [Vector2](class_vector2) x_axis, [Vector2](class_vector2) y_axis, [Vector2](class_vector2) origin **)** ### Member Variables * [real](class_real) **x** diff --git a/class_menubutton.md b/class_menubutton.md index ffd3491..ed58740 100644 --- a/class_menubutton.md +++ b/class_menubutton.md @@ -6,10 +6,10 @@ Special button that brings up a [PopupMenu](class_popupmenu) when clicked. ### Member Functions - * [Object](class_object) **[`get_popup`](#get_popup)** **(** **)** + * [Object](class_object) **[get_popup](#get_popup)** **(** **)** ### Signals - * **`about_to_show`** **(** **)** + * **about_to_show** **(** **)** ### Description Special button that brings up a [PopupMenu](class_popupmenu) when clicked. That's pretty much all it does, as it's just a helper class when bulding GUIs. @@ -17,6 +17,6 @@ Special button that brings up a [PopupMenu](class_popupmenu) when clicked. That' ### Member Function Description #### get_popup - * [Object](class_object) **`get_popup`** **(** **)** + * [Object](class_object) **get_popup** **(** **)** Return the [PopupMenu](class_popupmenu) contained in this button. diff --git a/class_mesh.md b/class_mesh.md index fefe7dc..1828579 100644 --- a/class_mesh.md +++ b/class_mesh.md @@ -6,24 +6,24 @@ A [Resource](class_resource) that contains vertex-array based geometry. ### Member Functions - * void **[`add_morph_target`](#add_morph_target)** **(** [String](class_string) name **)** - * [int](class_int) **[`get_morph_target_count`](#get_morph_target_count)** **(** **)** const - * [String](class_string) **[`get_morph_target_name`](#get_morph_target_name)** **(** [int](class_int) index **)** const - * void **[`clear_morph_targets`](#clear_morph_targets)** **(** **)** - * void **[`set_morph_target_mode`](#set_morph_target_mode)** **(** [int](class_int) mode **)** - * [int](class_int) **[`get_morph_target_mode`](#get_morph_target_mode)** **(** **)** const - * void **[`add_surface`](#add_surface)** **(** [int](class_int) primitive, [Array](class_array) arrays, [Array](class_array) morph_arrays, [bool](class_bool) arg3=Array() **)** - * [int](class_int) **[`get_surface_count`](#get_surface_count)** **(** **)** const - * void **[`surface_remove`](#surface_remove)** **(** [int](class_int) surf_idx **)** - * [int](class_int) **[`surface_get_array_len`](#surface_get_array_len)** **(** [int](class_int) surf_idx **)** const - * [int](class_int) **[`surface_get_array_index_len`](#surface_get_array_index_len)** **(** [int](class_int) surf_idx **)** const - * [int](class_int) **[`surface_get_format`](#surface_get_format)** **(** [int](class_int) surf_idx **)** const - * [int](class_int) **[`surface_get_primitive_type`](#surface_get_primitive_type)** **(** [int](class_int) surf_idx **)** const - * void **[`surface_set_material`](#surface_set_material)** **(** [int](class_int) surf_idx, [Material](class_material) material **)** - * [Material](class_material) **[`surface_get_material`](#surface_get_material)** **(** [int](class_int) surf_idx **)** const - * void **[`surface_set_name`](#surface_set_name)** **(** [int](class_int) surf_idx, [String](class_string) name **)** - * [String](class_string) **[`surface_get_name`](#surface_get_name)** **(** [int](class_int) surf_idx **)** const - * void **[`center_geometry`](#center_geometry)** **(** **)** + * void **[add_morph_target](#add_morph_target)** **(** [String](class_string) name **)** + * [int](class_int) **[get_morph_target_count](#get_morph_target_count)** **(** **)** const + * [String](class_string) **[get_morph_target_name](#get_morph_target_name)** **(** [int](class_int) index **)** const + * void **[clear_morph_targets](#clear_morph_targets)** **(** **)** + * void **[set_morph_target_mode](#set_morph_target_mode)** **(** [int](class_int) mode **)** + * [int](class_int) **[get_morph_target_mode](#get_morph_target_mode)** **(** **)** const + * void **[add_surface](#add_surface)** **(** [int](class_int) primitive, [Array](class_array) arrays, [Array](class_array) morph_arrays, [bool](class_bool) arg3=Array() **)** + * [int](class_int) **[get_surface_count](#get_surface_count)** **(** **)** const + * void **[surface_remove](#surface_remove)** **(** [int](class_int) surf_idx **)** + * [int](class_int) **[surface_get_array_len](#surface_get_array_len)** **(** [int](class_int) surf_idx **)** const + * [int](class_int) **[surface_get_array_index_len](#surface_get_array_index_len)** **(** [int](class_int) surf_idx **)** const + * [int](class_int) **[surface_get_format](#surface_get_format)** **(** [int](class_int) surf_idx **)** const + * [int](class_int) **[surface_get_primitive_type](#surface_get_primitive_type)** **(** [int](class_int) surf_idx **)** const + * void **[surface_set_material](#surface_set_material)** **(** [int](class_int) surf_idx, [Material](class_material) material **)** + * [Material](class_material) **[surface_get_material](#surface_get_material)** **(** [int](class_int) surf_idx **)** const + * void **[surface_set_name](#surface_set_name)** **(** [int](class_int) surf_idx, [String](class_string) name **)** + * [String](class_string) **[surface_get_name](#surface_get_name)** **(** [int](class_int) surf_idx **)** const + * void **[center_geometry](#center_geometry)** **(** **)** ### Numeric Constants * **NO_INDEX_ARRAY** = **-1** - Default value used for index_array_len when no indices are present. @@ -60,48 +60,48 @@ Mesh is a type of [Resource](class_resource) that contains vertex-array based ge ### Member Function Description #### add_surface - * void **`add_surface`** **(** [int](class_int) primitive, [Array](class_array) arrays, [Array](class_array) morph_arrays, [bool](class_bool) arg3=Array() **)** + * void **add_surface** **(** [int](class_int) primitive, [Array](class_array) arrays, [Array](class_array) morph_arrays, [bool](class_bool) arg3=Array() **)** -Create a new surface ([`get_surface_count`](#get_surface_count) will become surf_idx for this. +Create a new surface ([get_surface_count](#get_surface_count) will become surf_idx for this. "#10;"#9;"#9;"#9;Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_POINTS, PRIMITIVE_LINES, PRIMITIVE_LINE_STRIP, PRIMITIVE_LINE_LOOP, PRIMITIVE_TRIANGLES, PRIMITIVE_TRIANGLE_STRIP, PRIMITIVE_TRIANGLE_FAN. (As a note, when using indices, it is recommended to only use just points, lines or triangles). "#10;"#9;"#9;"#9;The format of a surface determines which arrays it will allocate and hold, so "format" is a combination of ARRAY_FORMAT_* mask constants ORed together. ARRAY_FORMAT_VERTEX must be always present. "array_len" determines the amount of vertices in the array (not primitives!). if ARRAY_FORMAT_INDEX is in the format mask, then it means that an index array will be allocated and "index_array_len" must be passed. #### get_surface_count - * [int](class_int) **`get_surface_count`** **(** **)** const + * [int](class_int) **get_surface_count** **(** **)** const Return the amount of surfaces that the [Mesh](class_mesh) holds. #### surface_remove - * void **`surface_remove`** **(** [int](class_int) surf_idx **)** + * void **surface_remove** **(** [int](class_int) surf_idx **)** Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down. #### surface_get_array_len - * [int](class_int) **`surface_get_array_len`** **(** [int](class_int) surf_idx **)** const + * [int](class_int) **surface_get_array_len** **(** [int](class_int) surf_idx **)** const -Return the length in vertices of the vertex array in the requested surface (see [`add_surface`](#add_surface)). +Return the length in vertices of the vertex array in the requested surface (see [add_surface](#add_surface)). #### surface_get_array_index_len - * [int](class_int) **`surface_get_array_index_len`** **(** [int](class_int) surf_idx **)** const + * [int](class_int) **surface_get_array_index_len** **(** [int](class_int) surf_idx **)** const -Return the length in indices of the index array in the requested surface (see [`add_surface`](#add_surface)). +Return the length in indices of the index array in the requested surface (see [add_surface](#add_surface)). #### surface_get_format - * [int](class_int) **`surface_get_format`** **(** [int](class_int) surf_idx **)** const + * [int](class_int) **surface_get_format** **(** [int](class_int) surf_idx **)** const -Return the format mask of the requested surface (see [`add_surface`](#add_surface)). +Return the format mask of the requested surface (see [add_surface](#add_surface)). #### surface_get_primitive_type - * [int](class_int) **`surface_get_primitive_type`** **(** [int](class_int) surf_idx **)** const + * [int](class_int) **surface_get_primitive_type** **(** [int](class_int) surf_idx **)** const -Return the primitive type of the requested surface (see [`add_surface`](#add_surface)). +Return the primitive type of the requested surface (see [add_surface](#add_surface)). #### surface_set_material - * void **`surface_set_material`** **(** [int](class_int) surf_idx, [Material](class_material) material **)** + * void **surface_set_material** **(** [int](class_int) surf_idx, [Material](class_material) material **)** Set a [Material](class_material) for a given surface. Surface will be rendered using this material. #### surface_get_material - * [Material](class_material) **`surface_get_material`** **(** [int](class_int) surf_idx **)** const + * [Material](class_material) **surface_get_material** **(** [int](class_int) surf_idx **)** const Return a [Material](class_material) in a given surface. Surface is rendered using this material. diff --git a/class_meshdatatool.md b/class_meshdatatool.md index 3e824d9..9f9c9ca 100644 --- a/class_meshdatatool.md +++ b/class_meshdatatool.md @@ -6,43 +6,43 @@ ### Member Functions - * void **[`clear`](#clear)** **(** **)** - * [int](class_int) **[`create_from_surface`](#create_from_surface)** **(** [Object](class_object) mesh, [int](class_int) surface **)** - * [int](class_int) **[`commit_to_surface`](#commit_to_surface)** **(** [Object](class_object) mesh **)** - * [int](class_int) **[`get_format`](#get_format)** **(** **)** const - * [int](class_int) **[`get_vertex_count`](#get_vertex_count)** **(** **)** const - * [int](class_int) **[`get_edge_count`](#get_edge_count)** **(** **)** const - * [int](class_int) **[`get_face_count`](#get_face_count)** **(** **)** const - * void **[`set_vertex`](#set_vertex)** **(** [int](class_int) idx, [Vector3](class_vector3) vertex **)** - * [Vector3](class_vector3) **[`get_vertex`](#get_vertex)** **(** [int](class_int) idx **)** const - * void **[`set_vertex_normal`](#set_vertex_normal)** **(** [int](class_int) idx, [Vector3](class_vector3) normal **)** - * [Vector3](class_vector3) **[`get_vertex_normal`](#get_vertex_normal)** **(** [int](class_int) idx **)** const - * void **[`set_vertex_tangent`](#set_vertex_tangent)** **(** [int](class_int) idx, [Plane](class_plane) tangent **)** - * [Plane](class_plane) **[`get_vertex_tangent`](#get_vertex_tangent)** **(** [int](class_int) idx **)** const - * void **[`set_vertex_uv`](#set_vertex_uv)** **(** [int](class_int) idx, [Vector2](class_vector2) uv **)** - * [Vector2](class_vector2) **[`get_vertex_uv`](#get_vertex_uv)** **(** [int](class_int) idx **)** const - * void **[`set_vertex_uv2`](#set_vertex_uv2)** **(** [int](class_int) idx, [Vector2](class_vector2) uv2 **)** - * [Vector2](class_vector2) **[`get_vertex_uv2`](#get_vertex_uv2)** **(** [int](class_int) idx **)** const - * void **[`set_vertex_color`](#set_vertex_color)** **(** [int](class_int) idx, [Color](class_color) color **)** - * [Color](class_color) **[`get_vertex_color`](#get_vertex_color)** **(** [int](class_int) idx **)** const - * void **[`set_vertex_bones`](#set_vertex_bones)** **(** [int](class_int) idx, [IntArray](class_intarray) bones **)** - * [IntArray](class_intarray) **[`get_vertex_bones`](#get_vertex_bones)** **(** [int](class_int) idx **)** const - * void **[`set_vertex_weights`](#set_vertex_weights)** **(** [int](class_int) idx, [RealArray](class_realarray) weights **)** - * [RealArray](class_realarray) **[`get_vertex_weights`](#get_vertex_weights)** **(** [int](class_int) idx **)** const - * void **[`set_vertex_meta`](#set_vertex_meta)** **(** [int](class_int) idx, var meta **)** - * void **[`get_vertex_meta`](#get_vertex_meta)** **(** [int](class_int) idx **)** const - * [IntArray](class_intarray) **[`get_vertex_edges`](#get_vertex_edges)** **(** [int](class_int) idx **)** const - * [IntArray](class_intarray) **[`get_vertex_faces`](#get_vertex_faces)** **(** [int](class_int) idx **)** const - * [int](class_int) **[`get_edge_vertex`](#get_edge_vertex)** **(** [int](class_int) idx, [int](class_int) vertex **)** const - * [IntArray](class_intarray) **[`get_edge_faces`](#get_edge_faces)** **(** [int](class_int) idx **)** const - * void **[`set_edge_meta`](#set_edge_meta)** **(** [int](class_int) idx, var meta **)** - * void **[`get_edge_meta`](#get_edge_meta)** **(** [int](class_int) idx **)** const - * [int](class_int) **[`get_face_vertex`](#get_face_vertex)** **(** [int](class_int) idx, [int](class_int) vertex **)** const - * [int](class_int) **[`get_face_edge`](#get_face_edge)** **(** [int](class_int) idx, [int](class_int) edge **)** const - * void **[`set_face_meta`](#set_face_meta)** **(** [int](class_int) idx, var meta **)** - * void **[`get_face_meta`](#get_face_meta)** **(** [int](class_int) idx **)** const - * [Vector3](class_vector3) **[`get_face_normal`](#get_face_normal)** **(** [int](class_int) idx **)** const - * void **[`set_material`](#set_material)** **(** [Material](class_material) material **)** - * [Object](class_object) **[`get_material`](#get_material)** **(** **)** const + * void **[clear](#clear)** **(** **)** + * [int](class_int) **[create_from_surface](#create_from_surface)** **(** [Object](class_object) mesh, [int](class_int) surface **)** + * [int](class_int) **[commit_to_surface](#commit_to_surface)** **(** [Object](class_object) mesh **)** + * [int](class_int) **[get_format](#get_format)** **(** **)** const + * [int](class_int) **[get_vertex_count](#get_vertex_count)** **(** **)** const + * [int](class_int) **[get_edge_count](#get_edge_count)** **(** **)** const + * [int](class_int) **[get_face_count](#get_face_count)** **(** **)** const + * void **[set_vertex](#set_vertex)** **(** [int](class_int) idx, [Vector3](class_vector3) vertex **)** + * [Vector3](class_vector3) **[get_vertex](#get_vertex)** **(** [int](class_int) idx **)** const + * void **[set_vertex_normal](#set_vertex_normal)** **(** [int](class_int) idx, [Vector3](class_vector3) normal **)** + * [Vector3](class_vector3) **[get_vertex_normal](#get_vertex_normal)** **(** [int](class_int) idx **)** const + * void **[set_vertex_tangent](#set_vertex_tangent)** **(** [int](class_int) idx, [Plane](class_plane) tangent **)** + * [Plane](class_plane) **[get_vertex_tangent](#get_vertex_tangent)** **(** [int](class_int) idx **)** const + * void **[set_vertex_uv](#set_vertex_uv)** **(** [int](class_int) idx, [Vector2](class_vector2) uv **)** + * [Vector2](class_vector2) **[get_vertex_uv](#get_vertex_uv)** **(** [int](class_int) idx **)** const + * void **[set_vertex_uv2](#set_vertex_uv2)** **(** [int](class_int) idx, [Vector2](class_vector2) uv2 **)** + * [Vector2](class_vector2) **[get_vertex_uv2](#get_vertex_uv2)** **(** [int](class_int) idx **)** const + * void **[set_vertex_color](#set_vertex_color)** **(** [int](class_int) idx, [Color](class_color) color **)** + * [Color](class_color) **[get_vertex_color](#get_vertex_color)** **(** [int](class_int) idx **)** const + * void **[set_vertex_bones](#set_vertex_bones)** **(** [int](class_int) idx, [IntArray](class_intarray) bones **)** + * [IntArray](class_intarray) **[get_vertex_bones](#get_vertex_bones)** **(** [int](class_int) idx **)** const + * void **[set_vertex_weights](#set_vertex_weights)** **(** [int](class_int) idx, [RealArray](class_realarray) weights **)** + * [RealArray](class_realarray) **[get_vertex_weights](#get_vertex_weights)** **(** [int](class_int) idx **)** const + * void **[set_vertex_meta](#set_vertex_meta)** **(** [int](class_int) idx, var meta **)** + * void **[get_vertex_meta](#get_vertex_meta)** **(** [int](class_int) idx **)** const + * [IntArray](class_intarray) **[get_vertex_edges](#get_vertex_edges)** **(** [int](class_int) idx **)** const + * [IntArray](class_intarray) **[get_vertex_faces](#get_vertex_faces)** **(** [int](class_int) idx **)** const + * [int](class_int) **[get_edge_vertex](#get_edge_vertex)** **(** [int](class_int) idx, [int](class_int) vertex **)** const + * [IntArray](class_intarray) **[get_edge_faces](#get_edge_faces)** **(** [int](class_int) idx **)** const + * void **[set_edge_meta](#set_edge_meta)** **(** [int](class_int) idx, var meta **)** + * void **[get_edge_meta](#get_edge_meta)** **(** [int](class_int) idx **)** const + * [int](class_int) **[get_face_vertex](#get_face_vertex)** **(** [int](class_int) idx, [int](class_int) vertex **)** const + * [int](class_int) **[get_face_edge](#get_face_edge)** **(** [int](class_int) idx, [int](class_int) edge **)** const + * void **[set_face_meta](#set_face_meta)** **(** [int](class_int) idx, var meta **)** + * void **[get_face_meta](#get_face_meta)** **(** [int](class_int) idx **)** const + * [Vector3](class_vector3) **[get_face_normal](#get_face_normal)** **(** [int](class_int) idx **)** const + * void **[set_material](#set_material)** **(** [Material](class_material) material **)** + * [Object](class_object) **[get_material](#get_material)** **(** **)** const ### Member Function Description diff --git a/class_meshinstance.md b/class_meshinstance.md index acbfab4..1225b71 100644 --- a/class_meshinstance.md +++ b/class_meshinstance.md @@ -6,11 +6,11 @@ Node that instances meshes into a [Scenario]. ### Member Functions - * void **[`set_mesh`](#set_mesh)** **(** [Mesh](class_mesh) mesh **)** - * [Mesh](class_mesh) **[`get_mesh`](#get_mesh)** **(** **)** const - * [AABB](class_aabb) **[`get_aabb`](#get_aabb)** **(** **)** const - * void **[`create_trimesh_collision`](#create_trimesh_collision)** **(** **)** - * void **[`create_convex_collision`](#create_convex_collision)** **(** **)** + * void **[set_mesh](#set_mesh)** **(** [Mesh](class_mesh) mesh **)** + * [Mesh](class_mesh) **[get_mesh](#get_mesh)** **(** **)** const + * [AABB](class_aabb) **[get_aabb](#get_aabb)** **(** **)** const + * void **[create_trimesh_collision](#create_trimesh_collision)** **(** **)** + * void **[create_convex_collision](#create_convex_collision)** **(** **)** ### Description MeshInstance is a [Node](class_node) that takes a [Mesh](class_mesh) resource and adds it to the current [Scenario] by creating an instance of it. This is the class most often used to get 3D geometry rendered and can be used to instance a sigle [Mesh](class_mesh) in many places. This allows to reuse geometry and save on resources. When a [Mesh](class_mesh) has to be instanced more than thousands of times at close proximity, consider using a [MultiMesh](class_multimesh) in a [MultiMeshInstance](class_multimeshinstance) instead. @@ -18,21 +18,21 @@ MeshInstance is a [Node](class_node) that takes a [Mesh](class_mesh) resource an ### Member Function Description #### set_mesh - * void **`set_mesh`** **(** [Mesh](class_mesh) mesh **)** + * void **set_mesh** **(** [Mesh](class_mesh) mesh **)** Set the [Mesh](class_mesh) resource for the instance. #### get_mesh - * [Mesh](class_mesh) **`get_mesh`** **(** **)** const + * [Mesh](class_mesh) **get_mesh** **(** **)** const Return the current [Mesh](class_mesh) resource for the instance. #### get_aabb - * [AABB](class_aabb) **`get_aabb`** **(** **)** const + * [AABB](class_aabb) **get_aabb** **(** **)** const Return the AABB of the mesh, in local coordinates. #### create_trimesh_collision - * void **`create_trimesh_collision`** **(** **)** + * void **create_trimesh_collision** **(** **)** This helper creates a [StaticBody](class_staticbody) child [Node](class_node) using the mesh geometry as collision. It"apos;s mainly used for testing. diff --git a/class_meshlibrary.md b/class_meshlibrary.md index 1360ece..cdd4ad1 100644 --- a/class_meshlibrary.md +++ b/class_meshlibrary.md @@ -6,17 +6,17 @@ Library of meshes. ### Member Functions - * void **[`create_item`](#create_item)** **(** [int](class_int) id **)** - * void **[`set_item_name`](#set_item_name)** **(** [int](class_int) id, [String](class_string) name **)** - * void **[`set_item_mesh`](#set_item_mesh)** **(** [int](class_int) id, [Mesh](class_mesh) mesh **)** - * void **[`set_item_shape`](#set_item_shape)** **(** [int](class_int) id, [Shape](class_shape) shape **)** - * [String](class_string) **[`get_item_name`](#get_item_name)** **(** [int](class_int) id **)** const - * [Mesh](class_mesh) **[`get_item_mesh`](#get_item_mesh)** **(** [int](class_int) id **)** const - * [Shape](class_shape) **[`get_item_shape`](#get_item_shape)** **(** [int](class_int) id **)** const - * void **[`remove_item`](#remove_item)** **(** [int](class_int) id **)** - * void **[`clear`](#clear)** **(** **)** - * [IntArray](class_intarray) **[`get_item_list`](#get_item_list)** **(** **)** const - * [int](class_int) **[`get_last_unused_item_id`](#get_last_unused_item_id)** **(** **)** const + * void **[create_item](#create_item)** **(** [int](class_int) id **)** + * void **[set_item_name](#set_item_name)** **(** [int](class_int) id, [String](class_string) name **)** + * void **[set_item_mesh](#set_item_mesh)** **(** [int](class_int) id, [Mesh](class_mesh) mesh **)** + * void **[set_item_shape](#set_item_shape)** **(** [int](class_int) id, [Shape](class_shape) shape **)** + * [String](class_string) **[get_item_name](#get_item_name)** **(** [int](class_int) id **)** const + * [Mesh](class_mesh) **[get_item_mesh](#get_item_mesh)** **(** [int](class_int) id **)** const + * [Shape](class_shape) **[get_item_shape](#get_item_shape)** **(** [int](class_int) id **)** const + * void **[remove_item](#remove_item)** **(** [int](class_int) id **)** + * void **[clear](#clear)** **(** **)** + * [IntArray](class_intarray) **[get_item_list](#get_item_list)** **(** **)** const + * [int](class_int) **[get_last_unused_item_id](#get_last_unused_item_id)** **(** **)** const ### Description Library of meshes. Contains a list of [Mesh](class_mesh) resources, each with name and ID. Useful for GridMap or painting Terrain. @@ -24,46 +24,46 @@ Library of meshes. Contains a list of [Mesh](class_mesh) resources, each with na ### Member Function Description #### create_item - * void **`create_item`** **(** [int](class_int) id **)** + * void **create_item** **(** [int](class_int) id **)** Create a new item in the library, supplied an id. #### set_item_name - * void **`set_item_name`** **(** [int](class_int) id, [String](class_string) name **)** + * void **set_item_name** **(** [int](class_int) id, [String](class_string) name **)** Set the name of the item. #### set_item_mesh - * void **`set_item_mesh`** **(** [int](class_int) id, [Mesh](class_mesh) mesh **)** + * void **set_item_mesh** **(** [int](class_int) id, [Mesh](class_mesh) mesh **)** Set the mesh of the item. #### get_item_name - * [String](class_string) **`get_item_name`** **(** [int](class_int) id **)** const + * [String](class_string) **get_item_name** **(** [int](class_int) id **)** const Return the name of the item. #### get_item_mesh - * [Mesh](class_mesh) **`get_item_mesh`** **(** [int](class_int) id **)** const + * [Mesh](class_mesh) **get_item_mesh** **(** [int](class_int) id **)** const Return the mesh of the item. #### remove_item - * void **`remove_item`** **(** [int](class_int) id **)** + * void **remove_item** **(** [int](class_int) id **)** Remove the item. #### clear - * void **`clear`** **(** **)** + * void **clear** **(** **)** Clear the library. #### get_item_list - * [IntArray](class_intarray) **`get_item_list`** **(** **)** const + * [IntArray](class_intarray) **get_item_list** **(** **)** const Return the list of items. #### get_last_unused_item_id - * [int](class_int) **`get_last_unused_item_id`** **(** **)** const + * [int](class_int) **get_last_unused_item_id** **(** **)** const Get an unused id for a new item. diff --git a/class_multimesh.md b/class_multimesh.md index 9a3f9be..a0f3990 100644 --- a/class_multimesh.md +++ b/class_multimesh.md @@ -6,77 +6,77 @@ Provides high perfomance mesh instancing. ### Member Functions - * void **[`set_mesh`](#set_mesh)** **(** [Mesh](class_mesh) mesh **)** - * [Mesh](class_mesh) **[`get_mesh`](#get_mesh)** **(** **)** const - * void **[`set_instance_count`](#set_instance_count)** **(** [int](class_int) arg0 **)** - * [int](class_int) **[`get_instance_count`](#get_instance_count)** **(** **)** const - * void **[`set_instance_transform`](#set_instance_transform)** **(** [int](class_int) arg0, [Transform](class_transform) arg1 **)** - * [Transform](class_transform) **[`get_instance_transform`](#get_instance_transform)** **(** [int](class_int) arg0 **)** const - * void **[`set_instance_color`](#set_instance_color)** **(** [int](class_int) arg0, [Color](class_color) arg1 **)** - * [Color](class_color) **[`get_instance_color`](#get_instance_color)** **(** [int](class_int) arg0 **)** const - * void **[`set_aabb`](#set_aabb)** **(** [AABB](class_aabb) arg0 **)** - * [AABB](class_aabb) **[`get_aabb`](#get_aabb)** **(** **)** const - * void **[`generate_aabb`](#generate_aabb)** **(** **)** + * void **[set_mesh](#set_mesh)** **(** [Mesh](class_mesh) mesh **)** + * [Mesh](class_mesh) **[get_mesh](#get_mesh)** **(** **)** const + * void **[set_instance_count](#set_instance_count)** **(** [int](class_int) arg0 **)** + * [int](class_int) **[get_instance_count](#get_instance_count)** **(** **)** const + * void **[set_instance_transform](#set_instance_transform)** **(** [int](class_int) arg0, [Transform](class_transform) arg1 **)** + * [Transform](class_transform) **[get_instance_transform](#get_instance_transform)** **(** [int](class_int) arg0 **)** const + * void **[set_instance_color](#set_instance_color)** **(** [int](class_int) arg0, [Color](class_color) arg1 **)** + * [Color](class_color) **[get_instance_color](#get_instance_color)** **(** [int](class_int) arg0 **)** const + * void **[set_aabb](#set_aabb)** **(** [AABB](class_aabb) arg0 **)** + * [AABB](class_aabb) **[get_aabb](#get_aabb)** **(** **)** const + * void **[generate_aabb](#generate_aabb)** **(** **)** ### Description MultiMesh provides low level mesh instancing. If the amount of [Mesh](class_mesh) instances needed goes from hundreds to thousands (and most need to be visible at close proximity) creating such a large amount of [MeshInstance](class_meshinstance) nodes may affect performance by using too much CPU or video memory. For this case a MultiMesh becomes very useful, as it can draw thousands of instances with little API overhead. As a drawback, if the instances are too far away of each other, performance may be reduced as every sigle instance will always rendered (they are spatially indexed as one, for the whole object). - Since instances may have any behavior, the AABB used for visibility must be provided by the user, or generated with [`generate_aabb`](#generate_aabb). + Since instances may have any behavior, the AABB used for visibility must be provided by the user, or generated with [generate_aabb](#generate_aabb). ### Member Function Description #### set_mesh - * void **`set_mesh`** **(** [Mesh](class_mesh) mesh **)** + * void **set_mesh** **(** [Mesh](class_mesh) mesh **)** Set the [Mesh](class_mesh) resource to be drawn in multiple instances. #### get_mesh - * [Mesh](class_mesh) **`get_mesh`** **(** **)** const + * [Mesh](class_mesh) **get_mesh** **(** **)** const Return the [Mesh](class_mesh) resource drawn as multiple instances. #### set_instance_count - * void **`set_instance_count`** **(** [int](class_int) arg0 **)** + * void **set_instance_count** **(** [int](class_int) arg0 **)** Set the amount of instnces that is going to be drawn. Changing this number will erase all the existing instance transform and color data. #### get_instance_count - * [int](class_int) **`get_instance_count`** **(** **)** const + * [int](class_int) **get_instance_count** **(** **)** const Return the amount of instnces that is going to be drawn. #### set_instance_transform - * void **`set_instance_transform`** **(** [int](class_int) arg0, [Transform](class_transform) arg1 **)** + * void **set_instance_transform** **(** [int](class_int) arg0, [Transform](class_transform) arg1 **)** Set the transform for a specific instance. #### get_instance_transform - * [Transform](class_transform) **`get_instance_transform`** **(** [int](class_int) arg0 **)** const + * [Transform](class_transform) **get_instance_transform** **(** [int](class_int) arg0 **)** const Return the transform of a specific instance. #### set_instance_color - * void **`set_instance_color`** **(** [int](class_int) arg0, [Color](class_color) arg1 **)** + * void **set_instance_color** **(** [int](class_int) arg0, [Color](class_color) arg1 **)** Set the color of a specific instance. #### get_instance_color - * [Color](class_color) **`get_instance_color`** **(** [int](class_int) arg0 **)** const + * [Color](class_color) **get_instance_color** **(** [int](class_int) arg0 **)** const Get the color of a specific instance. #### set_aabb - * void **`set_aabb`** **(** [AABB](class_aabb) arg0 **)** + * void **set_aabb** **(** [AABB](class_aabb) arg0 **)** Set the visibility AABB. If not provided, MultiMesh will not be visible. #### get_aabb - * [AABB](class_aabb) **`get_aabb`** **(** **)** const + * [AABB](class_aabb) **get_aabb** **(** **)** const Return the visibility AABB. #### generate_aabb - * void **`generate_aabb`** **(** **)** + * void **generate_aabb** **(** **)** Generate a new visibility AABB, using mesh AABB and instance transforms. Since instance information is stored in the [VisualServer](class_visualserver), this function is VERY SLOW and must NOT be used often. diff --git a/class_multimeshinstance.md b/class_multimeshinstance.md index cbc0949..8607ab7 100644 --- a/class_multimeshinstance.md +++ b/class_multimeshinstance.md @@ -6,8 +6,8 @@ Node that instances a [MultiMesh](class_multimesh). ### Member Functions - * void **[`set_multimesh`](#set_multimesh)** **(** [Object](class_object) multimesh **)** - * [Object](class_object) **[`get_multimesh`](#get_multimesh)** **(** **)** const + * void **[set_multimesh](#set_multimesh)** **(** [Object](class_object) multimesh **)** + * [Object](class_object) **[get_multimesh](#get_multimesh)** **(** **)** const ### Description MultiMeshInstance is a [Node](class_node) that takes a [MultiMesh](class_multimesh) resource and adds it to the current [Scenario] by creating an instance of it (yes, this is an instance of instances). @@ -15,11 +15,11 @@ MultiMeshInstance is a [Node](class_node) that takes a [MultiMesh](class_multime ### Member Function Description #### set_multimesh - * void **`set_multimesh`** **(** [Object](class_object) multimesh **)** + * void **set_multimesh** **(** [Object](class_object) multimesh **)** Set the [MultiMesh](class_multimesh) to be instance. #### get_multimesh - * [Object](class_object) **`get_multimesh`** **(** **)** const + * [Object](class_object) **get_multimesh** **(** **)** const Return the [MultiMesh](class_multimesh) that is used for instancing. diff --git a/class_mutex.md b/class_mutex.md index 99870d3..f3a0357 100644 --- a/class_mutex.md +++ b/class_mutex.md @@ -6,8 +6,8 @@ ### Member Functions - * void **[`lock`](#lock)** **(** **)** - * [int](class_int) **[`try_lock`](#try_lock)** **(** **)** - * void **[`unlock`](#unlock)** **(** **)** + * void **[lock](#lock)** **(** **)** + * [int](class_int) **[try_lock](#try_lock)** **(** **)** + * void **[unlock](#unlock)** **(** **)** ### Member Function Description diff --git a/class_nil.md b/class_nil.md index 436905d..3c6da31 100644 --- a/class_nil.md +++ b/class_nil.md @@ -5,33 +5,33 @@ ### Member Functions - * void **[`Nil`](#Nil)** **(** [bool](class_bool) from **)** - * void **[`Nil`](#Nil)** **(** [int](class_int) from **)** - * void **[`Nil`](#Nil)** **(** [real](class_real) from **)** - * void **[`Nil`](#Nil)** **(** [String](class_string) from **)** - * void **[`Nil`](#Nil)** **(** [Vector2](class_vector2) from **)** - * void **[`Nil`](#Nil)** **(** [Rect2](class_rect2) from **)** - * void **[`Nil`](#Nil)** **(** [Vector3](class_vector3) from **)** - * void **[`Nil`](#Nil)** **(** [Matrix32](class_matrix32) from **)** - * void **[`Nil`](#Nil)** **(** [Plane](class_plane) from **)** - * void **[`Nil`](#Nil)** **(** [Quat](class_quat) from **)** - * void **[`Nil`](#Nil)** **(** [AABB](class_aabb) from **)** - * void **[`Nil`](#Nil)** **(** [Matrix3](class_matrix3) from **)** - * void **[`Nil`](#Nil)** **(** [Transform](class_transform) from **)** - * void **[`Nil`](#Nil)** **(** [Color](class_color) from **)** - * void **[`Nil`](#Nil)** **(** [Image](class_image) from **)** - * void **[`Nil`](#Nil)** **(** [NodePath](class_nodepath) from **)** - * void **[`Nil`](#Nil)** **(** [RID](class_rid) from **)** - * void **[`Nil`](#Nil)** **(** [Object](class_object) from **)** - * void **[`Nil`](#Nil)** **(** [InputEvent](class_inputevent) from **)** - * void **[`Nil`](#Nil)** **(** [Dictionary](class_dictionary) from **)** - * void **[`Nil`](#Nil)** **(** [Array](class_array) from **)** - * void **[`Nil`](#Nil)** **(** [RawArray](class_rawarray) from **)** - * void **[`Nil`](#Nil)** **(** [IntArray](class_intarray) from **)** - * void **[`Nil`](#Nil)** **(** [RealArray](class_realarray) from **)** - * void **[`Nil`](#Nil)** **(** [StringArray](class_stringarray) from **)** - * void **[`Nil`](#Nil)** **(** [Vector2Array](class_vector2array) from **)** - * void **[`Nil`](#Nil)** **(** [Vector3Array](class_vector3array) from **)** - * void **[`Nil`](#Nil)** **(** [ColorArray](class_colorarray) from **)** + * void **[Nil](#Nil)** **(** [bool](class_bool) from **)** + * void **[Nil](#Nil)** **(** [int](class_int) from **)** + * void **[Nil](#Nil)** **(** [real](class_real) from **)** + * void **[Nil](#Nil)** **(** [String](class_string) from **)** + * void **[Nil](#Nil)** **(** [Vector2](class_vector2) from **)** + * void **[Nil](#Nil)** **(** [Rect2](class_rect2) from **)** + * void **[Nil](#Nil)** **(** [Vector3](class_vector3) from **)** + * void **[Nil](#Nil)** **(** [Matrix32](class_matrix32) from **)** + * void **[Nil](#Nil)** **(** [Plane](class_plane) from **)** + * void **[Nil](#Nil)** **(** [Quat](class_quat) from **)** + * void **[Nil](#Nil)** **(** [AABB](class_aabb) from **)** + * void **[Nil](#Nil)** **(** [Matrix3](class_matrix3) from **)** + * void **[Nil](#Nil)** **(** [Transform](class_transform) from **)** + * void **[Nil](#Nil)** **(** [Color](class_color) from **)** + * void **[Nil](#Nil)** **(** [Image](class_image) from **)** + * void **[Nil](#Nil)** **(** [NodePath](class_nodepath) from **)** + * void **[Nil](#Nil)** **(** [RID](class_rid) from **)** + * void **[Nil](#Nil)** **(** [Object](class_object) from **)** + * void **[Nil](#Nil)** **(** [InputEvent](class_inputevent) from **)** + * void **[Nil](#Nil)** **(** [Dictionary](class_dictionary) from **)** + * void **[Nil](#Nil)** **(** [Array](class_array) from **)** + * void **[Nil](#Nil)** **(** [RawArray](class_rawarray) from **)** + * void **[Nil](#Nil)** **(** [IntArray](class_intarray) from **)** + * void **[Nil](#Nil)** **(** [RealArray](class_realarray) from **)** + * void **[Nil](#Nil)** **(** [StringArray](class_stringarray) from **)** + * void **[Nil](#Nil)** **(** [Vector2Array](class_vector2array) from **)** + * void **[Nil](#Nil)** **(** [Vector3Array](class_vector3array) from **)** + * void **[Nil](#Nil)** **(** [ColorArray](class_colorarray) from **)** ### Member Function Description diff --git a/class_node.md b/class_node.md index ec6890c..5e8e75e 100644 --- a/class_node.md +++ b/class_node.md @@ -6,69 +6,69 @@ Base class for all the "Scene" elements. ### Member Functions - * void **[`_enter_scene`](#_enter_scene)** **(** **)** virtual - * void **[`_exit_scene`](#_exit_scene)** **(** **)** virtual - * void **[`_fixed_process`](#_fixed_process)** **(** [real](class_real) delta **)** virtual - * void **[`_input`](#_input)** **(** [InputEvent](class_inputevent) event **)** virtual - * void **[`_process`](#_process)** **(** [real](class_real) delta **)** virtual - * void **[`_ready`](#_ready)** **(** **)** virtual - * void **[`_unhandled_input`](#_unhandled_input)** **(** [InputEvent](class_inputevent) event **)** virtual - * void **[`_unhandled_key_input`](#_unhandled_key_input)** **(** [InputEvent](class_inputevent) key_event **)** virtual - * void **[`set_name`](#set_name)** **(** [String](class_string) name **)** - * [String](class_string) **[`get_name`](#get_name)** **(** **)** const - * void **[`add_child`](#add_child)** **(** [Node](class_node) node **)** - * void **[`remove_child`](#remove_child)** **(** [Node](class_node) node **)** - * void **[`remove_and_delete_child`](#remove_and_delete_child)** **(** [Node](class_node) node **)** - * [int](class_int) **[`get_child_count`](#get_child_count)** **(** **)** const - * [Array](class_array) **[`get_children`](#get_children)** **(** **)** const - * [Node](class_node) **[`get_child`](#get_child)** **(** [int](class_int) idx **)** const - * [bool](class_bool) **[`has_node`](#has_node)** **(** [NodePath](class_nodepath) path **)** const - * [Node](class_node) **[`get_node`](#get_node)** **(** [NodePath](class_nodepath) path **)** const - * Parent **[`get_parent`](#get_parent)** **(** **)** const - * [bool](class_bool) **[`has_node_and_resource`](#has_node_and_resource)** **(** [NodePath](class_nodepath) path **)** const - * [Array](class_array) **[`get_node_and_resource`](#get_node_and_resource)** **(** [NodePath](class_nodepath) path **)** - * [bool](class_bool) **[`is_inside_scene`](#is_inside_scene)** **(** **)** const - * [bool](class_bool) **[`is_a_parent_of`](#is_a_parent_of)** **(** [Node](class_node) node **)** const - * [bool](class_bool) **[`is_greater_than`](#is_greater_than)** **(** [Node](class_node) node **)** const - * [NodePath](class_nodepath) **[`get_path`](#get_path)** **(** **)** const - * [NodePath](class_nodepath) **[`get_path_to`](#get_path_to)** **(** [Node](class_node) node **)** const - * void **[`add_to_group`](#add_to_group)** **(** [String](class_string) group, [bool](class_bool) arg1=false **)** - * void **[`remove_from_group`](#remove_from_group)** **(** [String](class_string) group **)** - * [bool](class_bool) **[`is_in_group`](#is_in_group)** **(** [String](class_string) group **)** const - * void **[`move_child`](#move_child)** **(** [Node](class_node) child_node, [int](class_int) to_pos **)** - * void **[`raise`](#raise)** **(** **)** - * void **[`set_owner`](#set_owner)** **(** [Node](class_node) owner **)** - * [Node](class_node) **[`get_owner`](#get_owner)** **(** **)** const - * void **[`remove_and_skip`](#remove_and_skip)** **(** **)** - * [int](class_int) **[`get_index`](#get_index)** **(** **)** const - * void **[`print_tree`](#print_tree)** **(** **)** - * void **[`set_filename`](#set_filename)** **(** [String](class_string) filename **)** - * [String](class_string) **[`get_filename`](#get_filename)** **(** **)** const - * void **[`propagate_notification`](#propagate_notification)** **(** [int](class_int) what **)** - * void **[`set_fixed_process`](#set_fixed_process)** **(** [bool](class_bool) enable **)** - * [real](class_real) **[`get_fixed_process_delta_time`](#get_fixed_process_delta_time)** **(** **)** const - * [bool](class_bool) **[`is_fixed_processing`](#is_fixed_processing)** **(** **)** const - * void **[`set_process`](#set_process)** **(** [bool](class_bool) enable **)** - * [real](class_real) **[`get_process_delta_time`](#get_process_delta_time)** **(** **)** const - * [bool](class_bool) **[`is_processing`](#is_processing)** **(** **)** const - * void **[`set_process_input`](#set_process_input)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_processing_input`](#is_processing_input)** **(** **)** const - * void **[`set_process_unhandled_input`](#set_process_unhandled_input)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_processing_unhandled_input`](#is_processing_unhandled_input)** **(** **)** const - * void **[`set_pause_mode`](#set_pause_mode)** **(** [int](class_int) mode **)** - * [int](class_int) **[`get_pause_mode`](#get_pause_mode)** **(** **)** const - * [bool](class_bool) **[`can_process`](#can_process)** **(** **)** const - * void **[`print_stray_nodes`](#print_stray_nodes)** **(** **)** - * [int](class_int) **[`get_position_in_parent`](#get_position_in_parent)** **(** **)** const - * [SceneMainLoop](class_scenemainloop) **[`get_scene`](#get_scene)** **(** **)** const - * [Node](class_node) **[`duplicate`](#duplicate)** **(** **)** const - * void **[`replace_by`](#replace_by)** **(** [Node](class_node) node, [bool](class_bool) keep_data=false **)** - * void **[`queue_free`](#queue_free)** **(** **)** + * void **[_enter_scene](#_enter_scene)** **(** **)** virtual + * void **[_exit_scene](#_exit_scene)** **(** **)** virtual + * void **[_fixed_process](#_fixed_process)** **(** [real](class_real) delta **)** virtual + * void **[_input](#_input)** **(** [InputEvent](class_inputevent) event **)** virtual + * void **[_process](#_process)** **(** [real](class_real) delta **)** virtual + * void **[_ready](#_ready)** **(** **)** virtual + * void **[_unhandled_input](#_unhandled_input)** **(** [InputEvent](class_inputevent) event **)** virtual + * void **[_unhandled_key_input](#_unhandled_key_input)** **(** [InputEvent](class_inputevent) key_event **)** virtual + * void **[set_name](#set_name)** **(** [String](class_string) name **)** + * [String](class_string) **[get_name](#get_name)** **(** **)** const + * void **[add_child](#add_child)** **(** [Node](class_node) node **)** + * void **[remove_child](#remove_child)** **(** [Node](class_node) node **)** + * void **[remove_and_delete_child](#remove_and_delete_child)** **(** [Node](class_node) node **)** + * [int](class_int) **[get_child_count](#get_child_count)** **(** **)** const + * [Array](class_array) **[get_children](#get_children)** **(** **)** const + * [Node](class_node) **[get_child](#get_child)** **(** [int](class_int) idx **)** const + * [bool](class_bool) **[has_node](#has_node)** **(** [NodePath](class_nodepath) path **)** const + * [Node](class_node) **[get_node](#get_node)** **(** [NodePath](class_nodepath) path **)** const + * Parent **[get_parent](#get_parent)** **(** **)** const + * [bool](class_bool) **[has_node_and_resource](#has_node_and_resource)** **(** [NodePath](class_nodepath) path **)** const + * [Array](class_array) **[get_node_and_resource](#get_node_and_resource)** **(** [NodePath](class_nodepath) path **)** + * [bool](class_bool) **[is_inside_scene](#is_inside_scene)** **(** **)** const + * [bool](class_bool) **[is_a_parent_of](#is_a_parent_of)** **(** [Node](class_node) node **)** const + * [bool](class_bool) **[is_greater_than](#is_greater_than)** **(** [Node](class_node) node **)** const + * [NodePath](class_nodepath) **[get_path](#get_path)** **(** **)** const + * [NodePath](class_nodepath) **[get_path_to](#get_path_to)** **(** [Node](class_node) node **)** const + * void **[add_to_group](#add_to_group)** **(** [String](class_string) group, [bool](class_bool) arg1=false **)** + * void **[remove_from_group](#remove_from_group)** **(** [String](class_string) group **)** + * [bool](class_bool) **[is_in_group](#is_in_group)** **(** [String](class_string) group **)** const + * void **[move_child](#move_child)** **(** [Node](class_node) child_node, [int](class_int) to_pos **)** + * void **[raise](#raise)** **(** **)** + * void **[set_owner](#set_owner)** **(** [Node](class_node) owner **)** + * [Node](class_node) **[get_owner](#get_owner)** **(** **)** const + * void **[remove_and_skip](#remove_and_skip)** **(** **)** + * [int](class_int) **[get_index](#get_index)** **(** **)** const + * void **[print_tree](#print_tree)** **(** **)** + * void **[set_filename](#set_filename)** **(** [String](class_string) filename **)** + * [String](class_string) **[get_filename](#get_filename)** **(** **)** const + * void **[propagate_notification](#propagate_notification)** **(** [int](class_int) what **)** + * void **[set_fixed_process](#set_fixed_process)** **(** [bool](class_bool) enable **)** + * [real](class_real) **[get_fixed_process_delta_time](#get_fixed_process_delta_time)** **(** **)** const + * [bool](class_bool) **[is_fixed_processing](#is_fixed_processing)** **(** **)** const + * void **[set_process](#set_process)** **(** [bool](class_bool) enable **)** + * [real](class_real) **[get_process_delta_time](#get_process_delta_time)** **(** **)** const + * [bool](class_bool) **[is_processing](#is_processing)** **(** **)** const + * void **[set_process_input](#set_process_input)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_processing_input](#is_processing_input)** **(** **)** const + * void **[set_process_unhandled_input](#set_process_unhandled_input)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_processing_unhandled_input](#is_processing_unhandled_input)** **(** **)** const + * void **[set_pause_mode](#set_pause_mode)** **(** [int](class_int) mode **)** + * [int](class_int) **[get_pause_mode](#get_pause_mode)** **(** **)** const + * [bool](class_bool) **[can_process](#can_process)** **(** **)** const + * void **[print_stray_nodes](#print_stray_nodes)** **(** **)** + * [int](class_int) **[get_position_in_parent](#get_position_in_parent)** **(** **)** const + * [SceneMainLoop](class_scenemainloop) **[get_scene](#get_scene)** **(** **)** const + * [Node](class_node) **[duplicate](#duplicate)** **(** **)** const + * void **[replace_by](#replace_by)** **(** [Node](class_node) node, [bool](class_bool) keep_data=false **)** + * void **[queue_free](#queue_free)** **(** **)** ### Signals - * **`enter_scene`** **(** **)** - * **`renamed`** **(** **)** - * **`exit_scene`** **(** **)** + * **enter_scene** **(** **)** + * **renamed** **(** **)** + * **exit_scene** **(** **)** ### Numeric Constants * **NOTIFICATION_ENTER_SCENE** = **10** - Notification received when the node enters the Scene Tree and gains access to the [RootNode]. Note that children nodes will not have received the notification at that time yet. @@ -91,246 +91,246 @@ Nodes can be set as children of other nodes, resulting in a tree arrangement. An [SceneMainLoop](class_scenemainloop) contains the "active" tree of nodes, and a node becomes active (receinving NOTIFICATION_ENTER_SCENE) when added to that tree. A node can contain any number of nodes as a children (but there is only one tree root) with the requirement that no two childrens with the same name can exist. Nodes can, optionally, be added to groups. This makes it easy to reach a number of nodes from the code (for example an "enemies" group). - Nodes can be set to "process" state, so they constantly receive a callback requesting them to process (do anything). Normal processing ([`_process`](#_process)) happens as fast as possible and is dependent on the frame rate, so the processing time delta is variable. Fixed processing ([`_fixed_process`](#_fixed_process)) happens a fixed amount of times per second (by default 60) and is useful to link itself to the physics. - Nodes can also process input events. When set, the [`_input`](#_input) function will be called with every input that the program receives. Since this is usually too overkill (unless used for simple projects), an [`_unhandled_input`](#_unhandled_input) function is called when the input was not handled by anyone else (usually, GUI [Control](class_control) nodes). + Nodes can be set to "process" state, so they constantly receive a callback requesting them to process (do anything). Normal processing ([_process](#_process)) happens as fast as possible and is dependent on the frame rate, so the processing time delta is variable. Fixed processing ([_fixed_process](#_fixed_process)) happens a fixed amount of times per second (by default 60) and is useful to link itself to the physics. + Nodes can also process input events. When set, the [_input](#_input) function will be called with every input that the program receives. Since this is usually too overkill (unless used for simple projects), an [_unhandled_input](#_unhandled_input) function is called when the input was not handled by anyone else (usually, GUI [Control](class_control) nodes). To keep track of the scene hieararchy (specially when instancing scenes into scenes) an "owner" can be set to a node. This keeps track of who instanced what. This is mostly useful when writing editors and tools, though. Finally, when a node is freed, it will free all its children nodes too. ### Member Function Description #### _enter_scene - * void **`_enter_scene`** **(** **)** virtual + * void **_enter_scene** **(** **)** virtual Called when entered the scene. #### _exit_scene - * void **`_exit_scene`** **(** **)** virtual + * void **_exit_scene** **(** **)** virtual Called when being removed from the scene. #### _fixed_process - * void **`_fixed_process`** **(** [real](class_real) delta **)** virtual + * void **_fixed_process** **(** [real](class_real) delta **)** virtual Called for fixed processing (synced to the physics). #### _input - * void **`_input`** **(** [InputEvent](class_inputevent) event **)** virtual + * void **_input** **(** [InputEvent](class_inputevent) event **)** virtual -Called when any input happens (also must enable with [`set_process_input`](#set_process_input) or the property). +Called when any input happens (also must enable with [set_process_input](#set_process_input) or the property). #### _process - * void **`_process`** **(** [real](class_real) delta **)** virtual + * void **_process** **(** [real](class_real) delta **)** virtual Called for processing. This is called every frame, with the delta time from the previous frame. #### _ready - * void **`_ready`** **(** **)** virtual + * void **_ready** **(** **)** virtual Called when ready (entered scene and children entered too). #### _unhandled_input - * void **`_unhandled_input`** **(** [InputEvent](class_inputevent) event **)** virtual + * void **_unhandled_input** **(** [InputEvent](class_inputevent) event **)** virtual -Called when any input happens that was not handled by something else (also must enable with [`set_process_unhandled_input`](#set_process_unhandled_input) or the property). +Called when any input happens that was not handled by something else (also must enable with [set_process_unhandled_input](#set_process_unhandled_input) or the property). #### _unhandled_key_input - * void **`_unhandled_key_input`** **(** [InputEvent](class_inputevent) key_event **)** virtual + * void **_unhandled_key_input** **(** [InputEvent](class_inputevent) key_event **)** virtual Called when any key input happens that was not handled by something else. #### set_name - * void **`set_name`** **(** [String](class_string) name **)** + * void **set_name** **(** [String](class_string) name **)** Set the name of the [Node](class_node). Name must be unique within parent, and setting an already existing name will cause for the node to be automatically renamed. #### get_name - * [String](class_string) **`get_name`** **(** **)** const + * [String](class_string) **get_name** **(** **)** const Return the name of the [Node](class_node). Name is be unique within parent. #### add_child - * void **`add_child`** **(** [Node](class_node) node **)** + * void **add_child** **(** [Node](class_node) node **)** Add a child [Node](class_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. #### remove_child - * void **`remove_child`** **(** [Node](class_node) node **)** + * void **remove_child** **(** [Node](class_node) node **)** Remove a child [Node](class_node). Node is NOT deleted and will have to be deleted manually. #### get_child_count - * [int](class_int) **`get_child_count`** **(** **)** const + * [int](class_int) **get_child_count** **(** **)** const Return the amount of children nodes. #### get_child - * [Node](class_node) **`get_child`** **(** [int](class_int) idx **)** const + * [Node](class_node) **get_child** **(** [int](class_int) idx **)** const -Return a children node by it"apos;s index (see [`get_child_count`](#get_child_count)). This method is often used for iterating all children of a node. +Return a children node by it"apos;s index (see [get_child_count](#get_child_count)). This method is often used for iterating all children of a node. #### get_node - * [Node](class_node) **`get_node`** **(** [NodePath](class_nodepath) path **)** const + * [Node](class_node) **get_node** **(** [NodePath](class_nodepath) path **)** const Fetch a node. "path" must be valid (or else error will occur) and can be either the name of a child node, a relative path (from the current node to another node), or an absolute path to a node. Examples ofa paths are: get_node("Sword") , get_node("../Swamp/Alligator") , get_node("/MyGame"). -Note: fetching absolute paths only works when the node is inside the scene tree (see [`is_inside_scene`](#is_inside_scene)). +Note: fetching absolute paths only works when the node is inside the scene tree (see [is_inside_scene](#is_inside_scene)). #### get_parent - * Parent **`get_parent`** **(** **)** const + * Parent **get_parent** **(** **)** const Return the parent [Node](class_node) of the current [Node](class_node), or an empty Object if the node lacks a parent. #### is_inside_scene - * [bool](class_bool) **`is_inside_scene`** **(** **)** const + * [bool](class_bool) **is_inside_scene** **(** **)** const Return wether the node is inside a scene tree (a tree where the topmost node is a [RootNode]) #### is_a_parent_of - * [bool](class_bool) **`is_a_parent_of`** **(** [Node](class_node) node **)** const + * [bool](class_bool) **is_a_parent_of** **(** [Node](class_node) node **)** const Return _true_ if the "node" argument is a direct or indirect child of the current node, otherwise return _false_. #### is_greater_than - * [bool](class_bool) **`is_greater_than`** **(** [Node](class_node) node **)** const + * [bool](class_bool) **is_greater_than** **(** [Node](class_node) node **)** const Return _true_ if "node" occurs later in the scene hierarchy than the current node, otherwise return _false_. #### get_path - * [NodePath](class_nodepath) **`get_path`** **(** **)** const + * [NodePath](class_nodepath) **get_path** **(** **)** const -Return the absolute path of the current node. This only works if the curent node is inside the scene tree (see [`is_inside_scene`](#is_inside_scene)). +Return the absolute path of the current node. This only works if the curent node is inside the scene tree (see [is_inside_scene](#is_inside_scene)). #### get_path_to - * [NodePath](class_nodepath) **`get_path_to`** **(** [Node](class_node) node **)** const + * [NodePath](class_nodepath) **get_path_to** **(** [Node](class_node) node **)** const Return the relative path from the current node to the specified node in "node" argument. Both nodes must be in the same scene, or else the function will fail. #### add_to_group - * void **`add_to_group`** **(** [String](class_string) group, [bool](class_bool) arg1=false **)** + * void **add_to_group** **(** [String](class_string) group, [bool](class_bool) arg1=false **)** -Add a node to a group. Groups are helpers to name and organize group of nodes, like for example: "Enemies" "Collectables", etc. A [Node](class_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 [`is_inside_scene`](#is_inside_scene)). +Add a node to a group. Groups are helpers to name and organize group of nodes, like for example: "Enemies" "Collectables", etc. A [Node](class_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 [is_inside_scene](#is_inside_scene)). #### remove_from_group - * void **`remove_from_group`** **(** [String](class_string) group **)** + * void **remove_from_group** **(** [String](class_string) group **)** Remove a node from a group. #### move_child - * void **`move_child`** **(** [Node](class_node) child_node, [int](class_int) to_pos **)** + * void **move_child** **(** [Node](class_node) child_node, [int](class_int) to_pos **)** Move a child node to a different position (order) amongst the other children. Since calls, signals, etc are performed by tree order, changing the order of chilren nodes may be useful. #### raise - * void **`raise`** **(** **)** + * void **raise** **(** **)** Move this node to the top of the array of nodes of the parent node. This is often useful on GUIs ([Control](class_control)), because their order of drawing fully depends on their order in the tree. #### set_owner - * void **`set_owner`** **(** [Node](class_node) owner **)** + * void **set_owner** **(** [Node](class_node) owner **)** Set the node owner. A node can have any other node as owner (as long as a valid parent, grandparent, etc ascending in the tree). When saving a node (using SceneSaver) all the nodes it owns will be saved with it. This allows to create complex SceneTrees, with instancing and subinstancing. #### get_owner - * [Node](class_node) **`get_owner`** **(** **)** const + * [Node](class_node) **get_owner** **(** **)** const -Get the node owner (see [`set_node_owner`](#set_node_owner)). +Get the node owner (see [set_node_owner](#set_node_owner)). #### remove_and_skip - * void **`remove_and_skip`** **(** **)** + * void **remove_and_skip** **(** **)** Remove a node and set all its children as childrens of the parent node (if exists). All even subscriptions that pass by the removed node will be unsubscribed. #### get_index - * [int](class_int) **`get_index`** **(** **)** const + * [int](class_int) **get_index** **(** **)** const Get the node index in the parent (assuming it has a parent). #### print_tree - * void **`print_tree`** **(** **)** + * void **print_tree** **(** **)** Print the screne to stdout. Used mainly for debugging purposes. #### set_filename - * void **`set_filename`** **(** [String](class_string) filename **)** + * void **set_filename** **(** [String](class_string) filename **)** A node can contain a filename. This filename should not be changed by the user, unless writing editors and tools. When a scene is instanced from a file, it topmost node contains the filename from where it was loaded. #### get_filename - * [String](class_string) **`get_filename`** **(** **)** const + * [String](class_string) **get_filename** **(** **)** const -Return a filename that may be containedA node can contained by the node. When a scene is instanced from a file, it topmost node contains the filename from where it was loaded (see [`set_filename`](#set_filename)). +Return a filename that may be containedA node can contained by the node. When a scene is instanced from a file, it topmost node contains the filename from where it was loaded (see [set_filename](#set_filename)). #### propagate_notification - * void **`propagate_notification`** **(** [int](class_int) what **)** + * void **propagate_notification** **(** [int](class_int) what **)** Notify the current node and all its chldren recursively by calling notification() in all of them. #### set_fixed_process - * void **`set_fixed_process`** **(** [bool](class_bool) enable **)** + * void **set_fixed_process** **(** [bool](class_bool) enable **)** -Enables or disables node fixed framerate processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS at a fixed (usually 60fps, check [OS](class_os) to change that) interval (and the [`_fixed_process`](#_fixed_process) callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling [`get_fixed_process_time`](#get_fixed_process_time). +Enables or disables node fixed framerate processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS at a fixed (usually 60fps, check [OS](class_os) to change that) interval (and the [_fixed_process](#_fixed_process) callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling [get_fixed_process_time](#get_fixed_process_time). #### get_fixed_process_delta_time - * [real](class_real) **`get_fixed_process_delta_time`** **(** **)** const + * [real](class_real) **get_fixed_process_delta_time** **(** **)** const Return the time elapsed since the last fixed frame. This is always the same in fixed proecssing unless the frames per second is changed in [OS](class_os). #### is_fixed_processing - * [bool](class_bool) **`is_fixed_processing`** **(** **)** const + * [bool](class_bool) **is_fixed_processing** **(** **)** const -Return true if fixed processing is enabled (see [`set_fixed_process`](#set_fixed_process)). +Return true if fixed processing is enabled (see [set_fixed_process](#set_fixed_process)). #### set_process - * void **`set_process`** **(** [bool](class_bool) enable **)** + * void **set_process** **(** [bool](class_bool) enable **)** -Enables or disables node processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS on every drawn frame (and the [`_process`](#_process) callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling [`get_process_time`](#get_process_time). +Enables or disables node processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS on every drawn frame (and the [_process](#_process) callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling [get_process_time](#get_process_time). #### get_process_delta_time - * [real](class_real) **`get_process_delta_time`** **(** **)** const + * [real](class_real) **get_process_delta_time** **(** **)** const Return the time elapsed (in seconds) since the last process callback. This is almost always different each time. #### is_processing - * [bool](class_bool) **`is_processing`** **(** **)** const + * [bool](class_bool) **is_processing** **(** **)** const -Return wether processing is enabled in the current node (see [`set_process`](#set_process)). +Return wether processing is enabled in the current node (see [set_process](#set_process)). #### set_process_input - * void **`set_process_input`** **(** [bool](class_bool) enable **)** + * void **set_process_input** **(** [bool](class_bool) enable **)** -Enable input processing for node. This is not requiered for GUI controls! It hooks up the node to receive all input (see [`_input`](#_input)). +Enable input processing for node. This is not requiered for GUI controls! It hooks up the node to receive all input (see [_input](#_input)). #### is_processing_input - * [bool](class_bool) **`is_processing_input`** **(** **)** const + * [bool](class_bool) **is_processing_input** **(** **)** const -Return true if the node is processing input (see [`set_process_input`](#set_process_input)). +Return true if the node is processing input (see [set_process_input](#set_process_input)). #### set_process_unhandled_input - * void **`set_process_unhandled_input`** **(** [bool](class_bool) enable **)** + * void **set_process_unhandled_input** **(** [bool](class_bool) enable **)** -Enable unhandled input processing for node. This is not requiered for GUI controls! It hooks up the node to receive all input that was not previously handled before (usually by a [Control](class_control)). (see [`_unhandled_input`](#_unhandled_input)). +Enable unhandled input processing for node. This is not requiered for GUI controls! It hooks up the node to receive all input that was not previously handled before (usually by a [Control](class_control)). (see [_unhandled_input](#_unhandled_input)). #### is_processing_unhandled_input - * [bool](class_bool) **`is_processing_unhandled_input`** **(** **)** const + * [bool](class_bool) **is_processing_unhandled_input** **(** **)** const -Return true if the node is processing unhandled input (see [`set_process_unhandled_input`](#set_process_unhandled_input)). +Return true if the node is processing unhandled input (see [set_process_unhandled_input](#set_process_unhandled_input)). #### can_process - * [bool](class_bool) **`can_process`** **(** **)** const + * [bool](class_bool) **can_process** **(** **)** const Return true if the node can process. #### get_scene - * [SceneMainLoop](class_scenemainloop) **`get_scene`** **(** **)** const + * [SceneMainLoop](class_scenemainloop) **get_scene** **(** **)** const Get the current SceneMainLoop. Only returned if the node is inside the scene, else returns null. #### duplicate - * [Node](class_node) **`duplicate`** **(** **)** const + * [Node](class_node) **duplicate** **(** **)** const Return a duplicate of the scene, with all nodes and parameters copied. Subscriptions will not be duplicated. #### replace_by - * void **`replace_by`** **(** [Node](class_node) node, [bool](class_bool) keep_data=false **)** + * void **replace_by** **(** [Node](class_node) node, [bool](class_bool) keep_data=false **)** Replace a node in a scene by a given one. Subscriptions that pass through this node will be lost. diff --git a/class_node2d.md b/class_node2d.md index 3c4fa57..286f292 100644 --- a/class_node2d.md +++ b/class_node2d.md @@ -6,16 +6,16 @@ Base node for 2D system. ### Member Functions - * void **[`set_pos`](#set_pos)** **(** [Vector2](class_vector2) pos **)** - * void **[`set_rot`](#set_rot)** **(** [real](class_real) rot **)** - * void **[`set_scale`](#set_scale)** **(** [Vector2](class_vector2) scale **)** - * [Vector2](class_vector2) **[`get_pos`](#get_pos)** **(** **)** const - * [real](class_real) **[`get_rot`](#get_rot)** **(** **)** const - * [Vector2](class_vector2) **[`get_scale`](#get_scale)** **(** **)** const - * [Vector2](class_vector2) **[`get_global_pos`](#get_global_pos)** **(** **)** const - * void **[`set_transform`](#set_transform)** **(** [Matrix32](class_matrix32) xform **)** - * void **[`set_global_transform`](#set_global_transform)** **(** [Matrix32](class_matrix32) xform **)** - * void **[`edit_set_pivot`](#edit_set_pivot)** **(** [Vector2](class_vector2) arg0 **)** + * void **[set_pos](#set_pos)** **(** [Vector2](class_vector2) pos **)** + * void **[set_rot](#set_rot)** **(** [real](class_real) rot **)** + * void **[set_scale](#set_scale)** **(** [Vector2](class_vector2) scale **)** + * [Vector2](class_vector2) **[get_pos](#get_pos)** **(** **)** const + * [real](class_real) **[get_rot](#get_rot)** **(** **)** const + * [Vector2](class_vector2) **[get_scale](#get_scale)** **(** **)** const + * [Vector2](class_vector2) **[get_global_pos](#get_global_pos)** **(** **)** const + * void **[set_transform](#set_transform)** **(** [Matrix32](class_matrix32) xform **)** + * void **[set_global_transform](#set_global_transform)** **(** [Matrix32](class_matrix32) xform **)** + * void **[edit_set_pivot](#edit_set_pivot)** **(** [Vector2](class_vector2) arg0 **)** ### Description Base node for 2D system. Node2D contains a position, rotation and scale, which is used to position and animate. @@ -25,36 +25,36 @@ Base node for 2D system. Node2D contains a position, rotation and scale, which i ### Member Function Description #### set_pos - * void **`set_pos`** **(** [Vector2](class_vector2) pos **)** + * void **set_pos** **(** [Vector2](class_vector2) pos **)** Set the position of the 2d node. #### set_rot - * void **`set_rot`** **(** [real](class_real) rot **)** + * void **set_rot** **(** [real](class_real) rot **)** Set the rotation of the 2d node. #### set_scale - * void **`set_scale`** **(** [Vector2](class_vector2) scale **)** + * void **set_scale** **(** [Vector2](class_vector2) scale **)** Set the scale of the 2d node. #### get_pos - * [Vector2](class_vector2) **`get_pos`** **(** **)** const + * [Vector2](class_vector2) **get_pos** **(** **)** const Return the position of the 2D node. #### get_rot - * [real](class_real) **`get_rot`** **(** **)** const + * [real](class_real) **get_rot** **(** **)** const Return the rotation of the 2D node. #### get_scale - * [Vector2](class_vector2) **`get_scale`** **(** **)** const + * [Vector2](class_vector2) **get_scale** **(** **)** const Return the scale of the 2D node. #### get_global_pos - * [Vector2](class_vector2) **`get_global_pos`** **(** **)** const + * [Vector2](class_vector2) **get_global_pos** **(** **)** const Return the global position of the 2D node. diff --git a/class_nodepath.md b/class_nodepath.md index c0e0466..d581151 100644 --- a/class_nodepath.md +++ b/class_nodepath.md @@ -5,14 +5,14 @@ Built-in type optimized for path traversing. ### Member Functions - * [String](class_string) **[`get_name`](#get_name)** **(** [int](class_int) idx **)** - * [int](class_int) **[`get_name_count`](#get_name_count)** **(** **)** - * [String](class_string) **[`get_property`](#get_property)** **(** **)** - * [String](class_string) **[`get_subname`](#get_subname)** **(** [int](class_int) idx **)** - * [int](class_int) **[`get_subname_count`](#get_subname_count)** **(** **)** - * [bool](class_bool) **[`is_absolute`](#is_absolute)** **(** **)** - * [bool](class_bool) **[`is_empty`](#is_empty)** **(** **)** - * void **[`NodePath`](#NodePath)** **(** [String](class_string) from **)** + * [String](class_string) **[get_name](#get_name)** **(** [int](class_int) idx **)** + * [int](class_int) **[get_name_count](#get_name_count)** **(** **)** + * [String](class_string) **[get_property](#get_property)** **(** **)** + * [String](class_string) **[get_subname](#get_subname)** **(** [int](class_int) idx **)** + * [int](class_int) **[get_subname_count](#get_subname_count)** **(** **)** + * [bool](class_bool) **[is_absolute](#is_absolute)** **(** **)** + * [bool](class_bool) **[is_empty](#is_empty)** **(** **)** + * void **[NodePath](#NodePath)** **(** [String](class_string) from **)** ### Description Built-in type optimized for path traversing. A Node path is an optimized compiled path used for traversing the scene tree. @@ -21,36 +21,36 @@ Built-in type optimized for path traversing. A Node path is an optimized compile ### Member Function Description #### get_name - * [String](class_string) **`get_name`** **(** [int](class_int) idx **)** + * [String](class_string) **get_name** **(** [int](class_int) idx **)** Return a path level name. #### get_name_count - * [int](class_int) **`get_name_count`** **(** **)** + * [int](class_int) **get_name_count** **(** **)** Return the path level count. #### get_property - * [String](class_string) **`get_property`** **(** **)** + * [String](class_string) **get_property** **(** **)** Return the property associated (empty if none). #### get_subname - * [String](class_string) **`get_subname`** **(** [int](class_int) idx **)** + * [String](class_string) **get_subname** **(** [int](class_int) idx **)** Return the subname level name. #### get_subname_count - * [int](class_int) **`get_subname_count`** **(** **)** + * [int](class_int) **get_subname_count** **(** **)** Return the subname count. #### is_absolute - * [bool](class_bool) **`is_absolute`** **(** **)** + * [bool](class_bool) **is_absolute** **(** **)** Return true if the node path is absolute (not relative). #### is_empty - * [bool](class_bool) **`is_empty`** **(** **)** + * [bool](class_bool) **is_empty** **(** **)** Return true if the node path is empty. diff --git a/class_object.md b/class_object.md index eb6242f..f4cfd18 100644 --- a/class_object.md +++ b/class_object.md @@ -5,43 +5,43 @@ Base class for all non built-in types. ### Member Functions - * void **[`_get`](#_get)** **(** [String](class_string) property **)** virtual - * [Array](class_array) **[`_get_property_list`](#_get_property_list)** **(** **)** virtual - * void **[`_notification`](#_notification)** **(** [int](class_int) what **)** virtual - * void **[`_set`](#_set)** **(** [String](class_string) property, var value **)** virtual - * [String](class_string) **[`get_type`](#get_type)** **(** **)** const - * [bool](class_bool) **[`is_type`](#is_type)** **(** [String](class_string) type **)** const - * void **[`set`](#set)** **(** [String](class_string) property, var value **)** - * void **[`get`](#get)** **(** [String](class_string) property **)** const - * [Array](class_array) **[`get_property_list`](#get_property_list)** **(** **)** const - * void **[`notification`](#notification)** **(** [int](class_int) what, [bool](class_bool) arg1=false **)** - * [int](class_int) **[`get_instance_ID`](#get_instance_ID)** **(** **)** const - * void **[`set_script`](#set_script)** **(** [Script](class_script) script **)** - * [Script](class_script) **[`get_script`](#get_script)** **(** **)** const - * void **[`set_meta`](#set_meta)** **(** [String](class_string) name, var value **)** - * void **[`get_meta`](#get_meta)** **(** [String](class_string) name **)** const - * [bool](class_bool) **[`has_meta`](#has_meta)** **(** [String](class_string) name **)** const - * [StringArray](class_stringarray) **[`get_meta_list`](#get_meta_list)** **(** **)** const - * void **[`add_user_signal`](#add_user_signal)** **(** [String](class_string) signal, [Array](class_array) arguments=Array() **)** - * void **[`emit_signal`](#emit_signal)** **(** [String](class_string) signal, var arg0=NULL, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL **)** - * void **[`call`](#call)** **(** [String](class_string) method, var arg0=NULL, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL, var arg5=NULL, var arg6=NULL, var arg7=NULL, var arg8=NULL, var arg9=NULL **)** - * void **[`call_deferred`](#call_deferred)** **(** [String](class_string) method, var arg0=NULL, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL **)** - * void **[`callv`](#callv)** **(** [String](class_string) method, [Array](class_array) arg_array **)** - * [bool](class_bool) **[`has_method`](#has_method)** **(** [String](class_string) arg0 **)** const - * [Array](class_array) **[`get_signal_list`](#get_signal_list)** **(** **)** const - * void **[`connect`](#connect)** **(** [String](class_string) signal, [Object](class_object) target, [String](class_string) method, [Array](class_array) binds=Array(), [int](class_int) flags=0 **)** - * void **[`disconnect`](#disconnect)** **(** [String](class_string) signal, [Object](class_object) target, [String](class_string) method **)** - * [bool](class_bool) **[`is_connected`](#is_connected)** **(** [String](class_string) signal, [Object](class_object) target, [String](class_string) method **)** const - * void **[`set_block_signals`](#set_block_signals)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_blocking_signals`](#is_blocking_signals)** **(** **)** const - * void **[`set_message_translation`](#set_message_translation)** **(** [bool](class_bool) enable **)** - * void **[`can_translate_messages`](#can_translate_messages)** **(** [bool](class_bool) arg0 **)** - * void **[`property_list_changed_notify`](#property_list_changed_notify)** **(** **)** - * [String](class_string) **[`XL_MESSAGE`](#XL_MESSAGE)** **(** [String](class_string) message **)** const - * [String](class_string) **[`tr`](#tr)** **(** [String](class_string) message **)** const + * void **[_get](#_get)** **(** [String](class_string) property **)** virtual + * [Array](class_array) **[_get_property_list](#_get_property_list)** **(** **)** virtual + * void **[_notification](#_notification)** **(** [int](class_int) what **)** virtual + * void **[_set](#_set)** **(** [String](class_string) property, var value **)** virtual + * [String](class_string) **[get_type](#get_type)** **(** **)** const + * [bool](class_bool) **[is_type](#is_type)** **(** [String](class_string) type **)** const + * void **[set](#set)** **(** [String](class_string) property, var value **)** + * void **[get](#get)** **(** [String](class_string) property **)** const + * [Array](class_array) **[get_property_list](#get_property_list)** **(** **)** const + * void **[notification](#notification)** **(** [int](class_int) what, [bool](class_bool) arg1=false **)** + * [int](class_int) **[get_instance_ID](#get_instance_ID)** **(** **)** const + * void **[set_script](#set_script)** **(** [Script](class_script) script **)** + * [Script](class_script) **[get_script](#get_script)** **(** **)** const + * void **[set_meta](#set_meta)** **(** [String](class_string) name, var value **)** + * void **[get_meta](#get_meta)** **(** [String](class_string) name **)** const + * [bool](class_bool) **[has_meta](#has_meta)** **(** [String](class_string) name **)** const + * [StringArray](class_stringarray) **[get_meta_list](#get_meta_list)** **(** **)** const + * void **[add_user_signal](#add_user_signal)** **(** [String](class_string) signal, [Array](class_array) arguments=Array() **)** + * void **[emit_signal](#emit_signal)** **(** [String](class_string) signal, var arg0=NULL, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL **)** + * void **[call](#call)** **(** [String](class_string) method, var arg0=NULL, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL, var arg5=NULL, var arg6=NULL, var arg7=NULL, var arg8=NULL, var arg9=NULL **)** + * void **[call_deferred](#call_deferred)** **(** [String](class_string) method, var arg0=NULL, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL **)** + * void **[callv](#callv)** **(** [String](class_string) method, [Array](class_array) arg_array **)** + * [bool](class_bool) **[has_method](#has_method)** **(** [String](class_string) arg0 **)** const + * [Array](class_array) **[get_signal_list](#get_signal_list)** **(** **)** const + * void **[connect](#connect)** **(** [String](class_string) signal, [Object](class_object) target, [String](class_string) method, [Array](class_array) binds=Array(), [int](class_int) flags=0 **)** + * void **[disconnect](#disconnect)** **(** [String](class_string) signal, [Object](class_object) target, [String](class_string) method **)** + * [bool](class_bool) **[is_connected](#is_connected)** **(** [String](class_string) signal, [Object](class_object) target, [String](class_string) method **)** const + * void **[set_block_signals](#set_block_signals)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_blocking_signals](#is_blocking_signals)** **(** **)** const + * void **[set_message_translation](#set_message_translation)** **(** [bool](class_bool) enable **)** + * void **[can_translate_messages](#can_translate_messages)** **(** [bool](class_bool) arg0 **)** + * void **[property_list_changed_notify](#property_list_changed_notify)** **(** **)** + * [String](class_string) **[XL_MESSAGE](#XL_MESSAGE)** **(** [String](class_string) message **)** const + * [String](class_string) **[tr](#tr)** **(** [String](class_string) message **)** const ### Signals - * **`script_changed`** **(** **)** + * **script_changed** **(** **)** ### Numeric Constants * **NOTIFICATION_POSTINITIALIZE** = **0** - Called right when the object is initialized. Not available in script. @@ -52,165 +52,165 @@ Base class for all non built-in types. ### Description Base class for all non built-in types. Everything not a built-in type starts the inheritance chain from this class. - Objects do not manage memory, if inheriting from one the object will most likely have to be deleted manually (call the [`free`](#free) function from the script or delete from C++). + Objects do not manage memory, if inheriting from one the object will most likely have to be deleted manually (call the [free](#free) function from the script or delete from C++). Some derivates add memory management, such as [Reference](class_reference) (which keps a reference count and deletes itself automatically when no longer referenced) and [Node](class_node), which deletes the children tree when deleted. - Objects export properties, which are mainly useful for storage and editing, but not really so much in programming. Properties are exported in [`_get_property_list`](#_get_property_list) and handled in [`_get`](#_get) and [_set]. However, scripting languages and C++ have simper means to export them. - Objects also receive notifications ([`_notification`](#_notification)). Notifications are a simple way to notify the object about simple events, so they can all be handled together. + Objects export properties, which are mainly useful for storage and editing, but not really so much in programming. Properties are exported in [_get_property_list](#_get_property_list) and handled in [_get](#_get) and [_set]. However, scripting languages and C++ have simper means to export them. + Objects also receive notifications ([_notification](#_notification)). Notifications are a simple way to notify the object about simple events, so they can all be handled together. ### Member Function Description #### _get - * void **`_get`** **(** [String](class_string) property **)** virtual + * void **_get** **(** [String](class_string) property **)** virtual Return a property, return null if the property does not exist. #### _get_property_list - * [Array](class_array) **`_get_property_list`** **(** **)** virtual + * [Array](class_array) **_get_property_list** **(** **)** virtual Return the property list, array of dictionaries, dictionaries must countain: name:String, type:int (see TYPE_* enum in globals) and optionally: hint:int (see PROPERTY_HINT_* in globals), hint_string:String, usage:int (see PROPERTY_USAGE_* in globals). #### _notification - * void **`_notification`** **(** [int](class_int) what **)** virtual + * void **_notification** **(** [int](class_int) what **)** virtual Notification request, the notification id is received. #### _set - * void **`_set`** **(** [String](class_string) property, var value **)** virtual + * void **_set** **(** [String](class_string) property, var value **)** virtual Set a property. Return true if the property was found. #### get_type - * [String](class_string) **`get_type`** **(** **)** const + * [String](class_string) **get_type** **(** **)** const Return the type of the object as a string. #### is_type - * [bool](class_bool) **`is_type`** **(** [String](class_string) type **)** const + * [bool](class_bool) **is_type** **(** [String](class_string) type **)** const Check the type of the obeject against a string (including inheritance). #### set - * void **`set`** **(** [String](class_string) property, var value **)** + * void **set** **(** [String](class_string) property, var value **)** Set property into the object. #### get - * void **`get`** **(** [String](class_string) property **)** const + * void **get** **(** [String](class_string) property **)** const Get a property from the object. #### get_property_list - * [Array](class_array) **`get_property_list`** **(** **)** const + * [Array](class_array) **get_property_list** **(** **)** const Return the list of properties as an array of dictionaries, dictionaries countain: name:String, type:int (see TYPE_* enum in globals) and optionally: hint:int (see PROPERTY_HINT_* in globals), hint_string:String, usage:int (see PROPERTY_USAGE_* in globals). #### notification - * void **`notification`** **(** [int](class_int) what, [bool](class_bool) arg1=false **)** + * void **notification** **(** [int](class_int) what, [bool](class_bool) arg1=false **)** Notify the object of something. #### get_instance_ID - * [int](class_int) **`get_instance_ID`** **(** **)** const + * [int](class_int) **get_instance_ID** **(** **)** const Return the instance ID. All objects have a unique instance ID. #### set_script - * void **`set_script`** **(** [Script](class_script) script **)** + * void **set_script** **(** [Script](class_script) script **)** Set a script into the object, scripts extend the object functionality. #### get_script - * [Script](class_script) **`get_script`** **(** **)** const + * [Script](class_script) **get_script** **(** **)** const Return the object script (or null if it doesn't have one). #### set_meta - * void **`set_meta`** **(** [String](class_string) name, var value **)** + * void **set_meta** **(** [String](class_string) name, var value **)** Set a metadata into the object. Medatada is serialized. Metadata can be _anything_. #### get_meta - * void **`get_meta`** **(** [String](class_string) name **)** const + * void **get_meta** **(** [String](class_string) name **)** const Return a metadata from the object. #### has_meta - * [bool](class_bool) **`has_meta`** **(** [String](class_string) name **)** const + * [bool](class_bool) **has_meta** **(** [String](class_string) name **)** const Return true if a metadata is found with the requested name. #### get_meta_list - * [StringArray](class_stringarray) **`get_meta_list`** **(** **)** const + * [StringArray](class_stringarray) **get_meta_list** **(** **)** const Return the list of metadatas in the object. #### add_user_signal - * void **`add_user_signal`** **(** [String](class_string) signal, [Array](class_array) arguments=Array() **)** + * void **add_user_signal** **(** [String](class_string) signal, [Array](class_array) arguments=Array() **)** 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 [@GlobalScope] TYPE_*). #### emit_signal - * void **`emit_signal`** **(** [String](class_string) signal, var arg0=NULL, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL **)** + * void **emit_signal** **(** [String](class_string) signal, var arg0=NULL, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL **)** Emit a signal. Arguments are passed in an array. #### call - * void **`call`** **(** [String](class_string) method, var arg0=NULL, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL, var arg5=NULL, var arg6=NULL, var arg7=NULL, var arg8=NULL, var arg9=NULL **)** + * void **call** **(** [String](class_string) method, var arg0=NULL, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL, var arg5=NULL, var arg6=NULL, var arg7=NULL, var arg8=NULL, var arg9=NULL **)** Call a function in the object, result is returned. #### call_deferred - * void **`call_deferred`** **(** [String](class_string) method, var arg0=NULL, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL **)** + * void **call_deferred** **(** [String](class_string) method, var arg0=NULL, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL **)** Create and store a function in the object. The call will take place on idle time. #### get_signal_list - * [Array](class_array) **`get_signal_list`** **(** **)** const + * [Array](class_array) **get_signal_list** **(** **)** const Return the list of signals as an array of dictionaries. #### connect - * void **`connect`** **(** [String](class_string) signal, [Object](class_object) target, [String](class_string) method, [Array](class_array) binds=Array(), [int](class_int) flags=0 **)** + * void **connect** **(** [String](class_string) signal, [Object](class_object) target, [String](class_string) method, [Array](class_array) binds=Array(), [int](class_int) flags=0 **)** 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 [`is_connected`](#is_connected) to check. + 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 [is_connected](#is_connected) to check. #### disconnect - * void **`disconnect`** **(** [String](class_string) signal, [Object](class_object) target, [String](class_string) method **)** + * void **disconnect** **(** [String](class_string) signal, [Object](class_object) target, [String](class_string) method **)** Disconnect a signal from a method. #### is_connected - * [bool](class_bool) **`is_connected`** **(** [String](class_string) signal, [Object](class_object) target, [String](class_string) method **)** const + * [bool](class_bool) **is_connected** **(** [String](class_string) signal, [Object](class_object) target, [String](class_string) method **)** const Return true if a connection exists for a given signal and target/method. #### set_block_signals - * void **`set_block_signals`** **(** [bool](class_bool) enable **)** + * void **set_block_signals** **(** [bool](class_bool) enable **)** If set to true, signal emission is blocked. #### is_blocking_signals - * [bool](class_bool) **`is_blocking_signals`** **(** **)** const + * [bool](class_bool) **is_blocking_signals** **(** **)** const Return true if signal emission blocking is enabled. #### set_message_translation - * void **`set_message_translation`** **(** [bool](class_bool) enable **)** + * void **set_message_translation** **(** [bool](class_bool) enable **)** Set true if this object can translate strings (in calls to tr() ). Default is true. #### can_translate_messages - * void **`can_translate_messages`** **(** [bool](class_bool) arg0 **)** + * void **can_translate_messages** **(** [bool](class_bool) arg0 **)** Return true if this object can translate strings. #### XL_MESSAGE - * [String](class_string) **`XL_MESSAGE`** **(** [String](class_string) message **)** const + * [String](class_string) **XL_MESSAGE** **(** [String](class_string) message **)** const deprecated, will go away. #### tr - * [String](class_string) **`tr`** **(** [String](class_string) message **)** const + * [String](class_string) **tr** **(** [String](class_string) message **)** const -Translate a message. Only works in message translation is enabled (which is by default). See [`set_message_translation`](#set_message_translation). +Translate a message. Only works in message translation is enabled (which is by default). See [set_message_translation](#set_message_translation). diff --git a/class_optionbutton.md b/class_optionbutton.md index ae48591..7d4ad80 100644 --- a/class_optionbutton.md +++ b/class_optionbutton.md @@ -6,29 +6,29 @@ Button control that provides selectable options when pressed. ### Member Functions - * void **[`add_item`](#add_item)** **(** [String](class_string) label, [int](class_int) id=-1 **)** - * void **[`add_icon_item`](#add_icon_item)** **(** [Texture](class_texture) texture, [String](class_string) label, [int](class_int) id **)** - * void **[`set_item_text`](#set_item_text)** **(** [int](class_int) idx, [String](class_string) text **)** - * void **[`set_item_icon`](#set_item_icon)** **(** [int](class_int) idx, [Texture](class_texture) texture **)** - * void **[`set_item_disabled`](#set_item_disabled)** **(** [int](class_int) idx, [bool](class_bool) disabled **)** - * void **[`set_item_ID`](#set_item_ID)** **(** [int](class_int) idx, [int](class_int) id **)** - * void **[`set_item_metadata`](#set_item_metadata)** **(** [int](class_int) idx, var metadata **)** - * [String](class_string) **[`get_item_text`](#get_item_text)** **(** [int](class_int) idx **)** const - * [Texture](class_texture) **[`get_item_icon`](#get_item_icon)** **(** [int](class_int) idx **)** const - * [int](class_int) **[`get_item_ID`](#get_item_ID)** **(** [int](class_int) idx **)** const - * void **[`get_item_metadata`](#get_item_metadata)** **(** [int](class_int) idx **)** const - * [bool](class_bool) **[`is_item_disabled`](#is_item_disabled)** **(** [int](class_int) idx **)** const - * [int](class_int) **[`get_item_count`](#get_item_count)** **(** **)** const - * void **[`add_separator`](#add_separator)** **(** **)** - * void **[`clear`](#clear)** **(** **)** - * void **[`select`](#select)** **(** [int](class_int) arg0 **)** - * [int](class_int) **[`get_selected`](#get_selected)** **(** **)** const - * [int](class_int) **[`get_selected_ID`](#get_selected_ID)** **(** **)** const - * void **[`get_selected_metadata`](#get_selected_metadata)** **(** **)** const - * void **[`remove_item`](#remove_item)** **(** [int](class_int) idx **)** + * void **[add_item](#add_item)** **(** [String](class_string) label, [int](class_int) id=-1 **)** + * void **[add_icon_item](#add_icon_item)** **(** [Texture](class_texture) texture, [String](class_string) label, [int](class_int) id **)** + * void **[set_item_text](#set_item_text)** **(** [int](class_int) idx, [String](class_string) text **)** + * void **[set_item_icon](#set_item_icon)** **(** [int](class_int) idx, [Texture](class_texture) texture **)** + * void **[set_item_disabled](#set_item_disabled)** **(** [int](class_int) idx, [bool](class_bool) disabled **)** + * void **[set_item_ID](#set_item_ID)** **(** [int](class_int) idx, [int](class_int) id **)** + * void **[set_item_metadata](#set_item_metadata)** **(** [int](class_int) idx, var metadata **)** + * [String](class_string) **[get_item_text](#get_item_text)** **(** [int](class_int) idx **)** const + * [Texture](class_texture) **[get_item_icon](#get_item_icon)** **(** [int](class_int) idx **)** const + * [int](class_int) **[get_item_ID](#get_item_ID)** **(** [int](class_int) idx **)** const + * void **[get_item_metadata](#get_item_metadata)** **(** [int](class_int) idx **)** const + * [bool](class_bool) **[is_item_disabled](#is_item_disabled)** **(** [int](class_int) idx **)** const + * [int](class_int) **[get_item_count](#get_item_count)** **(** **)** const + * void **[add_separator](#add_separator)** **(** **)** + * void **[clear](#clear)** **(** **)** + * void **[select](#select)** **(** [int](class_int) arg0 **)** + * [int](class_int) **[get_selected](#get_selected)** **(** **)** const + * [int](class_int) **[get_selected_ID](#get_selected_ID)** **(** **)** const + * void **[get_selected_metadata](#get_selected_metadata)** **(** **)** const + * void **[remove_item](#remove_item)** **(** [int](class_int) idx **)** ### Signals - * **`item_selected`** **(** [int](class_int) ID **)** + * **item_selected** **(** [int](class_int) ID **)** ### Description OptionButton is a type button that provides a selectable list of items when pressed. The item selected becomes the "current" item and is displayed as the button text. @@ -36,66 +36,66 @@ OptionButton is a type button that provides a selectable list of items when pres ### Member Function Description #### add_item - * void **`add_item`** **(** [String](class_string) label, [int](class_int) id=-1 **)** + * void **add_item** **(** [String](class_string) label, [int](class_int) id=-1 **)** Add an item, with text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end. #### add_icon_item - * void **`add_icon_item`** **(** [Texture](class_texture) texture, [String](class_string) label, [int](class_int) id **)** + * void **add_icon_item** **(** [Texture](class_texture) texture, [String](class_string) label, [int](class_int) id **)** Add an item, with a "texture" icon, text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end. #### set_item_text - * void **`set_item_text`** **(** [int](class_int) idx, [String](class_string) text **)** + * void **set_item_text** **(** [int](class_int) idx, [String](class_string) text **)** Set the text of an item at index "idx". #### set_item_icon - * void **`set_item_icon`** **(** [int](class_int) idx, [Texture](class_texture) texture **)** + * void **set_item_icon** **(** [int](class_int) idx, [Texture](class_texture) texture **)** Set the icon of an item at index "idx". #### set_item_ID - * void **`set_item_ID`** **(** [int](class_int) idx, [int](class_int) id **)** + * void **set_item_ID** **(** [int](class_int) idx, [int](class_int) id **)** Set the ID of an item at index "idx". #### get_item_text - * [String](class_string) **`get_item_text`** **(** [int](class_int) idx **)** const + * [String](class_string) **get_item_text** **(** [int](class_int) idx **)** const Return the text of the item at index "idx". #### get_item_icon - * [Texture](class_texture) **`get_item_icon`** **(** [int](class_int) idx **)** const + * [Texture](class_texture) **get_item_icon** **(** [int](class_int) idx **)** const Return the icon of the item at index "idx". #### get_item_ID - * [int](class_int) **`get_item_ID`** **(** [int](class_int) idx **)** const + * [int](class_int) **get_item_ID** **(** [int](class_int) idx **)** const Return the ID of the item at index "idx". #### get_item_count - * [int](class_int) **`get_item_count`** **(** **)** const + * [int](class_int) **get_item_count** **(** **)** const Return the amount of items in the OptionButton. #### add_separator - * void **`add_separator`** **(** **)** + * void **add_separator** **(** **)** Add a separator to the list of items. Separators help to group items. Separator also takes up an index and is appended at the end. #### clear - * void **`clear`** **(** **)** + * void **clear** **(** **)** Clear all the items in the [OptionButton](class_optionbutton). #### select - * void **`select`** **(** [int](class_int) arg0 **)** + * void **select** **(** [int](class_int) arg0 **)** Select an item by index and make it the current item. #### get_selected - * [int](class_int) **`get_selected`** **(** **)** const + * [int](class_int) **get_selected** **(** **)** const Return the current item index diff --git a/class_os.md b/class_os.md index 2956c92..a535a97 100644 --- a/class_os.md +++ b/class_os.md @@ -6,53 +6,53 @@ Operating System functions. ### Member Functions - * [Vector2](class_vector2) **[`get_mouse_pos`](#get_mouse_pos)** **(** **)** const - * void **[`set_clipboard`](#set_clipboard)** **(** [String](class_string) clipboard **)** - * [String](class_string) **[`get_clipboard`](#get_clipboard)** **(** **)** const - * void **[`set_video_mode`](#set_video_mode)** **(** [Vector2](class_vector2) size, [bool](class_bool) fullscreen, [bool](class_bool) resizable, [int](class_int) screen=0 **)** - * [Vector2](class_vector2) **[`get_video_mode_size`](#get_video_mode_size)** **(** [int](class_int) screen=0 **)** const - * [bool](class_bool) **[`is_video_mode_fullscreen`](#is_video_mode_fullscreen)** **(** [int](class_int) screen=0 **)** const - * [bool](class_bool) **[`is_video_mode_resizable`](#is_video_mode_resizable)** **(** [int](class_int) screen=0 **)** const - * [Array](class_array) **[`get_fullscreen_mode_list`](#get_fullscreen_mode_list)** **(** [int](class_int) screen=0 **)** const - * void **[`set_iterations_per_second`](#set_iterations_per_second)** **(** [int](class_int) iterations_per_second **)** - * [int](class_int) **[`get_iterations_per_second`](#get_iterations_per_second)** **(** **)** const - * [bool](class_bool) **[`has_touchscreen_ui_hint`](#has_touchscreen_ui_hint)** **(** **)** const - * void **[`set_low_processor_usage_mode`](#set_low_processor_usage_mode)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_in_low_processor_usage_mode`](#is_in_low_processor_usage_mode)** **(** **)** const - * [int](class_int) **[`get_processor_count`](#get_processor_count)** **(** **)** const - * [String](class_string) **[`get_executable_path`](#get_executable_path)** **(** **)** const - * [int](class_int) **[`execute`](#execute)** **(** [String](class_string) path, [StringArray](class_stringarray) arguments, [bool](class_bool) blocking **)** - * [int](class_int) **[`kill`](#kill)** **(** [int](class_int) pid **)** - * [int](class_int) **[`shell_open`](#shell_open)** **(** [String](class_string) uri **)** - * [String](class_string) **[`get_environment`](#get_environment)** **(** [String](class_string) environment **)** const - * [bool](class_bool) **[`has_environment`](#has_environment)** **(** [String](class_string) environment **)** const - * [String](class_string) **[`get_name`](#get_name)** **(** **)** const - * [StringArray](class_stringarray) **[`get_cmdline_args`](#get_cmdline_args)** **(** **)** - * [Object](class_object) **[`get_main_loop`](#get_main_loop)** **(** **)** const - * [Dictionary](class_dictionary) **[`get_date`](#get_date)** **(** **)** const - * [Dictionary](class_dictionary) **[`get_time`](#get_time)** **(** **)** const - * [int](class_int) **[`get_unix_time`](#get_unix_time)** **(** **)** const - * void **[`set_icon`](#set_icon)** **(** [Image](class_image) arg0 **)** - * void **[`delay_usec`](#delay_usec)** **(** [int](class_int) usec **)** const - * void **[`delay_msec`](#delay_msec)** **(** [int](class_int) msec **)** const - * [int](class_int) **[`get_ticks_msec`](#get_ticks_msec)** **(** **)** const - * [String](class_string) **[`get_locale`](#get_locale)** **(** **)** const - * [String](class_string) **[`get_model_name`](#get_model_name)** **(** **)** const - * [String](class_string) **[`get_custom_level`](#get_custom_level)** **(** **)** const - * [bool](class_bool) **[`can_draw`](#can_draw)** **(** **)** const - * [int](class_int) **[`get_frames_drawn`](#get_frames_drawn)** **(** **)** - * [bool](class_bool) **[`is_stdout_verbose`](#is_stdout_verbose)** **(** **)** const - * [int](class_int) **[`get_mouse_button_state`](#get_mouse_button_state)** **(** **)** const - * void **[`dump_memory_to_file`](#dump_memory_to_file)** **(** [String](class_string) file **)** - * void **[`dump_resources_to_file`](#dump_resources_to_file)** **(** [String](class_string) file **)** - * void **[`print_resources_in_use`](#print_resources_in_use)** **(** [bool](class_bool) short=false **)** - * void **[`print_all_resources`](#print_all_resources)** **(** [String](class_string) tofile="" **)** - * [int](class_int) **[`get_static_memory_usage`](#get_static_memory_usage)** **(** **)** const - * [int](class_int) **[`get_static_memory_peak_usage`](#get_static_memory_peak_usage)** **(** **)** const - * [int](class_int) **[`get_dynamic_memory_usage`](#get_dynamic_memory_usage)** **(** **)** const - * [String](class_string) **[`get_data_dir`](#get_data_dir)** **(** **)** const - * [String](class_string) **[`get_unique_ID`](#get_unique_ID)** **(** **)** const - * [real](class_real) **[`get_frames_per_second`](#get_frames_per_second)** **(** **)** const + * [Vector2](class_vector2) **[get_mouse_pos](#get_mouse_pos)** **(** **)** const + * void **[set_clipboard](#set_clipboard)** **(** [String](class_string) clipboard **)** + * [String](class_string) **[get_clipboard](#get_clipboard)** **(** **)** const + * void **[set_video_mode](#set_video_mode)** **(** [Vector2](class_vector2) size, [bool](class_bool) fullscreen, [bool](class_bool) resizable, [int](class_int) screen=0 **)** + * [Vector2](class_vector2) **[get_video_mode_size](#get_video_mode_size)** **(** [int](class_int) screen=0 **)** const + * [bool](class_bool) **[is_video_mode_fullscreen](#is_video_mode_fullscreen)** **(** [int](class_int) screen=0 **)** const + * [bool](class_bool) **[is_video_mode_resizable](#is_video_mode_resizable)** **(** [int](class_int) screen=0 **)** const + * [Array](class_array) **[get_fullscreen_mode_list](#get_fullscreen_mode_list)** **(** [int](class_int) screen=0 **)** const + * void **[set_iterations_per_second](#set_iterations_per_second)** **(** [int](class_int) iterations_per_second **)** + * [int](class_int) **[get_iterations_per_second](#get_iterations_per_second)** **(** **)** const + * [bool](class_bool) **[has_touchscreen_ui_hint](#has_touchscreen_ui_hint)** **(** **)** const + * void **[set_low_processor_usage_mode](#set_low_processor_usage_mode)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_in_low_processor_usage_mode](#is_in_low_processor_usage_mode)** **(** **)** const + * [int](class_int) **[get_processor_count](#get_processor_count)** **(** **)** const + * [String](class_string) **[get_executable_path](#get_executable_path)** **(** **)** const + * [int](class_int) **[execute](#execute)** **(** [String](class_string) path, [StringArray](class_stringarray) arguments, [bool](class_bool) blocking **)** + * [int](class_int) **[kill](#kill)** **(** [int](class_int) pid **)** + * [int](class_int) **[shell_open](#shell_open)** **(** [String](class_string) uri **)** + * [String](class_string) **[get_environment](#get_environment)** **(** [String](class_string) environment **)** const + * [bool](class_bool) **[has_environment](#has_environment)** **(** [String](class_string) environment **)** const + * [String](class_string) **[get_name](#get_name)** **(** **)** const + * [StringArray](class_stringarray) **[get_cmdline_args](#get_cmdline_args)** **(** **)** + * [Object](class_object) **[get_main_loop](#get_main_loop)** **(** **)** const + * [Dictionary](class_dictionary) **[get_date](#get_date)** **(** **)** const + * [Dictionary](class_dictionary) **[get_time](#get_time)** **(** **)** const + * [int](class_int) **[get_unix_time](#get_unix_time)** **(** **)** const + * void **[set_icon](#set_icon)** **(** [Image](class_image) arg0 **)** + * void **[delay_usec](#delay_usec)** **(** [int](class_int) usec **)** const + * void **[delay_msec](#delay_msec)** **(** [int](class_int) msec **)** const + * [int](class_int) **[get_ticks_msec](#get_ticks_msec)** **(** **)** const + * [String](class_string) **[get_locale](#get_locale)** **(** **)** const + * [String](class_string) **[get_model_name](#get_model_name)** **(** **)** const + * [String](class_string) **[get_custom_level](#get_custom_level)** **(** **)** const + * [bool](class_bool) **[can_draw](#can_draw)** **(** **)** const + * [int](class_int) **[get_frames_drawn](#get_frames_drawn)** **(** **)** + * [bool](class_bool) **[is_stdout_verbose](#is_stdout_verbose)** **(** **)** const + * [int](class_int) **[get_mouse_button_state](#get_mouse_button_state)** **(** **)** const + * void **[dump_memory_to_file](#dump_memory_to_file)** **(** [String](class_string) file **)** + * void **[dump_resources_to_file](#dump_resources_to_file)** **(** [String](class_string) file **)** + * void **[print_resources_in_use](#print_resources_in_use)** **(** [bool](class_bool) short=false **)** + * void **[print_all_resources](#print_all_resources)** **(** [String](class_string) tofile="" **)** + * [int](class_int) **[get_static_memory_usage](#get_static_memory_usage)** **(** **)** const + * [int](class_int) **[get_static_memory_peak_usage](#get_static_memory_peak_usage)** **(** **)** const + * [int](class_int) **[get_dynamic_memory_usage](#get_dynamic_memory_usage)** **(** **)** const + * [String](class_string) **[get_data_dir](#get_data_dir)** **(** **)** const + * [String](class_string) **[get_unique_ID](#get_unique_ID)** **(** **)** const + * [real](class_real) **[get_frames_per_second](#get_frames_per_second)** **(** **)** const ### Numeric Constants * **DAY_SUNDAY** = **0** @@ -90,157 +90,157 @@ Operating System functions. OS Wraps the most common functionality to communicat ### Member Function Description #### get_mouse_pos - * [Vector2](class_vector2) **`get_mouse_pos`** **(** **)** const + * [Vector2](class_vector2) **get_mouse_pos** **(** **)** const Return the mouse pos. #### set_clipboard - * void **`set_clipboard`** **(** [String](class_string) clipboard **)** + * void **set_clipboard** **(** [String](class_string) clipboard **)** Set clipboard to the OS. #### get_clipboard - * [String](class_string) **`get_clipboard`** **(** **)** const + * [String](class_string) **get_clipboard** **(** **)** const Get clipboard from the host OS. #### set_video_mode - * void **`set_video_mode`** **(** [Vector2](class_vector2) size, [bool](class_bool) fullscreen, [bool](class_bool) resizable, [int](class_int) screen=0 **)** + * void **set_video_mode** **(** [Vector2](class_vector2) size, [bool](class_bool) fullscreen, [bool](class_bool) resizable, [int](class_int) screen=0 **)** Change the video mode. #### get_video_mode_size - * [Vector2](class_vector2) **`get_video_mode_size`** **(** [int](class_int) screen=0 **)** const + * [Vector2](class_vector2) **get_video_mode_size** **(** [int](class_int) screen=0 **)** const Return the current video mode size. #### is_video_mode_fullscreen - * [bool](class_bool) **`is_video_mode_fullscreen`** **(** [int](class_int) screen=0 **)** const + * [bool](class_bool) **is_video_mode_fullscreen** **(** [int](class_int) screen=0 **)** const Return true if the current video mode is fullscreen. #### is_video_mode_resizable - * [bool](class_bool) **`is_video_mode_resizable`** **(** [int](class_int) screen=0 **)** const + * [bool](class_bool) **is_video_mode_resizable** **(** [int](class_int) screen=0 **)** const Return true if the window is resizable. #### get_fullscreen_mode_list - * [Array](class_array) **`get_fullscreen_mode_list`** **(** [int](class_int) screen=0 **)** const + * [Array](class_array) **get_fullscreen_mode_list** **(** [int](class_int) screen=0 **)** const Return the list of fullscreen modes. #### set_iterations_per_second - * void **`set_iterations_per_second`** **(** [int](class_int) iterations_per_second **)** + * void **set_iterations_per_second** **(** [int](class_int) iterations_per_second **)** Set the amount of fixed iterations per second (for fixed process and physics). #### get_iterations_per_second - * [int](class_int) **`get_iterations_per_second`** **(** **)** const + * [int](class_int) **get_iterations_per_second** **(** **)** const Return the amount of fixed iterations per second (for fixed process and physics). #### set_low_processor_usage_mode - * void **`set_low_processor_usage_mode`** **(** [bool](class_bool) enable **)** + * void **set_low_processor_usage_mode** **(** [bool](class_bool) enable **)** Set to true to enable the low cpu usage mode. In this mode, the screen only redraws when there are changes, and a considerable sleep time is inserted between frames. This way, editors using the engine UI only use very little cpu. #### is_in_low_processor_usage_mode - * [bool](class_bool) **`is_in_low_processor_usage_mode`** **(** **)** const + * [bool](class_bool) **is_in_low_processor_usage_mode** **(** **)** const Return true if low cpu usage mode is enabled. #### get_executable_path - * [String](class_string) **`get_executable_path`** **(** **)** const + * [String](class_string) **get_executable_path** **(** **)** const Return the path tot he current engine executable. #### execute - * [int](class_int) **`execute`** **(** [String](class_string) path, [StringArray](class_stringarray) arguments, [bool](class_bool) blocking **)** + * [int](class_int) **execute** **(** [String](class_string) path, [StringArray](class_stringarray) arguments, [bool](class_bool) blocking **)** Execute the binary file in given path, optionally blocking until it returns. A process ID is returned. #### kill - * [int](class_int) **`kill`** **(** [int](class_int) pid **)** + * [int](class_int) **kill** **(** [int](class_int) pid **)** Kill a process ID. #### get_environment - * [String](class_string) **`get_environment`** **(** [String](class_string) environment **)** const + * [String](class_string) **get_environment** **(** [String](class_string) environment **)** const Return an environment variable. #### has_environment - * [bool](class_bool) **`has_environment`** **(** [String](class_string) environment **)** const + * [bool](class_bool) **has_environment** **(** [String](class_string) environment **)** const Return true if an envieronment variable exists. #### get_name - * [String](class_string) **`get_name`** **(** **)** const + * [String](class_string) **get_name** **(** **)** const Return the name of the host OS. #### get_cmdline_args - * [StringArray](class_stringarray) **`get_cmdline_args`** **(** **)** + * [StringArray](class_stringarray) **get_cmdline_args** **(** **)** Return the commandline passed to the engine. #### get_main_loop - * [Object](class_object) **`get_main_loop`** **(** **)** const + * [Object](class_object) **get_main_loop** **(** **)** const Return the main loop object (see [MainLoop](class_mainloop)). #### get_date - * [Dictionary](class_dictionary) **`get_date`** **(** **)** const + * [Dictionary](class_dictionary) **get_date** **(** **)** const Return the current date. #### get_time - * [Dictionary](class_dictionary) **`get_time`** **(** **)** const + * [Dictionary](class_dictionary) **get_time** **(** **)** const Return the current time. #### delay_usec - * void **`delay_usec`** **(** [int](class_int) usec **)** const + * void **delay_usec** **(** [int](class_int) usec **)** const Delay executing of the current thread by given usecs. #### get_ticks_msec - * [int](class_int) **`get_ticks_msec`** **(** **)** const + * [int](class_int) **get_ticks_msec** **(** **)** const Return the amount of time passed in milliseconds since the engine started. #### get_locale - * [String](class_string) **`get_locale`** **(** **)** const + * [String](class_string) **get_locale** **(** **)** const Return the host OS locale. #### can_draw - * [bool](class_bool) **`can_draw`** **(** **)** const + * [bool](class_bool) **can_draw** **(** **)** const Return true if the host OS allows drawing. #### get_frames_drawn - * [int](class_int) **`get_frames_drawn`** **(** **)** + * [int](class_int) **get_frames_drawn** **(** **)** Return the total amount of frames drawn. #### is_stdout_verbose - * [bool](class_bool) **`is_stdout_verbose`** **(** **)** const + * [bool](class_bool) **is_stdout_verbose** **(** **)** const Return true if the engine was executed with -v (verbose stdout). #### get_mouse_button_state - * [int](class_int) **`get_mouse_button_state`** **(** **)** const + * [int](class_int) **get_mouse_button_state** **(** **)** const Return the state of the mouse buttons (each button in each bit). #### get_static_memory_peak_usage - * [int](class_int) **`get_static_memory_peak_usage`** **(** **)** const + * [int](class_int) **get_static_memory_peak_usage** **(** **)** const Return the max amount of static memory used (only works in debug). #### get_dynamic_memory_usage - * [int](class_int) **`get_dynamic_memory_usage`** **(** **)** const + * [int](class_int) **get_dynamic_memory_usage** **(** **)** const Return the total amount of dynamic memory used (only works in debug). diff --git a/class_packeddatacontainer.md b/class_packeddatacontainer.md index b24aa28..ec041c7 100644 --- a/class_packeddatacontainer.md +++ b/class_packeddatacontainer.md @@ -6,7 +6,7 @@ ### Member Functions - * [int](class_int) **[`pack`](#pack)** **(** var value **)** - * [int](class_int) **[`size`](#size)** **(** **)** const + * [int](class_int) **[pack](#pack)** **(** var value **)** + * [int](class_int) **[size](#size)** **(** **)** const ### Member Function Description diff --git a/class_packeddatacontainerref.md b/class_packeddatacontainerref.md index f8ebbca..beaf19d 100644 --- a/class_packeddatacontainerref.md +++ b/class_packeddatacontainerref.md @@ -6,6 +6,6 @@ ### Member Functions - * [int](class_int) **[`size`](#size)** **(** **)** const + * [int](class_int) **[size](#size)** **(** **)** const ### Member Function Description diff --git a/class_packedscene.md b/class_packedscene.md index 9a49d02..b3bcc2f 100644 --- a/class_packedscene.md +++ b/class_packedscene.md @@ -6,9 +6,9 @@ ### Member Functions - * [int](class_int) **[`pack`](#pack)** **(** [Node](class_node) path **)** - * [Node](class_node) **[`instance`](#instance)** **(** [bool](class_bool) arg0=false **)** const - * [bool](class_bool) **[`can_instance`](#can_instance)** **(** **)** const + * [int](class_int) **[pack](#pack)** **(** [Node](class_node) path **)** + * [Node](class_node) **[instance](#instance)** **(** [bool](class_bool) arg0=false **)** const + * [bool](class_bool) **[can_instance](#can_instance)** **(** **)** const ### Description explain ownership, and that node does not need to own itself @@ -16,7 +16,7 @@ explain ownership, and that node does not need to own itself ### Member Function Description #### pack - * [int](class_int) **`pack`** **(** [Node](class_node) path **)** + * [int](class_int) **pack** **(** [Node](class_node) path **)** Pack will ignore any sub-nodes not owned by given node. See [Node.set_owner]. diff --git a/class_packetpeer.md b/class_packetpeer.md index 892a896..ac24b64 100644 --- a/class_packetpeer.md +++ b/class_packetpeer.md @@ -6,8 +6,8 @@ Abstraction and base class for packet-based protocols. ### Member Functions - * void **[`get_var`](#get_var)** **(** **)** const - * [int](class_int) **[`put_var`](#put_var)** **(** Variant var **)** + * void **[get_var](#get_var)** **(** **)** const + * [int](class_int) **[put_var](#put_var)** **(** Variant var **)** ### Description PacketPeer is an abstration and base class for packet-based protocols (such as UDP). It provides an API for sending and receiving packets both as raw data or variables. This makes it easy to transfer data over a protocol, without having to encode data as low level bytes or having to worry about network ordering. diff --git a/class_packetpeerstream.md b/class_packetpeerstream.md index 0afa965..d83cbcb 100644 --- a/class_packetpeerstream.md +++ b/class_packetpeerstream.md @@ -6,7 +6,7 @@ Wrapper to use a PacketPeer over a StreamPeer. ### Member Functions - * void **[`set_stream_peer`](#set_stream_peer)** **(** [StreamPeer](class_streampeer) peer **)** + * void **[set_stream_peer](#set_stream_peer)** **(** [StreamPeer](class_streampeer) peer **)** ### Description PacketStreamPeer provides a wrapper for working using packets over a stream. This allows for using packet based code with StreamPeers. PacketPeerStream implements a custom protocol over the StreamPeer, so the user should not read or write to the wrapped StreamPeer directly. @@ -14,6 +14,6 @@ PacketStreamPeer provides a wrapper for working using packets over a stream. Thi ### Member Function Description #### set_stream_peer - * void **`set_stream_peer`** **(** [StreamPeer](class_streampeer) peer **)** + * void **set_stream_peer** **(** [StreamPeer](class_streampeer) peer **)** Set the StreamPeer object to be wrapped diff --git a/class_parallaxbackground.md b/class_parallaxbackground.md index b6a8096..e0db78e 100644 --- a/class_parallaxbackground.md +++ b/class_parallaxbackground.md @@ -6,15 +6,15 @@ ### Member Functions - * void **[`set_scroll_offset`](#set_scroll_offset)** **(** [Vector2](class_vector2) ofs **)** - * [Vector2](class_vector2) **[`get_scroll_offset`](#get_scroll_offset)** **(** **)** const - * void **[`set_scroll_base_offset`](#set_scroll_base_offset)** **(** [Vector2](class_vector2) ofs **)** - * [Vector2](class_vector2) **[`get_scroll_base_offset`](#get_scroll_base_offset)** **(** **)** const - * void **[`set_scroll_base_scale`](#set_scroll_base_scale)** **(** [Vector2](class_vector2) scale **)** - * [Vector2](class_vector2) **[`get_scroll_base_scale`](#get_scroll_base_scale)** **(** **)** const - * void **[`set_limit_begin`](#set_limit_begin)** **(** [Vector2](class_vector2) ofs **)** - * [Vector2](class_vector2) **[`get_limit_begin`](#get_limit_begin)** **(** **)** const - * void **[`set_limit_end`](#set_limit_end)** **(** [Vector2](class_vector2) ofs **)** - * [Vector2](class_vector2) **[`get_limit_end`](#get_limit_end)** **(** **)** const + * void **[set_scroll_offset](#set_scroll_offset)** **(** [Vector2](class_vector2) ofs **)** + * [Vector2](class_vector2) **[get_scroll_offset](#get_scroll_offset)** **(** **)** const + * void **[set_scroll_base_offset](#set_scroll_base_offset)** **(** [Vector2](class_vector2) ofs **)** + * [Vector2](class_vector2) **[get_scroll_base_offset](#get_scroll_base_offset)** **(** **)** const + * void **[set_scroll_base_scale](#set_scroll_base_scale)** **(** [Vector2](class_vector2) scale **)** + * [Vector2](class_vector2) **[get_scroll_base_scale](#get_scroll_base_scale)** **(** **)** const + * void **[set_limit_begin](#set_limit_begin)** **(** [Vector2](class_vector2) ofs **)** + * [Vector2](class_vector2) **[get_limit_begin](#get_limit_begin)** **(** **)** const + * void **[set_limit_end](#set_limit_end)** **(** [Vector2](class_vector2) ofs **)** + * [Vector2](class_vector2) **[get_limit_end](#get_limit_end)** **(** **)** const ### Member Function Description diff --git a/class_parallaxlayer.md b/class_parallaxlayer.md index 4239f40..a5560c8 100644 --- a/class_parallaxlayer.md +++ b/class_parallaxlayer.md @@ -6,9 +6,9 @@ ### Member Functions - * void **[`set_motion_scale`](#set_motion_scale)** **(** [Vector2](class_vector2) scale **)** - * [Vector2](class_vector2) **[`get_motion_scale`](#get_motion_scale)** **(** **)** const - * void **[`set_mirroring`](#set_mirroring)** **(** [Vector2](class_vector2) mirror **)** - * [Vector2](class_vector2) **[`get_mirroring`](#get_mirroring)** **(** **)** const + * void **[set_motion_scale](#set_motion_scale)** **(** [Vector2](class_vector2) scale **)** + * [Vector2](class_vector2) **[get_motion_scale](#get_motion_scale)** **(** **)** const + * void **[set_mirroring](#set_mirroring)** **(** [Vector2](class_vector2) mirror **)** + * [Vector2](class_vector2) **[get_mirroring](#get_mirroring)** **(** **)** const ### Member Function Description diff --git a/class_particleattractor2d.md b/class_particleattractor2d.md index eb6dcb0..2dd88c2 100644 --- a/class_particleattractor2d.md +++ b/class_particleattractor2d.md @@ -6,17 +6,17 @@ ### Member Functions - * void **[`set_enabled`](#set_enabled)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`is_enabled`](#is_enabled)** **(** **)** const - * void **[`set_radius`](#set_radius)** **(** [real](class_real) radius **)** - * [real](class_real) **[`get_radius`](#get_radius)** **(** **)** const - * void **[`set_disable_radius`](#set_disable_radius)** **(** [real](class_real) radius **)** - * [real](class_real) **[`get_disable_radius`](#get_disable_radius)** **(** **)** const - * void **[`set_gravity`](#set_gravity)** **(** [real](class_real) gravity **)** - * [real](class_real) **[`get_gravity`](#get_gravity)** **(** **)** const - * void **[`set_absorption`](#set_absorption)** **(** [real](class_real) absorption **)** - * [real](class_real) **[`get_absorption`](#get_absorption)** **(** **)** const - * void **[`set_particles_path`](#set_particles_path)** **(** [NodePath](class_nodepath) path **)** - * [NodePath](class_nodepath) **[`get_particles_path`](#get_particles_path)** **(** **)** const + * void **[set_enabled](#set_enabled)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[is_enabled](#is_enabled)** **(** **)** const + * void **[set_radius](#set_radius)** **(** [real](class_real) radius **)** + * [real](class_real) **[get_radius](#get_radius)** **(** **)** const + * void **[set_disable_radius](#set_disable_radius)** **(** [real](class_real) radius **)** + * [real](class_real) **[get_disable_radius](#get_disable_radius)** **(** **)** const + * void **[set_gravity](#set_gravity)** **(** [real](class_real) gravity **)** + * [real](class_real) **[get_gravity](#get_gravity)** **(** **)** const + * void **[set_absorption](#set_absorption)** **(** [real](class_real) absorption **)** + * [real](class_real) **[get_absorption](#get_absorption)** **(** **)** const + * void **[set_particles_path](#set_particles_path)** **(** [NodePath](class_nodepath) path **)** + * [NodePath](class_nodepath) **[get_particles_path](#get_particles_path)** **(** **)** const ### Member Function Description diff --git a/class_particles.md b/class_particles.md index 58ea8f6..a41b8bc 100644 --- a/class_particles.md +++ b/class_particles.md @@ -6,38 +6,38 @@ Particle system 3D Node ### Member Functions - * void **[`set_amount`](#set_amount)** **(** [int](class_int) amount **)** - * [int](class_int) **[`get_amount`](#get_amount)** **(** **)** const - * void **[`set_emitting`](#set_emitting)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`is_emitting`](#is_emitting)** **(** **)** const - * void **[`set_visibility_aabb`](#set_visibility_aabb)** **(** [AABB](class_aabb) aabb **)** - * [AABB](class_aabb) **[`get_visibility_aabb`](#get_visibility_aabb)** **(** **)** const - * void **[`set_emission_half_extents`](#set_emission_half_extents)** **(** [Vector3](class_vector3) half_extents **)** - * [Vector3](class_vector3) **[`get_emission_half_extents`](#get_emission_half_extents)** **(** **)** const - * void **[`set_emission_base_velocity`](#set_emission_base_velocity)** **(** [Vector3](class_vector3) base_velocity **)** - * [Vector3](class_vector3) **[`get_emission_base_velocity`](#get_emission_base_velocity)** **(** **)** const - * void **[`set_emission_points`](#set_emission_points)** **(** [Vector3Array](class_vector3array) points **)** - * [Vector3Array](class_vector3array) **[`get_emission_points`](#get_emission_points)** **(** **)** const - * void **[`set_gravity_normal`](#set_gravity_normal)** **(** [Vector3](class_vector3) normal **)** - * [Vector3](class_vector3) **[`get_gravity_normal`](#get_gravity_normal)** **(** **)** const - * void **[`set_variable`](#set_variable)** **(** [int](class_int) variable, [real](class_real) value **)** - * [real](class_real) **[`get_variable`](#get_variable)** **(** [int](class_int) variable **)** const - * void **[`set_randomness`](#set_randomness)** **(** [int](class_int) variable, [real](class_real) randomness **)** - * [real](class_real) **[`get_randomness`](#get_randomness)** **(** [int](class_int) arg0 **)** const - * void **[`set_color_phase_pos`](#set_color_phase_pos)** **(** [int](class_int) phase, [real](class_real) pos **)** - * [real](class_real) **[`get_color_phase_pos`](#get_color_phase_pos)** **(** [int](class_int) phase **)** const - * void **[`set_color_phase_color`](#set_color_phase_color)** **(** [int](class_int) phase, [Color](class_color) color **)** - * [Color](class_color) **[`get_color_phase_color`](#get_color_phase_color)** **(** [int](class_int) phase **)** const - * void **[`set_material`](#set_material)** **(** [Material](class_material) material **)** - * [Material](class_material) **[`get_material`](#get_material)** **(** **)** const - * void **[`set_emit_timeout`](#set_emit_timeout)** **(** [real](class_real) arg0 **)** - * [real](class_real) **[`get_emit_timeout`](#get_emit_timeout)** **(** **)** const - * void **[`set_height_from_velocity`](#set_height_from_velocity)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`has_height_from_velocity`](#has_height_from_velocity)** **(** **)** const - * void **[`set_use_local_coordinates`](#set_use_local_coordinates)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_using_local_coordinates`](#is_using_local_coordinates)** **(** **)** const - * void **[`set_color_phases`](#set_color_phases)** **(** [int](class_int) count **)** - * [int](class_int) **[`get_color_phases`](#get_color_phases)** **(** **)** const + * void **[set_amount](#set_amount)** **(** [int](class_int) amount **)** + * [int](class_int) **[get_amount](#get_amount)** **(** **)** const + * void **[set_emitting](#set_emitting)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[is_emitting](#is_emitting)** **(** **)** const + * void **[set_visibility_aabb](#set_visibility_aabb)** **(** [AABB](class_aabb) aabb **)** + * [AABB](class_aabb) **[get_visibility_aabb](#get_visibility_aabb)** **(** **)** const + * void **[set_emission_half_extents](#set_emission_half_extents)** **(** [Vector3](class_vector3) half_extents **)** + * [Vector3](class_vector3) **[get_emission_half_extents](#get_emission_half_extents)** **(** **)** const + * void **[set_emission_base_velocity](#set_emission_base_velocity)** **(** [Vector3](class_vector3) base_velocity **)** + * [Vector3](class_vector3) **[get_emission_base_velocity](#get_emission_base_velocity)** **(** **)** const + * void **[set_emission_points](#set_emission_points)** **(** [Vector3Array](class_vector3array) points **)** + * [Vector3Array](class_vector3array) **[get_emission_points](#get_emission_points)** **(** **)** const + * void **[set_gravity_normal](#set_gravity_normal)** **(** [Vector3](class_vector3) normal **)** + * [Vector3](class_vector3) **[get_gravity_normal](#get_gravity_normal)** **(** **)** const + * void **[set_variable](#set_variable)** **(** [int](class_int) variable, [real](class_real) value **)** + * [real](class_real) **[get_variable](#get_variable)** **(** [int](class_int) variable **)** const + * void **[set_randomness](#set_randomness)** **(** [int](class_int) variable, [real](class_real) randomness **)** + * [real](class_real) **[get_randomness](#get_randomness)** **(** [int](class_int) arg0 **)** const + * void **[set_color_phase_pos](#set_color_phase_pos)** **(** [int](class_int) phase, [real](class_real) pos **)** + * [real](class_real) **[get_color_phase_pos](#get_color_phase_pos)** **(** [int](class_int) phase **)** const + * void **[set_color_phase_color](#set_color_phase_color)** **(** [int](class_int) phase, [Color](class_color) color **)** + * [Color](class_color) **[get_color_phase_color](#get_color_phase_color)** **(** [int](class_int) phase **)** const + * void **[set_material](#set_material)** **(** [Material](class_material) material **)** + * [Material](class_material) **[get_material](#get_material)** **(** **)** const + * void **[set_emit_timeout](#set_emit_timeout)** **(** [real](class_real) arg0 **)** + * [real](class_real) **[get_emit_timeout](#get_emit_timeout)** **(** **)** const + * void **[set_height_from_velocity](#set_height_from_velocity)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[has_height_from_velocity](#has_height_from_velocity)** **(** **)** const + * void **[set_use_local_coordinates](#set_use_local_coordinates)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_using_local_coordinates](#is_using_local_coordinates)** **(** **)** const + * void **[set_color_phases](#set_color_phases)** **(** [int](class_int) count **)** + * [int](class_int) **[get_color_phases](#get_color_phases)** **(** **)** const ### Numeric Constants * **VAR_LIFETIME** = **0** @@ -61,101 +61,101 @@ Particles is a particle system 3D [Node](class_node) that is used to simulate se ### Member Function Description #### set_amount - * void **`set_amount`** **(** [int](class_int) amount **)** + * void **set_amount** **(** [int](class_int) amount **)** Set total amount of particles in the system. #### get_amount - * [int](class_int) **`get_amount`** **(** **)** const + * [int](class_int) **get_amount** **(** **)** const Return the total amount of particles in the system. #### set_emitting - * void **`set_emitting`** **(** [bool](class_bool) enabled **)** + * void **set_emitting** **(** [bool](class_bool) enabled **)** Set the "emitting" property state. When emitting, the particle system generates new particles at constant rate. #### is_emitting - * [bool](class_bool) **`is_emitting`** **(** **)** const + * [bool](class_bool) **is_emitting** **(** **)** const -Return the "emitting" property state (see [`set_emitting`](#set_emitting)). +Return the "emitting" property state (see [set_emitting](#set_emitting)). #### set_visibility_aabb - * void **`set_visibility_aabb`** **(** [AABB](class_aabb) aabb **)** + * void **set_visibility_aabb** **(** [AABB](class_aabb) aabb **)** Set the visibility AABB for the particle system, since the default one will not work properly most of the time. #### get_visibility_aabb - * [AABB](class_aabb) **`get_visibility_aabb`** **(** **)** const + * [AABB](class_aabb) **get_visibility_aabb** **(** **)** const Return the current visibility AABB. #### set_emission_half_extents - * void **`set_emission_half_extents`** **(** [Vector3](class_vector3) half_extents **)** + * void **set_emission_half_extents** **(** [Vector3](class_vector3) half_extents **)** Set the half extents for the emission box. #### get_emission_half_extents - * [Vector3](class_vector3) **`get_emission_half_extents`** **(** **)** const + * [Vector3](class_vector3) **get_emission_half_extents** **(** **)** const Return the half extents for the emission box. #### set_gravity_normal - * void **`set_gravity_normal`** **(** [Vector3](class_vector3) normal **)** + * void **set_gravity_normal** **(** [Vector3](class_vector3) normal **)** Set the normal vector towards where gravity is pulling (by default, negative Y). #### get_gravity_normal - * [Vector3](class_vector3) **`get_gravity_normal`** **(** **)** const + * [Vector3](class_vector3) **get_gravity_normal** **(** **)** const Return the normal vector towards where gravity is pulling (by default, negative Y). #### set_variable - * void **`set_variable`** **(** [int](class_int) variable, [real](class_real) value **)** + * void **set_variable** **(** [int](class_int) variable, [real](class_real) value **)** Set a specific variable for the particle system (see VAR_* enum). #### get_variable - * [real](class_real) **`get_variable`** **(** [int](class_int) variable **)** const + * [real](class_real) **get_variable** **(** [int](class_int) variable **)** const Return a specific variable for the particle system (see VAR_* enum). #### set_randomness - * void **`set_randomness`** **(** [int](class_int) variable, [real](class_real) randomness **)** + * void **set_randomness** **(** [int](class_int) variable, [real](class_real) randomness **)** Set the randomness for a specific variable of the particle system. Randomness produces small changes from the default each time a particle is emitted. #### get_randomness - * [real](class_real) **`get_randomness`** **(** [int](class_int) arg0 **)** const + * [real](class_real) **get_randomness** **(** [int](class_int) arg0 **)** const Return the randomness for a specific variable of the particle system. Randomness produces small changes from the default each time a particle is emitted. #### set_color_phase_pos - * void **`set_color_phase_pos`** **(** [int](class_int) phase, [real](class_real) pos **)** + * void **set_color_phase_pos** **(** [int](class_int) phase, [real](class_real) pos **)** Set the position of a color phase (0 to 1) #### get_color_phase_pos - * [real](class_real) **`get_color_phase_pos`** **(** [int](class_int) phase **)** const + * [real](class_real) **get_color_phase_pos** **(** [int](class_int) phase **)** const Return the position of a color phase (0 to 1) #### set_color_phase_color - * void **`set_color_phase_color`** **(** [int](class_int) phase, [Color](class_color) color **)** + * void **set_color_phase_color** **(** [int](class_int) phase, [Color](class_color) color **)** Set the color of a color phase. #### get_color_phase_color - * [Color](class_color) **`get_color_phase_color`** **(** [int](class_int) phase **)** const + * [Color](class_color) **get_color_phase_color** **(** [int](class_int) phase **)** const Return the color of a color phase. #### set_material - * void **`set_material`** **(** [Material](class_material) material **)** + * void **set_material** **(** [Material](class_material) material **)** Set the material used to draw particles #### get_material - * [Material](class_material) **`get_material`** **(** **)** const + * [Material](class_material) **get_material** **(** **)** const Return the material used to draw particles diff --git a/class_particles2d.md b/class_particles2d.md index 592b642..3308e94 100644 --- a/class_particles2d.md +++ b/class_particles2d.md @@ -6,47 +6,47 @@ ### Member Functions - * void **[`set_emitting`](#set_emitting)** **(** [bool](class_bool) active **)** - * [bool](class_bool) **[`is_emitting`](#is_emitting)** **(** **)** const - * void **[`set_amount`](#set_amount)** **(** [int](class_int) amount **)** - * [int](class_int) **[`get_amount`](#get_amount)** **(** **)** const - * void **[`set_lifetime`](#set_lifetime)** **(** [real](class_real) lifetime **)** - * [real](class_real) **[`get_lifetime`](#get_lifetime)** **(** **)** const - * void **[`set_time_scale`](#set_time_scale)** **(** [real](class_real) time_scale **)** - * [real](class_real) **[`get_time_scale`](#get_time_scale)** **(** **)** const - * void **[`set_pre_process_time`](#set_pre_process_time)** **(** [real](class_real) time **)** - * [real](class_real) **[`get_pre_process_time`](#get_pre_process_time)** **(** **)** const - * void **[`set_emit_timeout`](#set_emit_timeout)** **(** [real](class_real) value **)** - * [real](class_real) **[`get_emit_timeout`](#get_emit_timeout)** **(** **)** const - * void **[`set_param`](#set_param)** **(** [int](class_int) param, [real](class_real) value **)** - * [real](class_real) **[`get_param`](#get_param)** **(** [int](class_int) param **)** const - * void **[`set_randomness`](#set_randomness)** **(** [int](class_int) param, [real](class_real) value **)** - * [real](class_real) **[`get_randomness`](#get_randomness)** **(** [int](class_int) param **)** const - * void **[`set_texture`](#set_texture)** **(** [Object](class_object) texture **)** - * [Texture](class_texture) **[`get_texture`](#get_texture)** **(** **)** const - * void **[`set_emissor_offset`](#set_emissor_offset)** **(** [Vector2](class_vector2) offset **)** - * [Vector2](class_vector2) **[`get_emissor_offset`](#get_emissor_offset)** **(** **)** const - * void **[`set_flip_h`](#set_flip_h)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_flipped_h`](#is_flipped_h)** **(** **)** const - * void **[`set_flip_v`](#set_flip_v)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_flipped_v`](#is_flipped_v)** **(** **)** const - * void **[`set_emission_half_extents`](#set_emission_half_extents)** **(** [Vector2](class_vector2) extents **)** - * [Vector2](class_vector2) **[`get_emission_half_extents`](#get_emission_half_extents)** **(** **)** const - * void **[`set_color_phases`](#set_color_phases)** **(** [int](class_int) phases **)** - * [int](class_int) **[`get_color_phases`](#get_color_phases)** **(** **)** const - * void **[`set_color_phase_color`](#set_color_phase_color)** **(** [int](class_int) phase, [Color](class_color) color **)** - * [Color](class_color) **[`get_color_phase_color`](#get_color_phase_color)** **(** [int](class_int) phase **)** const - * void **[`set_color_phase_pos`](#set_color_phase_pos)** **(** [int](class_int) phase, [real](class_real) pos **)** - * [real](class_real) **[`get_color_phase_pos`](#get_color_phase_pos)** **(** [int](class_int) phase **)** const - * void **[`pre_process`](#pre_process)** **(** [real](class_real) time **)** - * void **[`set_use_local_space`](#set_use_local_space)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_using_local_space`](#is_using_local_space)** **(** **)** const - * void **[`set_initial_velocity`](#set_initial_velocity)** **(** [Vector2](class_vector2) velocity **)** - * [Vector2](class_vector2) **[`get_initial_velocity`](#get_initial_velocity)** **(** **)** const - * void **[`set_explosiveness`](#set_explosiveness)** **(** [real](class_real) amount **)** - * [real](class_real) **[`get_explosiveness`](#get_explosiveness)** **(** **)** const - * void **[`set_emission_points`](#set_emission_points)** **(** [Vector2Array](class_vector2array) points **)** - * [Vector2Array](class_vector2array) **[`get_emission_points`](#get_emission_points)** **(** **)** const + * void **[set_emitting](#set_emitting)** **(** [bool](class_bool) active **)** + * [bool](class_bool) **[is_emitting](#is_emitting)** **(** **)** const + * void **[set_amount](#set_amount)** **(** [int](class_int) amount **)** + * [int](class_int) **[get_amount](#get_amount)** **(** **)** const + * void **[set_lifetime](#set_lifetime)** **(** [real](class_real) lifetime **)** + * [real](class_real) **[get_lifetime](#get_lifetime)** **(** **)** const + * void **[set_time_scale](#set_time_scale)** **(** [real](class_real) time_scale **)** + * [real](class_real) **[get_time_scale](#get_time_scale)** **(** **)** const + * void **[set_pre_process_time](#set_pre_process_time)** **(** [real](class_real) time **)** + * [real](class_real) **[get_pre_process_time](#get_pre_process_time)** **(** **)** const + * void **[set_emit_timeout](#set_emit_timeout)** **(** [real](class_real) value **)** + * [real](class_real) **[get_emit_timeout](#get_emit_timeout)** **(** **)** const + * void **[set_param](#set_param)** **(** [int](class_int) param, [real](class_real) value **)** + * [real](class_real) **[get_param](#get_param)** **(** [int](class_int) param **)** const + * void **[set_randomness](#set_randomness)** **(** [int](class_int) param, [real](class_real) value **)** + * [real](class_real) **[get_randomness](#get_randomness)** **(** [int](class_int) param **)** const + * void **[set_texture](#set_texture)** **(** [Object](class_object) texture **)** + * [Texture](class_texture) **[get_texture](#get_texture)** **(** **)** const + * void **[set_emissor_offset](#set_emissor_offset)** **(** [Vector2](class_vector2) offset **)** + * [Vector2](class_vector2) **[get_emissor_offset](#get_emissor_offset)** **(** **)** const + * void **[set_flip_h](#set_flip_h)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_flipped_h](#is_flipped_h)** **(** **)** const + * void **[set_flip_v](#set_flip_v)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_flipped_v](#is_flipped_v)** **(** **)** const + * void **[set_emission_half_extents](#set_emission_half_extents)** **(** [Vector2](class_vector2) extents **)** + * [Vector2](class_vector2) **[get_emission_half_extents](#get_emission_half_extents)** **(** **)** const + * void **[set_color_phases](#set_color_phases)** **(** [int](class_int) phases **)** + * [int](class_int) **[get_color_phases](#get_color_phases)** **(** **)** const + * void **[set_color_phase_color](#set_color_phase_color)** **(** [int](class_int) phase, [Color](class_color) color **)** + * [Color](class_color) **[get_color_phase_color](#get_color_phase_color)** **(** [int](class_int) phase **)** const + * void **[set_color_phase_pos](#set_color_phase_pos)** **(** [int](class_int) phase, [real](class_real) pos **)** + * [real](class_real) **[get_color_phase_pos](#get_color_phase_pos)** **(** [int](class_int) phase **)** const + * void **[pre_process](#pre_process)** **(** [real](class_real) time **)** + * void **[set_use_local_space](#set_use_local_space)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_using_local_space](#is_using_local_space)** **(** **)** const + * void **[set_initial_velocity](#set_initial_velocity)** **(** [Vector2](class_vector2) velocity **)** + * [Vector2](class_vector2) **[get_initial_velocity](#get_initial_velocity)** **(** **)** const + * void **[set_explosiveness](#set_explosiveness)** **(** [real](class_real) amount **)** + * [real](class_real) **[get_explosiveness](#get_explosiveness)** **(** **)** const + * void **[set_emission_points](#set_emission_points)** **(** [Vector2Array](class_vector2array) points **)** + * [Vector2Array](class_vector2array) **[get_emission_points](#get_emission_points)** **(** **)** const ### Numeric Constants * **PARAM_DIRECTION** = **0** diff --git a/class_particlesystemmaterial.md b/class_particlesystemmaterial.md index 40ccc82..5a4c37d 100644 --- a/class_particlesystemmaterial.md +++ b/class_particlesystemmaterial.md @@ -6,7 +6,7 @@ ### Member Functions - * void **[`set_texture`](#set_texture)** **(** [Object](class_object) texture **)** - * [Texture](class_texture) **[`get_texture`](#get_texture)** **(** **)** const + * void **[set_texture](#set_texture)** **(** [Object](class_object) texture **)** + * [Texture](class_texture) **[get_texture](#get_texture)** **(** **)** const ### Member Function Description diff --git a/class_path.md b/class_path.md index 0cbc03f..ef75610 100644 --- a/class_path.md +++ b/class_path.md @@ -6,7 +6,7 @@ ### Member Functions - * void **[`set_curve`](#set_curve)** **(** [Curve3D](class_curve3d) curve **)** - * [Curve3D](class_curve3d) **[`get_curve`](#get_curve)** **(** **)** const + * void **[set_curve](#set_curve)** **(** [Curve3D](class_curve3d) curve **)** + * [Curve3D](class_curve3d) **[get_curve](#get_curve)** **(** **)** const ### Member Function Description diff --git a/class_path2d.md b/class_path2d.md index d13543d..d8e04f2 100644 --- a/class_path2d.md +++ b/class_path2d.md @@ -6,7 +6,7 @@ ### Member Functions - * void **[`set_curve`](#set_curve)** **(** [Curve2D](class_curve2d) curve **)** - * [Curve2D](class_curve2d) **[`get_curve`](#get_curve)** **(** **)** const + * void **[set_curve](#set_curve)** **(** [Curve2D](class_curve2d) curve **)** + * [Curve2D](class_curve2d) **[get_curve](#get_curve)** **(** **)** const ### Member Function Description diff --git a/class_pathfollow.md b/class_pathfollow.md index ca2a04b..715ea00 100644 --- a/class_pathfollow.md +++ b/class_pathfollow.md @@ -6,20 +6,20 @@ ### Member Functions - * void **[`set_offset`](#set_offset)** **(** [real](class_real) offset **)** - * [real](class_real) **[`get_offset`](#get_offset)** **(** **)** const - * void **[`set_h_offset`](#set_h_offset)** **(** [real](class_real) h_offset **)** - * [real](class_real) **[`get_h_offset`](#get_h_offset)** **(** **)** const - * void **[`set_v_offset`](#set_v_offset)** **(** [real](class_real) v_offset **)** - * [real](class_real) **[`get_v_offset`](#get_v_offset)** **(** **)** const - * void **[`set_unit_offset`](#set_unit_offset)** **(** [real](class_real) unit_offset **)** - * [real](class_real) **[`get_unit_offset`](#get_unit_offset)** **(** **)** const - * void **[`set_rotation_mode`](#set_rotation_mode)** **(** [int](class_int) rotation_mode **)** - * [int](class_int) **[`get_rotation_mode`](#get_rotation_mode)** **(** **)** const - * void **[`set_cubic_interpolation`](#set_cubic_interpolation)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`get_cubic_interpolation`](#get_cubic_interpolation)** **(** **)** const - * void **[`set_loop`](#set_loop)** **(** [bool](class_bool) loop **)** - * [bool](class_bool) **[`has_loop`](#has_loop)** **(** **)** const + * void **[set_offset](#set_offset)** **(** [real](class_real) offset **)** + * [real](class_real) **[get_offset](#get_offset)** **(** **)** const + * void **[set_h_offset](#set_h_offset)** **(** [real](class_real) h_offset **)** + * [real](class_real) **[get_h_offset](#get_h_offset)** **(** **)** const + * void **[set_v_offset](#set_v_offset)** **(** [real](class_real) v_offset **)** + * [real](class_real) **[get_v_offset](#get_v_offset)** **(** **)** const + * void **[set_unit_offset](#set_unit_offset)** **(** [real](class_real) unit_offset **)** + * [real](class_real) **[get_unit_offset](#get_unit_offset)** **(** **)** const + * void **[set_rotation_mode](#set_rotation_mode)** **(** [int](class_int) rotation_mode **)** + * [int](class_int) **[get_rotation_mode](#get_rotation_mode)** **(** **)** const + * void **[set_cubic_interpolation](#set_cubic_interpolation)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[get_cubic_interpolation](#get_cubic_interpolation)** **(** **)** const + * void **[set_loop](#set_loop)** **(** [bool](class_bool) loop **)** + * [bool](class_bool) **[has_loop](#has_loop)** **(** **)** const ### Numeric Constants * **ROTATION_NONE** = **0** diff --git a/class_pathremap.md b/class_pathremap.md index 82efc8e..54fa6da 100644 --- a/class_pathremap.md +++ b/class_pathremap.md @@ -6,11 +6,11 @@ Singleton containing the list of remapped resources. ### Member Functions - * void **[`add_remap`](#add_remap)** **(** [String](class_string) from, [String](class_string) to, [String](class_string) locale="" **)** - * [bool](class_bool) **[`has_remap`](#has_remap)** **(** [String](class_string) path **)** const - * [String](class_string) **[`get_remap`](#get_remap)** **(** [String](class_string) path **)** const - * void **[`erase_remap`](#erase_remap)** **(** [String](class_string) path **)** - * void **[`clear_remaps`](#clear_remaps)** **(** **)** + * void **[add_remap](#add_remap)** **(** [String](class_string) from, [String](class_string) to, [String](class_string) locale="" **)** + * [bool](class_bool) **[has_remap](#has_remap)** **(** [String](class_string) path **)** const + * [String](class_string) **[get_remap](#get_remap)** **(** [String](class_string) path **)** const + * void **[erase_remap](#erase_remap)** **(** [String](class_string) path **)** + * void **[clear_remaps](#clear_remaps)** **(** **)** ### Description When exporting, the types of some resources may change internally so they are converted to more optimized versions. While it's not usually necesary to access to this directly (path remapping happens automatically when opeining a file), it's exported just for information. @@ -18,26 +18,26 @@ When exporting, the types of some resources may change internally so they are co ### Member Function Description #### add_remap - * void **`add_remap`** **(** [String](class_string) from, [String](class_string) to, [String](class_string) locale="" **)** + * void **add_remap** **(** [String](class_string) from, [String](class_string) to, [String](class_string) locale="" **)** Add a remap from a file to another. #### has_remap - * [bool](class_bool) **`has_remap`** **(** [String](class_string) path **)** const + * [bool](class_bool) **has_remap** **(** [String](class_string) path **)** const Return true if a file is being remapped. #### get_remap - * [String](class_string) **`get_remap`** **(** [String](class_string) path **)** const + * [String](class_string) **get_remap** **(** [String](class_string) path **)** const Return the remapped new path of a file. #### erase_remap - * void **`erase_remap`** **(** [String](class_string) path **)** + * void **erase_remap** **(** [String](class_string) path **)** Erase a remap. #### clear_remaps - * void **`clear_remaps`** **(** **)** + * void **clear_remaps** **(** **)** Clear all remaps. diff --git a/class_performance.md b/class_performance.md index b1890b2..6387b71 100644 --- a/class_performance.md +++ b/class_performance.md @@ -6,7 +6,7 @@ ### Member Functions - * [real](class_real) **[`get_monitor`](#get_monitor)** **(** [int](class_int) monitor **)** const + * [real](class_real) **[get_monitor](#get_monitor)** **(** [int](class_int) monitor **)** const ### Numeric Constants * **TIME_FPS** = **0** diff --git a/class_phashtranslation.md b/class_phashtranslation.md index a3aea92..e50a833 100644 --- a/class_phashtranslation.md +++ b/class_phashtranslation.md @@ -6,7 +6,7 @@ Optimized translation. ### Member Functions - * void **[`generate`](#generate)** **(** [Translation](class_translation) from **)** + * void **[generate](#generate)** **(** [Translation](class_translation) from **)** ### Description Optimized translation. Uses real-time compressed translations, which results in very small dictionaries. diff --git a/class_physics2ddirectbodystate.md b/class_physics2ddirectbodystate.md index 3c52bbd..02bd528 100644 --- a/class_physics2ddirectbodystate.md +++ b/class_physics2ddirectbodystate.md @@ -6,31 +6,31 @@ Direct access object to a physics body in the [Physics2DServer](class_physics2dserver). ### Member Functions - * [Vector2](class_vector2) **[`get_total_gravity`](#get_total_gravity)** **(** **)** const - * [real](class_real) **[`get_total_density`](#get_total_density)** **(** **)** const - * [real](class_real) **[`get_inverse_mass`](#get_inverse_mass)** **(** **)** const - * [real](class_real) **[`get_inverse_inertia`](#get_inverse_inertia)** **(** **)** const - * void **[`set_linear_velocity`](#set_linear_velocity)** **(** [Vector2](class_vector2) velocity **)** - * [Vector2](class_vector2) **[`get_linear_velocity`](#get_linear_velocity)** **(** **)** const - * void **[`set_angular_velocity`](#set_angular_velocity)** **(** [real](class_real) velocity **)** - * [real](class_real) **[`get_angular_velocity`](#get_angular_velocity)** **(** **)** const - * void **[`set_transform`](#set_transform)** **(** [Matrix32](class_matrix32) transform **)** - * [Matrix32](class_matrix32) **[`get_transform`](#get_transform)** **(** **)** const - * void **[`set_sleep_state`](#set_sleep_state)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`is_sleeping`](#is_sleeping)** **(** **)** const - * [int](class_int) **[`get_contact_count`](#get_contact_count)** **(** **)** const - * [Vector2](class_vector2) **[`get_contact_local_pos`](#get_contact_local_pos)** **(** [int](class_int) contact_idx **)** const - * [Vector2](class_vector2) **[`get_contact_local_normal`](#get_contact_local_normal)** **(** [int](class_int) contact_idx **)** const - * [int](class_int) **[`get_contact_local_shape`](#get_contact_local_shape)** **(** [int](class_int) contact_idx **)** const - * [RID](class_rid) **[`get_contact_collider`](#get_contact_collider)** **(** [int](class_int) contact_idx **)** const - * [Vector2](class_vector2) **[`get_contact_collider_pos`](#get_contact_collider_pos)** **(** [int](class_int) contact_idx **)** const - * [int](class_int) **[`get_contact_collider_id`](#get_contact_collider_id)** **(** [int](class_int) contact_idx **)** const - * [Object](class_object) **[`get_contact_collider_object`](#get_contact_collider_object)** **(** [int](class_int) contact_idx **)** const - * [int](class_int) **[`get_contact_collider_shape`](#get_contact_collider_shape)** **(** [int](class_int) contact_idx **)** const - * [Vector2](class_vector2) **[`get_contact_collider_velocity_at_pos`](#get_contact_collider_velocity_at_pos)** **(** [int](class_int) contact_idx **)** const - * [real](class_real) **[`get_step`](#get_step)** **(** **)** const - * void **[`integrate_forces`](#integrate_forces)** **(** **)** - * [Physics2DDirectSpaceState](class_physics2ddirectspacestate) **[`get_space_state`](#get_space_state)** **(** **)** + * [Vector2](class_vector2) **[get_total_gravity](#get_total_gravity)** **(** **)** const + * [real](class_real) **[get_total_density](#get_total_density)** **(** **)** const + * [real](class_real) **[get_inverse_mass](#get_inverse_mass)** **(** **)** const + * [real](class_real) **[get_inverse_inertia](#get_inverse_inertia)** **(** **)** const + * void **[set_linear_velocity](#set_linear_velocity)** **(** [Vector2](class_vector2) velocity **)** + * [Vector2](class_vector2) **[get_linear_velocity](#get_linear_velocity)** **(** **)** const + * void **[set_angular_velocity](#set_angular_velocity)** **(** [real](class_real) velocity **)** + * [real](class_real) **[get_angular_velocity](#get_angular_velocity)** **(** **)** const + * void **[set_transform](#set_transform)** **(** [Matrix32](class_matrix32) transform **)** + * [Matrix32](class_matrix32) **[get_transform](#get_transform)** **(** **)** const + * void **[set_sleep_state](#set_sleep_state)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[is_sleeping](#is_sleeping)** **(** **)** const + * [int](class_int) **[get_contact_count](#get_contact_count)** **(** **)** const + * [Vector2](class_vector2) **[get_contact_local_pos](#get_contact_local_pos)** **(** [int](class_int) contact_idx **)** const + * [Vector2](class_vector2) **[get_contact_local_normal](#get_contact_local_normal)** **(** [int](class_int) contact_idx **)** const + * [int](class_int) **[get_contact_local_shape](#get_contact_local_shape)** **(** [int](class_int) contact_idx **)** const + * [RID](class_rid) **[get_contact_collider](#get_contact_collider)** **(** [int](class_int) contact_idx **)** const + * [Vector2](class_vector2) **[get_contact_collider_pos](#get_contact_collider_pos)** **(** [int](class_int) contact_idx **)** const + * [int](class_int) **[get_contact_collider_id](#get_contact_collider_id)** **(** [int](class_int) contact_idx **)** const + * [Object](class_object) **[get_contact_collider_object](#get_contact_collider_object)** **(** [int](class_int) contact_idx **)** const + * [int](class_int) **[get_contact_collider_shape](#get_contact_collider_shape)** **(** [int](class_int) contact_idx **)** const + * [Vector2](class_vector2) **[get_contact_collider_velocity_at_pos](#get_contact_collider_velocity_at_pos)** **(** [int](class_int) contact_idx **)** const + * [real](class_real) **[get_step](#get_step)** **(** **)** const + * void **[integrate_forces](#integrate_forces)** **(** **)** + * [Physics2DDirectSpaceState](class_physics2ddirectspacestate) **[get_space_state](#get_space_state)** **(** **)** ### Description Direct access object to a physics body in the [Physics2DServer](class_physics2dserver). This object is passed via the direct state callback of rigid/character bodies, and is intended for changing the direct state of that body. @@ -38,121 +38,121 @@ Direct access object to a physics body in the [Physics2DServer](class_physics2ds ### Member Function Description #### get_total_gravity - * [Vector2](class_vector2) **`get_total_gravity`** **(** **)** const + * [Vector2](class_vector2) **get_total_gravity** **(** **)** const Return the total gravity vector being currently applied to this body. #### get_total_density - * [real](class_real) **`get_total_density`** **(** **)** const + * [real](class_real) **get_total_density** **(** **)** const Return the space density currently being applied to this body. #### get_inverse_mass - * [real](class_real) **`get_inverse_mass`** **(** **)** const + * [real](class_real) **get_inverse_mass** **(** **)** const Return the inverse of the mass of the body. #### get_inverse_inertia - * [real](class_real) **`get_inverse_inertia`** **(** **)** const + * [real](class_real) **get_inverse_inertia** **(** **)** const Return the inverse of the inertia of the body. #### set_linear_velocity - * void **`set_linear_velocity`** **(** [Vector2](class_vector2) velocity **)** + * void **set_linear_velocity** **(** [Vector2](class_vector2) velocity **)** Change the linear velocity of the body. #### get_linear_velocity - * [Vector2](class_vector2) **`get_linear_velocity`** **(** **)** const + * [Vector2](class_vector2) **get_linear_velocity** **(** **)** const Return the current linear velocity of the body. #### set_angular_velocity - * void **`set_angular_velocity`** **(** [real](class_real) velocity **)** + * void **set_angular_velocity** **(** [real](class_real) velocity **)** Change the angular velocity of the body. #### get_angular_velocity - * [real](class_real) **`get_angular_velocity`** **(** **)** const + * [real](class_real) **get_angular_velocity** **(** **)** const Return the angular velocity of the body. #### set_transform - * void **`set_transform`** **(** [Matrix32](class_matrix32) transform **)** + * void **set_transform** **(** [Matrix32](class_matrix32) transform **)** Change the transform matrix of the body. #### get_transform - * [Matrix32](class_matrix32) **`get_transform`** **(** **)** const + * [Matrix32](class_matrix32) **get_transform** **(** **)** const Return the transform matrix of the body. #### set_sleep_state - * void **`set_sleep_state`** **(** [bool](class_bool) enabled **)** + * void **set_sleep_state** **(** [bool](class_bool) enabled **)** Set the sleeping state of the body, only affects character/rigid bodies. #### is_sleeping - * [bool](class_bool) **`is_sleeping`** **(** **)** const + * [bool](class_bool) **is_sleeping** **(** **)** const Return true if this body is currently sleeping (not active). #### get_contact_count - * [int](class_int) **`get_contact_count`** **(** **)** const + * [int](class_int) **get_contact_count** **(** **)** const Return the amount of contacts this body has with other bodies. Note that by default this returns 0 unless bodies are configured to log contacts. #### get_contact_local_pos - * [Vector2](class_vector2) **`get_contact_local_pos`** **(** [int](class_int) contact_idx **)** const + * [Vector2](class_vector2) **get_contact_local_pos** **(** [int](class_int) contact_idx **)** const Return the local position (of this body) of the contact point. #### get_contact_local_shape - * [int](class_int) **`get_contact_local_shape`** **(** [int](class_int) contact_idx **)** const + * [int](class_int) **get_contact_local_shape** **(** [int](class_int) contact_idx **)** const Return the local shape index of the collision. #### get_contact_collider - * [RID](class_rid) **`get_contact_collider`** **(** [int](class_int) contact_idx **)** const + * [RID](class_rid) **get_contact_collider** **(** [int](class_int) contact_idx **)** const Return the RID of the collider. #### get_contact_collider_pos - * [Vector2](class_vector2) **`get_contact_collider_pos`** **(** [int](class_int) contact_idx **)** const + * [Vector2](class_vector2) **get_contact_collider_pos** **(** [int](class_int) contact_idx **)** const Return the contact position in the collider. #### get_contact_collider_id - * [int](class_int) **`get_contact_collider_id`** **(** [int](class_int) contact_idx **)** const + * [int](class_int) **get_contact_collider_id** **(** [int](class_int) contact_idx **)** const Return the object id of the collider. #### get_contact_collider_object - * [Object](class_object) **`get_contact_collider_object`** **(** [int](class_int) contact_idx **)** const + * [Object](class_object) **get_contact_collider_object** **(** [int](class_int) contact_idx **)** const Return the collider object, this depends on how it was created (will return a scene node if such was used to create it). #### get_contact_collider_shape - * [int](class_int) **`get_contact_collider_shape`** **(** [int](class_int) contact_idx **)** const + * [int](class_int) **get_contact_collider_shape** **(** [int](class_int) contact_idx **)** const Return the collider shape index. #### get_contact_collider_velocity_at_pos - * [Vector2](class_vector2) **`get_contact_collider_velocity_at_pos`** **(** [int](class_int) contact_idx **)** const + * [Vector2](class_vector2) **get_contact_collider_velocity_at_pos** **(** [int](class_int) contact_idx **)** const Return the linear velocity vector at contact point of the collider. #### get_step - * [real](class_real) **`get_step`** **(** **)** const + * [real](class_real) **get_step** **(** **)** const Return the timestep (delta) used for the simulation. #### integrate_forces - * void **`integrate_forces`** **(** **)** + * void **integrate_forces** **(** **)** Call the built-in force integration code. #### get_space_state - * [Physics2DDirectSpaceState](class_physics2ddirectspacestate) **`get_space_state`** **(** **)** + * [Physics2DDirectSpaceState](class_physics2ddirectspacestate) **get_space_state** **(** **)** Return the current state of space, useful for queries. diff --git a/class_physics2ddirectspacestate.md b/class_physics2ddirectspacestate.md index 15bb2e6..3100995 100644 --- a/class_physics2ddirectspacestate.md +++ b/class_physics2ddirectspacestate.md @@ -6,8 +6,8 @@ Direct access object to a space in the [Physics2DServer](class_physics2dserver). ### Member Functions - * void **[`intersect_ray`](#intersect_ray)** **(** [Vector2](class_vector2) from, [Vector2](class_vector2) to, [Array](class_array) exclude=Array(), [int](class_int) umask=0 **)** - * void **[`intersect_shape`](#intersect_shape)** **(** [RID](class_rid) shape, [Matrix32](class_matrix32) xform, [int](class_int) result_max, [Array](class_array) exclude=Array(), [int](class_int) umask=0 **)** + * void **[intersect_ray](#intersect_ray)** **(** [Vector2](class_vector2) from, [Vector2](class_vector2) to, [Array](class_array) exclude=Array(), [int](class_int) umask=0 **)** + * void **[intersect_shape](#intersect_shape)** **(** [RID](class_rid) shape, [Matrix32](class_matrix32) xform, [int](class_int) result_max, [Array](class_array) exclude=Array(), [int](class_int) umask=0 **)** ### Description Direct access object to a space in the [Physics2DServer](class_physics2dserver). It's used mainly to do queries against objects and areas residing in a given space. @@ -15,7 +15,7 @@ Direct access object to a space in the [Physics2DServer](class_physics2dserver). ### Member Function Description #### intersect_ray - * void **`intersect_ray`** **(** [Vector2](class_vector2) from, [Vector2](class_vector2) to, [Array](class_array) exclude=Array(), [int](class_int) umask=0 **)** + * void **intersect_ray** **(** [Vector2](class_vector2) from, [Vector2](class_vector2) to, [Array](class_array) exclude=Array(), [int](class_int) umask=0 **)** Intersect a ray in a given space, the returned object is a dictionary with the following fields: @@ -36,6 +36,6 @@ Intersect a ray in a given space, the returned object is a dictionary with the f If the ray did not intersect anything, then null is returned instead of a [Dictionary](class_dictionary). #### intersect_shape - * void **`intersect_shape`** **(** [RID](class_rid) shape, [Matrix32](class_matrix32) xform, [int](class_int) result_max, [Array](class_array) exclude=Array(), [int](class_int) umask=0 **)** + * void **intersect_shape** **(** [RID](class_rid) shape, [Matrix32](class_matrix32) xform, [int](class_int) result_max, [Array](class_array) exclude=Array(), [int](class_int) umask=0 **)** Intersect a given shape (RID or [Shape2D](class_shape2d)) against the space, the intersected shapes are returned in a special result object. diff --git a/class_physics2dserver.md b/class_physics2dserver.md index 94dd654..e885895 100644 --- a/class_physics2dserver.md +++ b/class_physics2dserver.md @@ -6,79 +6,79 @@ Physics 2D Server. ### Member Functions - * [RID](class_rid) **[`shape_create`](#shape_create)** **(** [int](class_int) type **)** - * void **[`shape_set_data`](#shape_set_data)** **(** [RID](class_rid) shape, var data **)** - * [int](class_int) **[`shape_get_type`](#shape_get_type)** **(** [RID](class_rid) shape **)** const - * void **[`shape_get_data`](#shape_get_data)** **(** [RID](class_rid) shape **)** const - * [RID](class_rid) **[`space_create`](#space_create)** **(** **)** - * void **[`space_set_active`](#space_set_active)** **(** [RID](class_rid) space, [bool](class_bool) active **)** - * [bool](class_bool) **[`space_is_active`](#space_is_active)** **(** [RID](class_rid) space **)** const - * void **[`space_set_param`](#space_set_param)** **(** [RID](class_rid) space, [int](class_int) param, [real](class_real) value **)** - * [real](class_real) **[`space_get_param`](#space_get_param)** **(** [RID](class_rid) space, [int](class_int) param **)** const - * [Physics2DDirectSpaceState](class_physics2ddirectspacestate) **[`space_get_direct_state`](#space_get_direct_state)** **(** [RID](class_rid) space **)** - * [RID](class_rid) **[`area_create`](#area_create)** **(** **)** - * void **[`area_set_space`](#area_set_space)** **(** [RID](class_rid) area, [RID](class_rid) space **)** - * [RID](class_rid) **[`area_get_space`](#area_get_space)** **(** [RID](class_rid) area **)** const - * void **[`area_set_space_override_mode`](#area_set_space_override_mode)** **(** [RID](class_rid) area, [int](class_int) mode **)** - * [int](class_int) **[`area_get_space_override_mode`](#area_get_space_override_mode)** **(** [RID](class_rid) area **)** const - * void **[`area_add_shape`](#area_add_shape)** **(** [RID](class_rid) area, [int](class_int) shape, [RID](class_rid) transform=1,0, 0,1, 0,0 **)** - * [RID](class_rid) **[`area_set_shape`](#area_set_shape)** **(** [RID](class_rid) area, [int](class_int) shape_idx **)** const - * void **[`area_set_shape_transform`](#area_set_shape_transform)** **(** [RID](class_rid) area, [int](class_int) shape_idx, [Matrix32](class_matrix32) transform **)** - * [int](class_int) **[`area_get_shape_count`](#area_get_shape_count)** **(** [RID](class_rid) area **)** const - * [RID](class_rid) **[`area_get_shape`](#area_get_shape)** **(** [RID](class_rid) area, [int](class_int) shape_idx **)** const - * [Matrix32](class_matrix32) **[`area_get_shape_transform`](#area_get_shape_transform)** **(** [RID](class_rid) area, [int](class_int) shape_idx **)** const - * void **[`area_remove_shape`](#area_remove_shape)** **(** [RID](class_rid) area, [int](class_int) shape_idx **)** - * void **[`area_clear_shapes`](#area_clear_shapes)** **(** [RID](class_rid) area **)** - * void **[`area_set_param`](#area_set_param)** **(** [RID](class_rid) area, [int](class_int) param **)** const - * [Matrix32](class_matrix32) **[`area_set_transform`](#area_set_transform)** **(** [RID](class_rid) area **)** const - * void **[`area_get_param`](#area_get_param)** **(** [RID](class_rid) area, [int](class_int) param **)** const - * [Matrix32](class_matrix32) **[`area_get_transform`](#area_get_transform)** **(** [RID](class_rid) area **)** const - * void **[`area_attach_object_instance_ID`](#area_attach_object_instance_ID)** **(** [RID](class_rid) area, [int](class_int) id **)** - * [int](class_int) **[`area_get_object_instance_ID`](#area_get_object_instance_ID)** **(** [RID](class_rid) area **)** const - * void **[`area_set_monitor_callback`](#area_set_monitor_callback)** **(** [RID](class_rid) receiver, [Object](class_object) method, [String](class_string) arg2 **)** - * [RID](class_rid) **[`body_create`](#body_create)** **(** [int](class_int) mode=2, [bool](class_bool) init_sleeping=false **)** - * void **[`body_set_space`](#body_set_space)** **(** [RID](class_rid) body, [RID](class_rid) space **)** - * [RID](class_rid) **[`body_get_space`](#body_get_space)** **(** [RID](class_rid) body **)** const - * void **[`body_set_mode`](#body_set_mode)** **(** [RID](class_rid) body, [int](class_int) mode **)** - * [int](class_int) **[`body_get_mode`](#body_get_mode)** **(** [RID](class_rid) body, [int](class_int) arg1 **)** const - * void **[`body_add_shape`](#body_add_shape)** **(** [RID](class_rid) body, [RID](class_rid) shape, [Matrix32](class_matrix32) transform=1,0, 0,1, 0,0 **)** - * void **[`body_set_shape`](#body_set_shape)** **(** [RID](class_rid) body, [int](class_int) shape_idx, [RID](class_rid) shape **)** - * void **[`body_set_shape_transform`](#body_set_shape_transform)** **(** [RID](class_rid) body, [int](class_int) shape_idx, [Matrix32](class_matrix32) transform **)** - * [int](class_int) **[`body_get_shape_count`](#body_get_shape_count)** **(** [RID](class_rid) body **)** const - * [RID](class_rid) **[`body_get_shape`](#body_get_shape)** **(** [RID](class_rid) body, [int](class_int) shape_idx **)** const - * [Matrix32](class_matrix32) **[`body_get_shape_transform`](#body_get_shape_transform)** **(** [RID](class_rid) body, [int](class_int) shape_idx **)** const - * void **[`body_remove_shape`](#body_remove_shape)** **(** [RID](class_rid) body, [int](class_int) shape_idx **)** - * void **[`body_clear_shapes`](#body_clear_shapes)** **(** [RID](class_rid) body **)** - * void **[`body_set_shape_as_trigger`](#body_set_shape_as_trigger)** **(** [RID](class_rid) body, [int](class_int) shape_idx, [bool](class_bool) enable **)** - * [bool](class_bool) **[`body_is_shape_set_as_trigger`](#body_is_shape_set_as_trigger)** **(** [RID](class_rid) body, [int](class_int) shape_idx **)** const - * void **[`body_attach_object_instance_ID`](#body_attach_object_instance_ID)** **(** [RID](class_rid) body, [int](class_int) id **)** - * [int](class_int) **[`body_get_object_instance_ID`](#body_get_object_instance_ID)** **(** [RID](class_rid) body **)** const - * void **[`body_set_enable_continuous_collision_detection`](#body_set_enable_continuous_collision_detection)** **(** [RID](class_rid) body, [bool](class_bool) enable **)** - * [bool](class_bool) **[`body_is_continuous_collision_detection_enabled`](#body_is_continuous_collision_detection_enabled)** **(** [RID](class_rid) body **)** const - * void **[`body_set_param`](#body_set_param)** **(** [RID](class_rid) body, [int](class_int) param, [real](class_real) value **)** - * [real](class_real) **[`body_get_param`](#body_get_param)** **(** [RID](class_rid) body, [int](class_int) param **)** const - * void **[`body_static_simulate_motion`](#body_static_simulate_motion)** **(** [RID](class_rid) body, [Matrix32](class_matrix32) new_xform **)** - * void **[`body_set_state`](#body_set_state)** **(** [RID](class_rid) body, [int](class_int) state, var value **)** - * void **[`body_get_state`](#body_get_state)** **(** [RID](class_rid) body, [int](class_int) state **)** const - * void **[`body_apply_impulse`](#body_apply_impulse)** **(** [RID](class_rid) body, [Vector2](class_vector2) pos, [Vector2](class_vector2) impulse **)** - * void **[`body_set_axis_velocity`](#body_set_axis_velocity)** **(** [RID](class_rid) body, [Vector2](class_vector2) axis_velocity **)** - * void **[`body_add_collision_exception`](#body_add_collision_exception)** **(** [RID](class_rid) body, [RID](class_rid) excepted_body **)** - * void **[`body_remove_collision_exception`](#body_remove_collision_exception)** **(** [RID](class_rid) body, [RID](class_rid) excepted_body **)** - * void **[`body_set_max_contacts_reported`](#body_set_max_contacts_reported)** **(** [RID](class_rid) body, [int](class_int) amount **)** - * [int](class_int) **[`body_get_max_contacts_reported`](#body_get_max_contacts_reported)** **(** [RID](class_rid) body **)** const - * void **[`body_set_omit_force_integration`](#body_set_omit_force_integration)** **(** [RID](class_rid) body, [bool](class_bool) enable **)** - * [bool](class_bool) **[`body_is_omitting_force_integration`](#body_is_omitting_force_integration)** **(** [RID](class_rid) body **)** const - * void **[`body_set_force_integration_callback`](#body_set_force_integration_callback)** **(** [RID](class_rid) body, [Object](class_object) receiver, [String](class_string) method, var arg3 **)** - * void **[`joint_set_param`](#joint_set_param)** **(** [RID](class_rid) joint, [int](class_int) param, [real](class_real) value **)** - * [real](class_real) **[`joint_get_param`](#joint_get_param)** **(** [RID](class_rid) joint, [int](class_int) param **)** const - * [RID](class_rid) **[`pin_joint_create`](#pin_joint_create)** **(** [Vector2](class_vector2) anchor, [RID](class_rid) body_a, [RID](class_rid) body_b=RID() **)** - * [RID](class_rid) **[`groove_joint_create`](#groove_joint_create)** **(** [Vector2](class_vector2) groove1_a, [Vector2](class_vector2) groove2_a, [Vector2](class_vector2) anchor_b, [RID](class_rid) body_a=RID(), [RID](class_rid) body_b=RID() **)** - * [RID](class_rid) **[`damped_spring_joint_create`](#damped_spring_joint_create)** **(** [Vector2](class_vector2) anchor_a, [Vector2](class_vector2) anchor_b, [RID](class_rid) body_a, [RID](class_rid) body_b=RID() **)** - * void **[`damped_string_joint_set_param`](#damped_string_joint_set_param)** **(** [RID](class_rid) joint, [int](class_int) param, [real](class_real) value=RID() **)** - * [real](class_real) **[`damped_string_joint_get_param`](#damped_string_joint_get_param)** **(** [RID](class_rid) joint, [int](class_int) param **)** const - * [int](class_int) **[`joint_get_type`](#joint_get_type)** **(** [RID](class_rid) joint **)** const - * void **[`free`](#free)** **(** [RID](class_rid) rid **)** - * void **[`set_active`](#set_active)** **(** [bool](class_bool) active **)** + * [RID](class_rid) **[shape_create](#shape_create)** **(** [int](class_int) type **)** + * void **[shape_set_data](#shape_set_data)** **(** [RID](class_rid) shape, var data **)** + * [int](class_int) **[shape_get_type](#shape_get_type)** **(** [RID](class_rid) shape **)** const + * void **[shape_get_data](#shape_get_data)** **(** [RID](class_rid) shape **)** const + * [RID](class_rid) **[space_create](#space_create)** **(** **)** + * void **[space_set_active](#space_set_active)** **(** [RID](class_rid) space, [bool](class_bool) active **)** + * [bool](class_bool) **[space_is_active](#space_is_active)** **(** [RID](class_rid) space **)** const + * void **[space_set_param](#space_set_param)** **(** [RID](class_rid) space, [int](class_int) param, [real](class_real) value **)** + * [real](class_real) **[space_get_param](#space_get_param)** **(** [RID](class_rid) space, [int](class_int) param **)** const + * [Physics2DDirectSpaceState](class_physics2ddirectspacestate) **[space_get_direct_state](#space_get_direct_state)** **(** [RID](class_rid) space **)** + * [RID](class_rid) **[area_create](#area_create)** **(** **)** + * void **[area_set_space](#area_set_space)** **(** [RID](class_rid) area, [RID](class_rid) space **)** + * [RID](class_rid) **[area_get_space](#area_get_space)** **(** [RID](class_rid) area **)** const + * void **[area_set_space_override_mode](#area_set_space_override_mode)** **(** [RID](class_rid) area, [int](class_int) mode **)** + * [int](class_int) **[area_get_space_override_mode](#area_get_space_override_mode)** **(** [RID](class_rid) area **)** const + * void **[area_add_shape](#area_add_shape)** **(** [RID](class_rid) area, [int](class_int) shape, [RID](class_rid) transform=1,0, 0,1, 0,0 **)** + * [RID](class_rid) **[area_set_shape](#area_set_shape)** **(** [RID](class_rid) area, [int](class_int) shape_idx **)** const + * void **[area_set_shape_transform](#area_set_shape_transform)** **(** [RID](class_rid) area, [int](class_int) shape_idx, [Matrix32](class_matrix32) transform **)** + * [int](class_int) **[area_get_shape_count](#area_get_shape_count)** **(** [RID](class_rid) area **)** const + * [RID](class_rid) **[area_get_shape](#area_get_shape)** **(** [RID](class_rid) area, [int](class_int) shape_idx **)** const + * [Matrix32](class_matrix32) **[area_get_shape_transform](#area_get_shape_transform)** **(** [RID](class_rid) area, [int](class_int) shape_idx **)** const + * void **[area_remove_shape](#area_remove_shape)** **(** [RID](class_rid) area, [int](class_int) shape_idx **)** + * void **[area_clear_shapes](#area_clear_shapes)** **(** [RID](class_rid) area **)** + * void **[area_set_param](#area_set_param)** **(** [RID](class_rid) area, [int](class_int) param **)** const + * [Matrix32](class_matrix32) **[area_set_transform](#area_set_transform)** **(** [RID](class_rid) area **)** const + * void **[area_get_param](#area_get_param)** **(** [RID](class_rid) area, [int](class_int) param **)** const + * [Matrix32](class_matrix32) **[area_get_transform](#area_get_transform)** **(** [RID](class_rid) area **)** const + * void **[area_attach_object_instance_ID](#area_attach_object_instance_ID)** **(** [RID](class_rid) area, [int](class_int) id **)** + * [int](class_int) **[area_get_object_instance_ID](#area_get_object_instance_ID)** **(** [RID](class_rid) area **)** const + * void **[area_set_monitor_callback](#area_set_monitor_callback)** **(** [RID](class_rid) receiver, [Object](class_object) method, [String](class_string) arg2 **)** + * [RID](class_rid) **[body_create](#body_create)** **(** [int](class_int) mode=2, [bool](class_bool) init_sleeping=false **)** + * void **[body_set_space](#body_set_space)** **(** [RID](class_rid) body, [RID](class_rid) space **)** + * [RID](class_rid) **[body_get_space](#body_get_space)** **(** [RID](class_rid) body **)** const + * void **[body_set_mode](#body_set_mode)** **(** [RID](class_rid) body, [int](class_int) mode **)** + * [int](class_int) **[body_get_mode](#body_get_mode)** **(** [RID](class_rid) body, [int](class_int) arg1 **)** const + * void **[body_add_shape](#body_add_shape)** **(** [RID](class_rid) body, [RID](class_rid) shape, [Matrix32](class_matrix32) transform=1,0, 0,1, 0,0 **)** + * void **[body_set_shape](#body_set_shape)** **(** [RID](class_rid) body, [int](class_int) shape_idx, [RID](class_rid) shape **)** + * void **[body_set_shape_transform](#body_set_shape_transform)** **(** [RID](class_rid) body, [int](class_int) shape_idx, [Matrix32](class_matrix32) transform **)** + * [int](class_int) **[body_get_shape_count](#body_get_shape_count)** **(** [RID](class_rid) body **)** const + * [RID](class_rid) **[body_get_shape](#body_get_shape)** **(** [RID](class_rid) body, [int](class_int) shape_idx **)** const + * [Matrix32](class_matrix32) **[body_get_shape_transform](#body_get_shape_transform)** **(** [RID](class_rid) body, [int](class_int) shape_idx **)** const + * void **[body_remove_shape](#body_remove_shape)** **(** [RID](class_rid) body, [int](class_int) shape_idx **)** + * void **[body_clear_shapes](#body_clear_shapes)** **(** [RID](class_rid) body **)** + * void **[body_set_shape_as_trigger](#body_set_shape_as_trigger)** **(** [RID](class_rid) body, [int](class_int) shape_idx, [bool](class_bool) enable **)** + * [bool](class_bool) **[body_is_shape_set_as_trigger](#body_is_shape_set_as_trigger)** **(** [RID](class_rid) body, [int](class_int) shape_idx **)** const + * void **[body_attach_object_instance_ID](#body_attach_object_instance_ID)** **(** [RID](class_rid) body, [int](class_int) id **)** + * [int](class_int) **[body_get_object_instance_ID](#body_get_object_instance_ID)** **(** [RID](class_rid) body **)** const + * void **[body_set_enable_continuous_collision_detection](#body_set_enable_continuous_collision_detection)** **(** [RID](class_rid) body, [bool](class_bool) enable **)** + * [bool](class_bool) **[body_is_continuous_collision_detection_enabled](#body_is_continuous_collision_detection_enabled)** **(** [RID](class_rid) body **)** const + * void **[body_set_param](#body_set_param)** **(** [RID](class_rid) body, [int](class_int) param, [real](class_real) value **)** + * [real](class_real) **[body_get_param](#body_get_param)** **(** [RID](class_rid) body, [int](class_int) param **)** const + * void **[body_static_simulate_motion](#body_static_simulate_motion)** **(** [RID](class_rid) body, [Matrix32](class_matrix32) new_xform **)** + * void **[body_set_state](#body_set_state)** **(** [RID](class_rid) body, [int](class_int) state, var value **)** + * void **[body_get_state](#body_get_state)** **(** [RID](class_rid) body, [int](class_int) state **)** const + * void **[body_apply_impulse](#body_apply_impulse)** **(** [RID](class_rid) body, [Vector2](class_vector2) pos, [Vector2](class_vector2) impulse **)** + * void **[body_set_axis_velocity](#body_set_axis_velocity)** **(** [RID](class_rid) body, [Vector2](class_vector2) axis_velocity **)** + * void **[body_add_collision_exception](#body_add_collision_exception)** **(** [RID](class_rid) body, [RID](class_rid) excepted_body **)** + * void **[body_remove_collision_exception](#body_remove_collision_exception)** **(** [RID](class_rid) body, [RID](class_rid) excepted_body **)** + * void **[body_set_max_contacts_reported](#body_set_max_contacts_reported)** **(** [RID](class_rid) body, [int](class_int) amount **)** + * [int](class_int) **[body_get_max_contacts_reported](#body_get_max_contacts_reported)** **(** [RID](class_rid) body **)** const + * void **[body_set_omit_force_integration](#body_set_omit_force_integration)** **(** [RID](class_rid) body, [bool](class_bool) enable **)** + * [bool](class_bool) **[body_is_omitting_force_integration](#body_is_omitting_force_integration)** **(** [RID](class_rid) body **)** const + * void **[body_set_force_integration_callback](#body_set_force_integration_callback)** **(** [RID](class_rid) body, [Object](class_object) receiver, [String](class_string) method, var arg3 **)** + * void **[joint_set_param](#joint_set_param)** **(** [RID](class_rid) joint, [int](class_int) param, [real](class_real) value **)** + * [real](class_real) **[joint_get_param](#joint_get_param)** **(** [RID](class_rid) joint, [int](class_int) param **)** const + * [RID](class_rid) **[pin_joint_create](#pin_joint_create)** **(** [Vector2](class_vector2) anchor, [RID](class_rid) body_a, [RID](class_rid) body_b=RID() **)** + * [RID](class_rid) **[groove_joint_create](#groove_joint_create)** **(** [Vector2](class_vector2) groove1_a, [Vector2](class_vector2) groove2_a, [Vector2](class_vector2) anchor_b, [RID](class_rid) body_a=RID(), [RID](class_rid) body_b=RID() **)** + * [RID](class_rid) **[damped_spring_joint_create](#damped_spring_joint_create)** **(** [Vector2](class_vector2) anchor_a, [Vector2](class_vector2) anchor_b, [RID](class_rid) body_a, [RID](class_rid) body_b=RID() **)** + * void **[damped_string_joint_set_param](#damped_string_joint_set_param)** **(** [RID](class_rid) joint, [int](class_int) param, [real](class_real) value=RID() **)** + * [real](class_real) **[damped_string_joint_get_param](#damped_string_joint_get_param)** **(** [RID](class_rid) joint, [int](class_int) param **)** const + * [int](class_int) **[joint_get_type](#joint_get_type)** **(** [RID](class_rid) joint **)** const + * void **[free](#free)** **(** [RID](class_rid) rid **)** + * void **[set_active](#set_active)** **(** [bool](class_bool) active **)** ### Numeric Constants * **SHAPE_LINE** = **0** diff --git a/class_physics2dshapequeryresult.md b/class_physics2dshapequeryresult.md index 3622aeb..01fbf5e 100644 --- a/class_physics2dshapequeryresult.md +++ b/class_physics2dshapequeryresult.md @@ -6,10 +6,10 @@ ### Member Functions - * [int](class_int) **[`get_result_count`](#get_result_count)** **(** **)** const - * [RID](class_rid) **[`get_result_rid`](#get_result_rid)** **(** [int](class_int) idx **)** const - * [int](class_int) **[`get_result_object_id`](#get_result_object_id)** **(** [int](class_int) idx **)** const - * [Object](class_object) **[`get_result_object`](#get_result_object)** **(** [int](class_int) idx **)** const - * [int](class_int) **[`get_result_object_shape`](#get_result_object_shape)** **(** [int](class_int) idx **)** const + * [int](class_int) **[get_result_count](#get_result_count)** **(** **)** const + * [RID](class_rid) **[get_result_rid](#get_result_rid)** **(** [int](class_int) idx **)** const + * [int](class_int) **[get_result_object_id](#get_result_object_id)** **(** [int](class_int) idx **)** const + * [Object](class_object) **[get_result_object](#get_result_object)** **(** [int](class_int) idx **)** const + * [int](class_int) **[get_result_object_shape](#get_result_object_shape)** **(** [int](class_int) idx **)** const ### Member Function Description diff --git a/class_physicsdirectbodystate.md b/class_physicsdirectbodystate.md index 5b0bcff..ddeaf97 100644 --- a/class_physicsdirectbodystate.md +++ b/class_physicsdirectbodystate.md @@ -6,31 +6,31 @@ ### Member Functions - * [Vector3](class_vector3) **[`get_total_gravity`](#get_total_gravity)** **(** **)** const - * [real](class_real) **[`get_total_density`](#get_total_density)** **(** **)** const - * [real](class_real) **[`get_inverse_mass`](#get_inverse_mass)** **(** **)** const - * [Vector3](class_vector3) **[`get_inverse_inertia`](#get_inverse_inertia)** **(** **)** const - * void **[`set_linear_velocity`](#set_linear_velocity)** **(** [Vector3](class_vector3) velocity **)** - * [Vector3](class_vector3) **[`get_linear_velocity`](#get_linear_velocity)** **(** **)** const - * void **[`set_angular_velocity`](#set_angular_velocity)** **(** [Vector3](class_vector3) velocity **)** - * [Vector3](class_vector3) **[`get_angular_velocity`](#get_angular_velocity)** **(** **)** const - * void **[`set_transform`](#set_transform)** **(** [Transform](class_transform) transform **)** - * [Transform](class_transform) **[`get_transform`](#get_transform)** **(** **)** const - * void **[`add_force`](#add_force)** **(** [Vector3](class_vector3) force, [Vector3](class_vector3) pos **)** - * void **[`set_sleep_state`](#set_sleep_state)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`is_sleeping`](#is_sleeping)** **(** **)** const - * [int](class_int) **[`get_contact_count`](#get_contact_count)** **(** **)** const - * [Vector3](class_vector3) **[`get_contact_local_pos`](#get_contact_local_pos)** **(** [int](class_int) contact_idx **)** const - * [Vector3](class_vector3) **[`get_contact_local_normal`](#get_contact_local_normal)** **(** [int](class_int) contact_idx **)** const - * [int](class_int) **[`get_contact_local_shape`](#get_contact_local_shape)** **(** [int](class_int) contact_idx **)** const - * [RID](class_rid) **[`get_contact_collider`](#get_contact_collider)** **(** [int](class_int) contact_idx **)** const - * [Vector3](class_vector3) **[`get_contact_collider_pos`](#get_contact_collider_pos)** **(** [int](class_int) contact_idx **)** const - * [int](class_int) **[`get_contact_collider_id`](#get_contact_collider_id)** **(** [int](class_int) contact_idx **)** const - * [Object](class_object) **[`get_contact_collider_object`](#get_contact_collider_object)** **(** [int](class_int) contact_idx **)** const - * [int](class_int) **[`get_contact_collider_shape`](#get_contact_collider_shape)** **(** [int](class_int) contact_idx **)** const - * [Vector3](class_vector3) **[`get_contact_collider_velocity_at_pos`](#get_contact_collider_velocity_at_pos)** **(** [int](class_int) contact_idx **)** const - * [real](class_real) **[`get_step`](#get_step)** **(** **)** const - * void **[`integrate_forces`](#integrate_forces)** **(** **)** - * [PhysicsDirectSpaceState](class_physicsdirectspacestate) **[`get_space_state`](#get_space_state)** **(** **)** + * [Vector3](class_vector3) **[get_total_gravity](#get_total_gravity)** **(** **)** const + * [real](class_real) **[get_total_density](#get_total_density)** **(** **)** const + * [real](class_real) **[get_inverse_mass](#get_inverse_mass)** **(** **)** const + * [Vector3](class_vector3) **[get_inverse_inertia](#get_inverse_inertia)** **(** **)** const + * void **[set_linear_velocity](#set_linear_velocity)** **(** [Vector3](class_vector3) velocity **)** + * [Vector3](class_vector3) **[get_linear_velocity](#get_linear_velocity)** **(** **)** const + * void **[set_angular_velocity](#set_angular_velocity)** **(** [Vector3](class_vector3) velocity **)** + * [Vector3](class_vector3) **[get_angular_velocity](#get_angular_velocity)** **(** **)** const + * void **[set_transform](#set_transform)** **(** [Transform](class_transform) transform **)** + * [Transform](class_transform) **[get_transform](#get_transform)** **(** **)** const + * void **[add_force](#add_force)** **(** [Vector3](class_vector3) force, [Vector3](class_vector3) pos **)** + * void **[set_sleep_state](#set_sleep_state)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[is_sleeping](#is_sleeping)** **(** **)** const + * [int](class_int) **[get_contact_count](#get_contact_count)** **(** **)** const + * [Vector3](class_vector3) **[get_contact_local_pos](#get_contact_local_pos)** **(** [int](class_int) contact_idx **)** const + * [Vector3](class_vector3) **[get_contact_local_normal](#get_contact_local_normal)** **(** [int](class_int) contact_idx **)** const + * [int](class_int) **[get_contact_local_shape](#get_contact_local_shape)** **(** [int](class_int) contact_idx **)** const + * [RID](class_rid) **[get_contact_collider](#get_contact_collider)** **(** [int](class_int) contact_idx **)** const + * [Vector3](class_vector3) **[get_contact_collider_pos](#get_contact_collider_pos)** **(** [int](class_int) contact_idx **)** const + * [int](class_int) **[get_contact_collider_id](#get_contact_collider_id)** **(** [int](class_int) contact_idx **)** const + * [Object](class_object) **[get_contact_collider_object](#get_contact_collider_object)** **(** [int](class_int) contact_idx **)** const + * [int](class_int) **[get_contact_collider_shape](#get_contact_collider_shape)** **(** [int](class_int) contact_idx **)** const + * [Vector3](class_vector3) **[get_contact_collider_velocity_at_pos](#get_contact_collider_velocity_at_pos)** **(** [int](class_int) contact_idx **)** const + * [real](class_real) **[get_step](#get_step)** **(** **)** const + * void **[integrate_forces](#integrate_forces)** **(** **)** + * [PhysicsDirectSpaceState](class_physicsdirectspacestate) **[get_space_state](#get_space_state)** **(** **)** ### Member Function Description diff --git a/class_physicsdirectspacestate.md b/class_physicsdirectspacestate.md index e8d3388..ca27e7a 100644 --- a/class_physicsdirectspacestate.md +++ b/class_physicsdirectspacestate.md @@ -6,7 +6,7 @@ ### Member Functions - * void **[`intersect_ray`](#intersect_ray)** **(** [Vector3](class_vector3) from, [Vector3](class_vector3) to, [Array](class_array) exclude=Array(), [int](class_int) umask=0 **)** - * void **[`intersect_shape`](#intersect_shape)** **(** [RID](class_rid) shape, [Transform](class_transform) xform, [int](class_int) result_max, [Array](class_array) exclude=Array(), [int](class_int) umask=0 **)** + * void **[intersect_ray](#intersect_ray)** **(** [Vector3](class_vector3) from, [Vector3](class_vector3) to, [Array](class_array) exclude=Array(), [int](class_int) umask=0 **)** + * void **[intersect_shape](#intersect_shape)** **(** [RID](class_rid) shape, [Transform](class_transform) xform, [int](class_int) result_max, [Array](class_array) exclude=Array(), [int](class_int) umask=0 **)** ### Member Function Description diff --git a/class_physicsserver.md b/class_physicsserver.md index 94b344a..a73f4fa 100644 --- a/class_physicsserver.md +++ b/class_physicsserver.md @@ -6,69 +6,69 @@ ### Member Functions - * [RID](class_rid) **[`shape_create`](#shape_create)** **(** [int](class_int) type **)** - * void **[`shape_set_data`](#shape_set_data)** **(** [RID](class_rid) shape, var data **)** - * [int](class_int) **[`shape_get_type`](#shape_get_type)** **(** [RID](class_rid) shape **)** const - * void **[`shape_get_data`](#shape_get_data)** **(** [RID](class_rid) shape **)** const - * [RID](class_rid) **[`space_create`](#space_create)** **(** **)** - * void **[`space_set_active`](#space_set_active)** **(** [RID](class_rid) space, [bool](class_bool) active **)** - * [bool](class_bool) **[`space_is_active`](#space_is_active)** **(** [RID](class_rid) space **)** const - * void **[`space_set_param`](#space_set_param)** **(** [RID](class_rid) space, [int](class_int) param, [real](class_real) value **)** - * [real](class_real) **[`space_get_param`](#space_get_param)** **(** [RID](class_rid) space, [int](class_int) param **)** const - * [PhysicsDirectSpaceState](class_physicsdirectspacestate) **[`space_get_direct_state`](#space_get_direct_state)** **(** [RID](class_rid) space **)** - * [RID](class_rid) **[`area_create`](#area_create)** **(** **)** - * void **[`area_set_space`](#area_set_space)** **(** [RID](class_rid) area, [RID](class_rid) space **)** - * [RID](class_rid) **[`area_get_space`](#area_get_space)** **(** [RID](class_rid) area **)** const - * void **[`area_set_space_override_mode`](#area_set_space_override_mode)** **(** [RID](class_rid) area, [int](class_int) mode **)** - * [int](class_int) **[`area_get_space_override_mode`](#area_get_space_override_mode)** **(** [RID](class_rid) area **)** const - * void **[`area_add_shape`](#area_add_shape)** **(** [RID](class_rid) area, [int](class_int) shape, [RID](class_rid) transform=Transform() **)** - * [RID](class_rid) **[`area_set_shape`](#area_set_shape)** **(** [RID](class_rid) area, [int](class_int) shape_idx **)** const - * void **[`area_set_shape_transform`](#area_set_shape_transform)** **(** [RID](class_rid) area, [int](class_int) shape_idx, [Transform](class_transform) transform **)** - * [int](class_int) **[`area_get_shape_count`](#area_get_shape_count)** **(** [RID](class_rid) area **)** const - * [RID](class_rid) **[`area_get_shape`](#area_get_shape)** **(** [RID](class_rid) area, [int](class_int) shape_idx **)** const - * [Transform](class_transform) **[`area_get_shape_transform`](#area_get_shape_transform)** **(** [RID](class_rid) area, [int](class_int) shape_idx **)** const - * void **[`area_remove_shape`](#area_remove_shape)** **(** [RID](class_rid) area, [int](class_int) shape_idx **)** - * void **[`area_clear_shapes`](#area_clear_shapes)** **(** [RID](class_rid) area **)** - * void **[`area_set_param`](#area_set_param)** **(** [RID](class_rid) area, [int](class_int) param **)** const - * [Transform](class_transform) **[`area_set_transform`](#area_set_transform)** **(** [RID](class_rid) area **)** const - * void **[`area_get_param`](#area_get_param)** **(** [RID](class_rid) area, [int](class_int) param **)** const - * [Transform](class_transform) **[`area_get_transform`](#area_get_transform)** **(** [RID](class_rid) area **)** const - * void **[`area_attach_object_instance_ID`](#area_attach_object_instance_ID)** **(** [RID](class_rid) area, [int](class_int) id **)** - * [int](class_int) **[`area_get_object_instance_ID`](#area_get_object_instance_ID)** **(** [RID](class_rid) area **)** const - * void **[`area_set_monitor_callback`](#area_set_monitor_callback)** **(** [RID](class_rid) receiver, [Object](class_object) method, [String](class_string) arg2 **)** - * [RID](class_rid) **[`body_create`](#body_create)** **(** [int](class_int) mode=2, [bool](class_bool) init_sleeping=false **)** - * void **[`body_set_space`](#body_set_space)** **(** [RID](class_rid) body, [RID](class_rid) space **)** - * [RID](class_rid) **[`body_get_space`](#body_get_space)** **(** [RID](class_rid) body **)** const - * void **[`body_set_mode`](#body_set_mode)** **(** [RID](class_rid) body, [int](class_int) mode **)** - * [int](class_int) **[`body_get_mode`](#body_get_mode)** **(** [RID](class_rid) body, [int](class_int) arg1 **)** const - * void **[`body_add_shape`](#body_add_shape)** **(** [RID](class_rid) body, [RID](class_rid) shape, [Transform](class_transform) transform=Transform() **)** - * void **[`body_set_shape`](#body_set_shape)** **(** [RID](class_rid) body, [int](class_int) shape_idx, [RID](class_rid) shape **)** - * void **[`body_set_shape_transform`](#body_set_shape_transform)** **(** [RID](class_rid) body, [int](class_int) shape_idx, [Transform](class_transform) transform **)** - * [int](class_int) **[`body_get_shape_count`](#body_get_shape_count)** **(** [RID](class_rid) body **)** const - * [RID](class_rid) **[`body_get_shape`](#body_get_shape)** **(** [RID](class_rid) body, [int](class_int) shape_idx **)** const - * [Transform](class_transform) **[`body_get_shape_transform`](#body_get_shape_transform)** **(** [RID](class_rid) body, [int](class_int) shape_idx **)** const - * void **[`body_remove_shape`](#body_remove_shape)** **(** [RID](class_rid) body, [int](class_int) shape_idx **)** - * void **[`body_clear_shapes`](#body_clear_shapes)** **(** [RID](class_rid) body **)** - * void **[`body_attach_object_instance_ID`](#body_attach_object_instance_ID)** **(** [RID](class_rid) body, [int](class_int) id **)** - * [int](class_int) **[`body_get_object_instance_ID`](#body_get_object_instance_ID)** **(** [RID](class_rid) body **)** const - * void **[`body_set_enable_continuous_collision_detection`](#body_set_enable_continuous_collision_detection)** **(** [RID](class_rid) body, [bool](class_bool) enable **)** - * [bool](class_bool) **[`body_is_continuous_collision_detection_enabled`](#body_is_continuous_collision_detection_enabled)** **(** [RID](class_rid) body **)** const - * void **[`body_set_param`](#body_set_param)** **(** [RID](class_rid) body, [int](class_int) param, [real](class_real) value **)** - * [real](class_real) **[`body_get_param`](#body_get_param)** **(** [RID](class_rid) body, [int](class_int) param **)** const - * void **[`body_static_simulate_motion`](#body_static_simulate_motion)** **(** [RID](class_rid) body, [Transform](class_transform) new_xform **)** - * void **[`body_set_state`](#body_set_state)** **(** [RID](class_rid) body, [int](class_int) state, var value **)** - * void **[`body_get_state`](#body_get_state)** **(** [RID](class_rid) body, [int](class_int) state **)** const - * void **[`body_apply_impulse`](#body_apply_impulse)** **(** [RID](class_rid) body, [Vector3](class_vector3) pos, [Vector3](class_vector3) impulse **)** - * void **[`body_set_axis_velocity`](#body_set_axis_velocity)** **(** [RID](class_rid) body, [Vector3](class_vector3) axis_velocity **)** - * void **[`body_add_collision_exception`](#body_add_collision_exception)** **(** [RID](class_rid) body, [RID](class_rid) excepted_body **)** - * void **[`body_remove_collision_exception`](#body_remove_collision_exception)** **(** [RID](class_rid) body, [RID](class_rid) excepted_body **)** - * void **[`body_set_max_contacts_reported`](#body_set_max_contacts_reported)** **(** [RID](class_rid) body, [int](class_int) amount **)** - * [int](class_int) **[`body_get_max_contacts_reported`](#body_get_max_contacts_reported)** **(** [RID](class_rid) body **)** const - * void **[`body_set_omit_force_integration`](#body_set_omit_force_integration)** **(** [RID](class_rid) body, [bool](class_bool) enable **)** - * [bool](class_bool) **[`body_is_omitting_force_integration`](#body_is_omitting_force_integration)** **(** [RID](class_rid) body **)** const - * void **[`body_set_force_integration_callback`](#body_set_force_integration_callback)** **(** [RID](class_rid) body, [Object](class_object) receiver, [String](class_string) method, var userdata=NULL **)** - * void **[`free`](#free)** **(** [RID](class_rid) rid **)** - * void **[`set_active`](#set_active)** **(** [bool](class_bool) active **)** + * [RID](class_rid) **[shape_create](#shape_create)** **(** [int](class_int) type **)** + * void **[shape_set_data](#shape_set_data)** **(** [RID](class_rid) shape, var data **)** + * [int](class_int) **[shape_get_type](#shape_get_type)** **(** [RID](class_rid) shape **)** const + * void **[shape_get_data](#shape_get_data)** **(** [RID](class_rid) shape **)** const + * [RID](class_rid) **[space_create](#space_create)** **(** **)** + * void **[space_set_active](#space_set_active)** **(** [RID](class_rid) space, [bool](class_bool) active **)** + * [bool](class_bool) **[space_is_active](#space_is_active)** **(** [RID](class_rid) space **)** const + * void **[space_set_param](#space_set_param)** **(** [RID](class_rid) space, [int](class_int) param, [real](class_real) value **)** + * [real](class_real) **[space_get_param](#space_get_param)** **(** [RID](class_rid) space, [int](class_int) param **)** const + * [PhysicsDirectSpaceState](class_physicsdirectspacestate) **[space_get_direct_state](#space_get_direct_state)** **(** [RID](class_rid) space **)** + * [RID](class_rid) **[area_create](#area_create)** **(** **)** + * void **[area_set_space](#area_set_space)** **(** [RID](class_rid) area, [RID](class_rid) space **)** + * [RID](class_rid) **[area_get_space](#area_get_space)** **(** [RID](class_rid) area **)** const + * void **[area_set_space_override_mode](#area_set_space_override_mode)** **(** [RID](class_rid) area, [int](class_int) mode **)** + * [int](class_int) **[area_get_space_override_mode](#area_get_space_override_mode)** **(** [RID](class_rid) area **)** const + * void **[area_add_shape](#area_add_shape)** **(** [RID](class_rid) area, [int](class_int) shape, [RID](class_rid) transform=Transform() **)** + * [RID](class_rid) **[area_set_shape](#area_set_shape)** **(** [RID](class_rid) area, [int](class_int) shape_idx **)** const + * void **[area_set_shape_transform](#area_set_shape_transform)** **(** [RID](class_rid) area, [int](class_int) shape_idx, [Transform](class_transform) transform **)** + * [int](class_int) **[area_get_shape_count](#area_get_shape_count)** **(** [RID](class_rid) area **)** const + * [RID](class_rid) **[area_get_shape](#area_get_shape)** **(** [RID](class_rid) area, [int](class_int) shape_idx **)** const + * [Transform](class_transform) **[area_get_shape_transform](#area_get_shape_transform)** **(** [RID](class_rid) area, [int](class_int) shape_idx **)** const + * void **[area_remove_shape](#area_remove_shape)** **(** [RID](class_rid) area, [int](class_int) shape_idx **)** + * void **[area_clear_shapes](#area_clear_shapes)** **(** [RID](class_rid) area **)** + * void **[area_set_param](#area_set_param)** **(** [RID](class_rid) area, [int](class_int) param **)** const + * [Transform](class_transform) **[area_set_transform](#area_set_transform)** **(** [RID](class_rid) area **)** const + * void **[area_get_param](#area_get_param)** **(** [RID](class_rid) area, [int](class_int) param **)** const + * [Transform](class_transform) **[area_get_transform](#area_get_transform)** **(** [RID](class_rid) area **)** const + * void **[area_attach_object_instance_ID](#area_attach_object_instance_ID)** **(** [RID](class_rid) area, [int](class_int) id **)** + * [int](class_int) **[area_get_object_instance_ID](#area_get_object_instance_ID)** **(** [RID](class_rid) area **)** const + * void **[area_set_monitor_callback](#area_set_monitor_callback)** **(** [RID](class_rid) receiver, [Object](class_object) method, [String](class_string) arg2 **)** + * [RID](class_rid) **[body_create](#body_create)** **(** [int](class_int) mode=2, [bool](class_bool) init_sleeping=false **)** + * void **[body_set_space](#body_set_space)** **(** [RID](class_rid) body, [RID](class_rid) space **)** + * [RID](class_rid) **[body_get_space](#body_get_space)** **(** [RID](class_rid) body **)** const + * void **[body_set_mode](#body_set_mode)** **(** [RID](class_rid) body, [int](class_int) mode **)** + * [int](class_int) **[body_get_mode](#body_get_mode)** **(** [RID](class_rid) body, [int](class_int) arg1 **)** const + * void **[body_add_shape](#body_add_shape)** **(** [RID](class_rid) body, [RID](class_rid) shape, [Transform](class_transform) transform=Transform() **)** + * void **[body_set_shape](#body_set_shape)** **(** [RID](class_rid) body, [int](class_int) shape_idx, [RID](class_rid) shape **)** + * void **[body_set_shape_transform](#body_set_shape_transform)** **(** [RID](class_rid) body, [int](class_int) shape_idx, [Transform](class_transform) transform **)** + * [int](class_int) **[body_get_shape_count](#body_get_shape_count)** **(** [RID](class_rid) body **)** const + * [RID](class_rid) **[body_get_shape](#body_get_shape)** **(** [RID](class_rid) body, [int](class_int) shape_idx **)** const + * [Transform](class_transform) **[body_get_shape_transform](#body_get_shape_transform)** **(** [RID](class_rid) body, [int](class_int) shape_idx **)** const + * void **[body_remove_shape](#body_remove_shape)** **(** [RID](class_rid) body, [int](class_int) shape_idx **)** + * void **[body_clear_shapes](#body_clear_shapes)** **(** [RID](class_rid) body **)** + * void **[body_attach_object_instance_ID](#body_attach_object_instance_ID)** **(** [RID](class_rid) body, [int](class_int) id **)** + * [int](class_int) **[body_get_object_instance_ID](#body_get_object_instance_ID)** **(** [RID](class_rid) body **)** const + * void **[body_set_enable_continuous_collision_detection](#body_set_enable_continuous_collision_detection)** **(** [RID](class_rid) body, [bool](class_bool) enable **)** + * [bool](class_bool) **[body_is_continuous_collision_detection_enabled](#body_is_continuous_collision_detection_enabled)** **(** [RID](class_rid) body **)** const + * void **[body_set_param](#body_set_param)** **(** [RID](class_rid) body, [int](class_int) param, [real](class_real) value **)** + * [real](class_real) **[body_get_param](#body_get_param)** **(** [RID](class_rid) body, [int](class_int) param **)** const + * void **[body_static_simulate_motion](#body_static_simulate_motion)** **(** [RID](class_rid) body, [Transform](class_transform) new_xform **)** + * void **[body_set_state](#body_set_state)** **(** [RID](class_rid) body, [int](class_int) state, var value **)** + * void **[body_get_state](#body_get_state)** **(** [RID](class_rid) body, [int](class_int) state **)** const + * void **[body_apply_impulse](#body_apply_impulse)** **(** [RID](class_rid) body, [Vector3](class_vector3) pos, [Vector3](class_vector3) impulse **)** + * void **[body_set_axis_velocity](#body_set_axis_velocity)** **(** [RID](class_rid) body, [Vector3](class_vector3) axis_velocity **)** + * void **[body_add_collision_exception](#body_add_collision_exception)** **(** [RID](class_rid) body, [RID](class_rid) excepted_body **)** + * void **[body_remove_collision_exception](#body_remove_collision_exception)** **(** [RID](class_rid) body, [RID](class_rid) excepted_body **)** + * void **[body_set_max_contacts_reported](#body_set_max_contacts_reported)** **(** [RID](class_rid) body, [int](class_int) amount **)** + * [int](class_int) **[body_get_max_contacts_reported](#body_get_max_contacts_reported)** **(** [RID](class_rid) body **)** const + * void **[body_set_omit_force_integration](#body_set_omit_force_integration)** **(** [RID](class_rid) body, [bool](class_bool) enable **)** + * [bool](class_bool) **[body_is_omitting_force_integration](#body_is_omitting_force_integration)** **(** [RID](class_rid) body **)** const + * void **[body_set_force_integration_callback](#body_set_force_integration_callback)** **(** [RID](class_rid) body, [Object](class_object) receiver, [String](class_string) method, var userdata=NULL **)** + * void **[free](#free)** **(** [RID](class_rid) rid **)** + * void **[set_active](#set_active)** **(** [bool](class_bool) active **)** ### Numeric Constants * **SHAPE_PLANE** = **0** diff --git a/class_physicsshapequeryresult.md b/class_physicsshapequeryresult.md index 6a22ac8..cc73a1d 100644 --- a/class_physicsshapequeryresult.md +++ b/class_physicsshapequeryresult.md @@ -6,10 +6,10 @@ Result of a shape query in Physics2DServer. ### Member Functions - * [int](class_int) **[`get_result_count`](#get_result_count)** **(** **)** const - * [RID](class_rid) **[`get_result_rid`](#get_result_rid)** **(** [int](class_int) idx **)** const - * [int](class_int) **[`get_result_object_id`](#get_result_object_id)** **(** [int](class_int) idx **)** const - * [Object](class_object) **[`get_result_object`](#get_result_object)** **(** [int](class_int) idx **)** const - * [int](class_int) **[`get_result_object_shape`](#get_result_object_shape)** **(** [int](class_int) idx **)** const + * [int](class_int) **[get_result_count](#get_result_count)** **(** **)** const + * [RID](class_rid) **[get_result_rid](#get_result_rid)** **(** [int](class_int) idx **)** const + * [int](class_int) **[get_result_object_id](#get_result_object_id)** **(** [int](class_int) idx **)** const + * [Object](class_object) **[get_result_object](#get_result_object)** **(** [int](class_int) idx **)** const + * [int](class_int) **[get_result_object_shape](#get_result_object_shape)** **(** [int](class_int) idx **)** const ### Member Function Description diff --git a/class_plane.md b/class_plane.md index 2b5642a..10165e2 100644 --- a/class_plane.md +++ b/class_plane.md @@ -5,19 +5,19 @@ Plane in hessian form. ### Member Functions - * [Vector3](class_vector3) **[`center`](#center)** **(** **)** - * [real](class_real) **[`distance_to`](#distance_to)** **(** [Vector3](class_vector3) point **)** - * [Vector3](class_vector3) **[`get_any_point`](#get_any_point)** **(** **)** - * [bool](class_bool) **[`has_point`](#has_point)** **(** [Vector3](class_vector3) point, [real](class_real) epsilon=0.00001 **)** - * [Vector3](class_vector3) **[`intersect_3`](#intersect_3)** **(** [Plane](class_plane) b, [Plane](class_plane) c **)** - * [Vector3](class_vector3) **[`intersects_ray`](#intersects_ray)** **(** [Vector3](class_vector3) from, [Vector3](class_vector3) dir **)** - * [Vector3](class_vector3) **[`intersects_segment`](#intersects_segment)** **(** [Vector3](class_vector3) begin, [Vector3](class_vector3) end **)** - * [bool](class_bool) **[`is_point_over`](#is_point_over)** **(** [Vector3](class_vector3) point **)** - * [Plane](class_plane) **[`normalized`](#normalized)** **(** **)** - * [Vector3](class_vector3) **[`project`](#project)** **(** [Vector3](class_vector3) point **)** - * void **[`Plane`](#Plane)** **(** [real](class_real) a, [real](class_real) b, [real](class_real) c, [real](class_real) d **)** - * void **[`Plane`](#Plane)** **(** [Vector3](class_vector3) v1, [Vector3](class_vector3) v2, [Vector3](class_vector3) v3 **)** - * void **[`Plane`](#Plane)** **(** [Vector3](class_vector3) normal, [real](class_real) d **)** + * [Vector3](class_vector3) **[center](#center)** **(** **)** + * [real](class_real) **[distance_to](#distance_to)** **(** [Vector3](class_vector3) point **)** + * [Vector3](class_vector3) **[get_any_point](#get_any_point)** **(** **)** + * [bool](class_bool) **[has_point](#has_point)** **(** [Vector3](class_vector3) point, [real](class_real) epsilon=0.00001 **)** + * [Vector3](class_vector3) **[intersectι](#intersect_3)** **(** [Plane](class_plane) b, [Plane](class_plane) c **)** + * [Vector3](class_vector3) **[intersects_ray](#intersects_ray)** **(** [Vector3](class_vector3) from, [Vector3](class_vector3) dir **)** + * [Vector3](class_vector3) **[intersects_segment](#intersects_segment)** **(** [Vector3](class_vector3) begin, [Vector3](class_vector3) end **)** + * [bool](class_bool) **[is_point_over](#is_point_over)** **(** [Vector3](class_vector3) point **)** + * [Plane](class_plane) **[normalized](#normalized)** **(** **)** + * [Vector3](class_vector3) **[project](#project)** **(** [Vector3](class_vector3) point **)** + * void **[Plane](#Plane)** **(** [real](class_real) a, [real](class_real) b, [real](class_real) c, [real](class_real) d **)** + * void **[Plane](#Plane)** **(** [Vector3](class_vector3) v1, [Vector3](class_vector3) v2, [Vector3](class_vector3) v3 **)** + * void **[Plane](#Plane)** **(** [Vector3](class_vector3) normal, [real](class_real) d **)** ### Member Variables * [Vector3](class_vector3) **normal** @@ -32,36 +32,36 @@ Plane represents a normalized plane equation. Basically, "normal" is the normal ### Member Function Description #### has_point - * [bool](class_bool) **`has_point`** **(** [Vector3](class_vector3) point, [real](class_real) epsilon=0.00001 **)** + * [bool](class_bool) **has_point** **(** [Vector3](class_vector3) point, [real](class_real) epsilon=0.00001 **)** Returns true if "p" is inside the plane (by a very minimum treshold). #### intersect_3 - * [Vector3](class_vector3) **`intersect_3`** **(** [Plane](class_plane) b, [Plane](class_plane) c **)** + * [Vector3](class_vector3) **intersectι** **(** [Plane](class_plane) b, [Plane](class_plane) c **)** Returns true if this plane intersects with planes "a" and "b". The resulting intersectin is placed in "r". #### intersects_ray - * [Vector3](class_vector3) **`intersects_ray`** **(** [Vector3](class_vector3) from, [Vector3](class_vector3) dir **)** + * [Vector3](class_vector3) **intersects_ray** **(** [Vector3](class_vector3) from, [Vector3](class_vector3) dir **)** Returns true if ray consiting of position "p" and direction normal "d" intersects this plane. If true, the result is placed in "r". #### intersects_segment - * [Vector3](class_vector3) **`intersects_segment`** **(** [Vector3](class_vector3) begin, [Vector3](class_vector3) end **)** + * [Vector3](class_vector3) **intersects_segment** **(** [Vector3](class_vector3) begin, [Vector3](class_vector3) end **)** Returns true if segment from position "sa" to position "sb" intersects this plane. If true, the result is placed in "r". #### is_point_over - * [bool](class_bool) **`is_point_over`** **(** [Vector3](class_vector3) point **)** + * [bool](class_bool) **is_point_over** **(** [Vector3](class_vector3) point **)** Returns true if "p" is located above the plane. #### normalized - * [Plane](class_plane) **`normalized`** **(** **)** + * [Plane](class_plane) **normalized** **(** **)** Returns a copy of the plane, normalized. #### project - * [Vector3](class_vector3) **`project`** **(** [Vector3](class_vector3) point **)** + * [Vector3](class_vector3) **project** **(** [Vector3](class_vector3) point **)** Returns the orthogonal projection of point "p" into a point in the plane. diff --git a/class_planeshape.md b/class_planeshape.md index bc02644..8f37a55 100644 --- a/class_planeshape.md +++ b/class_planeshape.md @@ -6,7 +6,7 @@ ### Member Functions - * void **[`set_plane`](#set_plane)** **(** [Plane](class_plane) plane **)** - * [Plane](class_plane) **[`get_plane`](#get_plane)** **(** **)** const + * void **[set_plane](#set_plane)** **(** [Plane](class_plane) plane **)** + * [Plane](class_plane) **[get_plane](#get_plane)** **(** **)** const ### Member Function Description diff --git a/class_popup.md b/class_popup.md index 87dd86e..5b94026 100644 --- a/class_popup.md +++ b/class_popup.md @@ -6,15 +6,15 @@ Base container control for popups and dialogs. ### Member Functions - * void **[`popup_centered`](#popup_centered)** **(** [Vector2](class_vector2) size=Vector2(0,0) **)** - * void **[`popup_centered_ratio`](#popup_centered_ratio)** **(** [real](class_real) ratio=0.75 **)** - * void **[`popup_centered_minsize`](#popup_centered_minsize)** **(** [Vector2](class_vector2) minsize=Vector2(0,0) **)** - * void **[`popup`](#popup)** **(** **)** - * void **[`set_exclusive`](#set_exclusive)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_exclusive`](#is_exclusive)** **(** **)** const + * void **[popup_centered](#popup_centered)** **(** [Vector2](class_vector2) size=Vector2(0,0) **)** + * void **[popup_centered_ratio](#popup_centered_ratio)** **(** [real](class_real) ratio=0.75 **)** + * void **[popup_centered_minsize](#popup_centered_minsize)** **(** [Vector2](class_vector2) minsize=Vector2(0,0) **)** + * void **[popup](#popup)** **(** **)** + * void **[set_exclusive](#set_exclusive)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_exclusive](#is_exclusive)** **(** **)** const ### Signals - * **`about_to_show`** **(** **)** + * **about_to_show** **(** **)** ### Numeric Constants * **NOTIFICATION_POST_POPUP** = **80** @@ -25,16 +25,16 @@ PopUp is a base [Control](class_control) used to show dialogs and popups. It's a ### Member Function Description #### popup_centered - * void **`popup_centered`** **(** [Vector2](class_vector2) size=Vector2(0,0) **)** + * void **popup_centered** **(** [Vector2](class_vector2) size=Vector2(0,0) **)** Popup (show the control in modal form) in the center of the screen, at the curent size, or at a size determined by "size". #### popup_centered_ratio - * void **`popup_centered_ratio`** **(** [real](class_real) ratio=0.75 **)** + * void **popup_centered_ratio** **(** [real](class_real) ratio=0.75 **)** Popup (show the control in modal form) in the center of the screen, scalled at a ratio of size of the screen. #### popup - * void **`popup`** **(** **)** + * void **popup** **(** **)** Popup (show the control in modal form). diff --git a/class_popupmenu.md b/class_popupmenu.md index 262d727..6fed50a 100644 --- a/class_popupmenu.md +++ b/class_popupmenu.md @@ -6,39 +6,39 @@ PopupMenu displays a list of options. ### Member Functions - * void **[`add_icon_item`](#add_icon_item)** **(** [Object](class_object) texture, [String](class_string) label, [int](class_int) id=-1, [int](class_int) accel=0 **)** - * void **[`add_item`](#add_item)** **(** [String](class_string) label, [int](class_int) id=-1, [int](class_int) accel=0 **)** - * void **[`add_icon_check_item`](#add_icon_check_item)** **(** [Object](class_object) texture, [String](class_string) label, [int](class_int) id=-1, [int](class_int) accel=0 **)** - * void **[`add_check_item`](#add_check_item)** **(** [String](class_string) label, [int](class_int) id=-1, [int](class_int) accel=0 **)** - * void **[`add_submenu_item`](#add_submenu_item)** **(** [String](class_string) label, [int](class_int) submenu, [int](class_int) id=-1 **)** - * void **[`set_item_text`](#set_item_text)** **(** [int](class_int) idx, [String](class_string) text **)** - * void **[`set_item_icon`](#set_item_icon)** **(** [int](class_int) idx, [Object](class_object) icon **)** - * void **[`set_item_accelerator`](#set_item_accelerator)** **(** [int](class_int) idx, [int](class_int) accel **)** - * void **[`set_item_metadata`](#set_item_metadata)** **(** [int](class_int) idx, var metadata **)** - * void **[`set_item_checked`](#set_item_checked)** **(** [int](class_int) idx, [bool](class_bool) arg1 **)** - * void **[`set_item_disabled`](#set_item_disabled)** **(** [int](class_int) idx, [bool](class_bool) disabled **)** - * void **[`set_item_submenu`](#set_item_submenu)** **(** [int](class_int) idx, [String](class_string) submenu **)** - * void **[`set_item_as_separator`](#set_item_as_separator)** **(** [int](class_int) idx, [bool](class_bool) enable **)** - * void **[`set_item_as_checkable`](#set_item_as_checkable)** **(** [int](class_int) idx, [bool](class_bool) enable **)** - * void **[`set_item_ID`](#set_item_ID)** **(** [int](class_int) idx, [int](class_int) id **)** - * [String](class_string) **[`get_item_text`](#get_item_text)** **(** [int](class_int) idx **)** const - * [Object](class_object) **[`get_item_icon`](#get_item_icon)** **(** [int](class_int) idx **)** const - * void **[`get_item_metadata`](#get_item_metadata)** **(** [int](class_int) idx **)** const - * [int](class_int) **[`get_item_accelerator`](#get_item_accelerator)** **(** [int](class_int) idx **)** const - * [String](class_string) **[`get_item_submenu`](#get_item_submenu)** **(** [int](class_int) idx **)** const - * [bool](class_bool) **[`is_item_separator`](#is_item_separator)** **(** [int](class_int) idx **)** const - * [bool](class_bool) **[`is_item_checkable`](#is_item_checkable)** **(** [int](class_int) idx **)** const - * [bool](class_bool) **[`is_item_checked`](#is_item_checked)** **(** [int](class_int) idx **)** const - * [bool](class_bool) **[`is_item_disabled`](#is_item_disabled)** **(** [int](class_int) idx **)** const - * [int](class_int) **[`get_item_ID`](#get_item_ID)** **(** [int](class_int) idx **)** const - * [int](class_int) **[`get_item_index`](#get_item_index)** **(** [int](class_int) id **)** const - * [int](class_int) **[`get_item_count`](#get_item_count)** **(** **)** const - * void **[`add_separator`](#add_separator)** **(** **)** - * void **[`remove_item`](#remove_item)** **(** [int](class_int) idx **)** - * void **[`clear`](#clear)** **(** **)** + * void **[add_icon_item](#add_icon_item)** **(** [Object](class_object) texture, [String](class_string) label, [int](class_int) id=-1, [int](class_int) accel=0 **)** + * void **[add_item](#add_item)** **(** [String](class_string) label, [int](class_int) id=-1, [int](class_int) accel=0 **)** + * void **[add_icon_check_item](#add_icon_check_item)** **(** [Object](class_object) texture, [String](class_string) label, [int](class_int) id=-1, [int](class_int) accel=0 **)** + * void **[add_check_item](#add_check_item)** **(** [String](class_string) label, [int](class_int) id=-1, [int](class_int) accel=0 **)** + * void **[add_submenu_item](#add_submenu_item)** **(** [String](class_string) label, [int](class_int) submenu, [int](class_int) id=-1 **)** + * void **[set_item_text](#set_item_text)** **(** [int](class_int) idx, [String](class_string) text **)** + * void **[set_item_icon](#set_item_icon)** **(** [int](class_int) idx, [Object](class_object) icon **)** + * void **[set_item_accelerator](#set_item_accelerator)** **(** [int](class_int) idx, [int](class_int) accel **)** + * void **[set_item_metadata](#set_item_metadata)** **(** [int](class_int) idx, var metadata **)** + * void **[set_item_checked](#set_item_checked)** **(** [int](class_int) idx, [bool](class_bool) arg1 **)** + * void **[set_item_disabled](#set_item_disabled)** **(** [int](class_int) idx, [bool](class_bool) disabled **)** + * void **[set_item_submenu](#set_item_submenu)** **(** [int](class_int) idx, [String](class_string) submenu **)** + * void **[set_item_as_separator](#set_item_as_separator)** **(** [int](class_int) idx, [bool](class_bool) enable **)** + * void **[set_item_as_checkable](#set_item_as_checkable)** **(** [int](class_int) idx, [bool](class_bool) enable **)** + * void **[set_item_ID](#set_item_ID)** **(** [int](class_int) idx, [int](class_int) id **)** + * [String](class_string) **[get_item_text](#get_item_text)** **(** [int](class_int) idx **)** const + * [Object](class_object) **[get_item_icon](#get_item_icon)** **(** [int](class_int) idx **)** const + * void **[get_item_metadata](#get_item_metadata)** **(** [int](class_int) idx **)** const + * [int](class_int) **[get_item_accelerator](#get_item_accelerator)** **(** [int](class_int) idx **)** const + * [String](class_string) **[get_item_submenu](#get_item_submenu)** **(** [int](class_int) idx **)** const + * [bool](class_bool) **[is_item_separator](#is_item_separator)** **(** [int](class_int) idx **)** const + * [bool](class_bool) **[is_item_checkable](#is_item_checkable)** **(** [int](class_int) idx **)** const + * [bool](class_bool) **[is_item_checked](#is_item_checked)** **(** [int](class_int) idx **)** const + * [bool](class_bool) **[is_item_disabled](#is_item_disabled)** **(** [int](class_int) idx **)** const + * [int](class_int) **[get_item_ID](#get_item_ID)** **(** [int](class_int) idx **)** const + * [int](class_int) **[get_item_index](#get_item_index)** **(** [int](class_int) id **)** const + * [int](class_int) **[get_item_count](#get_item_count)** **(** **)** const + * void **[add_separator](#add_separator)** **(** **)** + * void **[remove_item](#remove_item)** **(** [int](class_int) idx **)** + * void **[clear](#clear)** **(** **)** ### Signals - * **`item_pressed`** **(** [int](class_int) ID **)** + * **item_pressed** **(** [int](class_int) ID **)** ### Description PopupMenu is the typical Control that displays a list of options. They are popular in toolbars or context menus. @@ -46,91 +46,91 @@ PopupMenu is the typical Control that displays a list of options. They are popul ### Member Function Description #### add_icon_item - * void **`add_icon_item`** **(** [Object](class_object) texture, [String](class_string) label, [int](class_int) id=-1, [int](class_int) accel=0 **)** + * void **add_icon_item** **(** [Object](class_object) texture, [String](class_string) label, [int](class_int) id=-1, [int](class_int) accel=0 **)** Add a new item with text "label" and icon "texture. An id can optonally be provided, as well as an accelerator. If no id is provided, one will be created from the index. #### add_item - * void **`add_item`** **(** [String](class_string) label, [int](class_int) id=-1, [int](class_int) accel=0 **)** + * void **add_item** **(** [String](class_string) label, [int](class_int) id=-1, [int](class_int) accel=0 **)** Add a new item with text "label". An id can optonally be provided, as well as an accelerator. If no id is provided, one will be created from the index. #### add_icon_check_item - * void **`add_icon_check_item`** **(** [Object](class_object) texture, [String](class_string) label, [int](class_int) id=-1, [int](class_int) accel=0 **)** + * void **add_icon_check_item** **(** [Object](class_object) texture, [String](class_string) label, [int](class_int) id=-1, [int](class_int) accel=0 **)** Add a new checkable item with text "label" and icon "texture. An id can optonally 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"apos;t have any built-in checking behavior and must be checked/unchecked manually. #### add_check_item - * void **`add_check_item`** **(** [String](class_string) label, [int](class_int) id=-1, [int](class_int) accel=0 **)** + * void **add_check_item** **(** [String](class_string) label, [int](class_int) id=-1, [int](class_int) accel=0 **)** Add a new checkable item with text "label". An id can optonally 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"apos;t have any built-in checking behavior and must be checked/unchecked manually. #### set_item_text - * void **`set_item_text`** **(** [int](class_int) idx, [String](class_string) text **)** + * void **set_item_text** **(** [int](class_int) idx, [String](class_string) text **)** Set the text of the item at index "idx". #### set_item_icon - * void **`set_item_icon`** **(** [int](class_int) idx, [Object](class_object) icon **)** + * void **set_item_icon** **(** [int](class_int) idx, [Object](class_object) icon **)** Set the icon of the item at index "idx". #### set_item_accelerator - * void **`set_item_accelerator`** **(** [int](class_int) idx, [int](class_int) accel **)** + * void **set_item_accelerator** **(** [int](class_int) idx, [int](class_int) accel **)** Set the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is fucused. #### set_item_checked - * void **`set_item_checked`** **(** [int](class_int) idx, [bool](class_bool) arg1 **)** + * void **set_item_checked** **(** [int](class_int) idx, [bool](class_bool) arg1 **)** Set the checkstate status of the item at index "idx". #### set_item_ID - * void **`set_item_ID`** **(** [int](class_int) idx, [int](class_int) id **)** + * void **set_item_ID** **(** [int](class_int) idx, [int](class_int) id **)** Set the id of the item at index "idx". #### get_item_text - * [String](class_string) **`get_item_text`** **(** [int](class_int) idx **)** const + * [String](class_string) **get_item_text** **(** [int](class_int) idx **)** const Return the text of the item at index "idx". #### get_item_icon - * [Object](class_object) **`get_item_icon`** **(** [int](class_int) idx **)** const + * [Object](class_object) **get_item_icon** **(** [int](class_int) idx **)** const Return the icon of the item at index "idx". #### get_item_accelerator - * [int](class_int) **`get_item_accelerator`** **(** [int](class_int) idx **)** const + * [int](class_int) **get_item_accelerator** **(** [int](class_int) idx **)** const Return the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is fucused. #### is_item_checked - * [bool](class_bool) **`is_item_checked`** **(** [int](class_int) idx **)** const + * [bool](class_bool) **is_item_checked** **(** [int](class_int) idx **)** const Return the checkstate status of the item at index "idx". #### get_item_ID - * [int](class_int) **`get_item_ID`** **(** [int](class_int) idx **)** const + * [int](class_int) **get_item_ID** **(** [int](class_int) idx **)** const Return the id of the item at index "idx". #### get_item_index - * [int](class_int) **`get_item_index`** **(** [int](class_int) id **)** const + * [int](class_int) **get_item_index** **(** [int](class_int) id **)** const Find and return the index of the item containing a given id. #### get_item_count - * [int](class_int) **`get_item_count`** **(** **)** const + * [int](class_int) **get_item_count** **(** **)** const Return the amount of items. #### add_separator - * void **`add_separator`** **(** **)** + * void **add_separator** **(** **)** Add a separator between items. Separators also occupy an index. #### clear - * void **`clear`** **(** **)** + * void **clear** **(** **)** Clear the popup menu. diff --git a/class_portal.md b/class_portal.md index deea6b2..68063a6 100644 --- a/class_portal.md +++ b/class_portal.md @@ -6,16 +6,16 @@ Portals provide virtual openings to rooms. ### Member Functions - * void **[`set_shape`](#set_shape)** **(** [Vector2Array](class_vector2array) points **)** - * [Vector2Array](class_vector2array) **[`get_shape`](#get_shape)** **(** **)** const - * void **[`set_enabled`](#set_enabled)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_enabled`](#is_enabled)** **(** **)** const - * void **[`set_disable_distance`](#set_disable_distance)** **(** [real](class_real) distance **)** - * [real](class_real) **[`get_disable_distance`](#get_disable_distance)** **(** **)** const - * void **[`set_disabled_color`](#set_disabled_color)** **(** [Color](class_color) color **)** - * [Color](class_color) **[`get_disabled_color`](#get_disabled_color)** **(** **)** const - * void **[`set_connect_range`](#set_connect_range)** **(** [real](class_real) range **)** - * [real](class_real) **[`get_connect_range`](#get_connect_range)** **(** **)** const + * void **[set_shape](#set_shape)** **(** [Vector2Array](class_vector2array) points **)** + * [Vector2Array](class_vector2array) **[get_shape](#get_shape)** **(** **)** const + * void **[set_enabled](#set_enabled)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_enabled](#is_enabled)** **(** **)** const + * void **[set_disable_distance](#set_disable_distance)** **(** [real](class_real) distance **)** + * [real](class_real) **[get_disable_distance](#get_disable_distance)** **(** **)** const + * void **[set_disabled_color](#set_disabled_color)** **(** [Color](class_color) color **)** + * [Color](class_color) **[get_disabled_color](#get_disabled_color)** **(** **)** const + * void **[set_connect_range](#set_connect_range)** **(** [real](class_real) range **)** + * [real](class_real) **[get_connect_range](#get_connect_range)** **(** **)** const ### Description Portals provide virtual openings to [RoomInstance] 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 [RoomInstance]. 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 [RoomInstance], 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 [RoomInstance] node as a parent, grandparent or far parent, or else they will not be @@ -24,51 +24,51 @@ Portals provide virtual openings to [RoomInstance] nodes, so cameras can look at ### Member Function Description #### set_shape - * void **`set_shape`** **(** [Vector2Array](class_vector2array) points **)** + * void **set_shape** **(** [Vector2Array](class_vector2array) points **)** Set the portal shape. The shape is an array of [Point2] points, representing a convex polygon in the X,Y plane. #### get_shape - * [Vector2Array](class_vector2array) **`get_shape`** **(** **)** const + * [Vector2Array](class_vector2array) **get_shape** **(** **)** const Return the portal shape. The shape is an array of [Point2] points, representing a convex polygon in the X,Y plane. #### set_enabled - * void **`set_enabled`** **(** [bool](class_bool) enable **)** + * void **set_enabled** **(** [bool](class_bool) enable **)** Enable the portal (it is enabled by defaul though), disabling it will cause the parent [RoomInstance] to not be visible any longer when looking through the portal. #### is_enabled - * [bool](class_bool) **`is_enabled`** **(** **)** const + * [bool](class_bool) **is_enabled** **(** **)** const Return wether the portal is active. When disabled it causes the parent [RoomInstance] to not be visible any longer when looking through the portal. #### set_disable_distance - * void **`set_disable_distance`** **(** [real](class_real) distance **)** + * void **set_disable_distance** **(** [real](class_real) 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 [`set_disabled_color`](#set_disabled_color)). +Set the distance threshold for disabling the portal. Every time that the portal goes beyond "distance", it disables itself, becoming the opaque color (see [set_disabled_color](#set_disabled_color)). #### get_disable_distance - * [real](class_real) **`get_disable_distance`** **(** **)** const + * [real](class_real) **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 [`set_disabled_color`](#set_disabled_color)). +Return the distance threshold for disabling the portal. Every time that the portal goes beyond "distance", it disables itself, becoming the opaque color (see [set_disabled_color](#set_disabled_color)). #### set_disabled_color - * void **`set_disabled_color`** **(** [Color](class_color) color **)** + * void **set_disabled_color** **(** [Color](class_color) color **)** -When the portal goes beyond the disable distance (see [`set_disable_distance`](#set_disable_distance)), it becomes opaque and displayed with color "color". +When the portal goes beyond the disable distance (see [set_disable_distance](#set_disable_distance)), it becomes opaque and displayed with color "color". #### get_disabled_color - * [Color](class_color) **`get_disabled_color`** **(** **)** const + * [Color](class_color) **get_disabled_color** **(** **)** const -Return the color for when the portal goes beyond the disable distance (see [`set_disable_distance`](#set_disable_distance)) and becomes disabled. +Return the color for when the portal goes beyond the disable distance (see [set_disable_distance](#set_disable_distance)) and becomes disabled. #### set_connect_range - * void **`set_connect_range`** **(** [real](class_real) range **)** + * void **set_connect_range** **(** [real](class_real) range **)** Set the range for auto-connecting two portals from different rooms sharing the same space. #### get_connect_range - * [real](class_real) **`get_connect_range`** **(** **)** const + * [real](class_real) **get_connect_range** **(** **)** const Return the range for auto-connecting two portals from different rooms sharing the same space. diff --git a/class_proximitygroup.md b/class_proximitygroup.md index e1db726..193b8d9 100644 --- a/class_proximitygroup.md +++ b/class_proximitygroup.md @@ -6,14 +6,14 @@ General purpose proximity-detection node. ### Member Functions - * void **[`set_group_name`](#set_group_name)** **(** [String](class_string) name **)** - * void **[`broadcast`](#broadcast)** **(** [String](class_string) name, var parameters **)** - * void **[`set_dispatch_mode`](#set_dispatch_mode)** **(** [int](class_int) mode **)** - * void **[`set_grid_radius`](#set_grid_radius)** **(** [Vector3](class_vector3) radius **)** - * [Vector3](class_vector3) **[`get_grid_radius`](#get_grid_radius)** **(** **)** const + * void **[set_group_name](#set_group_name)** **(** [String](class_string) name **)** + * void **[broadcast](#broadcast)** **(** [String](class_string) name, var parameters **)** + * void **[set_dispatch_mode](#set_dispatch_mode)** **(** [int](class_int) mode **)** + * void **[set_grid_radius](#set_grid_radius)** **(** [Vector3](class_vector3) radius **)** + * [Vector3](class_vector3) **[get_grid_radius](#get_grid_radius)** **(** **)** const ### Signals - * **`broadcast`** **(** [String](class_string) name, [Array](class_array) parameters **)** + * **broadcast** **(** [String](class_string) name, [Array](class_array) parameters **)** ### Description General purpose proximity-detection node. diff --git a/class_quad.md b/class_quad.md index 2d14656..5a45e36 100644 --- a/class_quad.md +++ b/class_quad.md @@ -6,13 +6,13 @@ ### Member Functions - * void **[`set_axis`](#set_axis)** **(** [int](class_int) axis **)** - * [int](class_int) **[`get_axis`](#get_axis)** **(** **)** const - * void **[`set_size`](#set_size)** **(** [Vector2](class_vector2) size **)** - * [Vector2](class_vector2) **[`get_size`](#get_size)** **(** **)** const - * void **[`set_centered`](#set_centered)** **(** [bool](class_bool) centered **)** - * [bool](class_bool) **[`is_centered`](#is_centered)** **(** **)** const - * void **[`set_offset`](#set_offset)** **(** [Vector2](class_vector2) offset **)** - * [Vector2](class_vector2) **[`get_offset`](#get_offset)** **(** **)** const + * void **[set_axis](#set_axis)** **(** [int](class_int) axis **)** + * [int](class_int) **[get_axis](#get_axis)** **(** **)** const + * void **[set_size](#set_size)** **(** [Vector2](class_vector2) size **)** + * [Vector2](class_vector2) **[get_size](#get_size)** **(** **)** const + * void **[set_centered](#set_centered)** **(** [bool](class_bool) centered **)** + * [bool](class_bool) **[is_centered](#is_centered)** **(** **)** const + * void **[set_offset](#set_offset)** **(** [Vector2](class_vector2) offset **)** + * [Vector2](class_vector2) **[get_offset](#get_offset)** **(** **)** const ### Member Function Description diff --git a/class_quat.md b/class_quat.md index 091af95..2050b21 100644 --- a/class_quat.md +++ b/class_quat.md @@ -5,16 +5,16 @@ Quaternion. ### Member Functions - * [Quat](class_quat) **[`cubic_slerp`](#cubic_slerp)** **(** [Quat](class_quat) b, [Quat](class_quat) pre_a, [Quat](class_quat) post_b, [real](class_real) t **)** - * [real](class_real) **[`dot`](#dot)** **(** [Quat](class_quat) b **)** - * [Quat](class_quat) **[`inverse`](#inverse)** **(** **)** - * [real](class_real) **[`length`](#length)** **(** **)** - * [real](class_real) **[`length_squared`](#length_squared)** **(** **)** - * [Quat](class_quat) **[`normalized`](#normalized)** **(** **)** - * [Quat](class_quat) **[`slerp`](#slerp)** **(** [Quat](class_quat) b, [real](class_real) t **)** - * [Quat](class_quat) **[`slerpni`](#slerpni)** **(** [Quat](class_quat) b, [real](class_real) t **)** - * void **[`Quat`](#Quat)** **(** [real](class_real) x, [real](class_real) y, [real](class_real) z, [real](class_real) w **)** - * void **[`Quat`](#Quat)** **(** [Matrix3](class_matrix3) from **)** + * [Quat](class_quat) **[cubic_slerp](#cubic_slerp)** **(** [Quat](class_quat) b, [Quat](class_quat) pre_a, [Quat](class_quat) post_b, [real](class_real) t **)** + * [real](class_real) **[dot](#dot)** **(** [Quat](class_quat) b **)** + * [Quat](class_quat) **[inverse](#inverse)** **(** **)** + * [real](class_real) **[length](#length)** **(** **)** + * [real](class_real) **[length_squared](#length_squared)** **(** **)** + * [Quat](class_quat) **[normalized](#normalized)** **(** **)** + * [Quat](class_quat) **[slerp](#slerp)** **(** [Quat](class_quat) b, [real](class_real) t **)** + * [Quat](class_quat) **[slerpni](#slerpni)** **(** [Quat](class_quat) b, [real](class_real) t **)** + * void **[Quat](#Quat)** **(** [real](class_real) x, [real](class_real) y, [real](class_real) z, [real](class_real) w **)** + * void **[Quat](#Quat)** **(** [Matrix3](class_matrix3) from **)** ### Member Variables * [real](class_real) **x** @@ -28,31 +28,31 @@ Quaternion is a 4 dimensional vector that is used to represet a rotation. It mai ### Member Function Description #### dot - * [real](class_real) **`dot`** **(** [Quat](class_quat) b **)** + * [real](class_real) **dot** **(** [Quat](class_quat) b **)** Returns the dot product between two quaternions. #### inverse - * [Quat](class_quat) **`inverse`** **(** **)** + * [Quat](class_quat) **inverse** **(** **)** Returns the inverse of the quaternion (applies to the inverse rotatio too). #### length - * [real](class_real) **`length`** **(** **)** + * [real](class_real) **length** **(** **)** Returns the length of the quaternion. #### length_squared - * [real](class_real) **`length_squared`** **(** **)** + * [real](class_real) **length_squared** **(** **)** Returns the length of the quaternion, minus the square root. #### normalized - * [Quat](class_quat) **`normalized`** **(** **)** + * [Quat](class_quat) **normalized** **(** **)** Returns a copy of the quaternion, normalized to unit length. #### slerp - * [Quat](class_quat) **`slerp`** **(** [Quat](class_quat) b, [real](class_real) t **)** + * [Quat](class_quat) **slerp** **(** [Quat](class_quat) b, [real](class_real) t **)** Perform a spherical-linear interpolation with another quaternion. diff --git a/class_range.md b/class_range.md index 6f86624..4e7e0c7 100644 --- a/class_range.md +++ b/class_range.md @@ -6,30 +6,30 @@ Abstract base class for range-based controls. ### Member Functions - * [real](class_real) **[`get_val`](#get_val)** **(** **)** const - * [real](class_real) **[`get_value`](#get_value)** **(** **)** const - * [real](class_real) **[`get_min`](#get_min)** **(** **)** const - * [real](class_real) **[`get_max`](#get_max)** **(** **)** const - * [real](class_real) **[`get_step`](#get_step)** **(** **)** const - * [real](class_real) **[`get_page`](#get_page)** **(** **)** const - * [real](class_real) **[`get_unit_value`](#get_unit_value)** **(** **)** const - * [bool](class_bool) **[`get_rounded_values`](#get_rounded_values)** **(** **)** const - * void **[`set_val`](#set_val)** **(** [real](class_real) value **)** - * void **[`set_value`](#set_value)** **(** [real](class_real) value **)** - * void **[`set_min`](#set_min)** **(** [real](class_real) minimum **)** - * void **[`set_max`](#set_max)** **(** [real](class_real) maximum **)** - * void **[`set_step`](#set_step)** **(** [real](class_real) step **)** - * void **[`set_page`](#set_page)** **(** [real](class_real) pagesize **)** - * void **[`set_unit_value`](#set_unit_value)** **(** [real](class_real) value **)** - * void **[`set_rounded_values`](#set_rounded_values)** **(** [bool](class_bool) arg0 **)** - * void **[`set_exp_unit_value`](#set_exp_unit_value)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`is_unit_value_exp`](#is_unit_value_exp)** **(** **)** const - * void **[`share`](#share)** **(** [Object](class_object) with **)** - * void **[`unshare`](#unshare)** **(** **)** + * [real](class_real) **[get_val](#get_val)** **(** **)** const + * [real](class_real) **[get_value](#get_value)** **(** **)** const + * [real](class_real) **[get_min](#get_min)** **(** **)** const + * [real](class_real) **[get_max](#get_max)** **(** **)** const + * [real](class_real) **[get_step](#get_step)** **(** **)** const + * [real](class_real) **[get_page](#get_page)** **(** **)** const + * [real](class_real) **[get_unit_value](#get_unit_value)** **(** **)** const + * [bool](class_bool) **[get_rounded_values](#get_rounded_values)** **(** **)** const + * void **[set_val](#set_val)** **(** [real](class_real) value **)** + * void **[set_value](#set_value)** **(** [real](class_real) value **)** + * void **[set_min](#set_min)** **(** [real](class_real) minimum **)** + * void **[set_max](#set_max)** **(** [real](class_real) maximum **)** + * void **[set_step](#set_step)** **(** [real](class_real) step **)** + * void **[set_page](#set_page)** **(** [real](class_real) pagesize **)** + * void **[set_unit_value](#set_unit_value)** **(** [real](class_real) value **)** + * void **[set_rounded_values](#set_rounded_values)** **(** [bool](class_bool) arg0 **)** + * void **[set_exp_unit_value](#set_exp_unit_value)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[is_unit_value_exp](#is_unit_value_exp)** **(** **)** const + * void **[share](#share)** **(** [Object](class_object) with **)** + * void **[unshare](#unshare)** **(** **)** ### Signals - * **`value_changed`** **(** [real](class_real) value **)** - * **`changed`** **(** **)** + * **value_changed** **(** [real](class_real) value **)** + * **changed** **(** **)** ### Description Range is a base class for [Control](class_control) nodes that change a floating point _value_ between a need a _minimum_, _maximum_, using _step_ and _page_, for example a [ScrollBar](class_scrollbar). @@ -37,51 +37,51 @@ Range is a base class for [Control](class_control) nodes that change a floating ### Member Function Description #### get_val - * [real](class_real) **`get_val`** **(** **)** const + * [real](class_real) **get_val** **(** **)** const Return the current value. #### get_min - * [real](class_real) **`get_min`** **(** **)** const + * [real](class_real) **get_min** **(** **)** const Return the minimum value. #### get_max - * [real](class_real) **`get_max`** **(** **)** const + * [real](class_real) **get_max** **(** **)** const Return the maximum value. #### get_step - * [real](class_real) **`get_step`** **(** **)** const + * [real](class_real) **get_step** **(** **)** const Return the stepping, if step is 0, stepping is disabled. #### get_page - * [real](class_real) **`get_page`** **(** **)** const + * [real](class_real) **get_page** **(** **)** const Return the page size, if page is 0, paging is disabled. #### get_unit_value - * [real](class_real) **`get_unit_value`** **(** **)** const + * [real](class_real) **get_unit_value** **(** **)** const Return value mapped to 0 to 1 (unit) range. #### set_min - * void **`set_min`** **(** [real](class_real) minimum **)** + * void **set_min** **(** [real](class_real) minimum **)** Set minimum value, clamped range value to it if it"apos;s less. #### set_step - * void **`set_step`** **(** [real](class_real) step **)** + * void **set_step** **(** [real](class_real) step **)** Set step value. If step is 0, stepping will be disabled. #### set_page - * void **`set_page`** **(** [real](class_real) pagesize **)** + * void **set_page** **(** [real](class_real) pagesize **)** Set page size. Page is mainly used for scrollbars or anything that controls text scrolling. #### set_unit_value - * void **`set_unit_value`** **(** [real](class_real) value **)** + * void **set_unit_value** **(** [real](class_real) value **)** Set value mapped to 0 to 1 (unit) range, it will then be converted to the actual value within min and max. diff --git a/class_rawarray.md b/class_rawarray.md index 8f85c4b..ed46124 100644 --- a/class_rawarray.md +++ b/class_rawarray.md @@ -5,14 +5,14 @@ Raw byte array. ### Member Functions - * [int](class_int) **[`get`](#get)** **(** [int](class_int) idx **)** - * [String](class_string) **[`get_string_from_ascii`](#get_string_from_ascii)** **(** **)** - * [String](class_string) **[`get_string_from_utf8`](#get_string_from_utf8)** **(** **)** - * void **[`push_back`](#push_back)** **(** [int](class_int) byte **)** - * void **[`resize`](#resize)** **(** [int](class_int) idx **)** - * void **[`set`](#set)** **(** [int](class_int) idx, [int](class_int) byte **)** - * [int](class_int) **[`size`](#size)** **(** **)** - * void **[`RawArray`](#RawArray)** **(** [Array](class_array) from **)** + * [int](class_int) **[get](#get)** **(** [int](class_int) idx **)** + * [String](class_string) **[get_string_from_ascii](#get_string_from_ascii)** **(** **)** + * [String](class_string) **[get_string_from_utf8](#get_string_from_utf8)** **(** **)** + * void **[push_back](#push_back)** **(** [int](class_int) byte **)** + * void **[resize](#resize)** **(** [int](class_int) idx **)** + * void **[set](#set)** **(** [int](class_int) idx, [int](class_int) byte **)** + * [int](class_int) **[size](#size)** **(** **)** + * void **[RawArray](#RawArray)** **(** [Array](class_array) from **)** ### Description Raw byte array. Contains bytes. Optimized for memory usage, cant fragment the memory. diff --git a/class_raycast.md b/class_raycast.md index 9c162e1..ca32635 100644 --- a/class_raycast.md +++ b/class_raycast.md @@ -6,14 +6,14 @@ ### Member Functions - * void **[`set_enabled`](#set_enabled)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`is_enabled`](#is_enabled)** **(** **)** const - * void **[`set_cast_to`](#set_cast_to)** **(** [Vector3](class_vector3) local_point **)** - * [Vector3](class_vector3) **[`get_cast_to`](#get_cast_to)** **(** **)** const - * [bool](class_bool) **[`is_colliding`](#is_colliding)** **(** **)** const - * [Object](class_object) **[`get_collider`](#get_collider)** **(** **)** const - * [int](class_int) **[`get_collider_shape`](#get_collider_shape)** **(** **)** const - * [Vector3](class_vector3) **[`get_collision_point`](#get_collision_point)** **(** **)** const - * [Vector3](class_vector3) **[`get_collision_normal`](#get_collision_normal)** **(** **)** const + * void **[set_enabled](#set_enabled)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[is_enabled](#is_enabled)** **(** **)** const + * void **[set_cast_to](#set_cast_to)** **(** [Vector3](class_vector3) local_point **)** + * [Vector3](class_vector3) **[get_cast_to](#get_cast_to)** **(** **)** const + * [bool](class_bool) **[is_colliding](#is_colliding)** **(** **)** const + * [Object](class_object) **[get_collider](#get_collider)** **(** **)** const + * [int](class_int) **[get_collider_shape](#get_collider_shape)** **(** **)** const + * [Vector3](class_vector3) **[get_collision_point](#get_collision_point)** **(** **)** const + * [Vector3](class_vector3) **[get_collision_normal](#get_collision_normal)** **(** **)** const ### Member Function Description diff --git a/class_raycast2d.md b/class_raycast2d.md index 19fbbc2..e6ad704 100644 --- a/class_raycast2d.md +++ b/class_raycast2d.md @@ -6,14 +6,14 @@ ### Member Functions - * void **[`set_enabled`](#set_enabled)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`is_enabled`](#is_enabled)** **(** **)** const - * void **[`set_cast_to`](#set_cast_to)** **(** [Vector2](class_vector2) local_point **)** - * [Vector2](class_vector2) **[`get_cast_to`](#get_cast_to)** **(** **)** const - * [bool](class_bool) **[`is_colliding`](#is_colliding)** **(** **)** const - * [Object](class_object) **[`get_collider`](#get_collider)** **(** **)** const - * [int](class_int) **[`get_collider_shape`](#get_collider_shape)** **(** **)** const - * [Vector2](class_vector2) **[`get_collision_point`](#get_collision_point)** **(** **)** const - * [Vector2](class_vector2) **[`get_collision_normal`](#get_collision_normal)** **(** **)** const + * void **[set_enabled](#set_enabled)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[is_enabled](#is_enabled)** **(** **)** const + * void **[set_cast_to](#set_cast_to)** **(** [Vector2](class_vector2) local_point **)** + * [Vector2](class_vector2) **[get_cast_to](#get_cast_to)** **(** **)** const + * [bool](class_bool) **[is_colliding](#is_colliding)** **(** **)** const + * [Object](class_object) **[get_collider](#get_collider)** **(** **)** const + * [int](class_int) **[get_collider_shape](#get_collider_shape)** **(** **)** const + * [Vector2](class_vector2) **[get_collision_point](#get_collision_point)** **(** **)** const + * [Vector2](class_vector2) **[get_collision_normal](#get_collision_normal)** **(** **)** const ### Member Function Description diff --git a/class_rayshape.md b/class_rayshape.md index 12c8e6c..9e75159 100644 --- a/class_rayshape.md +++ b/class_rayshape.md @@ -6,7 +6,7 @@ ### Member Functions - * void **[`set_length`](#set_length)** **(** [real](class_real) length **)** - * [real](class_real) **[`get_length`](#get_length)** **(** **)** const + * void **[set_length](#set_length)** **(** [real](class_real) length **)** + * [real](class_real) **[get_length](#get_length)** **(** **)** const ### Member Function Description diff --git a/class_rayshape2d.md b/class_rayshape2d.md index 50d8842..298c85c 100644 --- a/class_rayshape2d.md +++ b/class_rayshape2d.md @@ -6,8 +6,8 @@ Ray 2D shape resource for physics. ### Member Functions - * void **[`set_length`](#set_length)** **(** [real](class_real) length **)** - * [real](class_real) **[`get_length`](#get_length)** **(** **)** const + * void **[set_length](#set_length)** **(** [real](class_real) length **)** + * [real](class_real) **[get_length](#get_length)** **(** **)** const ### Description Ray 2D shape resource for physics. A ray is not really a collision body, isntead it tries to separate itself from wathever is touching it's far endpoint. It's often useful for ccharacters. diff --git a/class_real.md b/class_real.md index e2ef9b2..2375cd5 100644 --- a/class_real.md +++ b/class_real.md @@ -5,9 +5,9 @@ Real (float) built-in type. ### Member Functions - * void **[`real`](#real)** **(** [bool](class_bool) from **)** - * void **[`real`](#real)** **(** [int](class_int) from **)** - * void **[`real`](#real)** **(** [String](class_string) from **)** + * void **[real](#real)** **(** [bool](class_bool) from **)** + * void **[real](#real)** **(** [int](class_int) from **)** + * void **[real](#real)** **(** [String](class_string) from **)** ### Description Real (float) built-in type. diff --git a/class_realarray.md b/class_realarray.md index 8a5a7c9..6baa0a3 100644 --- a/class_realarray.md +++ b/class_realarray.md @@ -5,12 +5,12 @@ Real Array . ### Member Functions - * [real](class_real) **[`get`](#get)** **(** [int](class_int) idx **)** - * void **[`push_back`](#push_back)** **(** [real](class_real) value **)** - * void **[`resize`](#resize)** **(** [int](class_int) idx **)** - * void **[`set`](#set)** **(** [int](class_int) idx, [real](class_real) value **)** - * [int](class_int) **[`size`](#size)** **(** **)** - * void **[`RealArray`](#RealArray)** **(** [Array](class_array) from **)** + * [real](class_real) **[get](#get)** **(** [int](class_int) idx **)** + * void **[push_back](#push_back)** **(** [real](class_real) value **)** + * void **[resize](#resize)** **(** [int](class_int) idx **)** + * void **[set](#set)** **(** [int](class_int) idx, [real](class_real) value **)** + * [int](class_int) **[size](#size)** **(** **)** + * void **[RealArray](#RealArray)** **(** [Array](class_array) from **)** ### Description Real Array. Array of floating point values. Can only contain floats. Optimized for memory usage, cant fragment the memory. diff --git a/class_rect2.md b/class_rect2.md index 6c4bb83..f0691d5 100644 --- a/class_rect2.md +++ b/class_rect2.md @@ -5,17 +5,17 @@ ### Member Functions - * [Rect2](class_rect2) **[`clip`](#clip)** **(** [Rect2](class_rect2) b **)** - * [bool](class_bool) **[`encloses`](#encloses)** **(** [Rect2](class_rect2) b **)** - * [Rect2](class_rect2) **[`expand`](#expand)** **(** [Vector2](class_vector2) to **)** - * [real](class_real) **[`get_area`](#get_area)** **(** **)** - * [Rect2](class_rect2) **[`grow`](#grow)** **(** [real](class_real) by **)** - * [bool](class_bool) **[`has_no_area`](#has_no_area)** **(** **)** - * [bool](class_bool) **[`has_point`](#has_point)** **(** [Vector2](class_vector2) point **)** - * [bool](class_bool) **[`intersects`](#intersects)** **(** [Rect2](class_rect2) b **)** - * [Rect2](class_rect2) **[`merge`](#merge)** **(** [Rect2](class_rect2) b **)** - * void **[`Rect2`](#Rect2)** **(** [Vector2](class_vector2) pos, [Vector2](class_vector2) size **)** - * void **[`Rect2`](#Rect2)** **(** [real](class_real) x, [real](class_real) y, [real](class_real) width, [real](class_real) height **)** + * [Rect2](class_rect2) **[clip](#clip)** **(** [Rect2](class_rect2) b **)** + * [bool](class_bool) **[encloses](#encloses)** **(** [Rect2](class_rect2) b **)** + * [Rect2](class_rect2) **[expand](#expand)** **(** [Vector2](class_vector2) to **)** + * [real](class_real) **[get_area](#get_area)** **(** **)** + * [Rect2](class_rect2) **[grow](#grow)** **(** [real](class_real) by **)** + * [bool](class_bool) **[has_no_area](#has_no_area)** **(** **)** + * [bool](class_bool) **[has_point](#has_point)** **(** [Vector2](class_vector2) point **)** + * [bool](class_bool) **[intersects](#intersects)** **(** [Rect2](class_rect2) b **)** + * [Rect2](class_rect2) **[merge](#merge)** **(** [Rect2](class_rect2) b **)** + * void **[Rect2](#Rect2)** **(** [Vector2](class_vector2) pos, [Vector2](class_vector2) size **)** + * void **[Rect2](#Rect2)** **(** [real](class_real) x, [real](class_real) y, [real](class_real) width, [real](class_real) height **)** ### Member Variables * [Vector2](class_vector2) **pos** diff --git a/class_rectangleshape2d.md b/class_rectangleshape2d.md index 3d87877..31f968c 100644 --- a/class_rectangleshape2d.md +++ b/class_rectangleshape2d.md @@ -6,8 +6,8 @@ Rectangle Shape for 2D Physics. ### Member Functions - * void **[`set_extents`](#set_extents)** **(** [Vector2](class_vector2) extents **)** - * [Vector2](class_vector2) **[`get_extents`](#get_extents)** **(** **)** const + * void **[set_extents](#set_extents)** **(** [Vector2](class_vector2) extents **)** + * [Vector2](class_vector2) **[get_extents](#get_extents)** **(** **)** const ### Description Rectangle Shape for 2D Physics. This shape is useful for modelling box-like 2D objects. @@ -15,11 +15,11 @@ Rectangle Shape for 2D Physics. This shape is useful for modelling box-like 2D o ### Member Function Description #### set_extents - * void **`set_extents`** **(** [Vector2](class_vector2) extents **)** + * void **set_extents** **(** [Vector2](class_vector2) extents **)** Set the half extents, the actual width and height of this shape is twice the half extents. #### get_extents - * [Vector2](class_vector2) **`get_extents`** **(** **)** const + * [Vector2](class_vector2) **get_extents** **(** **)** const Return the half extents, the actual width and height of this shape is twice the half extents. diff --git a/class_reference.md b/class_reference.md index e60f062..9f7e18e 100644 --- a/class_reference.md +++ b/class_reference.md @@ -6,9 +6,9 @@ Base class for anything refcounted. ### Member Functions - * [bool](class_bool) **[`init_ref`](#init_ref)** **(** **)** - * void **[`reference`](#reference)** **(** **)** - * [bool](class_bool) **[`unreference`](#unreference)** **(** **)** + * [bool](class_bool) **[init_ref](#init_ref)** **(** **)** + * void **[reference](#reference)** **(** **)** + * [bool](class_bool) **[unreference](#unreference)** **(** **)** ### Description Base class for anything refcounted. Resource and many other helper objects inherit this. References keep an internal reference counter so they are only released when no longer in use. @@ -16,11 +16,11 @@ Base class for anything refcounted. Resource and many other helper objects inher ### Member Function Description #### reference - * void **`reference`** **(** **)** + * void **reference** **(** **)** Increase the internal reference counter. Use this only if you really know what you are doing. #### unreference - * [bool](class_bool) **`unreference`** **(** **)** + * [bool](class_bool) **unreference** **(** **)** Decrease the internal reference counter. Use this only if you really know what you are doing. diff --git a/class_regex.md b/class_regex.md index 5ab9f60..0d76fe7 100644 --- a/class_regex.md +++ b/class_regex.md @@ -6,8 +6,8 @@ ### Member Functions - * [int](class_int) **[`compile`](#compile)** **(** [String](class_string) pattern **)** - * [int](class_int) **[`find`](#find)** **(** [String](class_string) text, [int](class_int) start=0, [int](class_int) end=-1 **)** const - * [StringArray](class_stringarray) **[`get_captures`](#get_captures)** **(** **)** const + * [int](class_int) **[compile](#compile)** **(** [String](class_string) pattern **)** + * [int](class_int) **[find](#find)** **(** [String](class_string) text, [int](class_int) start=0, [int](class_int) end=-1 **)** const + * [StringArray](class_stringarray) **[get_captures](#get_captures)** **(** **)** const ### Member Function Description diff --git a/class_remotetransform2d.md b/class_remotetransform2d.md index cc69ae9..b0cb0ce 100644 --- a/class_remotetransform2d.md +++ b/class_remotetransform2d.md @@ -6,7 +6,7 @@ ### Member Functions - * void **[`set_remote_node`](#set_remote_node)** **(** [NodePath](class_nodepath) path **)** - * [NodePath](class_nodepath) **[`get_remote_node`](#get_remote_node)** **(** **)** const + * void **[set_remote_node](#set_remote_node)** **(** [NodePath](class_nodepath) path **)** + * [NodePath](class_nodepath) **[get_remote_node](#get_remote_node)** **(** **)** const ### Member Function Description diff --git a/class_resource.md b/class_resource.md index 0cba96f..d3d95e7 100644 --- a/class_resource.md +++ b/class_resource.md @@ -6,17 +6,17 @@ Base class for all resources. ### Member Functions - * void **[`set_path`](#set_path)** **(** [String](class_string) path **)** - * [String](class_string) **[`get_path`](#get_path)** **(** **)** const - * void **[`set_name`](#set_name)** **(** [String](class_string) name **)** - * [String](class_string) **[`get_name`](#get_name)** **(** **)** const - * [RID](class_rid) **[`get_rid`](#get_rid)** **(** **)** const - * void **[`set_import_metadata`](#set_import_metadata)** **(** [Object](class_object) metadata **)** - * [Object](class_object) **[`get_import_metadata`](#get_import_metadata)** **(** **)** const - * [Object](class_object) **[`duplicate`](#duplicate)** **(** [bool](class_bool) arg0=false **)** + * void **[set_path](#set_path)** **(** [String](class_string) path **)** + * [String](class_string) **[get_path](#get_path)** **(** **)** const + * void **[set_name](#set_name)** **(** [String](class_string) name **)** + * [String](class_string) **[get_name](#get_name)** **(** **)** const + * [RID](class_rid) **[get_rid](#get_rid)** **(** **)** const + * void **[set_import_metadata](#set_import_metadata)** **(** [Object](class_object) metadata **)** + * [Object](class_object) **[get_import_metadata](#get_import_metadata)** **(** **)** const + * [Object](class_object) **[duplicate](#duplicate)** **(** [bool](class_bool) arg0=false **)** ### Signals - * **`changed`** **(** **)** + * **changed** **(** **)** ### Description Resource is the base class for all resource types. Resources are primarily data containers. They are reference counted and freed when no longer in use. They are also loaded only once from disk, and further attempts to load the resource will return the same reference (all this in contrast to a [Node](class_node), which is not reference counted and can be instanced from disk as many times as desred). Resources can be saved externally on disk or bundled into another object, such as a [Node](class_node) or another resource. @@ -24,26 +24,26 @@ Resource is the base class for all resource types. Resources are primarily data ### Member Function Description #### set_path - * void **`set_path`** **(** [String](class_string) path **)** + * void **set_path** **(** [String](class_string) path **)** Set the path of the resource. This is useful mainly for editors when saving/loading, and shouldn"apos;t be changed by anything else. #### get_path - * [String](class_string) **`get_path`** **(** **)** const + * [String](class_string) **get_path** **(** **)** const Return the path of the resource. This is useful mainly for editors when saving/loading, and shouldn"apos;t be changed by anything else. #### set_name - * void **`set_name`** **(** [String](class_string) name **)** + * void **set_name** **(** [String](class_string) name **)** Set the name of the resources, any name is ok (it doesn"apos;t have to be unique). Name is for descriptive purposes only. #### get_name - * [String](class_string) **`get_name`** **(** **)** const + * [String](class_string) **get_name** **(** **)** const Return the name of the resources, any name is ok (it doesn"apos;t have to be unique). Name is for descriptive purposes only. #### get_rid - * [RID](class_rid) **`get_rid`** **(** **)** const + * [RID](class_rid) **get_rid** **(** **)** const Return the RID of the resource (or an empty RID). Many resources (such as [Texture](class_texture), [Mesh](class_mesh), etc) are high level abstractions of resources stored in a server, so this function will return the original RID. diff --git a/class_resourceimportmetadata.md b/class_resourceimportmetadata.md index b50f300..a5a99d7 100644 --- a/class_resourceimportmetadata.md +++ b/class_resourceimportmetadata.md @@ -6,15 +6,15 @@ ### Member Functions - * void **[`set_editor`](#set_editor)** **(** [String](class_string) name **)** - * [String](class_string) **[`get_editor`](#get_editor)** **(** **)** const - * void **[`add_source`](#add_source)** **(** [String](class_string) path, [String](class_string) md5 **)** - * [String](class_string) **[`get_source_path`](#get_source_path)** **(** [int](class_int) idx **)** const - * [String](class_string) **[`get_source_md5`](#get_source_md5)** **(** [int](class_int) idx **)** const - * void **[`remove_source`](#remove_source)** **(** [int](class_int) idx **)** - * [int](class_int) **[`get_source_count`](#get_source_count)** **(** **)** const - * void **[`set_option`](#set_option)** **(** [String](class_string) key, var value **)** - * void **[`get_option`](#get_option)** **(** [String](class_string) key **)** const - * [StringArray](class_stringarray) **[`get_options`](#get_options)** **(** **)** const + * void **[set_editor](#set_editor)** **(** [String](class_string) name **)** + * [String](class_string) **[get_editor](#get_editor)** **(** **)** const + * void **[add_source](#add_source)** **(** [String](class_string) path, [String](class_string) md5 **)** + * [String](class_string) **[get_source_path](#get_source_path)** **(** [int](class_int) idx **)** const + * [String](class_string) **[get_source_md5](#get_source_md5)** **(** [int](class_int) idx **)** const + * void **[remove_source](#remove_source)** **(** [int](class_int) idx **)** + * [int](class_int) **[get_source_count](#get_source_count)** **(** **)** const + * void **[set_option](#set_option)** **(** [String](class_string) key, var value **)** + * void **[get_option](#get_option)** **(** [String](class_string) key **)** const + * [StringArray](class_stringarray) **[get_options](#get_options)** **(** **)** const ### Member Function Description diff --git a/class_resourceinteractiveloader.md b/class_resourceinteractiveloader.md index 372c56b..83adc2a 100644 --- a/class_resourceinteractiveloader.md +++ b/class_resourceinteractiveloader.md @@ -6,11 +6,11 @@ Interactive Resource Loader. ### Member Functions - * [Object](class_object) **[`get_resource`](#get_resource)** **(** **)** - * [int](class_int) **[`poll`](#poll)** **(** **)** - * [int](class_int) **[`wait`](#wait)** **(** **)** - * [int](class_int) **[`get_stage`](#get_stage)** **(** **)** const - * [int](class_int) **[`get_stage_count`](#get_stage_count)** **(** **)** const + * [Object](class_object) **[get_resource](#get_resource)** **(** **)** + * [int](class_int) **[poll](#poll)** **(** **)** + * [int](class_int) **[wait](#wait)** **(** **)** + * [int](class_int) **[get_stage](#get_stage)** **(** **)** const + * [int](class_int) **[get_stage_count](#get_stage_count)** **(** **)** const ### Description Interactive Resource Loader. This object is returned by ResourceLoader when performing an interactive load. It allows to load with high granularity, so this is mainly useful for displaying load bars/percentages. @@ -18,21 +18,21 @@ Interactive Resource Loader. This object is returned by ResourceLoader when perf ### Member Function Description #### get_resource - * [Object](class_object) **`get_resource`** **(** **)** + * [Object](class_object) **get_resource** **(** **)** Return the loaded resource (only if loaded). Otherwise, returns null. #### poll - * [int](class_int) **`poll`** **(** **)** + * [int](class_int) **poll** **(** **)** Poll the load. If OK is returned, this means poll will have to be called again. If ERR_EOF is returned, them the load has finished and the resource can be obtained by calling [get_resource]. #### get_stage - * [int](class_int) **`get_stage`** **(** **)** const + * [int](class_int) **get_stage** **(** **)** const Return the load stage. The total amount of stages can be queried with [get_stage_count] #### get_stage_count - * [int](class_int) **`get_stage_count`** **(** **)** const + * [int](class_int) **get_stage_count** **(** **)** const Return the total amount of stages (calls to [poll] ) needed to completely load this resource. diff --git a/class_resourceloader.md b/class_resourceloader.md index 58d7f0d..5576c78 100644 --- a/class_resourceloader.md +++ b/class_resourceloader.md @@ -6,12 +6,12 @@ Resource Loader. ### Member Functions - * [ResourceInteractiveLoader](class_resourceinteractiveloader) **[`load_interactive`](#load_interactive)** **(** [String](class_string) path, [String](class_string) type_hint="" **)** - * [Resource](class_resource) **[`load`](#load)** **(** [String](class_string) path, [String](class_string) type_hint="" **)** - * [StringArray](class_stringarray) **[`get_recognized_extensions_for_type`](#get_recognized_extensions_for_type)** **(** [String](class_string) type **)** - * void **[`set_abort_on_missing_resources`](#set_abort_on_missing_resources)** **(** [bool](class_bool) abort **)** - * [StringArray](class_stringarray) **[`get_dependencies`](#get_dependencies)** **(** [String](class_string) arg0 **)** - * [bool](class_bool) **[`has`](#has)** **(** [String](class_string) arg0 **)** + * [ResourceInteractiveLoader](class_resourceinteractiveloader) **[load_interactive](#load_interactive)** **(** [String](class_string) path, [String](class_string) type_hint="" **)** + * [Resource](class_resource) **[load](#load)** **(** [String](class_string) path, [String](class_string) type_hint="" **)** + * [StringArray](class_stringarray) **[get_recognized_extensions_for_type](#get_recognized_extensions_for_type)** **(** [String](class_string) type **)** + * void **[set_abort_on_missing_resources](#set_abort_on_missing_resources)** **(** [bool](class_bool) abort **)** + * [StringArray](class_stringarray) **[get_dependencies](#get_dependencies)** **(** [String](class_string) arg0 **)** + * [bool](class_bool) **[has](#has)** **(** [String](class_string) arg0 **)** ### Description Resource Loader. This is a static object accessible as [ResourceLoader](class_resourceloader). GDScript has a simplified load() function, though. @@ -19,21 +19,21 @@ Resource Loader. This is a static object accessible as [ResourceLoader](class_re ### Member Function Description #### load_interactive - * [ResourceInteractiveLoader](class_resourceinteractiveloader) **`load_interactive`** **(** [String](class_string) path, [String](class_string) type_hint="" **)** + * [ResourceInteractiveLoader](class_resourceinteractiveloader) **load_interactive** **(** [String](class_string) path, [String](class_string) type_hint="" **)** Load a resource interactively, the returned object allows to load with high granularity. #### load - * [Resource](class_resource) **`load`** **(** [String](class_string) path, [String](class_string) type_hint="" **)** + * [Resource](class_resource) **load** **(** [String](class_string) path, [String](class_string) type_hint="" **)** Load a resource. Optionally a hint can be given for the resource type to load. #### get_recognized_extensions_for_type - * [StringArray](class_stringarray) **`get_recognized_extensions_for_type`** **(** [String](class_string) type **)** + * [StringArray](class_stringarray) **get_recognized_extensions_for_type** **(** [String](class_string) type **)** Return the list of recognized extensions for a resource type. #### set_abort_on_missing_resources - * void **`set_abort_on_missing_resources`** **(** [bool](class_bool) abort **)** + * void **set_abort_on_missing_resources** **(** [bool](class_bool) abort **)** Change the behavior on missing sub-resources. Default is to abort load. diff --git a/class_resourcepreloader.md b/class_resourcepreloader.md index bbc04e5..49cc782 100644 --- a/class_resourcepreloader.md +++ b/class_resourcepreloader.md @@ -6,12 +6,12 @@ Resource Preloader Node. ### Member Functions - * void **[`add_resource`](#add_resource)** **(** [String](class_string) name, [Object](class_object) resource **)** - * void **[`remove_resource`](#remove_resource)** **(** [String](class_string) name **)** - * void **[`rename_resource`](#rename_resource)** **(** [String](class_string) name, [String](class_string) newname **)** - * [bool](class_bool) **[`has_resource`](#has_resource)** **(** [String](class_string) name **)** const - * [Object](class_object) **[`get_resource`](#get_resource)** **(** [String](class_string) name **)** const - * [StringArray](class_stringarray) **[`get_resource_list`](#get_resource_list)** **(** **)** const + * void **[add_resource](#add_resource)** **(** [String](class_string) name, [Object](class_object) resource **)** + * void **[remove_resource](#remove_resource)** **(** [String](class_string) name **)** + * void **[rename_resource](#rename_resource)** **(** [String](class_string) name, [String](class_string) newname **)** + * [bool](class_bool) **[has_resource](#has_resource)** **(** [String](class_string) name **)** const + * [Object](class_object) **[get_resource](#get_resource)** **(** [String](class_string) name **)** const + * [StringArray](class_stringarray) **[get_resource_list](#get_resource_list)** **(** **)** const ### Description Resource Preloader Node. This node is used to preload sub-resources inside a scene, so when the scene is loaded all the resourcs are ready to use and be retrieved from here. @@ -19,31 +19,31 @@ Resource Preloader Node. This node is used to preload sub-resources inside a sce ### Member Function Description #### add_resource - * void **`add_resource`** **(** [String](class_string) name, [Object](class_object) resource **)** + * void **add_resource** **(** [String](class_string) name, [Object](class_object) resource **)** Add a resource to the preloader. Set the text-id that will be used to identify it (retrieve it/erase it/etc). #### remove_resource - * void **`remove_resource`** **(** [String](class_string) name **)** + * void **remove_resource** **(** [String](class_string) name **)** Remove a resource from the preloader by text id. #### rename_resource - * void **`rename_resource`** **(** [String](class_string) name, [String](class_string) newname **)** + * void **rename_resource** **(** [String](class_string) name, [String](class_string) newname **)** Rename a resource inside the preloader, from a text-id to a new text-id. #### has_resource - * [bool](class_bool) **`has_resource`** **(** [String](class_string) name **)** const + * [bool](class_bool) **has_resource** **(** [String](class_string) name **)** const Return true if the preloader has a given resource. #### get_resource - * [Object](class_object) **`get_resource`** **(** [String](class_string) name **)** const + * [Object](class_object) **get_resource** **(** [String](class_string) name **)** const Return the resource given a text-id. #### get_resource_list - * [StringArray](class_stringarray) **`get_resource_list`** **(** **)** const + * [StringArray](class_stringarray) **get_resource_list** **(** **)** const Return the list of resources inside the preloader. diff --git a/class_resourcesaver.md b/class_resourcesaver.md index 5d0d1b1..43a1b74 100644 --- a/class_resourcesaver.md +++ b/class_resourcesaver.md @@ -6,8 +6,8 @@ Resource Saving Interface. ### Member Functions - * [int](class_int) **[`save`](#save)** **(** [String](class_string) path, [Resource](class_resource) resource, [int](class_int) arg2=0 **)** - * [StringArray](class_stringarray) **[`get_recognized_extensions`](#get_recognized_extensions)** **(** [Object](class_object) type **)** + * [int](class_int) **[save](#save)** **(** [String](class_string) path, [Resource](class_resource) resource, [int](class_int) arg2=0 **)** + * [StringArray](class_stringarray) **[get_recognized_extensions](#get_recognized_extensions)** **(** [Object](class_object) type **)** ### Description Resource Saving Interface. This interface is used for saving resources to disk. @@ -15,11 +15,11 @@ Resource Saving Interface. This interface is used for saving resources to disk. ### Member Function Description #### save - * [int](class_int) **`save`** **(** [String](class_string) path, [Resource](class_resource) resource, [int](class_int) arg2=0 **)** + * [int](class_int) **save** **(** [String](class_string) path, [Resource](class_resource) resource, [int](class_int) arg2=0 **)** Save a resource to disk, to a given path. #### get_recognized_extensions - * [StringArray](class_stringarray) **`get_recognized_extensions`** **(** [Object](class_object) type **)** + * [StringArray](class_stringarray) **get_recognized_extensions** **(** [Object](class_object) type **)** Return the list of extensions available for saving a resource of a given type. diff --git a/class_richtextlabel.md b/class_richtextlabel.md index b6cf4e8..13a3851 100644 --- a/class_richtextlabel.md +++ b/class_richtextlabel.md @@ -6,31 +6,31 @@ Label that displays rich text. ### Member Functions - * void **[`add_text`](#add_text)** **(** [String](class_string) text **)** - * void **[`add_image`](#add_image)** **(** [Texture](class_texture) image **)** - * void **[`newline`](#newline)** **(** **)** - * void **[`push_font`](#push_font)** **(** [Object](class_object) font **)** - * void **[`push_color`](#push_color)** **(** [Color](class_color) color **)** - * void **[`push_align`](#push_align)** **(** [int](class_int) align **)** - * void **[`push_indent`](#push_indent)** **(** [int](class_int) level **)** - * void **[`push_list`](#push_list)** **(** [int](class_int) type **)** - * void **[`push_meta`](#push_meta)** **(** var data **)** - * void **[`push_underline`](#push_underline)** **(** **)** - * void **[`pop`](#pop)** **(** **)** - * void **[`clear`](#clear)** **(** **)** - * void **[`set_meta_underline`](#set_meta_underline)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_meta_underlined`](#is_meta_underlined)** **(** **)** const - * void **[`set_scroll_active`](#set_scroll_active)** **(** [bool](class_bool) active **)** - * [bool](class_bool) **[`is_scroll_active`](#is_scroll_active)** **(** **)** const - * void **[`set_scroll_follow`](#set_scroll_follow)** **(** [bool](class_bool) follow **)** - * [bool](class_bool) **[`is_scroll_following`](#is_scroll_following)** **(** **)** const - * void **[`set_tab_size`](#set_tab_size)** **(** [int](class_int) spaces **)** - * [int](class_int) **[`get_tab_size`](#get_tab_size)** **(** **)** const - * void **[`set_selection_enabled`](#set_selection_enabled)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`is_selection_enabled`](#is_selection_enabled)** **(** **)** const + * void **[add_text](#add_text)** **(** [String](class_string) text **)** + * void **[add_image](#add_image)** **(** [Texture](class_texture) image **)** + * void **[newline](#newline)** **(** **)** + * void **[push_font](#push_font)** **(** [Object](class_object) font **)** + * void **[push_color](#push_color)** **(** [Color](class_color) color **)** + * void **[push_align](#push_align)** **(** [int](class_int) align **)** + * void **[push_indent](#push_indent)** **(** [int](class_int) level **)** + * void **[push_list](#push_list)** **(** [int](class_int) type **)** + * void **[push_meta](#push_meta)** **(** var data **)** + * void **[push_underline](#push_underline)** **(** **)** + * void **[pop](#pop)** **(** **)** + * void **[clear](#clear)** **(** **)** + * void **[set_meta_underline](#set_meta_underline)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_meta_underlined](#is_meta_underlined)** **(** **)** const + * void **[set_scroll_active](#set_scroll_active)** **(** [bool](class_bool) active **)** + * [bool](class_bool) **[is_scroll_active](#is_scroll_active)** **(** **)** const + * void **[set_scroll_follow](#set_scroll_follow)** **(** [bool](class_bool) follow **)** + * [bool](class_bool) **[is_scroll_following](#is_scroll_following)** **(** **)** const + * void **[set_tab_size](#set_tab_size)** **(** [int](class_int) spaces **)** + * [int](class_int) **[get_tab_size](#get_tab_size)** **(** **)** const + * void **[set_selection_enabled](#set_selection_enabled)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[is_selection_enabled](#is_selection_enabled)** **(** **)** const ### Signals - * **`meta_clicked`** **(** [Nil](class_nil) meta **)** + * **meta_clicked** **(** [Nil](class_nil) meta **)** ### Numeric Constants * **ALIGN_LEFT** = **0** @@ -58,11 +58,11 @@ Label that displays rich text. Rich text can contain custom text, fonts, images ### Member Function Description #### set_selection_enabled - * void **`set_selection_enabled`** **(** [bool](class_bool) enabled **)** + * void **set_selection_enabled** **(** [bool](class_bool) enabled **)** Set to true if selecting the text inside this richtext is allowed. #### is_selection_enabled - * [bool](class_bool) **`is_selection_enabled`** **(** **)** const + * [bool](class_bool) **is_selection_enabled** **(** **)** const Return true if selecting the text inside this richtext is allowed. diff --git a/class_rid.md b/class_rid.md index 85df583..c15c3d7 100644 --- a/class_rid.md +++ b/class_rid.md @@ -5,7 +5,7 @@ ### Member Functions - * [int](class_int) **[`get_id`](#get_id)** **(** **)** - * void **[`RID`](#RID)** **(** [Object](class_object) from **)** + * [int](class_int) **[get_id](#get_id)** **(** **)** + * void **[RID](#RID)** **(** [Object](class_object) from **)** ### Member Function Description diff --git a/class_rigidbody.md b/class_rigidbody.md index a02d0b6..07d849a 100644 --- a/class_rigidbody.md +++ b/class_rigidbody.md @@ -6,41 +6,41 @@ ### Member Functions - * void **[`_integrate_forces`](#_integrate_forces)** **(** [PhysicsDirectBodyState](class_physicsdirectbodystate) state **)** virtual - * void **[`set_mode`](#set_mode)** **(** [int](class_int) mode **)** - * [int](class_int) **[`get_mode`](#get_mode)** **(** **)** const - * void **[`set_mass`](#set_mass)** **(** [real](class_real) mass **)** - * [real](class_real) **[`get_mass`](#get_mass)** **(** **)** const - * void **[`set_weight`](#set_weight)** **(** [real](class_real) weight **)** - * [real](class_real) **[`get_weight`](#get_weight)** **(** **)** const - * void **[`set_friction`](#set_friction)** **(** [real](class_real) friction **)** - * [real](class_real) **[`get_friction`](#get_friction)** **(** **)** const - * void **[`set_bounce`](#set_bounce)** **(** [real](class_real) bounce **)** - * [real](class_real) **[`get_bounce`](#get_bounce)** **(** **)** const - * void **[`set_linear_velocity`](#set_linear_velocity)** **(** [Vector3](class_vector3) linear_velocity **)** - * [Vector3](class_vector3) **[`get_linear_velocity`](#get_linear_velocity)** **(** **)** const - * void **[`set_angular_velocity`](#set_angular_velocity)** **(** [Vector3](class_vector3) angular_velocity **)** - * [Vector3](class_vector3) **[`get_angular_velocity`](#get_angular_velocity)** **(** **)** const - * void **[`set_max_contacts_reported`](#set_max_contacts_reported)** **(** [int](class_int) amount **)** - * [int](class_int) **[`get_max_contacts_reported`](#get_max_contacts_reported)** **(** **)** const - * void **[`set_use_custom_integrator`](#set_use_custom_integrator)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_using_custom_integrator`](#is_using_custom_integrator)** **(** **)** - * void **[`set_contact_monitor`](#set_contact_monitor)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`is_contact_monitor_enabled`](#is_contact_monitor_enabled)** **(** **)** const - * void **[`set_use_continuous_collision_detection`](#set_use_continuous_collision_detection)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_using_continuous_collision_detection`](#is_using_continuous_collision_detection)** **(** **)** const - * void **[`set_axis_velocity`](#set_axis_velocity)** **(** [Vector3](class_vector3) axis_velocity **)** - * void **[`apply_impulse`](#apply_impulse)** **(** [Vector3](class_vector3) pos, [Vector3](class_vector3) impulse **)** - * void **[`set_active`](#set_active)** **(** [bool](class_bool) active **)** - * [bool](class_bool) **[`is_active`](#is_active)** **(** **)** const - * void **[`set_can_sleep`](#set_can_sleep)** **(** [bool](class_bool) able_to_sleep **)** - * [bool](class_bool) **[`is_able_to_sleep`](#is_able_to_sleep)** **(** **)** const + * void **[_integrate_forces](#_integrate_forces)** **(** [PhysicsDirectBodyState](class_physicsdirectbodystate) state **)** virtual + * void **[set_mode](#set_mode)** **(** [int](class_int) mode **)** + * [int](class_int) **[get_mode](#get_mode)** **(** **)** const + * void **[set_mass](#set_mass)** **(** [real](class_real) mass **)** + * [real](class_real) **[get_mass](#get_mass)** **(** **)** const + * void **[set_weight](#set_weight)** **(** [real](class_real) weight **)** + * [real](class_real) **[get_weight](#get_weight)** **(** **)** const + * void **[set_friction](#set_friction)** **(** [real](class_real) friction **)** + * [real](class_real) **[get_friction](#get_friction)** **(** **)** const + * void **[set_bounce](#set_bounce)** **(** [real](class_real) bounce **)** + * [real](class_real) **[get_bounce](#get_bounce)** **(** **)** const + * void **[set_linear_velocity](#set_linear_velocity)** **(** [Vector3](class_vector3) linear_velocity **)** + * [Vector3](class_vector3) **[get_linear_velocity](#get_linear_velocity)** **(** **)** const + * void **[set_angular_velocity](#set_angular_velocity)** **(** [Vector3](class_vector3) angular_velocity **)** + * [Vector3](class_vector3) **[get_angular_velocity](#get_angular_velocity)** **(** **)** const + * void **[set_max_contacts_reported](#set_max_contacts_reported)** **(** [int](class_int) amount **)** + * [int](class_int) **[get_max_contacts_reported](#get_max_contacts_reported)** **(** **)** const + * void **[set_use_custom_integrator](#set_use_custom_integrator)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_using_custom_integrator](#is_using_custom_integrator)** **(** **)** + * void **[set_contact_monitor](#set_contact_monitor)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[is_contact_monitor_enabled](#is_contact_monitor_enabled)** **(** **)** const + * void **[set_use_continuous_collision_detection](#set_use_continuous_collision_detection)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_using_continuous_collision_detection](#is_using_continuous_collision_detection)** **(** **)** const + * void **[set_axis_velocity](#set_axis_velocity)** **(** [Vector3](class_vector3) axis_velocity **)** + * void **[apply_impulse](#apply_impulse)** **(** [Vector3](class_vector3) pos, [Vector3](class_vector3) impulse **)** + * void **[set_active](#set_active)** **(** [bool](class_bool) active **)** + * [bool](class_bool) **[is_active](#is_active)** **(** **)** const + * void **[set_can_sleep](#set_can_sleep)** **(** [bool](class_bool) able_to_sleep **)** + * [bool](class_bool) **[is_able_to_sleep](#is_able_to_sleep)** **(** **)** const ### Signals - * **`body_enter`** **(** [Object](class_object) body **)** - * **`body_enter_shape`** **(** [int](class_int) body_id, [Object](class_object) body, [int](class_int) body_shape, [int](class_int) local_shape **)** - * **`body_exit`** **(** [Object](class_object) body **)** - * **`body_exit_shape`** **(** [int](class_int) body_id, [Object](class_object) body, [int](class_int) body_shape, [int](class_int) local_shape **)** + * **body_enter** **(** [Object](class_object) body **)** + * **body_enter_shape** **(** [int](class_int) body_id, [Object](class_object) body, [int](class_int) body_shape, [int](class_int) local_shape **)** + * **body_exit** **(** [Object](class_object) body **)** + * **body_exit_shape** **(** [int](class_int) body_id, [Object](class_object) body, [int](class_int) body_shape, [int](class_int) local_shape **)** ### Numeric Constants * **MODE_STATIC** = **1** diff --git a/class_rigidbody2d.md b/class_rigidbody2d.md index cc4dfbf..da084f6 100644 --- a/class_rigidbody2d.md +++ b/class_rigidbody2d.md @@ -6,43 +6,43 @@ Rigid body 2D node. ### Member Functions - * void **[`_integrate_forces`](#_integrate_forces)** **(** [Physics2DDirectBodyState](class_physics2ddirectbodystate) state **)** virtual - * void **[`set_mode`](#set_mode)** **(** [int](class_int) mode **)** - * [int](class_int) **[`get_mode`](#get_mode)** **(** **)** const - * void **[`set_mass`](#set_mass)** **(** [real](class_real) mass **)** - * [real](class_real) **[`get_mass`](#get_mass)** **(** **)** const - * void **[`set_weight`](#set_weight)** **(** [real](class_real) weight **)** - * [real](class_real) **[`get_weight`](#get_weight)** **(** **)** const - * void **[`set_friction`](#set_friction)** **(** [real](class_real) friction **)** - * [real](class_real) **[`get_friction`](#get_friction)** **(** **)** const - * void **[`set_bounce`](#set_bounce)** **(** [real](class_real) bounce **)** - * [real](class_real) **[`get_bounce`](#get_bounce)** **(** **)** const - * void **[`set_linear_velocity`](#set_linear_velocity)** **(** [Vector2](class_vector2) linear_velocity **)** - * [Vector2](class_vector2) **[`get_linear_velocity`](#get_linear_velocity)** **(** **)** const - * void **[`set_angular_velocity`](#set_angular_velocity)** **(** [real](class_real) angular_velocity **)** - * [real](class_real) **[`get_angular_velocity`](#get_angular_velocity)** **(** **)** const - * void **[`set_max_contacts_reported`](#set_max_contacts_reported)** **(** [int](class_int) amount **)** - * [int](class_int) **[`get_max_contacts_reported`](#get_max_contacts_reported)** **(** **)** const - * void **[`set_use_custom_integrator`](#set_use_custom_integrator)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_using_custom_integrator`](#is_using_custom_integrator)** **(** **)** - * void **[`set_contact_monitor`](#set_contact_monitor)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`is_contact_monitor_enabled`](#is_contact_monitor_enabled)** **(** **)** const - * void **[`set_use_continuous_collision_detection`](#set_use_continuous_collision_detection)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_using_continuous_collision_detection`](#is_using_continuous_collision_detection)** **(** **)** const - * void **[`set_axis_velocity`](#set_axis_velocity)** **(** [Vector2](class_vector2) axis_velocity **)** - * void **[`apply_impulse`](#apply_impulse)** **(** [Vector2](class_vector2) pos, [Vector2](class_vector2) impulse **)** - * void **[`set_applied_force`](#set_applied_force)** **(** [Vector2](class_vector2) force **)** - * [Vector2](class_vector2) **[`get_applied_force`](#get_applied_force)** **(** **)** const - * void **[`set_active`](#set_active)** **(** [bool](class_bool) active **)** - * [bool](class_bool) **[`is_active`](#is_active)** **(** **)** const - * void **[`set_can_sleep`](#set_can_sleep)** **(** [bool](class_bool) able_to_sleep **)** - * [bool](class_bool) **[`is_able_to_sleep`](#is_able_to_sleep)** **(** **)** const + * void **[_integrate_forces](#_integrate_forces)** **(** [Physics2DDirectBodyState](class_physics2ddirectbodystate) state **)** virtual + * void **[set_mode](#set_mode)** **(** [int](class_int) mode **)** + * [int](class_int) **[get_mode](#get_mode)** **(** **)** const + * void **[set_mass](#set_mass)** **(** [real](class_real) mass **)** + * [real](class_real) **[get_mass](#get_mass)** **(** **)** const + * void **[set_weight](#set_weight)** **(** [real](class_real) weight **)** + * [real](class_real) **[get_weight](#get_weight)** **(** **)** const + * void **[set_friction](#set_friction)** **(** [real](class_real) friction **)** + * [real](class_real) **[get_friction](#get_friction)** **(** **)** const + * void **[set_bounce](#set_bounce)** **(** [real](class_real) bounce **)** + * [real](class_real) **[get_bounce](#get_bounce)** **(** **)** const + * void **[set_linear_velocity](#set_linear_velocity)** **(** [Vector2](class_vector2) linear_velocity **)** + * [Vector2](class_vector2) **[get_linear_velocity](#get_linear_velocity)** **(** **)** const + * void **[set_angular_velocity](#set_angular_velocity)** **(** [real](class_real) angular_velocity **)** + * [real](class_real) **[get_angular_velocity](#get_angular_velocity)** **(** **)** const + * void **[set_max_contacts_reported](#set_max_contacts_reported)** **(** [int](class_int) amount **)** + * [int](class_int) **[get_max_contacts_reported](#get_max_contacts_reported)** **(** **)** const + * void **[set_use_custom_integrator](#set_use_custom_integrator)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_using_custom_integrator](#is_using_custom_integrator)** **(** **)** + * void **[set_contact_monitor](#set_contact_monitor)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[is_contact_monitor_enabled](#is_contact_monitor_enabled)** **(** **)** const + * void **[set_use_continuous_collision_detection](#set_use_continuous_collision_detection)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_using_continuous_collision_detection](#is_using_continuous_collision_detection)** **(** **)** const + * void **[set_axis_velocity](#set_axis_velocity)** **(** [Vector2](class_vector2) axis_velocity **)** + * void **[apply_impulse](#apply_impulse)** **(** [Vector2](class_vector2) pos, [Vector2](class_vector2) impulse **)** + * void **[set_applied_force](#set_applied_force)** **(** [Vector2](class_vector2) force **)** + * [Vector2](class_vector2) **[get_applied_force](#get_applied_force)** **(** **)** const + * void **[set_active](#set_active)** **(** [bool](class_bool) active **)** + * [bool](class_bool) **[is_active](#is_active)** **(** **)** const + * void **[set_can_sleep](#set_can_sleep)** **(** [bool](class_bool) able_to_sleep **)** + * [bool](class_bool) **[is_able_to_sleep](#is_able_to_sleep)** **(** **)** const ### Signals - * **`body_enter`** **(** [Object](class_object) body **)** - * **`body_enter_shape`** **(** [int](class_int) body_id, [Object](class_object) body, [int](class_int) body_shape, [int](class_int) local_shape **)** - * **`body_exit`** **(** [Object](class_object) body **)** - * **`body_exit_shape`** **(** [int](class_int) body_id, [Object](class_object) body, [int](class_int) body_shape, [int](class_int) local_shape **)** + * **body_enter** **(** [Object](class_object) body **)** + * **body_enter_shape** **(** [int](class_int) body_id, [Object](class_object) body, [int](class_int) body_shape, [int](class_int) local_shape **)** + * **body_exit** **(** [Object](class_object) body **)** + * **body_exit_shape** **(** [int](class_int) body_id, [Object](class_object) body, [int](class_int) body_shape, [int](class_int) local_shape **)** ### Numeric Constants * **MODE_STATIC** = **1** - Static mode (does not move, can't be moved). @@ -59,146 +59,146 @@ Rigid body 2D node. This node is used for placing rigid bodies in the scene. It ### Member Function Description #### _integrate_forces - * void **`_integrate_forces`** **(** [Physics2DDirectBodyState](class_physics2ddirectbodystate) state **)** virtual + * void **_integrate_forces** **(** [Physics2DDirectBodyState](class_physics2ddirectbodystate) state **)** virtual Override this function to use a custom force integrator. This allows to hook up to the physics processing and alter the simulation state for the object on every frame. #### set_mode - * void **`set_mode`** **(** [int](class_int) mode **)** + * void **set_mode** **(** [int](class_int) mode **)** Set the body mode, fromt he MODE_* enum. This allows to change to a static body or a character body. #### get_mode - * [int](class_int) **`get_mode`** **(** **)** const + * [int](class_int) **get_mode** **(** **)** const Return the current body mode, see [set_mode]. #### set_mass - * void **`set_mass`** **(** [real](class_real) mass **)** + * void **set_mass** **(** [real](class_real) mass **)** Set the body mass. #### get_mass - * [real](class_real) **`get_mass`** **(** **)** const + * [real](class_real) **get_mass** **(** **)** const Return the body mass. #### set_weight - * void **`set_weight`** **(** [real](class_real) weight **)** + * void **set_weight** **(** [real](class_real) weight **)** Set the body mass given standard earth-weight (gravity 9.8). Not really useful for 2D since most measuers for this node are in pixels. #### get_weight - * [real](class_real) **`get_weight`** **(** **)** const + * [real](class_real) **get_weight** **(** **)** const Return the body mass given standard earth-weight (gravity 9.8). #### set_friction - * void **`set_friction`** **(** [real](class_real) friction **)** + * void **set_friction** **(** [real](class_real) friction **)** Set the body friction, from 0 (friction less) to 1 (full friction). #### get_friction - * [real](class_real) **`get_friction`** **(** **)** const + * [real](class_real) **get_friction** **(** **)** const Return the body friction. #### set_bounce - * void **`set_bounce`** **(** [real](class_real) bounce **)** + * void **set_bounce** **(** [real](class_real) bounce **)** Set the body bounciness, from 0 (no bounce) to 1 (bounce). #### get_bounce - * [real](class_real) **`get_bounce`** **(** **)** const + * [real](class_real) **get_bounce** **(** **)** const Return the body bouncyness. #### set_linear_velocity - * void **`set_linear_velocity`** **(** [Vector2](class_vector2) linear_velocity **)** + * void **set_linear_velocity** **(** [Vector2](class_vector2) linear_velocity **)** Set the body linear velocity. Can be used sporadically, but** DONT SET THIS IN EVERY FRAME **, because physics may be running in another thread and definitely runs at a different granularity. Use [_integrate_forces] as your process loop if you want to have precise control of the body state. #### get_linear_velocity - * [Vector2](class_vector2) **`get_linear_velocity`** **(** **)** const + * [Vector2](class_vector2) **get_linear_velocity** **(** **)** const Return the body linear velocity. This changes by physics granularity. See [set_linear_velocity]. #### set_angular_velocity - * void **`set_angular_velocity`** **(** [real](class_real) angular_velocity **)** + * void **set_angular_velocity** **(** [real](class_real) angular_velocity **)** Set the body angular velocity. Can be used sporadically, but** DONT SET THIS IN EVERY FRAME **, because physics may be running in another thread and definitely runs at a different granularity. Use [_integrate_forces] as your process loop if you want to have precise control of the body state. #### get_angular_velocity - * [real](class_real) **`get_angular_velocity`** **(** **)** const + * [real](class_real) **get_angular_velocity** **(** **)** const Return the body angular velocity. This changes by physics granularity. See [set_angular_velocity]. #### set_max_contacts_reported - * void **`set_max_contacts_reported`** **(** [int](class_int) amount **)** + * void **set_max_contacts_reported** **(** [int](class_int) amount **)** Set the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. #### get_max_contacts_reported - * [int](class_int) **`get_max_contacts_reported`** **(** **)** const + * [int](class_int) **get_max_contacts_reported** **(** **)** const Return the maximum contacts that can be reported. See [set_max_contacts_reported]. #### set_use_custom_integrator - * void **`set_use_custom_integrator`** **(** [bool](class_bool) enable **)** + * void **set_use_custom_integrator** **(** [bool](class_bool) enable **)** Set to true if the body shall not do any internal force integration at all (like gravity or air friction). Only the [_integrate_forces] will be able to integrate them if overrided. #### is_using_custom_integrator - * [bool](class_bool) **`is_using_custom_integrator`** **(** **)** + * [bool](class_bool) **is_using_custom_integrator** **(** **)** Return true if the body is not doing any built-in force integration. #### set_contact_monitor - * void **`set_contact_monitor`** **(** [bool](class_bool) enabled **)** + * void **set_contact_monitor** **(** [bool](class_bool) enabled **)** Enable contact monitoring. (the signals to notify when a body entered/exited collision). #### is_contact_monitor_enabled - * [bool](class_bool) **`is_contact_monitor_enabled`** **(** **)** const + * [bool](class_bool) **is_contact_monitor_enabled** **(** **)** const Return wether contact monitoring is enabled. #### set_use_continuous_collision_detection - * void **`set_use_continuous_collision_detection`** **(** [bool](class_bool) enable **)** + * void **set_use_continuous_collision_detection** **(** [bool](class_bool) enable **)** Enable continuos collision detection. This prevents very fast-moving bodies (such as bullets) to not go through objects. #### is_using_continuous_collision_detection - * [bool](class_bool) **`is_using_continuous_collision_detection`** **(** **)** const + * [bool](class_bool) **is_using_continuous_collision_detection** **(** **)** const Return true if continuous collision detection is in use. #### set_axis_velocity - * void **`set_axis_velocity`** **(** [Vector2](class_vector2) axis_velocity **)** + * void **set_axis_velocity** **(** [Vector2](class_vector2) axis_velocity **)** Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. (This is useful for jumping behavior). #### apply_impulse - * void **`apply_impulse`** **(** [Vector2](class_vector2) pos, [Vector2](class_vector2) impulse **)** + * void **apply_impulse** **(** [Vector2](class_vector2) pos, [Vector2](class_vector2) impulse **)** Apply a positioned impulse (which will be affected by the body mass and shape). #### set_active - * void **`set_active`** **(** [bool](class_bool) active **)** + * void **set_active** **(** [bool](class_bool) active **)** Change the body state between sleeping/active states. As a note, static bodies can never be active. #### is_active - * [bool](class_bool) **`is_active`** **(** **)** const + * [bool](class_bool) **is_active** **(** **)** const Return the body state. As a note, static bodies are never active. #### set_can_sleep - * void **`set_can_sleep`** **(** [bool](class_bool) able_to_sleep **)** + * void **set_can_sleep** **(** [bool](class_bool) able_to_sleep **)** Set the body ability to fall asleep when not moving. This saves an enormous amount of processor time when there are plenty of rigid bodies (non static) in a scene. #### is_able_to_sleep - * [bool](class_bool) **`is_able_to_sleep`** **(** **)** const + * [bool](class_bool) **is_able_to_sleep** **(** **)** const Return true if the body has the ability to fall asleep when not moving. See [set_can_sleep]. diff --git a/class_room.md b/class_room.md index 4fcac03..8645636 100644 --- a/class_room.md +++ b/class_room.md @@ -6,11 +6,11 @@ Room data resource. ### Member Functions - * void **[`set_room`](#set_room)** **(** [Room](class_room) room **)** - * [Room](class_room) **[`get_room`](#get_room)** **(** **)** const - * void **[`compute_room_from_subtree`](#compute_room_from_subtree)** **(** **)** - * void **[`set_simulate_acoustics`](#set_simulate_acoustics)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_simulating_acoustics`](#is_simulating_acoustics)** **(** **)** const + * void **[set_room](#set_room)** **(** [Room](class_room) room **)** + * [Room](class_room) **[get_room](#get_room)** **(** **)** const + * void **[compute_room_from_subtree](#compute_room_from_subtree)** **(** **)** + * void **[set_simulate_acoustics](#set_simulate_acoustics)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_simulating_acoustics](#is_simulating_acoustics)** **(** **)** const ### Description Room contains the data to define the bounds of a scene (using a BSP Tree). It is instanced by a [RoomInstance] node to create rooms. See that class documentation for more information about rooms. diff --git a/class_roombounds.md b/class_roombounds.md index d8b277f..5cc05f6 100644 --- a/class_roombounds.md +++ b/class_roombounds.md @@ -6,11 +6,11 @@ ### Member Functions - * void **[`set_bounds`](#set_bounds)** **(** [Dictionary](class_dictionary) bsp_tree **)** - * [Dictionary](class_dictionary) **[`get_bounds`](#get_bounds)** **(** **)** const - * void **[`set_geometry_hint`](#set_geometry_hint)** **(** [Vector3Array](class_vector3array) triangles **)** - * [Vector3Array](class_vector3array) **[`get_geometry_hint`](#get_geometry_hint)** **(** **)** const - * void **[`regenerate_bsp`](#regenerate_bsp)** **(** **)** - * void **[`regenerate_bsp_cubic`](#regenerate_bsp_cubic)** **(** **)** + * void **[set_bounds](#set_bounds)** **(** [Dictionary](class_dictionary) bsp_tree **)** + * [Dictionary](class_dictionary) **[get_bounds](#get_bounds)** **(** **)** const + * void **[set_geometry_hint](#set_geometry_hint)** **(** [Vector3Array](class_vector3array) triangles **)** + * [Vector3Array](class_vector3array) **[get_geometry_hint](#get_geometry_hint)** **(** **)** const + * void **[regenerate_bsp](#regenerate_bsp)** **(** **)** + * void **[regenerate_bsp_cubic](#regenerate_bsp_cubic)** **(** **)** ### Member Function Description diff --git a/class_sample.md b/class_sample.md index a6bc37d..484e327 100644 --- a/class_sample.md +++ b/class_sample.md @@ -6,20 +6,20 @@ Audio Sample (sound) class. ### Member Functions - * void **[`create`](#create)** **(** [int](class_int) format, [bool](class_bool) stereo, [int](class_int) length **)** - * [int](class_int) **[`get_format`](#get_format)** **(** **)** const - * [bool](class_bool) **[`is_stereo`](#is_stereo)** **(** **)** const - * [int](class_int) **[`get_length`](#get_length)** **(** **)** const - * void **[`set_data`](#set_data)** **(** [RawArray](class_rawarray) data **)** - * [RawArray](class_rawarray) **[`get_data`](#get_data)** **(** **)** const - * void **[`set_mix_rate`](#set_mix_rate)** **(** [int](class_int) hz **)** - * [int](class_int) **[`get_mix_rate`](#get_mix_rate)** **(** **)** const - * void **[`set_loop_format`](#set_loop_format)** **(** [int](class_int) format **)** - * [int](class_int) **[`get_loop_format`](#get_loop_format)** **(** **)** const - * void **[`set_loop_begin`](#set_loop_begin)** **(** [int](class_int) pos **)** - * [int](class_int) **[`get_loop_begin`](#get_loop_begin)** **(** **)** const - * void **[`set_loop_end`](#set_loop_end)** **(** [int](class_int) pos **)** - * [int](class_int) **[`get_loop_end`](#get_loop_end)** **(** **)** const + * void **[create](#create)** **(** [int](class_int) format, [bool](class_bool) stereo, [int](class_int) length **)** + * [int](class_int) **[get_format](#get_format)** **(** **)** const + * [bool](class_bool) **[is_stereo](#is_stereo)** **(** **)** const + * [int](class_int) **[get_length](#get_length)** **(** **)** const + * void **[set_data](#set_data)** **(** [RawArray](class_rawarray) data **)** + * [RawArray](class_rawarray) **[get_data](#get_data)** **(** **)** const + * void **[set_mix_rate](#set_mix_rate)** **(** [int](class_int) hz **)** + * [int](class_int) **[get_mix_rate](#get_mix_rate)** **(** **)** const + * void **[set_loop_format](#set_loop_format)** **(** [int](class_int) format **)** + * [int](class_int) **[get_loop_format](#get_loop_format)** **(** **)** const + * void **[set_loop_begin](#set_loop_begin)** **(** [int](class_int) pos **)** + * [int](class_int) **[get_loop_begin](#get_loop_begin)** **(** **)** const + * void **[set_loop_end](#set_loop_end)** **(** [int](class_int) pos **)** + * [int](class_int) **[get_loop_end](#get_loop_end)** **(** **)** const ### Numeric Constants * **FORMAT_PCM8** = **0** - 8-Bits signed little endian PCM audio. @@ -35,71 +35,71 @@ Sample provides an audio sample class, containing audio data, together with some ### Member Function Description #### create - * void **`create`** **(** [int](class_int) format, [bool](class_bool) stereo, [int](class_int) length **)** + * void **create** **(** [int](class_int) format, [bool](class_bool) stereo, [int](class_int) length **)** Create new data for the sample, with format "format" (see FORMAT_* enum), stereo hint, and length in frames (not samples or bytes!) "frame". Calling create overrides previous existing data if it exists. Stereo samples are interleaved pairs of left and right (in that order) points #### get_format - * [int](class_int) **`get_format`** **(** **)** const + * [int](class_int) **get_format** **(** **)** const Return the sample format (see FORMAT_* enum). #### is_stereo - * [bool](class_bool) **`is_stereo`** **(** **)** const + * [bool](class_bool) **is_stereo** **(** **)** const Return true if the sample was created stereo. #### get_length - * [int](class_int) **`get_length`** **(** **)** const + * [int](class_int) **get_length** **(** **)** const Return the sample length in frames. #### set_data - * void **`set_data`** **(** [RawArray](class_rawarray) data **)** + * void **set_data** **(** [RawArray](class_rawarray) data **)** Set sample data. Data must be little endian, no matter the host platform, and exactly as long to fit all frames. Example, if data is Stereo, 16 bits, 256 frames, it will be 1024 bytes long. #### get_data - * [RawArray](class_rawarray) **`get_data`** **(** **)** const + * [RawArray](class_rawarray) **get_data** **(** **)** const Return sample data. Data will be endian, no matter with the host platform, and exactly as long to fit all frames. Example, if data is Stereo, 16 bits, 256 frames, it will be 1024 bytes long. #### set_mix_rate - * void **`set_mix_rate`** **(** [int](class_int) hz **)** + * void **set_mix_rate** **(** [int](class_int) hz **)** Set the mix rate for the sample (expected playback frequency). #### get_mix_rate - * [int](class_int) **`get_mix_rate`** **(** **)** const + * [int](class_int) **get_mix_rate** **(** **)** const Return the mix rate for the sample (expected playback frequency). #### set_loop_format - * void **`set_loop_format`** **(** [int](class_int) format **)** + * void **set_loop_format** **(** [int](class_int) format **)** Set the loop format, see LOOP_* enum #### get_loop_format - * [int](class_int) **`get_loop_format`** **(** **)** const + * [int](class_int) **get_loop_format** **(** **)** const Return the loop format, see LOOP_* enum. #### set_loop_begin - * void **`set_loop_begin`** **(** [int](class_int) pos **)** + * void **set_loop_begin** **(** [int](class_int) pos **)** Set the loop begin position, it must be a valid frame and less than the loop end position. #### get_loop_begin - * [int](class_int) **`get_loop_begin`** **(** **)** const + * [int](class_int) **get_loop_begin** **(** **)** const Return the loop begin position. #### set_loop_end - * void **`set_loop_end`** **(** [int](class_int) pos **)** + * void **set_loop_end** **(** [int](class_int) pos **)** Set the loop end position, it must be a valid frame and greater than the loop begin position. #### get_loop_end - * [int](class_int) **`get_loop_end`** **(** **)** const + * [int](class_int) **get_loop_end** **(** **)** const Return the loop begin position. diff --git a/class_samplelibrary.md b/class_samplelibrary.md index bb04bc2..3afeb36 100644 --- a/class_samplelibrary.md +++ b/class_samplelibrary.md @@ -6,14 +6,14 @@ Library that contains a collection of Samples. ### Member Functions - * void **[`add_sample`](#add_sample)** **(** [String](class_string) name, [Sample](class_sample) sample **)** - * [Sample](class_sample) **[`get_sample`](#get_sample)** **(** [String](class_string) name **)** const - * [bool](class_bool) **[`has_sample`](#has_sample)** **(** [String](class_string) name **)** const - * void **[`remove_sample`](#remove_sample)** **(** [String](class_string) name **)** - * void **[`sample_set_volume_db`](#sample_set_volume_db)** **(** [String](class_string) name, [real](class_real) db **)** - * [real](class_real) **[`sample_get_volume_db`](#sample_get_volume_db)** **(** [String](class_string) name **)** const - * void **[`sample_set_pitch_scale`](#sample_set_pitch_scale)** **(** [String](class_string) name, [real](class_real) pitch **)** - * [real](class_real) **[`sample_get_pitch_scale`](#sample_get_pitch_scale)** **(** [String](class_string) name **)** const + * void **[add_sample](#add_sample)** **(** [String](class_string) name, [Sample](class_sample) sample **)** + * [Sample](class_sample) **[get_sample](#get_sample)** **(** [String](class_string) name **)** const + * [bool](class_bool) **[has_sample](#has_sample)** **(** [String](class_string) name **)** const + * void **[remove_sample](#remove_sample)** **(** [String](class_string) name **)** + * void **[sample_set_volume_db](#sample_set_volume_db)** **(** [String](class_string) name, [real](class_real) db **)** + * [real](class_real) **[sample_get_volume_db](#sample_get_volume_db)** **(** [String](class_string) name **)** const + * void **[sample_set_pitch_scale](#sample_set_pitch_scale)** **(** [String](class_string) name, [real](class_real) pitch **)** + * [real](class_real) **[sample_get_pitch_scale](#sample_get_pitch_scale)** **(** [String](class_string) name **)** const ### Description Library that contains a collection of Samples, each identified by an text id. This is used as a data containeer for the majority of the SamplePlayer classes and derivatives. @@ -21,21 +21,21 @@ Library that contains a collection of Samples, each identified by an text id. Th ### Member Function Description #### add_sample - * void **`add_sample`** **(** [String](class_string) name, [Sample](class_sample) sample **)** + * void **add_sample** **(** [String](class_string) name, [Sample](class_sample) sample **)** Add a sample to the library, with a given text id; #### get_sample - * [Sample](class_sample) **`get_sample`** **(** [String](class_string) name **)** const + * [Sample](class_sample) **get_sample** **(** [String](class_string) name **)** const Return a sample from the library, from a given text-id. Return null if the sample is not found. #### has_sample - * [bool](class_bool) **`has_sample`** **(** [String](class_string) name **)** const + * [bool](class_bool) **has_sample** **(** [String](class_string) name **)** const Return true if the sample text id exists in the library. #### remove_sample - * void **`remove_sample`** **(** [String](class_string) name **)** + * void **remove_sample** **(** [String](class_string) name **)** Remove a sample given a specific text id. diff --git a/class_sampleplayer.md b/class_sampleplayer.md index 99fd0d6..8b42d0c 100644 --- a/class_sampleplayer.md +++ b/class_sampleplayer.md @@ -6,57 +6,57 @@ Sample Player node. ### Member Functions - * void **[`set_sample_library`](#set_sample_library)** **(** [SampleLibrary](class_samplelibrary) library **)** - * [SampleLibrary](class_samplelibrary) **[`get_sample_library`](#get_sample_library)** **(** **)** const - * void **[`set_voice_count`](#set_voice_count)** **(** [int](class_int) max_voices **)** - * [int](class_int) **[`get_voice_count`](#get_voice_count)** **(** **)** const - * [int](class_int) **[`play`](#play)** **(** [String](class_string) name, [bool](class_bool) unique=false **)** - * void **[`stop`](#stop)** **(** [int](class_int) voice **)** - * void **[`stop_all`](#stop_all)** **(** **)** - * void **[`set_mix_rate`](#set_mix_rate)** **(** [int](class_int) voice, [int](class_int) hz **)** - * void **[`set_pitch_scale`](#set_pitch_scale)** **(** [int](class_int) voice, [real](class_real) ratio **)** - * void **[`set_volume`](#set_volume)** **(** [int](class_int) voice, [real](class_real) nrg **)** - * void **[`set_volume_db`](#set_volume_db)** **(** [int](class_int) voice, [real](class_real) nrg **)** - * void **[`set_pan`](#set_pan)** **(** [int](class_int) voice, [real](class_real) pan, [real](class_real) depth=0, [real](class_real) height=0 **)** - * void **[`set_filter`](#set_filter)** **(** [int](class_int) voice, [int](class_int) type, [real](class_real) cutoff_hz, [real](class_real) resonance, [real](class_real) gain=0 **)** - * void **[`set_chorus`](#set_chorus)** **(** [int](class_int) voice, [real](class_real) send **)** - * void **[`set_reverb`](#set_reverb)** **(** [int](class_int) voice, [int](class_int) room_type, [real](class_real) send **)** - * [int](class_int) **[`get_mix_rate`](#get_mix_rate)** **(** [int](class_int) voice **)** const - * [real](class_real) **[`get_pitch_scale`](#get_pitch_scale)** **(** [int](class_int) voice **)** const - * [real](class_real) **[`get_volume`](#get_volume)** **(** [int](class_int) voice **)** const - * [real](class_real) **[`get_volume_db`](#get_volume_db)** **(** [int](class_int) voice **)** const - * [real](class_real) **[`get_pan`](#get_pan)** **(** [int](class_int) voice **)** const - * [real](class_real) **[`get_pan_depth`](#get_pan_depth)** **(** [int](class_int) voice **)** const - * [real](class_real) **[`get_pan_height`](#get_pan_height)** **(** [int](class_int) voice **)** const - * [int](class_int) **[`get_filter_type`](#get_filter_type)** **(** [int](class_int) voice **)** const - * [real](class_real) **[`get_filter_cutoff`](#get_filter_cutoff)** **(** [int](class_int) voice **)** const - * [real](class_real) **[`get_filter_resonance`](#get_filter_resonance)** **(** [int](class_int) voice **)** const - * [real](class_real) **[`get_filter_gain`](#get_filter_gain)** **(** [int](class_int) voice **)** const - * [real](class_real) **[`get_chorus`](#get_chorus)** **(** [int](class_int) voice **)** const - * [real](class_real) **[`get_reverb_room`](#get_reverb_room)** **(** [int](class_int) voice **)** const - * [real](class_real) **[`get_reverb`](#get_reverb)** **(** [int](class_int) voice **)** const - * void **[`set_default_pitch_scale`](#set_default_pitch_scale)** **(** [real](class_real) ratio **)** - * void **[`set_default_volume`](#set_default_volume)** **(** [real](class_real) nrg **)** - * void **[`set_default_volume_db`](#set_default_volume_db)** **(** [real](class_real) db **)** - * void **[`set_default_pan`](#set_default_pan)** **(** [real](class_real) pan, [real](class_real) depth=0, [real](class_real) height=0 **)** - * void **[`set_default_filter`](#set_default_filter)** **(** [int](class_int) type, [real](class_real) cutoff_hz, [real](class_real) resonance, [real](class_real) gain=0 **)** - * void **[`set_default_chorus`](#set_default_chorus)** **(** [real](class_real) send **)** - * void **[`set_default_reverb`](#set_default_reverb)** **(** [int](class_int) room_type, [real](class_real) send **)** - * [real](class_real) **[`get_default_pitch_scale`](#get_default_pitch_scale)** **(** **)** const - * [real](class_real) **[`get_default_volume`](#get_default_volume)** **(** **)** const - * [real](class_real) **[`get_default_volume_db`](#get_default_volume_db)** **(** **)** const - * [real](class_real) **[`get_default_pan`](#get_default_pan)** **(** **)** const - * [real](class_real) **[`get_default_pan_depth`](#get_default_pan_depth)** **(** **)** const - * [real](class_real) **[`get_default_pan_height`](#get_default_pan_height)** **(** **)** const - * [int](class_int) **[`get_default_filter_type`](#get_default_filter_type)** **(** **)** const - * [real](class_real) **[`get_default_filter_cutoff`](#get_default_filter_cutoff)** **(** **)** const - * [real](class_real) **[`get_default_filter_resonance`](#get_default_filter_resonance)** **(** **)** const - * [real](class_real) **[`get_default_filter_gain`](#get_default_filter_gain)** **(** **)** const - * [real](class_real) **[`get_default_chorus`](#get_default_chorus)** **(** **)** const - * [real](class_real) **[`get_default_reverb_room`](#get_default_reverb_room)** **(** **)** const - * [real](class_real) **[`get_default_reverb`](#get_default_reverb)** **(** **)** const - * [bool](class_bool) **[`is_active`](#is_active)** **(** **)** const - * [bool](class_bool) **[`is_voice_active`](#is_voice_active)** **(** [int](class_int) voice **)** const + * void **[set_sample_library](#set_sample_library)** **(** [SampleLibrary](class_samplelibrary) library **)** + * [SampleLibrary](class_samplelibrary) **[get_sample_library](#get_sample_library)** **(** **)** const + * void **[set_voice_count](#set_voice_count)** **(** [int](class_int) max_voices **)** + * [int](class_int) **[get_voice_count](#get_voice_count)** **(** **)** const + * [int](class_int) **[play](#play)** **(** [String](class_string) name, [bool](class_bool) unique=false **)** + * void **[stop](#stop)** **(** [int](class_int) voice **)** + * void **[stop_all](#stop_all)** **(** **)** + * void **[set_mix_rate](#set_mix_rate)** **(** [int](class_int) voice, [int](class_int) hz **)** + * void **[set_pitch_scale](#set_pitch_scale)** **(** [int](class_int) voice, [real](class_real) ratio **)** + * void **[set_volume](#set_volume)** **(** [int](class_int) voice, [real](class_real) nrg **)** + * void **[set_volume_db](#set_volume_db)** **(** [int](class_int) voice, [real](class_real) nrg **)** + * void **[set_pan](#set_pan)** **(** [int](class_int) voice, [real](class_real) pan, [real](class_real) depth=0, [real](class_real) height=0 **)** + * void **[set_filter](#set_filter)** **(** [int](class_int) voice, [int](class_int) type, [real](class_real) cutoff_hz, [real](class_real) resonance, [real](class_real) gain=0 **)** + * void **[set_chorus](#set_chorus)** **(** [int](class_int) voice, [real](class_real) send **)** + * void **[set_reverb](#set_reverb)** **(** [int](class_int) voice, [int](class_int) room_type, [real](class_real) send **)** + * [int](class_int) **[get_mix_rate](#get_mix_rate)** **(** [int](class_int) voice **)** const + * [real](class_real) **[get_pitch_scale](#get_pitch_scale)** **(** [int](class_int) voice **)** const + * [real](class_real) **[get_volume](#get_volume)** **(** [int](class_int) voice **)** const + * [real](class_real) **[get_volume_db](#get_volume_db)** **(** [int](class_int) voice **)** const + * [real](class_real) **[get_pan](#get_pan)** **(** [int](class_int) voice **)** const + * [real](class_real) **[get_pan_depth](#get_pan_depth)** **(** [int](class_int) voice **)** const + * [real](class_real) **[get_pan_height](#get_pan_height)** **(** [int](class_int) voice **)** const + * [int](class_int) **[get_filter_type](#get_filter_type)** **(** [int](class_int) voice **)** const + * [real](class_real) **[get_filter_cutoff](#get_filter_cutoff)** **(** [int](class_int) voice **)** const + * [real](class_real) **[get_filter_resonance](#get_filter_resonance)** **(** [int](class_int) voice **)** const + * [real](class_real) **[get_filter_gain](#get_filter_gain)** **(** [int](class_int) voice **)** const + * [real](class_real) **[get_chorus](#get_chorus)** **(** [int](class_int) voice **)** const + * [real](class_real) **[get_reverb_room](#get_reverb_room)** **(** [int](class_int) voice **)** const + * [real](class_real) **[get_reverb](#get_reverb)** **(** [int](class_int) voice **)** const + * void **[set_default_pitch_scale](#set_default_pitch_scale)** **(** [real](class_real) ratio **)** + * void **[set_default_volume](#set_default_volume)** **(** [real](class_real) nrg **)** + * void **[set_default_volume_db](#set_default_volume_db)** **(** [real](class_real) db **)** + * void **[set_default_pan](#set_default_pan)** **(** [real](class_real) pan, [real](class_real) depth=0, [real](class_real) height=0 **)** + * void **[set_default_filter](#set_default_filter)** **(** [int](class_int) type, [real](class_real) cutoff_hz, [real](class_real) resonance, [real](class_real) gain=0 **)** + * void **[set_default_chorus](#set_default_chorus)** **(** [real](class_real) send **)** + * void **[set_default_reverb](#set_default_reverb)** **(** [int](class_int) room_type, [real](class_real) send **)** + * [real](class_real) **[get_default_pitch_scale](#get_default_pitch_scale)** **(** **)** const + * [real](class_real) **[get_default_volume](#get_default_volume)** **(** **)** const + * [real](class_real) **[get_default_volume_db](#get_default_volume_db)** **(** **)** const + * [real](class_real) **[get_default_pan](#get_default_pan)** **(** **)** const + * [real](class_real) **[get_default_pan_depth](#get_default_pan_depth)** **(** **)** const + * [real](class_real) **[get_default_pan_height](#get_default_pan_height)** **(** **)** const + * [int](class_int) **[get_default_filter_type](#get_default_filter_type)** **(** **)** const + * [real](class_real) **[get_default_filter_cutoff](#get_default_filter_cutoff)** **(** **)** const + * [real](class_real) **[get_default_filter_resonance](#get_default_filter_resonance)** **(** **)** const + * [real](class_real) **[get_default_filter_gain](#get_default_filter_gain)** **(** **)** const + * [real](class_real) **[get_default_chorus](#get_default_chorus)** **(** **)** const + * [real](class_real) **[get_default_reverb_room](#get_default_reverb_room)** **(** **)** const + * [real](class_real) **[get_default_reverb](#get_default_reverb)** **(** **)** const + * [bool](class_bool) **[is_active](#is_active)** **(** **)** const + * [bool](class_bool) **[is_voice_active](#is_voice_active)** **(** [int](class_int) voice **)** const ### Numeric Constants * **FILTER_NONE** = **0** - Filter is disabled for voice. @@ -79,116 +79,116 @@ SamplePlayer is a [Node](class_node) meant for simple sample playback. A library ### Member Function Description #### set_voice_count - * void **`set_voice_count`** **(** [int](class_int) max_voices **)** + * void **set_voice_count** **(** [int](class_int) max_voices **)** Set the amount of simultaneous voices that will be used for playback. #### get_voice_count - * [int](class_int) **`get_voice_count`** **(** **)** const + * [int](class_int) **get_voice_count** **(** **)** const Return the amount of simultaneous voices that will be used for playback. #### play - * [int](class_int) **`play`** **(** [String](class_string) name, [bool](class_bool) unique=false **)** + * [int](class_int) **play** **(** [String](class_string) name, [bool](class_bool) unique=false **)** Play back sample, given it"apos;s identifier "name". if "unique" is true, all othere previous samples will be stopped. The voice allocated for playback will be returned. #### stop - * void **`stop`** **(** [int](class_int) voice **)** + * void **stop** **(** [int](class_int) voice **)** -Stop a voice "voice". (see [`play`](#play)). +Stop a voice "voice". (see [play](#play)). #### set_mix_rate - * void **`set_mix_rate`** **(** [int](class_int) voice, [int](class_int) hz **)** + * void **set_mix_rate** **(** [int](class_int) voice, [int](class_int) hz **)** Change the mix rate of a voice "voice" to given "hz". #### set_pitch_scale - * void **`set_pitch_scale`** **(** [int](class_int) voice, [real](class_real) ratio **)** + * void **set_pitch_scale** **(** [int](class_int) voice, [real](class_real) ratio **)** Scale the pitch (mix rate) of a voice by a ratio value "ratio". A ratio of 1.0 means the voice is unscaled. #### set_volume - * void **`set_volume`** **(** [int](class_int) voice, [real](class_real) nrg **)** + * void **set_volume** **(** [int](class_int) voice, [real](class_real) nrg **)** Set the volume of a voice, 0db is maximum volume (every about -6db, volume is reduced in half). "db" does in fact go from zero to negative. #### set_pan - * void **`set_pan`** **(** [int](class_int) voice, [real](class_real) pan, [real](class_real) depth=0, [real](class_real) height=0 **)** + * void **set_pan** **(** [int](class_int) voice, [real](class_real) pan, [real](class_real) depth=0, [real](class_real) height=0 **)** Set the panning of a voice. Panning goes from -1 (left) to +1 (right). Optionally, if the hardware supports 3D sound, also set depth and height (also in range -1 to +1). #### set_filter - * void **`set_filter`** **(** [int](class_int) voice, [int](class_int) type, [real](class_real) cutoff_hz, [real](class_real) resonance, [real](class_real) gain=0 **)** + * void **set_filter** **(** [int](class_int) voice, [int](class_int) type, [real](class_real) cutoff_hz, [real](class_real) resonance, [real](class_real) gain=0 **)** Set and enable a filter of a voice, with type "type" (see FILTER_* enum), cutoff (0 to 22khz) frequency and resonance (0+). #### set_chorus - * void **`set_chorus`** **(** [int](class_int) voice, [real](class_real) send **)** + * void **set_chorus** **(** [int](class_int) voice, [real](class_real) send **)** Set the chorus send level of a voice (0 to 1). For setting chorus parameters, see [AudioServer](class_audioserver). #### set_reverb - * void **`set_reverb`** **(** [int](class_int) voice, [int](class_int) room_type, [real](class_real) send **)** + * void **set_reverb** **(** [int](class_int) voice, [int](class_int) room_type, [real](class_real) send **)** Set the reverb send level and type of a voice (0 to 1). (see REVERB_* enum for type). #### get_mix_rate - * [int](class_int) **`get_mix_rate`** **(** [int](class_int) voice **)** const + * [int](class_int) **get_mix_rate** **(** [int](class_int) voice **)** const Return the current mix rate for a given voice. #### get_pitch_scale - * [real](class_real) **`get_pitch_scale`** **(** [int](class_int) voice **)** const + * [real](class_real) **get_pitch_scale** **(** [int](class_int) voice **)** const Return the current pitch scale for a given voice. #### get_volume - * [real](class_real) **`get_volume`** **(** [int](class_int) voice **)** const + * [real](class_real) **get_volume** **(** [int](class_int) voice **)** const Return the current volume (in db) for a given voice. 0db is maximum volume (every about -6db, volume is reduced in half). "db" does in fact go from zero to negative. #### get_pan - * [real](class_real) **`get_pan`** **(** [int](class_int) voice **)** const + * [real](class_real) **get_pan** **(** [int](class_int) voice **)** const Return the current panning for a given voice. Panning goes from -1 (left) to +1 (right). #### get_pan_depth - * [real](class_real) **`get_pan_depth`** **(** [int](class_int) voice **)** const + * [real](class_real) **get_pan_depth** **(** [int](class_int) voice **)** const Return the current pan depth for a given voice (not used unless the hardware supports 3D sound) #### get_pan_height - * [real](class_real) **`get_pan_height`** **(** [int](class_int) voice **)** const + * [real](class_real) **get_pan_height** **(** [int](class_int) voice **)** const Return the current pan height for a given voice (not used unless the hardware supports 3D sound) #### get_filter_type - * [int](class_int) **`get_filter_type`** **(** [int](class_int) voice **)** const + * [int](class_int) **get_filter_type** **(** [int](class_int) voice **)** const Return the current filter type in use (see FILTER_* enum) for a given voice. #### get_filter_cutoff - * [real](class_real) **`get_filter_cutoff`** **(** [int](class_int) voice **)** const + * [real](class_real) **get_filter_cutoff** **(** [int](class_int) voice **)** const Return the current filter cutoff for a given voice. Cutoff goes from 0 to 22khz. #### get_filter_resonance - * [real](class_real) **`get_filter_resonance`** **(** [int](class_int) voice **)** const + * [real](class_real) **get_filter_resonance** **(** [int](class_int) voice **)** const Return the current filter resonance for a given voice. Resonance goes from 0 up. #### get_chorus - * [real](class_real) **`get_chorus`** **(** [int](class_int) voice **)** const + * [real](class_real) **get_chorus** **(** [int](class_int) voice **)** const Return the current chorus send level for a given voice. (0 to 1). #### get_reverb_room - * [real](class_real) **`get_reverb_room`** **(** [int](class_int) voice **)** const + * [real](class_real) **get_reverb_room** **(** [int](class_int) voice **)** const Return the current reverb room type for a given voice (see REVERB_* enum). #### get_reverb - * [real](class_real) **`get_reverb`** **(** [int](class_int) voice **)** const + * [real](class_real) **get_reverb** **(** [int](class_int) voice **)** const Return the current reverb send level for a given voice. (0 to 1). diff --git a/class_sampleplayer2d.md b/class_sampleplayer2d.md index f6c381a..a36eedb 100644 --- a/class_sampleplayer2d.md +++ b/class_sampleplayer2d.md @@ -6,18 +6,18 @@ Sample player for Positional 2D Sound. ### Member Functions - * void **[`set_sample_library`](#set_sample_library)** **(** [SampleLibrary](class_samplelibrary) library **)** - * [SampleLibrary](class_samplelibrary) **[`get_sample_library`](#get_sample_library)** **(** **)** const - * void **[`set_polyphony`](#set_polyphony)** **(** [int](class_int) voices **)** - * [int](class_int) **[`get_polyphony`](#get_polyphony)** **(** **)** const - * [int](class_int) **[`play`](#play)** **(** [String](class_string) sample, [int](class_int) voice=-2 **)** - * void **[`voice_set_pitch_scale`](#voice_set_pitch_scale)** **(** [int](class_int) voice, [real](class_real) ratio **)** - * void **[`voice_set_volume_scale_db`](#voice_set_volume_scale_db)** **(** [int](class_int) voice, [real](class_real) db **)** - * [bool](class_bool) **[`is_voice_active`](#is_voice_active)** **(** [int](class_int) voice **)** const - * void **[`stop_voice`](#stop_voice)** **(** [int](class_int) voice **)** - * void **[`stop_all`](#stop_all)** **(** **)** - * void **[`set_random_pitch_scale`](#set_random_pitch_scale)** **(** [real](class_real) val **)** - * [real](class_real) **[`get_random_pitch_scale`](#get_random_pitch_scale)** **(** **)** const + * void **[set_sample_library](#set_sample_library)** **(** [SampleLibrary](class_samplelibrary) library **)** + * [SampleLibrary](class_samplelibrary) **[get_sample_library](#get_sample_library)** **(** **)** const + * void **[set_polyphony](#set_polyphony)** **(** [int](class_int) voices **)** + * [int](class_int) **[get_polyphony](#get_polyphony)** **(** **)** const + * [int](class_int) **[play](#play)** **(** [String](class_string) sample, [int](class_int) voice=-2 **)** + * void **[voice_set_pitch_scale](#voice_set_pitch_scale)** **(** [int](class_int) voice, [real](class_real) ratio **)** + * void **[voice_set_volume_scale_db](#voice_set_volume_scale_db)** **(** [int](class_int) voice, [real](class_real) db **)** + * [bool](class_bool) **[is_voice_active](#is_voice_active)** **(** [int](class_int) voice **)** const + * void **[stop_voice](#stop_voice)** **(** [int](class_int) voice **)** + * void **[stop_all](#stop_all)** **(** **)** + * void **[set_random_pitch_scale](#set_random_pitch_scale)** **(** [real](class_real) val **)** + * [real](class_real) **[get_random_pitch_scale](#get_random_pitch_scale)** **(** **)** const ### Numeric Constants * **INVALID_VOICE** = **-1** - If the voice is invalid, this is returned. @@ -29,51 +29,51 @@ Sample player for Positional 2D Sound. Plays sound samples positionally, left an ### Member Function Description #### set_sample_library - * void **`set_sample_library`** **(** [SampleLibrary](class_samplelibrary) library **)** + * void **set_sample_library** **(** [SampleLibrary](class_samplelibrary) library **)** Set the sample library for the player. #### get_sample_library - * [SampleLibrary](class_samplelibrary) **`get_sample_library`** **(** **)** const + * [SampleLibrary](class_samplelibrary) **get_sample_library** **(** **)** const Return the sample library used for the player. #### set_polyphony - * void **`set_polyphony`** **(** [int](class_int) voices **)** + * void **set_polyphony** **(** [int](class_int) voices **)** Set the polyphony of the player (maximum amount of simultaneous voices). #### get_polyphony - * [int](class_int) **`get_polyphony`** **(** **)** const + * [int](class_int) **get_polyphony** **(** **)** const Return the polyphony of the player (maximum amount of simultaneous voices). #### play - * [int](class_int) **`play`** **(** [String](class_string) sample, [int](class_int) voice=-2 **)** + * [int](class_int) **play** **(** [String](class_string) sample, [int](class_int) voice=-2 **)** Play a sample, an internal polyphony id can be passed, or else it's assigned automatically. Returns a voice id which can be used to modify the voice parameters. #### voice_set_pitch_scale - * void **`voice_set_pitch_scale`** **(** [int](class_int) voice, [real](class_real) ratio **)** + * void **voice_set_pitch_scale** **(** [int](class_int) voice, [real](class_real) ratio **)** Change the pitch scale of a currently playing voice. #### voice_set_volume_scale_db - * void **`voice_set_volume_scale_db`** **(** [int](class_int) voice, [real](class_real) db **)** + * void **voice_set_volume_scale_db** **(** [int](class_int) voice, [real](class_real) db **)** Change the volume scale of a currently playing voice (using dB). #### is_voice_active - * [bool](class_bool) **`is_voice_active`** **(** [int](class_int) voice **)** const + * [bool](class_bool) **is_voice_active** **(** [int](class_int) voice **)** const Return true if a voice is still active (false if it stopped playing). #### stop_voice - * void **`stop_voice`** **(** [int](class_int) voice **)** + * void **stop_voice** **(** [int](class_int) voice **)** Stop a given voice. #### stop_all - * void **`stop_all`** **(** **)** + * void **stop_all** **(** **)** Stop all playing voices. diff --git a/class_sceneinteractiveloader.md b/class_sceneinteractiveloader.md index 1562559..2718977 100644 --- a/class_sceneinteractiveloader.md +++ b/class_sceneinteractiveloader.md @@ -6,9 +6,9 @@ ### Member Functions - * [Object](class_object) **[`get_scene`](#get_scene)** **(** **)** - * [int](class_int) **[`poll`](#poll)** **(** **)** - * [int](class_int) **[`get_stage`](#get_stage)** **(** **)** const - * [int](class_int) **[`get_stage_count`](#get_stage_count)** **(** **)** const + * [Object](class_object) **[get_scene](#get_scene)** **(** **)** + * [int](class_int) **[poll](#poll)** **(** **)** + * [int](class_int) **[get_stage](#get_stage)** **(** **)** const + * [int](class_int) **[get_stage_count](#get_stage_count)** **(** **)** const ### Member Function Description diff --git a/class_sceneio.md b/class_sceneio.md index 10a3122..1d75adb 100644 --- a/class_sceneio.md +++ b/class_sceneio.md @@ -6,8 +6,8 @@ ### Member Functions - * [Node](class_node) **[`load`](#load)** **(** [String](class_string) path **)** - * [int](class_int) **[`save`](#save)** **(** [String](class_string) path, [Node](class_node) scene, [int](class_int) flags=0, OptimizedSaver optimizer=Object() **)** - * [SceneInteractiveLoader](class_sceneinteractiveloader) **[`load_interactive`](#load_interactive)** **(** [String](class_string) path **)** + * [Node](class_node) **[load](#load)** **(** [String](class_string) path **)** + * [int](class_int) **[save](#save)** **(** [String](class_string) path, [Node](class_node) scene, [int](class_int) flags=0, OptimizedSaver optimizer=Object() **)** + * [SceneInteractiveLoader](class_sceneinteractiveloader) **[load_interactive](#load_interactive)** **(** [String](class_string) path **)** ### Member Function Description diff --git a/class_scenemainloop.md b/class_scenemainloop.md index cc05321..bf3e1f9 100644 --- a/class_scenemainloop.md +++ b/class_scenemainloop.md @@ -6,26 +6,26 @@ Scene-Based implementation of the MainLoop. ### Member Functions - * void **[`notify_group`](#notify_group)** **(** [int](class_int) call_flags, [String](class_string) group, [int](class_int) notification **)** - * void **[`set_group`](#set_group)** **(** [int](class_int) call_flags, [String](class_string) group, [String](class_string) property, var value **)** - * [Array](class_array) **[`get_nodes_in_group`](#get_nodes_in_group)** **(** [String](class_string) arg0 **)** - * [Viewport](class_viewport) **[`get_root`](#get_root)** **(** **)** const - * void **[`set_auto_accept_quit`](#set_auto_accept_quit)** **(** [bool](class_bool) enabled **)** - * void **[`set_editor_hint`](#set_editor_hint)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_editor_hint`](#is_editor_hint)** **(** **)** const - * void **[`set_pause`](#set_pause)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_paused`](#is_paused)** **(** **)** const - * void **[`set_input_as_handled`](#set_input_as_handled)** **(** **)** - * [int](class_int) **[`get_node_count`](#get_node_count)** **(** **)** const - * [int](class_int) **[`get_frame`](#get_frame)** **(** **)** const - * void **[`quit`](#quit)** **(** **)** - * void **[`queue_delete`](#queue_delete)** **(** [Object](class_object) obj **)** - * void **[`call_group`](#call_group)** **(** [int](class_int) flags, [String](class_string) group, [String](class_string) method, var arg0=NULL, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL **)** + * void **[notify_group](#notify_group)** **(** [int](class_int) call_flags, [String](class_string) group, [int](class_int) notification **)** + * void **[set_group](#set_group)** **(** [int](class_int) call_flags, [String](class_string) group, [String](class_string) property, var value **)** + * [Array](class_array) **[get_nodes_in_group](#get_nodes_in_group)** **(** [String](class_string) arg0 **)** + * [Viewport](class_viewport) **[get_root](#get_root)** **(** **)** const + * void **[set_auto_accept_quit](#set_auto_accept_quit)** **(** [bool](class_bool) enabled **)** + * void **[set_editor_hint](#set_editor_hint)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_editor_hint](#is_editor_hint)** **(** **)** const + * void **[set_pause](#set_pause)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_paused](#is_paused)** **(** **)** const + * void **[set_input_as_handled](#set_input_as_handled)** **(** **)** + * [int](class_int) **[get_node_count](#get_node_count)** **(** **)** const + * [int](class_int) **[get_frame](#get_frame)** **(** **)** const + * void **[quit](#quit)** **(** **)** + * void **[queue_delete](#queue_delete)** **(** [Object](class_object) obj **)** + * void **[call_group](#call_group)** **(** [int](class_int) flags, [String](class_string) group, [String](class_string) method, var arg0=NULL, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL **)** ### Signals - * **`screen_resized`** **(** **)** - * **`node_removed`** **(** [Object](class_object) node **)** - * **`tree_changed`** **(** **)** + * **screen_resized** **(** **)** + * **node_removed** **(** [Object](class_object) node **)** + * **tree_changed** **(** **)** ### Numeric Constants * **GROUP_CALL_DEFAULT** = **0** - Regular group call flag (no flags). @@ -41,66 +41,66 @@ Scene implementation of the MainLoop. All scenes edited using the editor are loa ### Member Function Description #### notify_group - * void **`notify_group`** **(** [int](class_int) call_flags, [String](class_string) group, [int](class_int) notification **)** + * void **notify_group** **(** [int](class_int) call_flags, [String](class_string) group, [int](class_int) notification **)** Call a notification in all the nodes belonging to a given group. See GROUP_CALL_* enum for options. #### set_group - * void **`set_group`** **(** [int](class_int) call_flags, [String](class_string) group, [String](class_string) property, var value **)** + * void **set_group** **(** [int](class_int) call_flags, [String](class_string) group, [String](class_string) property, var value **)** Set a property in all the nodes belonging to a given group. See GROUP_CALL_* enum for options. #### get_nodes_in_group - * [Array](class_array) **`get_nodes_in_group`** **(** [String](class_string) arg0 **)** + * [Array](class_array) **get_nodes_in_group** **(** [String](class_string) arg0 **)** Get all the nods belonging to a given group. #### set_auto_accept_quit - * void **`set_auto_accept_quit`** **(** [bool](class_bool) enabled **)** + * void **set_auto_accept_quit** **(** [bool](class_bool) enabled **)** Set to true if the application will quit automatically when quit is requested (Alt-f4 or ctrl-c). #### set_editor_hint - * void **`set_editor_hint`** **(** [bool](class_bool) enable **)** + * void **set_editor_hint** **(** [bool](class_bool) enable **)** Set to true to tell nodes and the scene that it is being edited. This is used by editors, not release. #### is_editor_hint - * [bool](class_bool) **`is_editor_hint`** **(** **)** const + * [bool](class_bool) **is_editor_hint** **(** **)** const Return true if the scene is being run inside an editor. #### set_pause - * void **`set_pause`** **(** [bool](class_bool) enable **)** + * void **set_pause** **(** [bool](class_bool) enable **)** Set pause. The built-in pause system is very basic and only meant to avoid processing nodes not allowed to work in pause mode. #### is_paused - * [bool](class_bool) **`is_paused`** **(** **)** const + * [bool](class_bool) **is_paused** **(** **)** const Return true if the scene is paused. #### set_input_as_handled - * void **`set_input_as_handled`** **(** **)** + * void **set_input_as_handled** **(** **)** Handle a current input event (avoid further processing of it). #### get_frame - * [int](class_int) **`get_frame`** **(** **)** const + * [int](class_int) **get_frame** **(** **)** const Return the frame index (how many frames were drawn). #### quit - * void **`quit`** **(** **)** + * void **quit** **(** **)** Quit the application. #### queue_delete - * void **`queue_delete`** **(** [Object](class_object) obj **)** + * void **queue_delete** **(** [Object](class_object) obj **)** Queue an object for deletion next time the loop goes idle. #### call_group - * void **`call_group`** **(** [int](class_int) flags, [String](class_string) group, [String](class_string) method, var arg0=NULL, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL **)** + * void **call_group** **(** [int](class_int) flags, [String](class_string) group, [String](class_string) method, var arg0=NULL, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL **)** Call a function for all the nodes in a given group. diff --git a/class_scenepreloader.md b/class_scenepreloader.md index d207c04..aaf5de3 100644 --- a/class_scenepreloader.md +++ b/class_scenepreloader.md @@ -6,9 +6,9 @@ ### Member Functions - * [int](class_int) **[`load_scene`](#load_scene)** **(** [String](class_string) path **)** - * [String](class_string) **[`get_scene_path`](#get_scene_path)** **(** **)** const - * [Node](class_node) **[`instance`](#instance)** **(** **)** const - * [bool](class_bool) **[`can_instance`](#can_instance)** **(** **)** const + * [int](class_int) **[load_scene](#load_scene)** **(** [String](class_string) path **)** + * [String](class_string) **[get_scene_path](#get_scene_path)** **(** **)** const + * [Node](class_node) **[instance](#instance)** **(** **)** const + * [bool](class_bool) **[can_instance](#can_instance)** **(** **)** const ### Member Function Description diff --git a/class_script.md b/class_script.md index c7de42a..0f584fa 100644 --- a/class_script.md +++ b/class_script.md @@ -6,12 +6,12 @@ Base class for scripts. ### Member Functions - * [bool](class_bool) **[`can_instance`](#can_instance)** **(** **)** const - * [bool](class_bool) **[`instance_has`](#instance_has)** **(** [Object](class_object) base_object **)** const - * [bool](class_bool) **[`has_source_code`](#has_source_code)** **(** **)** const - * [String](class_string) **[`get_source_code`](#get_source_code)** **(** **)** const - * void **[`set_source_code`](#set_source_code)** **(** [String](class_string) source **)** - * [int](class_int) **[`reload`](#reload)** **(** **)** + * [bool](class_bool) **[can_instance](#can_instance)** **(** **)** const + * [bool](class_bool) **[instance_has](#instance_has)** **(** [Object](class_object) base_object **)** const + * [bool](class_bool) **[has_source_code](#has_source_code)** **(** **)** const + * [String](class_string) **[get_source_code](#get_source_code)** **(** **)** const + * void **[set_source_code](#set_source_code)** **(** [String](class_string) source **)** + * [int](class_int) **[reload](#reload)** **(** **)** ### Description Base class for scripts. Any script that is loaded becomes one of these resources, which can then create instances. @@ -19,31 +19,31 @@ Base class for scripts. Any script that is loaded becomes one of these resources ### Member Function Description #### can_instance - * [bool](class_bool) **`can_instance`** **(** **)** const + * [bool](class_bool) **can_instance** **(** **)** const Return true if this script can be instance (ie not a library). #### instance_has - * [bool](class_bool) **`instance_has`** **(** [Object](class_object) base_object **)** const + * [bool](class_bool) **instance_has** **(** [Object](class_object) base_object **)** const Return true if a given object uses an instance of this script. #### has_source_code - * [bool](class_bool) **`has_source_code`** **(** **)** const + * [bool](class_bool) **has_source_code** **(** **)** const Return true if the script contains source code. #### get_source_code - * [String](class_string) **`get_source_code`** **(** **)** const + * [String](class_string) **get_source_code** **(** **)** const Return the script source code (if available). #### set_source_code - * void **`set_source_code`** **(** [String](class_string) source **)** + * void **set_source_code** **(** [String](class_string) source **)** Set the script source code. #### reload - * [int](class_int) **`reload`** **(** **)** + * [int](class_int) **reload** **(** **)** Reload the script. This will fail if there are existing instances. diff --git a/class_scrollbar.md b/class_scrollbar.md index f99f384..52ea002 100644 --- a/class_scrollbar.md +++ b/class_scrollbar.md @@ -6,8 +6,8 @@ Base class for scroll bars. ### Member Functions - * void **[`set_custom_step`](#set_custom_step)** **(** [real](class_real) step **)** - * [real](class_real) **[`get_custom_step`](#get_custom_step)** **(** **)** const + * void **[set_custom_step](#set_custom_step)** **(** [real](class_real) step **)** + * [real](class_real) **[get_custom_step](#get_custom_step)** **(** **)** const ### Description Scrollbars are a [Range](class_range) based [Control](class_control), that display a draggable area (the size of the page). Horizontal ([HScrollBar](class_hscrollbar)) and Vertical ([VScrollBar](class_vscrollbar)) versions are available. diff --git a/class_scrollcontainer.md b/class_scrollcontainer.md index 1f70afb..bb5d22c 100644 --- a/class_scrollcontainer.md +++ b/class_scrollcontainer.md @@ -6,13 +6,13 @@ ### Member Functions - * void **[`set_enable_h_scroll`](#set_enable_h_scroll)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_h_scroll_enabled`](#is_h_scroll_enabled)** **(** **)** const - * void **[`set_enable_v_scroll`](#set_enable_v_scroll)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_v_scroll_enabled`](#is_v_scroll_enabled)** **(** **)** const - * void **[`set_h_scroll`](#set_h_scroll)** **(** [int](class_int) val **)** - * [int](class_int) **[`get_h_scroll`](#get_h_scroll)** **(** **)** const - * void **[`set_v_scroll`](#set_v_scroll)** **(** [int](class_int) val **)** - * [int](class_int) **[`get_v_scroll`](#get_v_scroll)** **(** **)** const + * void **[set_enable_h_scroll](#set_enable_h_scroll)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_h_scroll_enabled](#is_h_scroll_enabled)** **(** **)** const + * void **[set_enable_v_scroll](#set_enable_v_scroll)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_v_scroll_enabled](#is_v_scroll_enabled)** **(** **)** const + * void **[set_h_scroll](#set_h_scroll)** **(** [int](class_int) val **)** + * [int](class_int) **[get_h_scroll](#get_h_scroll)** **(** **)** const + * void **[set_v_scroll](#set_v_scroll)** **(** [int](class_int) val **)** + * [int](class_int) **[get_v_scroll](#get_v_scroll)** **(** **)** const ### Member Function Description diff --git a/class_segmentshape2d.md b/class_segmentshape2d.md index f519e62..1baf7d8 100644 --- a/class_segmentshape2d.md +++ b/class_segmentshape2d.md @@ -6,10 +6,10 @@ Segment Shape for 2D Collision Detection. ### Member Functions - * void **[`set_a`](#set_a)** **(** [Vector2](class_vector2) a **)** - * [Vector2](class_vector2) **[`get_a`](#get_a)** **(** **)** const - * void **[`set_b`](#set_b)** **(** [Vector2](class_vector2) b **)** - * [Vector2](class_vector2) **[`get_b`](#get_b)** **(** **)** const + * void **[set_a](#set_a)** **(** [Vector2](class_vector2) a **)** + * [Vector2](class_vector2) **[get_a](#get_a)** **(** **)** const + * void **[set_b](#set_b)** **(** [Vector2](class_vector2) b **)** + * [Vector2](class_vector2) **[get_b](#get_b)** **(** **)** const ### Description Segment Shape for 2D Collision Detection, consists of two points, 'a' and 'b'. diff --git a/class_semaphore.md b/class_semaphore.md index 4abcbd3..a4c8e3d 100644 --- a/class_semaphore.md +++ b/class_semaphore.md @@ -6,7 +6,7 @@ ### Member Functions - * [int](class_int) **[`wait`](#wait)** **(** **)** - * [int](class_int) **[`post`](#post)** **(** **)** + * [int](class_int) **[wait](#wait)** **(** **)** + * [int](class_int) **[post](#post)** **(** **)** ### Member Function Description diff --git a/class_shader.md b/class_shader.md index 5935c1c..2acc343 100644 --- a/class_shader.md +++ b/class_shader.md @@ -6,12 +6,12 @@ To be changed, ignore. ### Member Functions - * void **[`set_mode`](#set_mode)** **(** [int](class_int) mode **)** - * [int](class_int) **[`get_mode`](#get_mode)** **(** **)** const - * void **[`set_code`](#set_code)** **(** [String](class_string) vcode, [String](class_string) fcode, [int](class_int) vofs=0, [int](class_int) fofs=0 **)** - * [String](class_string) **[`get_vertex_code`](#get_vertex_code)** **(** **)** const - * [String](class_string) **[`get_fragment_code`](#get_fragment_code)** **(** **)** const - * [bool](class_bool) **[`has_param`](#has_param)** **(** [String](class_string) name **)** const + * void **[set_mode](#set_mode)** **(** [int](class_int) mode **)** + * [int](class_int) **[get_mode](#get_mode)** **(** **)** const + * void **[set_code](#set_code)** **(** [String](class_string) vcode, [String](class_string) fcode, [int](class_int) vofs=0, [int](class_int) fofs=0 **)** + * [String](class_string) **[get_vertex_code](#get_vertex_code)** **(** **)** const + * [String](class_string) **[get_fragment_code](#get_fragment_code)** **(** **)** const + * [bool](class_bool) **[has_param](#has_param)** **(** [String](class_string) name **)** const ### Numeric Constants * **MODE_MATERIAL** = **0** diff --git a/class_shadermaterial.md b/class_shadermaterial.md index 714b619..455e2d8 100644 --- a/class_shadermaterial.md +++ b/class_shadermaterial.md @@ -6,7 +6,7 @@ ### Member Functions - * void **[`set_shader`](#set_shader)** **(** [Shader](class_shader) shader **)** - * [Shader](class_shader) **[`get_shader`](#get_shader)** **(** **)** const + * void **[set_shader](#set_shader)** **(** [Shader](class_shader) shader **)** + * [Shader](class_shader) **[get_shader](#get_shader)** **(** **)** const ### Member Function Description diff --git a/class_shape2d.md b/class_shape2d.md index 3c90272..35e7a3e 100644 --- a/class_shape2d.md +++ b/class_shape2d.md @@ -6,8 +6,8 @@ Base class for all 2D Shapes. ### Member Functions - * void **[`set_custom_solver_bias`](#set_custom_solver_bias)** **(** [real](class_real) bias **)** - * [real](class_real) **[`get_custom_solver_bias`](#get_custom_solver_bias)** **(** **)** const + * void **[set_custom_solver_bias](#set_custom_solver_bias)** **(** [real](class_real) bias **)** + * [real](class_real) **[get_custom_solver_bias](#get_custom_solver_bias)** **(** **)** const ### Description Base class for all 2D Shapes. All 2D shape types inherit from this. @@ -15,11 +15,11 @@ Base class for all 2D Shapes. All 2D shape types inherit from this. ### Member Function Description #### set_custom_solver_bias - * void **`set_custom_solver_bias`** **(** [real](class_real) bias **)** + * void **set_custom_solver_bias** **(** [real](class_real) bias **)** Use a custom solver bias. No need to change this unless you really know what you are doing. #### get_custom_solver_bias - * [real](class_real) **`get_custom_solver_bias`** **(** **)** const + * [real](class_real) **get_custom_solver_bias** **(** **)** const Return the custom solver bias. No need to change this unless you really know what you are doing. diff --git a/class_skeleton.md b/class_skeleton.md index 1d3b7b2..8092b9a 100644 --- a/class_skeleton.md +++ b/class_skeleton.md @@ -6,23 +6,23 @@ Skeleton for characters and animated objects. ### Member Functions - * void **[`add_bone`](#add_bone)** **(** [String](class_string) name **)** - * [int](class_int) **[`find_bone`](#find_bone)** **(** [String](class_string) name **)** const - * [String](class_string) **[`get_bone_name`](#get_bone_name)** **(** [int](class_int) bone_idx **)** const - * [int](class_int) **[`get_bone_parent`](#get_bone_parent)** **(** [int](class_int) bone_idx **)** const - * void **[`set_bone_parent`](#set_bone_parent)** **(** [int](class_int) bone_idx, [int](class_int) parent_idx **)** - * [int](class_int) **[`get_bone_count`](#get_bone_count)** **(** **)** const - * [Transform](class_transform) **[`get_bone_rest`](#get_bone_rest)** **(** [int](class_int) bone_idx **)** const - * void **[`set_bone_rest`](#set_bone_rest)** **(** [int](class_int) bone_idx, [Transform](class_transform) rest **)** - * void **[`bind_child_node_to_bone`](#bind_child_node_to_bone)** **(** [int](class_int) bone_idx, [Node](class_node) node **)** - * void **[`unbind_child_node_from_bone`](#unbind_child_node_from_bone)** **(** [int](class_int) bone_idx, [Node](class_node) node **)** - * [Array](class_array) **[`get_bound_child_nodes_to_bone`](#get_bound_child_nodes_to_bone)** **(** [int](class_int) bone_idx **)** const - * void **[`clear_bones`](#clear_bones)** **(** **)** - * [Transform](class_transform) **[`get_bone_pose`](#get_bone_pose)** **(** [int](class_int) bone_idx **)** const - * void **[`set_bone_pose`](#set_bone_pose)** **(** [int](class_int) bone_idx, [Transform](class_transform) pose **)** - * [Transform](class_transform) **[`get_bone_custom_pose`](#get_bone_custom_pose)** **(** [int](class_int) bone_idx **)** const - * void **[`set_bone_custom_pose`](#set_bone_custom_pose)** **(** [int](class_int) bone_idx, [Transform](class_transform) custom_pose **)** - * [Transform](class_transform) **[`get_bone_transform`](#get_bone_transform)** **(** [int](class_int) bone_idx **)** const + * void **[add_bone](#add_bone)** **(** [String](class_string) name **)** + * [int](class_int) **[find_bone](#find_bone)** **(** [String](class_string) name **)** const + * [String](class_string) **[get_bone_name](#get_bone_name)** **(** [int](class_int) bone_idx **)** const + * [int](class_int) **[get_bone_parent](#get_bone_parent)** **(** [int](class_int) bone_idx **)** const + * void **[set_bone_parent](#set_bone_parent)** **(** [int](class_int) bone_idx, [int](class_int) parent_idx **)** + * [int](class_int) **[get_bone_count](#get_bone_count)** **(** **)** const + * [Transform](class_transform) **[get_bone_rest](#get_bone_rest)** **(** [int](class_int) bone_idx **)** const + * void **[set_bone_rest](#set_bone_rest)** **(** [int](class_int) bone_idx, [Transform](class_transform) rest **)** + * void **[bind_child_node_to_bone](#bind_child_node_to_bone)** **(** [int](class_int) bone_idx, [Node](class_node) node **)** + * void **[unbind_child_node_from_bone](#unbind_child_node_from_bone)** **(** [int](class_int) bone_idx, [Node](class_node) node **)** + * [Array](class_array) **[get_bound_child_nodes_to_bone](#get_bound_child_nodes_to_bone)** **(** [int](class_int) bone_idx **)** const + * void **[clear_bones](#clear_bones)** **(** **)** + * [Transform](class_transform) **[get_bone_pose](#get_bone_pose)** **(** [int](class_int) bone_idx **)** const + * void **[set_bone_pose](#set_bone_pose)** **(** [int](class_int) bone_idx, [Transform](class_transform) pose **)** + * [Transform](class_transform) **[get_bone_custom_pose](#get_bone_custom_pose)** **(** [int](class_int) bone_idx **)** const + * void **[set_bone_custom_pose](#set_bone_custom_pose)** **(** [int](class_int) bone_idx, [Transform](class_transform) custom_pose **)** + * [Transform](class_transform) **[get_bone_transform](#get_bone_transform)** **(** [int](class_int) bone_idx **)** const ### Numeric Constants * **NOTIFICATION_UPDATE_SKELETON** = **50** @@ -33,71 +33,71 @@ Skeleton provides a hierachial interface for managing bones, including pose, res ### Member Function Description #### add_bone - * void **`add_bone`** **(** [String](class_string) name **)** + * void **add_bone** **(** [String](class_string) name **)** -Add a bone, with name "name". [`get_bone_count`](#get_bone_count) will become the bone index. +Add a bone, with name "name". [get_bone_count](#get_bone_count) will become the bone index. #### find_bone - * [int](class_int) **`find_bone`** **(** [String](class_string) name **)** const + * [int](class_int) **find_bone** **(** [String](class_string) name **)** const Return the bone index that matches "name" as its name. #### get_bone_name - * [String](class_string) **`get_bone_name`** **(** [int](class_int) bone_idx **)** const + * [String](class_string) **get_bone_name** **(** [int](class_int) bone_idx **)** const Return the name of the bone at index "index" #### get_bone_parent - * [int](class_int) **`get_bone_parent`** **(** [int](class_int) bone_idx **)** const + * [int](class_int) **get_bone_parent** **(** [int](class_int) bone_idx **)** const Return the bone index which is the parent of the bone at "bone_idx". If -1, then bone has no parent. Note that the parent bone returned will always be less than "bone_idx". #### set_bone_parent - * void **`set_bone_parent`** **(** [int](class_int) bone_idx, [int](class_int) parent_idx **)** + * void **set_bone_parent** **(** [int](class_int) bone_idx, [int](class_int) parent_idx **)** Set the bone index "parent_idx" as the parent of the bone at "bone_idx". If -1, then bone has no parent. Note: "parent_idx" must be less than "bone_idx". #### get_bone_count - * [int](class_int) **`get_bone_count`** **(** **)** const + * [int](class_int) **get_bone_count** **(** **)** const Return the amount of bones in the skeleton. #### get_bone_rest - * [Transform](class_transform) **`get_bone_rest`** **(** [int](class_int) bone_idx **)** const + * [Transform](class_transform) **get_bone_rest** **(** [int](class_int) bone_idx **)** const Return the rest transform for a bone "bone_idx". #### set_bone_rest - * void **`set_bone_rest`** **(** [int](class_int) bone_idx, [Transform](class_transform) rest **)** + * void **set_bone_rest** **(** [int](class_int) bone_idx, [Transform](class_transform) rest **)** Set the rest transform for bone "bone_idx" #### bind_child_node_to_bone - * void **`bind_child_node_to_bone`** **(** [int](class_int) bone_idx, [Node](class_node) node **)** + * void **bind_child_node_to_bone** **(** [int](class_int) bone_idx, [Node](class_node) node **)** Deprecated soon #### unbind_child_node_from_bone - * void **`unbind_child_node_from_bone`** **(** [int](class_int) bone_idx, [Node](class_node) node **)** + * void **unbind_child_node_from_bone** **(** [int](class_int) bone_idx, [Node](class_node) node **)** Deprecated soon #### get_bound_child_nodes_to_bone - * [Array](class_array) **`get_bound_child_nodes_to_bone`** **(** [int](class_int) bone_idx **)** const + * [Array](class_array) **get_bound_child_nodes_to_bone** **(** [int](class_int) bone_idx **)** const Deprecated Soon #### clear_bones - * void **`clear_bones`** **(** **)** + * void **clear_bones** **(** **)** Clear all the bones in this skeleton. #### get_bone_pose - * [Transform](class_transform) **`get_bone_pose`** **(** [int](class_int) bone_idx **)** const + * [Transform](class_transform) **get_bone_pose** **(** [int](class_int) bone_idx **)** const Return the pose transform for bone "bone_idx". #### set_bone_pose - * void **`set_bone_pose`** **(** [int](class_int) bone_idx, [Transform](class_transform) pose **)** + * void **set_bone_pose** **(** [int](class_int) bone_idx, [Transform](class_transform) pose **)** Return the pose transform for bone "bone_idx". diff --git a/class_slider.md b/class_slider.md index 86a423b..1ab41f6 100644 --- a/class_slider.md +++ b/class_slider.md @@ -6,10 +6,10 @@ Base class for GUI Sliders. ### Member Functions - * void **[`set_ticks`](#set_ticks)** **(** [int](class_int) count **)** - * [int](class_int) **[`get_ticks`](#get_ticks)** **(** **)** const - * [bool](class_bool) **[`get_ticks_on_borders`](#get_ticks_on_borders)** **(** **)** const - * void **[`set_ticks_on_borders`](#set_ticks_on_borders)** **(** [bool](class_bool) ticks_on_border **)** + * void **[set_ticks](#set_ticks)** **(** [int](class_int) count **)** + * [int](class_int) **[get_ticks](#get_ticks)** **(** **)** const + * [bool](class_bool) **[get_ticks_on_borders](#get_ticks_on_borders)** **(** **)** const + * void **[set_ticks_on_borders](#set_ticks_on_borders)** **(** [bool](class_bool) ticks_on_border **)** ### Description Base class for GUI Sliders. @@ -17,21 +17,21 @@ Base class for GUI Sliders. ### Member Function Description #### set_ticks - * void **`set_ticks`** **(** [int](class_int) count **)** + * void **set_ticks** **(** [int](class_int) count **)** Set amount of ticks to display in slider. #### get_ticks - * [int](class_int) **`get_ticks`** **(** **)** const + * [int](class_int) **get_ticks** **(** **)** const Return amounts of ticks to display on slider. #### get_ticks_on_borders - * [bool](class_bool) **`get_ticks_on_borders`** **(** **)** const + * [bool](class_bool) **get_ticks_on_borders** **(** **)** const Return true if ticks are visible on borders. #### set_ticks_on_borders - * void **`set_ticks_on_borders`** **(** [bool](class_bool) ticks_on_border **)** + * void **set_ticks_on_borders** **(** [bool](class_bool) ticks_on_border **)** Set true if ticks are visible on borders. diff --git a/class_soundplayer2d.md b/class_soundplayer2d.md index ceb2536..71dba94 100644 --- a/class_soundplayer2d.md +++ b/class_soundplayer2d.md @@ -6,8 +6,8 @@ Base class for playing spatial 2D sound. ### Member Functions - * void **[`set_param`](#set_param)** **(** [int](class_int) param, [real](class_real) value **)** - * [real](class_real) **[`get_param`](#get_param)** **(** [int](class_int) param **)** const + * void **[set_param](#set_param)** **(** [int](class_int) param, [real](class_real) value **)** + * [real](class_real) **[get_param](#get_param)** **(** [int](class_int) param **)** const ### Numeric Constants * **PARAM_VOLUME_DB** = **0** diff --git a/class_soundroomparams.md b/class_soundroomparams.md index 38b2685..d11408a 100644 --- a/class_soundroomparams.md +++ b/class_soundroomparams.md @@ -6,11 +6,11 @@ ### Member Functions - * void **[`set_param`](#set_param)** **(** [int](class_int) param, [real](class_real) value **)** - * [real](class_real) **[`get_param`](#get_param)** **(** [int](class_int) param **)** const - * void **[`set_reverb_mode`](#set_reverb_mode)** **(** [int](class_int) reverb_mode **)** - * [int](class_int) **[`get_reverb_mode`](#get_reverb_mode)** **(** **)** const - * void **[`set_force_params_to_all_sources`](#set_force_params_to_all_sources)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`is_forcing_params_to_all_sources`](#is_forcing_params_to_all_sources)** **(** **)** + * void **[set_param](#set_param)** **(** [int](class_int) param, [real](class_real) value **)** + * [real](class_real) **[get_param](#get_param)** **(** [int](class_int) param **)** const + * void **[set_reverb_mode](#set_reverb_mode)** **(** [int](class_int) reverb_mode **)** + * [int](class_int) **[get_reverb_mode](#get_reverb_mode)** **(** **)** const + * void **[set_force_params_to_all_sources](#set_force_params_to_all_sources)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[is_forcing_params_to_all_sources](#is_forcing_params_to_all_sources)** **(** **)** ### Member Function Description diff --git a/class_spatial.md b/class_spatial.md index 1533a5d..48933bc 100644 --- a/class_spatial.md +++ b/class_spatial.md @@ -6,24 +6,24 @@ Base class for all 3D nodes. ### Member Functions - * void **[`set_transform`](#set_transform)** **(** [Transform](class_transform) local **)** - * [Transform](class_transform) **[`get_transform`](#get_transform)** **(** **)** const - * void **[`set_translation`](#set_translation)** **(** [Vector3](class_vector3) translation **)** - * [Vector3](class_vector3) **[`get_translation`](#get_translation)** **(** **)** const - * void **[`set_rotation`](#set_rotation)** **(** [Vector3](class_vector3) rotation **)** - * [Vector3](class_vector3) **[`get_rotation`](#get_rotation)** **(** **)** const - * void **[`set_scale`](#set_scale)** **(** [Vector3](class_vector3) scale **)** - * [Vector3](class_vector3) **[`get_scale`](#get_scale)** **(** **)** const - * void **[`set_global_transform`](#set_global_transform)** **(** [Transform](class_transform) global **)** - * [Transform](class_transform) **[`get_global_transform`](#get_global_transform)** **(** **)** const - * [Object](class_object) **[`get_parent_spatial`](#get_parent_spatial)** **(** **)** const - * void **[`set_ignore_transform_notification`](#set_ignore_transform_notification)** **(** [bool](class_bool) enabled **)** - * void **[`set_as_toplevel`](#set_as_toplevel)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_set_as_toplevel`](#is_set_as_toplevel)** **(** **)** const - * [World](class_world) **[`get_world`](#get_world)** **(** **)** const - * void **[`update_gizmo`](#update_gizmo)** **(** **)** - * void **[`set_gizmo`](#set_gizmo)** **(** SpatialGizmo gizmo **)** - * SpatialGizmo **[`get_gizmo`](#get_gizmo)** **(** **)** const + * void **[set_transform](#set_transform)** **(** [Transform](class_transform) local **)** + * [Transform](class_transform) **[get_transform](#get_transform)** **(** **)** const + * void **[set_translation](#set_translation)** **(** [Vector3](class_vector3) translation **)** + * [Vector3](class_vector3) **[get_translation](#get_translation)** **(** **)** const + * void **[set_rotation](#set_rotation)** **(** [Vector3](class_vector3) rotation **)** + * [Vector3](class_vector3) **[get_rotation](#get_rotation)** **(** **)** const + * void **[set_scale](#set_scale)** **(** [Vector3](class_vector3) scale **)** + * [Vector3](class_vector3) **[get_scale](#get_scale)** **(** **)** const + * void **[set_global_transform](#set_global_transform)** **(** [Transform](class_transform) global **)** + * [Transform](class_transform) **[get_global_transform](#get_global_transform)** **(** **)** const + * [Object](class_object) **[get_parent_spatial](#get_parent_spatial)** **(** **)** const + * void **[set_ignore_transform_notification](#set_ignore_transform_notification)** **(** [bool](class_bool) enabled **)** + * void **[set_as_toplevel](#set_as_toplevel)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_set_as_toplevel](#is_set_as_toplevel)** **(** **)** const + * [World](class_world) **[get_world](#get_world)** **(** **)** const + * void **[update_gizmo](#update_gizmo)** **(** **)** + * void **[set_gizmo](#set_gizmo)** **(** SpatialGizmo gizmo **)** + * SpatialGizmo **[get_gizmo](#get_gizmo)** **(** **)** const ### Numeric Constants * **NOTIFICATION_TRANSFORM_CHANGED** = **29** - Spatial nodes receive this notifacation with their global transform changes. This means that either the current or a parent node changed it's transform. @@ -36,26 +36,26 @@ Spatial is the base for every type of 3D [Node](class_node). It contains a 3D [T ### Member Function Description #### set_transform - * void **`set_transform`** **(** [Transform](class_transform) local **)** + * void **set_transform** **(** [Transform](class_transform) local **)** Set the transform locally, relative to the parent spatial node. #### get_transform - * [Transform](class_transform) **`get_transform`** **(** **)** const + * [Transform](class_transform) **get_transform** **(** **)** const Return the local transform, relative to the bone parent. #### set_global_transform - * void **`set_global_transform`** **(** [Transform](class_transform) global **)** + * void **set_global_transform** **(** [Transform](class_transform) global **)** Set the transform globally, relative to worldspace. #### get_global_transform - * [Transform](class_transform) **`get_global_transform`** **(** **)** const + * [Transform](class_transform) **get_global_transform** **(** **)** const Return the gloal transform, relative to worldspace. #### get_parent_spatial - * [Object](class_object) **`get_parent_spatial`** **(** **)** const + * [Object](class_object) **get_parent_spatial** **(** **)** const Return the parent [Spatial](class_spatial), or an empty [Object](class_object) if no parent exists or parent is not of type [Spatial. diff --git a/class_spatialplayer.md b/class_spatialplayer.md index 559adbe..03fe5e4 100644 --- a/class_spatialplayer.md +++ b/class_spatialplayer.md @@ -6,8 +6,8 @@ ### Member Functions - * void **[`set_param`](#set_param)** **(** [int](class_int) param, [real](class_real) value **)** - * [real](class_real) **[`get_param`](#get_param)** **(** [int](class_int) param **)** const + * void **[set_param](#set_param)** **(** [int](class_int) param, [real](class_real) value **)** + * [real](class_real) **[get_param](#get_param)** **(** [int](class_int) param **)** const ### Numeric Constants * **PARAM_VOLUME_DB** = **0** diff --git a/class_spatialsampleplayer.md b/class_spatialsampleplayer.md index 060272c..42bf4d5 100644 --- a/class_spatialsampleplayer.md +++ b/class_spatialsampleplayer.md @@ -6,16 +6,16 @@ ### Member Functions - * void **[`set_sample_library`](#set_sample_library)** **(** [SampleLibrary](class_samplelibrary) library **)** - * [SampleLibrary](class_samplelibrary) **[`get_sample_library`](#get_sample_library)** **(** **)** const - * void **[`set_polyphony`](#set_polyphony)** **(** [int](class_int) voices **)** - * [int](class_int) **[`get_polyphony`](#get_polyphony)** **(** **)** const - * [int](class_int) **[`play`](#play)** **(** [String](class_string) sample, [int](class_int) voice=-2 **)** - * void **[`voice_set_pitch_scale`](#voice_set_pitch_scale)** **(** [int](class_int) voice, [real](class_real) ratio **)** - * void **[`voice_set_volume_scale_db`](#voice_set_volume_scale_db)** **(** [int](class_int) voice, [real](class_real) db **)** - * [bool](class_bool) **[`is_voice_active`](#is_voice_active)** **(** [int](class_int) voice **)** const - * void **[`stop_voice`](#stop_voice)** **(** [int](class_int) voice **)** - * void **[`stop_all`](#stop_all)** **(** **)** + * void **[set_sample_library](#set_sample_library)** **(** [SampleLibrary](class_samplelibrary) library **)** + * [SampleLibrary](class_samplelibrary) **[get_sample_library](#get_sample_library)** **(** **)** const + * void **[set_polyphony](#set_polyphony)** **(** [int](class_int) voices **)** + * [int](class_int) **[get_polyphony](#get_polyphony)** **(** **)** const + * [int](class_int) **[play](#play)** **(** [String](class_string) sample, [int](class_int) voice=-2 **)** + * void **[voice_set_pitch_scale](#voice_set_pitch_scale)** **(** [int](class_int) voice, [real](class_real) ratio **)** + * void **[voice_set_volume_scale_db](#voice_set_volume_scale_db)** **(** [int](class_int) voice, [real](class_real) db **)** + * [bool](class_bool) **[is_voice_active](#is_voice_active)** **(** [int](class_int) voice **)** const + * void **[stop_voice](#stop_voice)** **(** [int](class_int) voice **)** + * void **[stop_all](#stop_all)** **(** **)** ### Numeric Constants * **INVALID_VOICE** = **-1** diff --git a/class_spatialstreamplayer.md b/class_spatialstreamplayer.md index 9457780..cb3a474 100644 --- a/class_spatialstreamplayer.md +++ b/class_spatialstreamplayer.md @@ -6,16 +6,16 @@ ### Member Functions - * void **[`set_stream`](#set_stream)** **(** Stream stream **)** - * Stream **[`get_stream`](#get_stream)** **(** **)** const - * void **[`play`](#play)** **(** **)** - * void **[`stop`](#stop)** **(** **)** - * [bool](class_bool) **[`is_playing`](#is_playing)** **(** **)** const - * void **[`set_loop`](#set_loop)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`has_loop`](#has_loop)** **(** **)** const - * [String](class_string) **[`get_stream_name`](#get_stream_name)** **(** **)** const - * [int](class_int) **[`get_loop_count`](#get_loop_count)** **(** **)** const - * [real](class_real) **[`get_pos`](#get_pos)** **(** **)** const - * void **[`seek_pos`](#seek_pos)** **(** [real](class_real) time **)** + * void **[set_stream](#set_stream)** **(** Stream stream **)** + * Stream **[get_stream](#get_stream)** **(** **)** const + * void **[play](#play)** **(** **)** + * void **[stop](#stop)** **(** **)** + * [bool](class_bool) **[is_playing](#is_playing)** **(** **)** const + * void **[set_loop](#set_loop)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[has_loop](#has_loop)** **(** **)** const + * [String](class_string) **[get_stream_name](#get_stream_name)** **(** **)** const + * [int](class_int) **[get_loop_count](#get_loop_count)** **(** **)** const + * [real](class_real) **[get_pos](#get_pos)** **(** **)** const + * void **[seek_pos](#seek_pos)** **(** [real](class_real) time **)** ### Member Function Description diff --git a/class_sphereshape.md b/class_sphereshape.md index 68080a8..02efb31 100644 --- a/class_sphereshape.md +++ b/class_sphereshape.md @@ -6,7 +6,7 @@ ### Member Functions - * void **[`set_radius`](#set_radius)** **(** [real](class_real) radius **)** - * [real](class_real) **[`get_radius`](#get_radius)** **(** **)** const + * void **[set_radius](#set_radius)** **(** [real](class_real) radius **)** + * [real](class_real) **[get_radius](#get_radius)** **(** **)** const ### Member Function Description diff --git a/class_spinbox.md b/class_spinbox.md index 10e5c4c..658b7e9 100644 --- a/class_spinbox.md +++ b/class_spinbox.md @@ -6,13 +6,13 @@ Numerical input text field. ### Member Functions - * void **[`set_suffix`](#set_suffix)** **(** [String](class_string) suffix **)** - * [String](class_string) **[`get_suffix`](#get_suffix)** **(** **)** const - * void **[`set_prefix`](#set_prefix)** **(** [String](class_string) prefix **)** - * [String](class_string) **[`get_prefix`](#get_prefix)** **(** **)** const - * void **[`set_editable`](#set_editable)** **(** [bool](class_bool) editable **)** - * [bool](class_bool) **[`is_editable`](#is_editable)** **(** **)** const - * [Object](class_object) **[`get_line_edit`](#get_line_edit)** **(** **)** + * void **[set_suffix](#set_suffix)** **(** [String](class_string) suffix **)** + * [String](class_string) **[get_suffix](#get_suffix)** **(** **)** const + * void **[set_prefix](#set_prefix)** **(** [String](class_string) prefix **)** + * [String](class_string) **[get_prefix](#get_prefix)** **(** **)** const + * void **[set_editable](#set_editable)** **(** [bool](class_bool) editable **)** + * [bool](class_bool) **[is_editable](#is_editable)** **(** **)** const + * [Object](class_object) **[get_line_edit](#get_line_edit)** **(** **)** ### Description SpinBox is a numerical input text field. It allows entering integers and floats. @@ -20,26 +20,26 @@ SpinBox is a numerical input text field. It allows entering integers and floats. ### Member Function Description #### set_suffix - * void **`set_suffix`** **(** [String](class_string) suffix **)** + * void **set_suffix** **(** [String](class_string) suffix **)** Set a specific suffix. #### get_suffix - * [String](class_string) **`get_suffix`** **(** **)** const + * [String](class_string) **get_suffix** **(** **)** const Return the specific suffix. #### set_prefix - * void **`set_prefix`** **(** [String](class_string) prefix **)** + * void **set_prefix** **(** [String](class_string) prefix **)** Set a prefix. #### set_editable - * void **`set_editable`** **(** [bool](class_bool) editable **)** + * void **set_editable** **(** [bool](class_bool) editable **)** Set whether the spinbox is editable. #### is_editable - * [bool](class_bool) **`is_editable`** **(** **)** const + * [bool](class_bool) **is_editable** **(** **)** const Return if the spinbox is editable. diff --git a/class_splitcontainer.md b/class_splitcontainer.md index c2bd532..366e247 100644 --- a/class_splitcontainer.md +++ b/class_splitcontainer.md @@ -6,12 +6,12 @@ Container for splitting and adjusting. ### Member Functions - * void **[`set_split_offset`](#set_split_offset)** **(** [int](class_int) offset **)** - * [int](class_int) **[`get_split_offset`](#get_split_offset)** **(** **)** const - * void **[`set_collapsed`](#set_collapsed)** **(** [bool](class_bool) collapsed **)** - * [bool](class_bool) **[`is_collapsed`](#is_collapsed)** **(** **)** const - * void **[`set_dragger_visible`](#set_dragger_visible)** **(** [bool](class_bool) visible **)** - * [bool](class_bool) **[`is_dragger_visible`](#is_dragger_visible)** **(** **)** const + * void **[set_split_offset](#set_split_offset)** **(** [int](class_int) offset **)** + * [int](class_int) **[get_split_offset](#get_split_offset)** **(** **)** const + * void **[set_collapsed](#set_collapsed)** **(** [bool](class_bool) collapsed **)** + * [bool](class_bool) **[is_collapsed](#is_collapsed)** **(** **)** const + * void **[set_dragger_visible](#set_dragger_visible)** **(** [bool](class_bool) visible **)** + * [bool](class_bool) **[is_dragger_visible](#is_dragger_visible)** **(** **)** const ### Description Container for splitting two controls vertically or horizontally, with a grabber that allows adjusting the split offset or ratio. @@ -19,21 +19,21 @@ Container for splitting two controls vertically or horizontally, with a grabber ### Member Function Description #### set_split_offset - * void **`set_split_offset`** **(** [int](class_int) offset **)** + * void **set_split_offset** **(** [int](class_int) offset **)** Set the split offset. #### get_split_offset - * [int](class_int) **`get_split_offset`** **(** **)** const + * [int](class_int) **get_split_offset** **(** **)** const Return the spluit offset; #### set_collapsed - * void **`set_collapsed`** **(** [bool](class_bool) collapsed **)** + * void **set_collapsed** **(** [bool](class_bool) collapsed **)** Set if the split must be collapsed. #### is_collapsed - * [bool](class_bool) **`is_collapsed`** **(** **)** const + * [bool](class_bool) **is_collapsed** **(** **)** const Return if the split is collapsed; diff --git a/class_sprite.md b/class_sprite.md index 0dc949a..46e918e 100644 --- a/class_sprite.md +++ b/class_sprite.md @@ -6,28 +6,28 @@ General purpose Sprite node. ### Member Functions - * void **[`set_texture`](#set_texture)** **(** [Texture](class_texture) texture **)** - * [Texture](class_texture) **[`get_texture`](#get_texture)** **(** **)** const - * void **[`set_centered`](#set_centered)** **(** [bool](class_bool) centered **)** - * [bool](class_bool) **[`is_centered`](#is_centered)** **(** **)** const - * void **[`set_offset`](#set_offset)** **(** [Vector2](class_vector2) offset **)** - * [Vector2](class_vector2) **[`get_offset`](#get_offset)** **(** **)** const - * void **[`set_flip_h`](#set_flip_h)** **(** [bool](class_bool) flip_h **)** - * [bool](class_bool) **[`is_flipped_h`](#is_flipped_h)** **(** **)** const - * void **[`set_flip_v`](#set_flip_v)** **(** [bool](class_bool) flip_v **)** - * [bool](class_bool) **[`is_flipped_v`](#is_flipped_v)** **(** **)** const - * void **[`set_region`](#set_region)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`is_region`](#is_region)** **(** **)** const - * void **[`set_region_rect`](#set_region_rect)** **(** [Rect2](class_rect2) rect **)** - * [Rect2](class_rect2) **[`get_region_rect`](#get_region_rect)** **(** **)** const - * void **[`set_frame`](#set_frame)** **(** [int](class_int) frame **)** - * [int](class_int) **[`get_frame`](#get_frame)** **(** **)** const - * void **[`set_vframes`](#set_vframes)** **(** [int](class_int) vframes **)** - * [int](class_int) **[`get_vframes`](#get_vframes)** **(** **)** const - * void **[`set_hframes`](#set_hframes)** **(** [int](class_int) hframes **)** - * [int](class_int) **[`get_hframes`](#get_hframes)** **(** **)** const - * void **[`set_modulate`](#set_modulate)** **(** [Color](class_color) modulate **)** - * [Color](class_color) **[`get_modulate`](#get_modulate)** **(** **)** const + * void **[set_texture](#set_texture)** **(** [Texture](class_texture) texture **)** + * [Texture](class_texture) **[get_texture](#get_texture)** **(** **)** const + * void **[set_centered](#set_centered)** **(** [bool](class_bool) centered **)** + * [bool](class_bool) **[is_centered](#is_centered)** **(** **)** const + * void **[set_offset](#set_offset)** **(** [Vector2](class_vector2) offset **)** + * [Vector2](class_vector2) **[get_offset](#get_offset)** **(** **)** const + * void **[set_flip_h](#set_flip_h)** **(** [bool](class_bool) flip_h **)** + * [bool](class_bool) **[is_flipped_h](#is_flipped_h)** **(** **)** const + * void **[set_flip_v](#set_flip_v)** **(** [bool](class_bool) flip_v **)** + * [bool](class_bool) **[is_flipped_v](#is_flipped_v)** **(** **)** const + * void **[set_region](#set_region)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[is_region](#is_region)** **(** **)** const + * void **[set_region_rect](#set_region_rect)** **(** [Rect2](class_rect2) rect **)** + * [Rect2](class_rect2) **[get_region_rect](#get_region_rect)** **(** **)** const + * void **[set_frame](#set_frame)** **(** [int](class_int) frame **)** + * [int](class_int) **[get_frame](#get_frame)** **(** **)** const + * void **[set_vframes](#set_vframes)** **(** [int](class_int) vframes **)** + * [int](class_int) **[get_vframes](#get_vframes)** **(** **)** const + * void **[set_hframes](#set_hframes)** **(** [int](class_int) hframes **)** + * [int](class_int) **[get_hframes](#get_hframes)** **(** **)** const + * void **[set_modulate](#set_modulate)** **(** [Color](class_color) modulate **)** + * [Color](class_color) **[get_modulate](#get_modulate)** **(** **)** const ### Description General purpose Sprite node. This Sprite node can show any texture as a sprite. The texture can be used as a spritesheet for animation, or only a region from a bigger texture can referenced, like an atlas. @@ -35,111 +35,111 @@ General purpose Sprite node. This Sprite node can show any texture as a sprite. ### Member Function Description #### set_texture - * void **`set_texture`** **(** [Texture](class_texture) texture **)** + * void **set_texture** **(** [Texture](class_texture) texture **)** Set the base texture for the sprite. #### get_texture - * [Texture](class_texture) **`get_texture`** **(** **)** const + * [Texture](class_texture) **get_texture** **(** **)** const Return the base texture for the sprite. #### set_centered - * void **`set_centered`** **(** [bool](class_bool) centered **)** + * void **set_centered** **(** [bool](class_bool) centered **)** Set whether the sprite should be centered on the origin. #### is_centered - * [bool](class_bool) **`is_centered`** **(** **)** const + * [bool](class_bool) **is_centered** **(** **)** const Return if the sprite is centered at the local origin. #### set_offset - * void **`set_offset`** **(** [Vector2](class_vector2) offset **)** + * void **set_offset** **(** [Vector2](class_vector2) offset **)** Set the sprite draw offset, useful for setting rotation pivots. #### get_offset - * [Vector2](class_vector2) **`get_offset`** **(** **)** const + * [Vector2](class_vector2) **get_offset** **(** **)** const Return sprite draw offst. #### set_flip_h - * void **`set_flip_h`** **(** [bool](class_bool) flip_h **)** + * void **set_flip_h** **(** [bool](class_bool) flip_h **)** Set true to flip the sprite horizontaly. #### is_flipped_h - * [bool](class_bool) **`is_flipped_h`** **(** **)** const + * [bool](class_bool) **is_flipped_h** **(** **)** const Return true if the sprite is flipped horizontally. #### set_flip_v - * void **`set_flip_v`** **(** [bool](class_bool) flip_v **)** + * void **set_flip_v** **(** [bool](class_bool) flip_v **)** Set true to flip the sprite vertically. #### is_flipped_v - * [bool](class_bool) **`is_flipped_v`** **(** **)** const + * [bool](class_bool) **is_flipped_v** **(** **)** const Return true if the sprite is flipped vertically. #### set_region - * void **`set_region`** **(** [bool](class_bool) enabled **)** + * void **set_region** **(** [bool](class_bool) enabled **)** Set the sprite as a sub-region of a bigger texture. Useful for texture-atlases. #### is_region - * [bool](class_bool) **`is_region`** **(** **)** const + * [bool](class_bool) **is_region** **(** **)** const Return if the sprite reads from a region. #### set_region_rect - * void **`set_region_rect`** **(** [Rect2](class_rect2) rect **)** + * void **set_region_rect** **(** [Rect2](class_rect2) rect **)** Set the region rect to read from. #### get_region_rect - * [Rect2](class_rect2) **`get_region_rect`** **(** **)** const + * [Rect2](class_rect2) **get_region_rect** **(** **)** const Return the region rect to read from. #### set_frame - * void **`set_frame`** **(** [int](class_int) frame **)** + * void **set_frame** **(** [int](class_int) frame **)** Set the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1. #### get_frame - * [int](class_int) **`get_frame`** **(** **)** const + * [int](class_int) **get_frame** **(** **)** const Return the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1. #### set_vframes - * void **`set_vframes`** **(** [int](class_int) vframes **)** + * void **set_vframes** **(** [int](class_int) vframes **)** Set the amount of vertical frames and converts the sprite into a sprite-sheet. This is useful for animation. #### get_vframes - * [int](class_int) **`get_vframes`** **(** **)** const + * [int](class_int) **get_vframes** **(** **)** const Return the amount of vertical frames. See [set_vframes]. #### set_hframes - * void **`set_hframes`** **(** [int](class_int) hframes **)** + * void **set_hframes** **(** [int](class_int) hframes **)** Set the amount of horizontal frames and converts the sprite into a sprite-sheet. This is useful for animation. #### get_hframes - * [int](class_int) **`get_hframes`** **(** **)** const + * [int](class_int) **get_hframes** **(** **)** const Return the amount of horizontal frames. See [set_hframes]. #### set_modulate - * void **`set_modulate`** **(** [Color](class_color) modulate **)** + * void **set_modulate** **(** [Color](class_color) modulate **)** Set color modulation for the sprite. All sprite pixels are multiplied by this color. #### get_modulate - * [Color](class_color) **`get_modulate`** **(** **)** const + * [Color](class_color) **get_modulate** **(** **)** const Return color modulation for the sprite. All sprite pixels are multiplied by this color. diff --git a/class_spriteframes.md b/class_spriteframes.md index cc12f5b..2482825 100644 --- a/class_spriteframes.md +++ b/class_spriteframes.md @@ -6,12 +6,12 @@ Sprite frame library for AnimatedSprite. ### Member Functions - * void **[`add_frame`](#add_frame)** **(** [Object](class_object) frame, [int](class_int) atpos=-1 **)** - * [int](class_int) **[`get_frame_count`](#get_frame_count)** **(** **)** const - * [Object](class_object) **[`get_frame`](#get_frame)** **(** [int](class_int) idx **)** const - * void **[`set_frame`](#set_frame)** **(** [int](class_int) idx, [Object](class_object) txt **)** - * void **[`remove_frame`](#remove_frame)** **(** [int](class_int) idx **)** - * void **[`clear`](#clear)** **(** **)** + * void **[add_frame](#add_frame)** **(** [Object](class_object) frame, [int](class_int) atpos=-1 **)** + * [int](class_int) **[get_frame_count](#get_frame_count)** **(** **)** const + * [Object](class_object) **[get_frame](#get_frame)** **(** [int](class_int) idx **)** const + * void **[set_frame](#set_frame)** **(** [int](class_int) idx, [Object](class_object) txt **)** + * void **[remove_frame](#remove_frame)** **(** [int](class_int) idx **)** + * void **[clear](#clear)** **(** **)** ### Description Sprite frame library for [AnimatedSprite](class_animatedsprite). @@ -19,26 +19,26 @@ Sprite frame library for [AnimatedSprite](class_animatedsprite). ### Member Function Description #### add_frame - * void **`add_frame`** **(** [Object](class_object) frame, [int](class_int) atpos=-1 **)** + * void **add_frame** **(** [Object](class_object) frame, [int](class_int) atpos=-1 **)** Add a frame (texture). #### get_frame_count - * [int](class_int) **`get_frame_count`** **(** **)** const + * [int](class_int) **get_frame_count** **(** **)** const Return the amount of frames. #### get_frame - * [Object](class_object) **`get_frame`** **(** [int](class_int) idx **)** const + * [Object](class_object) **get_frame** **(** [int](class_int) idx **)** const Return a texture (frame). #### remove_frame - * void **`remove_frame`** **(** [int](class_int) idx **)** + * void **remove_frame** **(** [int](class_int) idx **)** Remove a frame #### clear - * void **`clear`** **(** **)** + * void **clear** **(** **)** Clear the frames. diff --git a/class_staticbody.md b/class_staticbody.md index 53a1b56..d8e43e6 100644 --- a/class_staticbody.md +++ b/class_staticbody.md @@ -6,12 +6,12 @@ PhysicsBody for static collision objects. ### Member Functions - * void **[`set_simulate_motion`](#set_simulate_motion)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`is_simulating_motion`](#is_simulating_motion)** **(** **)** const - * void **[`set_constant_linear_velocity`](#set_constant_linear_velocity)** **(** [Vector3](class_vector3) vel **)** - * void **[`set_constant_angular_velocity`](#set_constant_angular_velocity)** **(** [Vector3](class_vector3) vel **)** - * [Vector3](class_vector3) **[`get_constant_linear_velocity`](#get_constant_linear_velocity)** **(** **)** const - * [Vector3](class_vector3) **[`get_constant_angular_velocity`](#get_constant_angular_velocity)** **(** **)** const + * void **[set_simulate_motion](#set_simulate_motion)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[is_simulating_motion](#is_simulating_motion)** **(** **)** const + * void **[set_constant_linear_velocity](#set_constant_linear_velocity)** **(** [Vector3](class_vector3) vel **)** + * void **[set_constant_angular_velocity](#set_constant_angular_velocity)** **(** [Vector3](class_vector3) vel **)** + * [Vector3](class_vector3) **[get_constant_linear_velocity](#get_constant_linear_velocity)** **(** **)** const + * [Vector3](class_vector3) **[get_constant_angular_velocity](#get_constant_angular_velocity)** **(** **)** const ### Description StaticBody implements a static collision [Node](class_node), by utilizing a rigid body in the [PhysicsServer](class_physicsserver). Static bodies are used for static collision. For more information on physics body nodes, see [PhysicsBody](class_physicsbody). diff --git a/class_staticbody2d.md b/class_staticbody2d.md index e8ead4f..a451485 100644 --- a/class_staticbody2d.md +++ b/class_staticbody2d.md @@ -6,16 +6,16 @@ Static body for 2D Physics. ### Member Functions - * void **[`set_simulate_motion`](#set_simulate_motion)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`is_simulating_motion`](#is_simulating_motion)** **(** **)** const - * void **[`set_constant_linear_velocity`](#set_constant_linear_velocity)** **(** [Vector2](class_vector2) vel **)** - * void **[`set_constant_angular_velocity`](#set_constant_angular_velocity)** **(** [real](class_real) vel **)** - * [Vector2](class_vector2) **[`get_constant_linear_velocity`](#get_constant_linear_velocity)** **(** **)** const - * [real](class_real) **[`get_constant_angular_velocity`](#get_constant_angular_velocity)** **(** **)** const - * void **[`set_friction`](#set_friction)** **(** [real](class_real) friction **)** - * [real](class_real) **[`get_friction`](#get_friction)** **(** **)** const - * void **[`set_bounce`](#set_bounce)** **(** [real](class_real) bounce **)** - * [real](class_real) **[`get_bounce`](#get_bounce)** **(** **)** const + * void **[set_simulate_motion](#set_simulate_motion)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[is_simulating_motion](#is_simulating_motion)** **(** **)** const + * void **[set_constant_linear_velocity](#set_constant_linear_velocity)** **(** [Vector2](class_vector2) vel **)** + * void **[set_constant_angular_velocity](#set_constant_angular_velocity)** **(** [real](class_real) vel **)** + * [Vector2](class_vector2) **[get_constant_linear_velocity](#get_constant_linear_velocity)** **(** **)** const + * [real](class_real) **[get_constant_angular_velocity](#get_constant_angular_velocity)** **(** **)** const + * void **[set_friction](#set_friction)** **(** [real](class_real) friction **)** + * [real](class_real) **[get_friction](#get_friction)** **(** **)** const + * void **[set_bounce](#set_bounce)** **(** [real](class_real) bounce **)** + * [real](class_real) **[get_bounce](#get_bounce)** **(** **)** const ### Description Static body for 2D Physics. A static body is a simple body that is not intended to move. They don't consume any CPU resources in contrast to a [RigidBody2D](class_rigidbody2d) so they are great for scenaro collision. @@ -26,31 +26,31 @@ Static body for 2D Physics. A static body is a simple body that is not intended ### Member Function Description #### set_simulate_motion - * void **`set_simulate_motion`** **(** [bool](class_bool) enabled **)** + * void **set_simulate_motion** **(** [bool](class_bool) enabled **)** Enable or disable simulated motion mode. #### is_simulating_motion - * [bool](class_bool) **`is_simulating_motion`** **(** **)** const + * [bool](class_bool) **is_simulating_motion** **(** **)** const Return true if simulated motion mode is enabled. #### set_constant_linear_velocity - * void **`set_constant_linear_velocity`** **(** [Vector2](class_vector2) vel **)** + * void **set_constant_linear_velocity** **(** [Vector2](class_vector2) vel **)** Set a constant linear velocity for the body. #### set_constant_angular_velocity - * void **`set_constant_angular_velocity`** **(** [real](class_real) vel **)** + * void **set_constant_angular_velocity** **(** [real](class_real) vel **)** Set a constant angular velocity for the body. #### get_constant_linear_velocity - * [Vector2](class_vector2) **`get_constant_linear_velocity`** **(** **)** const + * [Vector2](class_vector2) **get_constant_linear_velocity** **(** **)** const Return the constant linear velocity for the body. #### get_constant_angular_velocity - * [real](class_real) **`get_constant_angular_velocity`** **(** **)** const + * [real](class_real) **get_constant_angular_velocity** **(** **)** const Return the constant angular velocity for the body. diff --git a/class_streampeer.md b/class_streampeer.md index 95518e5..196007f 100644 --- a/class_streampeer.md +++ b/class_streampeer.md @@ -6,10 +6,10 @@ Abstraction and base class for stream-based protocols. ### Member Functions - * [int](class_int) **[`put_data`](#put_data)** **(** [RawArray](class_rawarray) data **)** - * [Array](class_array) **[`put_partial_data`](#put_partial_data)** **(** [RawArray](class_rawarray) data **)** - * [Array](class_array) **[`get_data`](#get_data)** **(** [int](class_int) bytes **)** - * [Array](class_array) **[`get_partial_data`](#get_partial_data)** **(** [int](class_int) bytes **)** + * [int](class_int) **[put_data](#put_data)** **(** [RawArray](class_rawarray) data **)** + * [Array](class_array) **[put_partial_data](#put_partial_data)** **(** [RawArray](class_rawarray) data **)** + * [Array](class_array) **[get_data](#get_data)** **(** [int](class_int) bytes **)** + * [Array](class_array) **[get_partial_data](#get_partial_data)** **(** [int](class_int) bytes **)** ### Description StreamPeer is an abstration and base class for stream-based protocols (such as TCP or Unix Sockets). It provides an API for sending and receiving data through streams as raw data or strings. @@ -17,21 +17,21 @@ StreamPeer is an abstration and base class for stream-based protocols (such as T ### Member Function Description #### put_data - * [int](class_int) **`put_data`** **(** [RawArray](class_rawarray) data **)** + * [int](class_int) **put_data** **(** [RawArray](class_rawarray) data **)** Send a chunk of data through the connection, blocking if necesary until the data is done sending. This function returns an [Error] code. #### put_partial_data - * [Array](class_array) **`put_partial_data`** **(** [RawArray](class_rawarray) data **)** + * [Array](class_array) **put_partial_data** **(** [RawArray](class_rawarray) data **)** Send a chunk of data through the connection, if all the data could not be sent at once, only part of it will. This function returns two values, an [Error] code and an integer, describing how much data was actually sent. #### get_data - * [Array](class_array) **`get_data`** **(** [int](class_int) bytes **)** + * [Array](class_array) **get_data** **(** [int](class_int) bytes **)** Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an [Error] code and a data array. #### get_partial_data - * [Array](class_array) **`get_partial_data`** **(** [int](class_int) bytes **)** + * [Array](class_array) **get_partial_data** **(** [int](class_int) bytes **)** Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an [Error] code, and a data array. diff --git a/class_streampeertcp.md b/class_streampeertcp.md index 3731515..f1b88ac 100644 --- a/class_streampeertcp.md +++ b/class_streampeertcp.md @@ -6,11 +6,11 @@ TCP Stream peer. ### Member Functions - * [int](class_int) **[`connect`](#connect)** **(** [String](class_string) host, [int](class_int) ip **)** - * [bool](class_bool) **[`is_connected`](#is_connected)** **(** **)** const - * [String](class_string) **[`get_connected_host`](#get_connected_host)** **(** **)** const - * [int](class_int) **[`get_connected_port`](#get_connected_port)** **(** **)** const - * void **[`disconnect`](#disconnect)** **(** **)** + * [int](class_int) **[connect](#connect)** **(** [String](class_string) host, [int](class_int) ip **)** + * [bool](class_bool) **[is_connected](#is_connected)** **(** **)** const + * [String](class_string) **[get_connected_host](#get_connected_host)** **(** **)** const + * [int](class_int) **[get_connected_port](#get_connected_port)** **(** **)** const + * void **[disconnect](#disconnect)** **(** **)** ### Description TCP Stream peer. This object can be used to connect to TCP servers, or also is returned by a tcp server. diff --git a/class_streamplayer.md b/class_streamplayer.md index 5c79f55..18a81a2 100644 --- a/class_streamplayer.md +++ b/class_streamplayer.md @@ -6,26 +6,26 @@ Base class for audio stream playback. ### Member Functions - * void **[`set_stream`](#set_stream)** **(** Stream stream **)** - * Stream **[`get_stream`](#get_stream)** **(** **)** const - * void **[`play`](#play)** **(** **)** - * void **[`stop`](#stop)** **(** **)** - * [bool](class_bool) **[`is_playing`](#is_playing)** **(** **)** const - * void **[`set_paused`](#set_paused)** **(** [bool](class_bool) paused **)** - * [bool](class_bool) **[`is_paused`](#is_paused)** **(** **)** const - * void **[`set_loop`](#set_loop)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`has_loop`](#has_loop)** **(** **)** const - * void **[`set_volume`](#set_volume)** **(** [real](class_real) volume **)** - * [real](class_real) **[`get_volume`](#get_volume)** **(** **)** const - * void **[`set_volume_db`](#set_volume_db)** **(** [real](class_real) db **)** - * [real](class_real) **[`get_volume_db`](#get_volume_db)** **(** **)** const - * [String](class_string) **[`get_stream_name`](#get_stream_name)** **(** **)** const - * [int](class_int) **[`get_loop_count`](#get_loop_count)** **(** **)** const - * [real](class_real) **[`get_pos`](#get_pos)** **(** **)** const - * void **[`seek_pos`](#seek_pos)** **(** [real](class_real) time **)** - * void **[`set_autoplay`](#set_autoplay)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`has_autoplay`](#has_autoplay)** **(** **)** const - * [real](class_real) **[`get_length`](#get_length)** **(** **)** const + * void **[set_stream](#set_stream)** **(** Stream stream **)** + * Stream **[get_stream](#get_stream)** **(** **)** const + * void **[play](#play)** **(** **)** + * void **[stop](#stop)** **(** **)** + * [bool](class_bool) **[is_playing](#is_playing)** **(** **)** const + * void **[set_paused](#set_paused)** **(** [bool](class_bool) paused **)** + * [bool](class_bool) **[is_paused](#is_paused)** **(** **)** const + * void **[set_loop](#set_loop)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[has_loop](#has_loop)** **(** **)** const + * void **[set_volume](#set_volume)** **(** [real](class_real) volume **)** + * [real](class_real) **[get_volume](#get_volume)** **(** **)** const + * void **[set_volume_db](#set_volume_db)** **(** [real](class_real) db **)** + * [real](class_real) **[get_volume_db](#get_volume_db)** **(** **)** const + * [String](class_string) **[get_stream_name](#get_stream_name)** **(** **)** const + * [int](class_int) **[get_loop_count](#get_loop_count)** **(** **)** const + * [real](class_real) **[get_pos](#get_pos)** **(** **)** const + * void **[seek_pos](#seek_pos)** **(** [real](class_real) time **)** + * void **[set_autoplay](#set_autoplay)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[has_autoplay](#has_autoplay)** **(** **)** const + * [real](class_real) **[get_length](#get_length)** **(** **)** const ### Description Base class for audio stream playback. Audio stream players inherit from it. diff --git a/class_string.md b/class_string.md index f636cb5..16bdfcf 100644 --- a/class_string.md +++ b/class_string.md @@ -5,53 +5,53 @@ Built-In string class. ### Member Functions - * [String](class_string) **[`basename`](#basename)** **(** **)** - * [bool](class_bool) **[`begins_with`](#begins_with)** **(** [String](class_string) text **)** - * [String](class_string) **[`capitalize`](#capitalize)** **(** **)** - * [int](class_int) **[`casecmp_to`](#casecmp_to)** **(** [String](class_string) to **)** - * [bool](class_bool) **[`empty`](#empty)** **(** **)** - * [String](class_string) **[`extension`](#extension)** **(** **)** - * [int](class_int) **[`find`](#find)** **(** [String](class_string) what, [int](class_int) from=0 **)** - * [int](class_int) **[`find_last`](#find_last)** **(** [String](class_string) what **)** - * [int](class_int) **[`findn`](#findn)** **(** [String](class_string) what, [int](class_int) from=0 **)** - * [String](class_string) **[`get_base_dir`](#get_base_dir)** **(** **)** - * [String](class_string) **[`get_file`](#get_file)** **(** **)** - * [int](class_int) **[`hash`](#hash)** **(** **)** - * [int](class_int) **[`hex_to_int`](#hex_to_int)** **(** **)** - * [String](class_string) **[`insert`](#insert)** **(** [int](class_int) pos, [String](class_string) what **)** - * [bool](class_bool) **[`is_abs_path`](#is_abs_path)** **(** **)** - * [bool](class_bool) **[`is_rel_path`](#is_rel_path)** **(** **)** - * [bool](class_bool) **[`is_valid_float`](#is_valid_float)** **(** **)** - * [bool](class_bool) **[`is_valid_html_color`](#is_valid_html_color)** **(** **)** - * [bool](class_bool) **[`is_valid_identifier`](#is_valid_identifier)** **(** **)** - * [bool](class_bool) **[`is_valid_integer`](#is_valid_integer)** **(** **)** - * [bool](class_bool) **[`is_valid_ip_address`](#is_valid_ip_address)** **(** **)** - * [String](class_string) **[`left`](#left)** **(** [int](class_int) pos **)** - * [int](class_int) **[`length`](#length)** **(** **)** - * [bool](class_bool) **[`match`](#match)** **(** [String](class_string) expr **)** - * [bool](class_bool) **[`matchn`](#matchn)** **(** [String](class_string) expr **)** - * [int](class_int) **[`nocasecmp_to`](#nocasecmp_to)** **(** [String](class_string) to **)** - * [String](class_string) **[`ord_at`](#ord_at)** **(** [int](class_int) at **)** - * [String](class_string) **[`pad_decimals`](#pad_decimals)** **(** [int](class_int) digits **)** - * [String](class_string) **[`pad_zeros`](#pad_zeros)** **(** [int](class_int) digits **)** - * [String](class_string) **[`percent_decode`](#percent_decode)** **(** **)** - * [String](class_string) **[`percent_encode`](#percent_encode)** **(** **)** - * [String](class_string) **[`plus_file`](#plus_file)** **(** [String](class_string) file **)** - * [String](class_string) **[`replace`](#replace)** **(** [String](class_string) what, [String](class_string) forwhat **)** - * [String](class_string) **[`replacen`](#replacen)** **(** [String](class_string) what, [String](class_string) forwhat **)** - * [int](class_int) **[`rfind`](#rfind)** **(** [String](class_string) what, [int](class_int) from=-1 **)** - * [int](class_int) **[`rfindn`](#rfindn)** **(** [String](class_string) what, [int](class_int) from=-1 **)** - * [String](class_string) **[`right`](#right)** **(** [int](class_int) pos **)** - * [StringArray](class_stringarray) **[`split`](#split)** **(** [String](class_string) divisor, [bool](class_bool) allow_empty=True **)** - * [RealArray](class_realarray) **[`split_floats`](#split_floats)** **(** [String](class_string) divisor, [bool](class_bool) allow_empty=True **)** - * [String](class_string) **[`strip_edges`](#strip_edges)** **(** **)** - * [String](class_string) **[`substr`](#substr)** **(** [int](class_int) from, [int](class_int) len **)** - * [real](class_real) **[`to_float`](#to_float)** **(** **)** - * [int](class_int) **[`to_int`](#to_int)** **(** **)** - * [String](class_string) **[`to_lower`](#to_lower)** **(** **)** - * [String](class_string) **[`to_upper`](#to_upper)** **(** **)** - * [String](class_string) **[`xml_escape`](#xml_escape)** **(** **)** - * [String](class_string) **[`xml_unescape`](#xml_unescape)** **(** **)** + * [String](class_string) **[basename](#basename)** **(** **)** + * [bool](class_bool) **[begins_with](#begins_with)** **(** [String](class_string) text **)** + * [String](class_string) **[capitalize](#capitalize)** **(** **)** + * [int](class_int) **[casecmp_to](#casecmp_to)** **(** [String](class_string) to **)** + * [bool](class_bool) **[empty](#empty)** **(** **)** + * [String](class_string) **[extension](#extension)** **(** **)** + * [int](class_int) **[find](#find)** **(** [String](class_string) what, [int](class_int) from=0 **)** + * [int](class_int) **[find_last](#find_last)** **(** [String](class_string) what **)** + * [int](class_int) **[findn](#findn)** **(** [String](class_string) what, [int](class_int) from=0 **)** + * [String](class_string) **[get_base_dir](#get_base_dir)** **(** **)** + * [String](class_string) **[get_file](#get_file)** **(** **)** + * [int](class_int) **[hash](#hash)** **(** **)** + * [int](class_int) **[hex_to_int](#hex_to_int)** **(** **)** + * [String](class_string) **[insert](#insert)** **(** [int](class_int) pos, [String](class_string) what **)** + * [bool](class_bool) **[is_abs_path](#is_abs_path)** **(** **)** + * [bool](class_bool) **[is_rel_path](#is_rel_path)** **(** **)** + * [bool](class_bool) **[is_valid_float](#is_valid_float)** **(** **)** + * [bool](class_bool) **[is_valid_html_color](#is_valid_html_color)** **(** **)** + * [bool](class_bool) **[is_valid_identifier](#is_valid_identifier)** **(** **)** + * [bool](class_bool) **[is_valid_integer](#is_valid_integer)** **(** **)** + * [bool](class_bool) **[is_valid_ip_address](#is_valid_ip_address)** **(** **)** + * [String](class_string) **[left](#left)** **(** [int](class_int) pos **)** + * [int](class_int) **[length](#length)** **(** **)** + * [bool](class_bool) **[match](#match)** **(** [String](class_string) expr **)** + * [bool](class_bool) **[matchn](#matchn)** **(** [String](class_string) expr **)** + * [int](class_int) **[nocasecmp_to](#nocasecmp_to)** **(** [String](class_string) to **)** + * [String](class_string) **[ord_at](#ord_at)** **(** [int](class_int) at **)** + * [String](class_string) **[pad_decimals](#pad_decimals)** **(** [int](class_int) digits **)** + * [String](class_string) **[pad_zeros](#pad_zeros)** **(** [int](class_int) digits **)** + * [String](class_string) **[percent_decode](#percent_decode)** **(** **)** + * [String](class_string) **[percent_encode](#percent_encode)** **(** **)** + * [String](class_string) **[plus_file](#plus_file)** **(** [String](class_string) file **)** + * [String](class_string) **[replace](#replace)** **(** [String](class_string) what, [String](class_string) forwhat **)** + * [String](class_string) **[replacen](#replacen)** **(** [String](class_string) what, [String](class_string) forwhat **)** + * [int](class_int) **[rfind](#rfind)** **(** [String](class_string) what, [int](class_int) from=-1 **)** + * [int](class_int) **[rfindn](#rfindn)** **(** [String](class_string) what, [int](class_int) from=-1 **)** + * [String](class_string) **[right](#right)** **(** [int](class_int) pos **)** + * [StringArray](class_stringarray) **[split](#split)** **(** [String](class_string) divisor, [bool](class_bool) allow_empty=True **)** + * [RealArray](class_realarray) **[split_floats](#split_floats)** **(** [String](class_string) divisor, [bool](class_bool) allow_empty=True **)** + * [String](class_string) **[strip_edges](#strip_edges)** **(** **)** + * [String](class_string) **[substr](#substr)** **(** [int](class_int) from, [int](class_int) len **)** + * [real](class_real) **[to_float](#to_float)** **(** **)** + * [int](class_int) **[to_int](#to_int)** **(** **)** + * [String](class_string) **[to_lower](#to_lower)** **(** **)** + * [String](class_string) **[to_upper](#to_upper)** **(** **)** + * [String](class_string) **[xml_escape](#xml_escape)** **(** **)** + * [String](class_string) **[xml_unescape](#xml_unescape)** **(** **)** ### Description This is the built in string class (and the one used by GDScript). It supports Unicode and provides all necesary means for string handling. Strings are reference counted and use a copy-on-write approach, so passing them around is cheap in resources. @@ -59,161 +59,161 @@ This is the built in string class (and the one used by GDScript). It supports Un ### Member Function Description #### basename - * [String](class_string) **`basename`** **(** **)** + * [String](class_string) **basename** **(** **)** If the string is a path to a file, return the path to the file without the extension. #### begins_with - * [bool](class_bool) **`begins_with`** **(** [String](class_string) text **)** + * [bool](class_bool) **begins_with** **(** [String](class_string) text **)** Return true if the strings begins with the given string. #### capitalize - * [String](class_string) **`capitalize`** **(** **)** + * [String](class_string) **capitalize** **(** **)** Return the string in uppercase. #### casecmp_to - * [int](class_int) **`casecmp_to`** **(** [String](class_string) to **)** + * [int](class_int) **casecmp_to** **(** [String](class_string) to **)** Perform a case-sensitive comparison to antoher string, return -1 if less, 0 if equal and +1 if greater. #### empty - * [bool](class_bool) **`empty`** **(** **)** + * [bool](class_bool) **empty** **(** **)** Return true if the string is empty. #### extension - * [String](class_string) **`extension`** **(** **)** + * [String](class_string) **extension** **(** **)** If the string is a path to a file, return the extension. #### find - * [int](class_int) **`find`** **(** [String](class_string) what, [int](class_int) from=0 **)** + * [int](class_int) **find** **(** [String](class_string) what, [int](class_int) from=0 **)** Find the first occurence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. #### find_last - * [int](class_int) **`find_last`** **(** [String](class_string) what **)** + * [int](class_int) **find_last** **(** [String](class_string) what **)** Find the last occurence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. #### findn - * [int](class_int) **`findn`** **(** [String](class_string) what, [int](class_int) from=0 **)** + * [int](class_int) **findn** **(** [String](class_string) what, [int](class_int) from=0 **)** Find the first occurence of a substring but search as case-insensitive, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. #### get_base_dir - * [String](class_string) **`get_base_dir`** **(** **)** + * [String](class_string) **get_base_dir** **(** **)** If the string is a path to a file, return the base directory. #### get_file - * [String](class_string) **`get_file`** **(** **)** + * [String](class_string) **get_file** **(** **)** If the string is a path to a file, return the file and ignore the base directory. #### hash - * [int](class_int) **`hash`** **(** **)** + * [int](class_int) **hash** **(** **)** Hash the string and return a 32 bits integer. #### insert - * [String](class_string) **`insert`** **(** [int](class_int) pos, [String](class_string) what **)** + * [String](class_string) **insert** **(** [int](class_int) pos, [String](class_string) what **)** Insert a substring at a given position. #### is_abs_path - * [bool](class_bool) **`is_abs_path`** **(** **)** + * [bool](class_bool) **is_abs_path** **(** **)** If the string is a path to a file or directory, return true if the path is absolute. #### is_rel_path - * [bool](class_bool) **`is_rel_path`** **(** **)** + * [bool](class_bool) **is_rel_path** **(** **)** If the string is a path to a file or directory, return true if the path is relative. #### left - * [String](class_string) **`left`** **(** [int](class_int) pos **)** + * [String](class_string) **left** **(** [int](class_int) pos **)** Return an amount of characters from the left of the string. #### length - * [int](class_int) **`length`** **(** **)** + * [int](class_int) **length** **(** **)** Return the length of the string in characters. #### match - * [bool](class_bool) **`match`** **(** [String](class_string) expr **)** + * [bool](class_bool) **match** **(** [String](class_string) expr **)** Do a simple expression matching, using ? and * wildcards. #### matchn - * [bool](class_bool) **`matchn`** **(** [String](class_string) expr **)** + * [bool](class_bool) **matchn** **(** [String](class_string) expr **)** Do a simple, case insensitive, expression matching, using ? and * wildcards. #### nocasecmp_to - * [int](class_int) **`nocasecmp_to`** **(** [String](class_string) to **)** + * [int](class_int) **nocasecmp_to** **(** [String](class_string) to **)** Perform a case-insensitive comparison to antoher string, return -1 if less, 0 if equal and +1 if greater. #### replace - * [String](class_string) **`replace`** **(** [String](class_string) what, [String](class_string) forwhat **)** + * [String](class_string) **replace** **(** [String](class_string) what, [String](class_string) forwhat **)** Replace occurrences of a substring for different ones inside the string. #### replacen - * [String](class_string) **`replacen`** **(** [String](class_string) what, [String](class_string) forwhat **)** + * [String](class_string) **replacen** **(** [String](class_string) what, [String](class_string) forwhat **)** Replace occurrences of a substring for different ones inside the string, but search case-insensitive. #### rfind - * [int](class_int) **`rfind`** **(** [String](class_string) what, [int](class_int) from=-1 **)** + * [int](class_int) **rfind** **(** [String](class_string) what, [int](class_int) from=-1 **)** Perform a search for a substring, but start from the end of the string instead of the begining. #### rfindn - * [int](class_int) **`rfindn`** **(** [String](class_string) what, [int](class_int) from=-1 **)** + * [int](class_int) **rfindn** **(** [String](class_string) what, [int](class_int) from=-1 **)** Perform a search for a substring, but start from the end of the string instead of the begining. Also search case-insensitive. #### right - * [String](class_string) **`right`** **(** [int](class_int) pos **)** + * [String](class_string) **right** **(** [int](class_int) pos **)** Return the right side of the string from a given position. #### split - * [StringArray](class_stringarray) **`split`** **(** [String](class_string) divisor, [bool](class_bool) allow_empty=True **)** + * [StringArray](class_stringarray) **split** **(** [String](class_string) divisor, [bool](class_bool) allow_empty=True **)** Split the string by a divisor string, return an array of the substrings. Example "One,Two,Three" will return ["One","Two","Three"] if split by ",". #### split_floats - * [RealArray](class_realarray) **`split_floats`** **(** [String](class_string) divisor, [bool](class_bool) allow_empty=True **)** + * [RealArray](class_realarray) **split_floats** **(** [String](class_string) divisor, [bool](class_bool) allow_empty=True **)** Split the string in floats by using a divisor string, return an array of the substrings. Example "1,2.5,3" will return [1,2.5,3] if split by ",". #### strip_edges - * [String](class_string) **`strip_edges`** **(** **)** + * [String](class_string) **strip_edges** **(** **)** Return a copy of the string stripped of any non-printable character at the begining and the end. #### to_lower - * [String](class_string) **`to_lower`** **(** **)** + * [String](class_string) **to_lower** **(** **)** Return the string converted to lowercase. #### to_upper - * [String](class_string) **`to_upper`** **(** **)** + * [String](class_string) **to_upper** **(** **)** Return the string converted to uppercase. #### xml_escape - * [String](class_string) **`xml_escape`** **(** **)** + * [String](class_string) **xml_escape** **(** **)** Perform XML escaping on the string. #### xml_unescape - * [String](class_string) **`xml_unescape`** **(** **)** + * [String](class_string) **xml_unescape** **(** **)** Perform XML un-escaping of the string. diff --git a/class_stringarray.md b/class_stringarray.md index 5ba4da8..7eb4dba 100644 --- a/class_stringarray.md +++ b/class_stringarray.md @@ -5,12 +5,12 @@ String Array . ### Member Functions - * [String](class_string) **[`get`](#get)** **(** [int](class_int) idx **)** - * void **[`push_back`](#push_back)** **(** [String](class_string) string **)** - * void **[`resize`](#resize)** **(** [int](class_int) idx **)** - * void **[`set`](#set)** **(** [int](class_int) idx, [String](class_string) string **)** - * [int](class_int) **[`size`](#size)** **(** **)** - * void **[`StringArray`](#StringArray)** **(** [Array](class_array) from **)** + * [String](class_string) **[get](#get)** **(** [int](class_int) idx **)** + * void **[push_back](#push_back)** **(** [String](class_string) string **)** + * void **[resize](#resize)** **(** [int](class_int) idx **)** + * void **[set](#set)** **(** [int](class_int) idx, [String](class_string) string **)** + * [int](class_int) **[size](#size)** **(** **)** + * void **[StringArray](#StringArray)** **(** [Array](class_array) from **)** ### Description String Array. Array of strings. Can only contain strings. Optimized for memory usage, cant fragment the memory. diff --git a/class_stylebox.md b/class_stylebox.md index bc9f05f..3076bc1 100644 --- a/class_stylebox.md +++ b/class_stylebox.md @@ -6,14 +6,14 @@ Base class for dawing stylized boxes for the UI. ### Member Functions - * [bool](class_bool) **[`test_mask`](#test_mask)** **(** [Vector2](class_vector2) point, [Rect2](class_rect2) rect **)** const - * void **[`set_default_margin`](#set_default_margin)** **(** [int](class_int) margin, [real](class_real) offset **)** - * [real](class_real) **[`get_default_margin`](#get_default_margin)** **(** [int](class_int) margin **)** const - * [real](class_real) **[`get_margin`](#get_margin)** **(** [int](class_int) margin **)** const - * [Vector2](class_vector2) **[`get_minimum_size`](#get_minimum_size)** **(** **)** const - * [Vector2](class_vector2) **[`get_center_size`](#get_center_size)** **(** **)** const - * [Vector2](class_vector2) **[`get_offset`](#get_offset)** **(** **)** const - * void **[`draw`](#draw)** **(** [RID](class_rid) arg0, [Rect2](class_rect2) arg1 **)** const + * [bool](class_bool) **[test_mask](#test_mask)** **(** [Vector2](class_vector2) point, [Rect2](class_rect2) rect **)** const + * void **[set_default_margin](#set_default_margin)** **(** [int](class_int) margin, [real](class_real) offset **)** + * [real](class_real) **[get_default_margin](#get_default_margin)** **(** [int](class_int) margin **)** const + * [real](class_real) **[get_margin](#get_margin)** **(** [int](class_int) margin **)** const + * [Vector2](class_vector2) **[get_minimum_size](#get_minimum_size)** **(** **)** const + * [Vector2](class_vector2) **[get_center_size](#get_center_size)** **(** **)** const + * [Vector2](class_vector2) **[get_offset](#get_offset)** **(** **)** const + * void **[draw](#draw)** **(** [RID](class_rid) arg0, [Rect2](class_rect2) arg1 **)** const ### Description StyleBox is [Resource](class_resource) that provides an abstract base class for dawing stylized boxes for the UI. StyleBoxes are used for dawing the styles of buttons, line edit backgrounds, tree backgrounds, etc. and also for testing a transparency mask for pointer signals. If mask test fails on a StyleBox assigned as mask to a control, clicks and motion signals will go through it to the one below. @@ -21,31 +21,31 @@ StyleBox is [Resource](class_resource) that provides an abstract base class for ### Member Function Description #### test_mask - * [bool](class_bool) **`test_mask`** **(** [Vector2](class_vector2) point, [Rect2](class_rect2) rect **)** const + * [bool](class_bool) **test_mask** **(** [Vector2](class_vector2) point, [Rect2](class_rect2) rect **)** const Test a position in a rectangle, return wether it pases the mask test. #### set_default_margin - * void **`set_default_margin`** **(** [int](class_int) margin, [real](class_real) offset **)** + * void **set_default_margin** **(** [int](class_int) margin, [real](class_real) offset **)** Set the default offset "offset" of the margin "margin" (see MARGIN_* enum) for a StyleBox, Controls that draw styleboxes with context inside need to know the margin, so the border of the stylebox is not occluded. #### get_default_margin - * [real](class_real) **`get_default_margin`** **(** [int](class_int) margin **)** const + * [real](class_real) **get_default_margin** **(** [int](class_int) margin **)** const Return the default offset of the margin "margin" (see MARGIN_* enum) of a StyleBox, Controls that draw styleboxes with context inside need to know the margin, so the border of the stylebox is not occluded. #### get_margin - * [real](class_real) **`get_margin`** **(** [int](class_int) margin **)** const + * [real](class_real) **get_margin** **(** [int](class_int) margin **)** const Return the offset of margin "margin" (see MARGIN_* enum). #### get_minimum_size - * [Vector2](class_vector2) **`get_minimum_size`** **(** **)** const + * [Vector2](class_vector2) **get_minimum_size** **(** **)** const Return the minimum size that this stylebox can be shrunk to. #### get_offset - * [Vector2](class_vector2) **`get_offset`** **(** **)** const + * [Vector2](class_vector2) **get_offset** **(** **)** const Return the "offset" of a stylebox, this is a helper function, like writing Point2( style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP) ) diff --git a/class_styleboxflat.md b/class_styleboxflat.md index fd1383a..7d87570 100644 --- a/class_styleboxflat.md +++ b/class_styleboxflat.md @@ -6,18 +6,18 @@ Stylebox of a single color. ### Member Functions - * void **[`set_bg_color`](#set_bg_color)** **(** [Color](class_color) color **)** - * [Color](class_color) **[`get_bg_color`](#get_bg_color)** **(** **)** const - * void **[`set_light_color`](#set_light_color)** **(** [Color](class_color) color **)** - * [Color](class_color) **[`get_light_color`](#get_light_color)** **(** **)** const - * void **[`set_dark_color`](#set_dark_color)** **(** [Color](class_color) color **)** - * [Color](class_color) **[`get_dark_color`](#get_dark_color)** **(** **)** const - * void **[`set_border_size`](#set_border_size)** **(** [int](class_int) size **)** - * [int](class_int) **[`get_border_size`](#get_border_size)** **(** **)** const - * void **[`set_border_blend`](#set_border_blend)** **(** [bool](class_bool) blend **)** - * [bool](class_bool) **[`get_border_blend`](#get_border_blend)** **(** **)** const - * void **[`set_draw_center`](#set_draw_center)** **(** [bool](class_bool) size **)** - * [bool](class_bool) **[`get_draw_center`](#get_draw_center)** **(** **)** const + * void **[set_bg_color](#set_bg_color)** **(** [Color](class_color) color **)** + * [Color](class_color) **[get_bg_color](#get_bg_color)** **(** **)** const + * void **[set_light_color](#set_light_color)** **(** [Color](class_color) color **)** + * [Color](class_color) **[get_light_color](#get_light_color)** **(** **)** const + * void **[set_dark_color](#set_dark_color)** **(** [Color](class_color) color **)** + * [Color](class_color) **[get_dark_color](#get_dark_color)** **(** **)** const + * void **[set_border_size](#set_border_size)** **(** [int](class_int) size **)** + * [int](class_int) **[get_border_size](#get_border_size)** **(** **)** const + * void **[set_border_blend](#set_border_blend)** **(** [bool](class_bool) blend **)** + * [bool](class_bool) **[get_border_blend](#get_border_blend)** **(** **)** const + * void **[set_draw_center](#set_draw_center)** **(** [bool](class_bool) size **)** + * [bool](class_bool) **[get_draw_center](#get_draw_center)** **(** **)** const ### Description Stylebox of a single color. Displays the stylebox of a single color, alternatively a border with light/dark colors can be assigned. diff --git a/class_styleboximagemask.md b/class_styleboximagemask.md index b2de50e..872fe1b 100644 --- a/class_styleboximagemask.md +++ b/class_styleboximagemask.md @@ -6,12 +6,12 @@ Image mask based StyleBox, for mask test. ### Member Functions - * void **[`set_image`](#set_image)** **(** [Image](class_image) image **)** - * [Image](class_image) **[`get_image`](#get_image)** **(** **)** const - * void **[`set_expand`](#set_expand)** **(** [bool](class_bool) expand **)** - * [bool](class_bool) **[`get_expand`](#get_expand)** **(** **)** const - * void **[`set_expand_margin_size`](#set_expand_margin_size)** **(** [int](class_int) margin, [real](class_real) size **)** - * [real](class_real) **[`get_expand_margin_size`](#get_expand_margin_size)** **(** [int](class_int) arg0 **)** const + * void **[set_image](#set_image)** **(** [Image](class_image) image **)** + * [Image](class_image) **[get_image](#get_image)** **(** **)** const + * void **[set_expand](#set_expand)** **(** [bool](class_bool) expand **)** + * [bool](class_bool) **[get_expand](#get_expand)** **(** **)** const + * void **[set_expand_margin_size](#set_expand_margin_size)** **(** [int](class_int) margin, [real](class_real) size **)** + * [real](class_real) **[get_expand_margin_size](#get_expand_margin_size)** **(** [int](class_int) arg0 **)** const ### Description This StyleBox is similar to [StyleBoxTexture](class_styleboxtexture), but only meant to be used for mask testing. It takes an image and applies stretch rules to determine if the poit clicked is masked or not. @@ -19,31 +19,31 @@ This StyleBox is similar to [StyleBoxTexture](class_styleboxtexture), but only m ### Member Function Description #### set_image - * void **`set_image`** **(** [Image](class_image) image **)** + * void **set_image** **(** [Image](class_image) image **)** Set the image used for mask testing. Pixels (converted to grey) that have a value, less than 0.5 will fail the test. #### get_image - * [Image](class_image) **`get_image`** **(** **)** const + * [Image](class_image) **get_image** **(** **)** const -Return the image used for mask testing. (see [`set_imag`](#set_imag)). +Return the image used for mask testing. (see [set_imag](#set_imag)). #### set_expand - * void **`set_expand`** **(** [bool](class_bool) expand **)** + * void **set_expand** **(** [bool](class_bool) expand **)** Set the expand property (default). When expanding, the image will use the same rules as [StyleBoxTexture](class_styleboxtexture) for expand. If not expanding, the image will always be tested at its original size. #### get_expand - * [bool](class_bool) **`get_expand`** **(** **)** const + * [bool](class_bool) **get_expand** **(** **)** const Return wether the expand property is set(default). When expanding, the image will use the same rules as [StyleBoxTexture](class_styleboxtexture) for expand. If not expanding, the image will always be tested at its original size. #### set_expand_margin_size - * void **`set_expand_margin_size`** **(** [int](class_int) margin, [real](class_real) size **)** + * void **set_expand_margin_size** **(** [int](class_int) margin, [real](class_real) size **)** Set an expand margin size (from enum MARGIN_*). Parts of the image below the size of the margin (and in the direction of the margin) will not expand. #### get_expand_margin_size - * [real](class_real) **`get_expand_margin_size`** **(** [int](class_int) arg0 **)** const + * [real](class_real) **get_expand_margin_size** **(** [int](class_int) arg0 **)** const Return the expand margin size (from enum MARGIN_*). Parts of the image below the size of the margin (and in the direction of the margin) will not expand. diff --git a/class_styleboxtexture.md b/class_styleboxtexture.md index 3db10cd..75ef09e 100644 --- a/class_styleboxtexture.md +++ b/class_styleboxtexture.md @@ -6,14 +6,14 @@ Texture Based 3x3 scale style. ### Member Functions - * void **[`set_texture`](#set_texture)** **(** [Texture](class_texture) texture **)** - * [Texture](class_texture) **[`get_texture`](#get_texture)** **(** **)** const - * void **[`set_margin_size`](#set_margin_size)** **(** [int](class_int) margin, [real](class_real) size **)** - * [real](class_real) **[`get_margin_size`](#get_margin_size)** **(** [int](class_int) arg0 **)** const - * void **[`set_expand_margin_size`](#set_expand_margin_size)** **(** [int](class_int) margin, [real](class_real) size **)** - * [real](class_real) **[`get_expand_margin_size`](#get_expand_margin_size)** **(** [int](class_int) arg0 **)** const - * void **[`set_draw_center`](#set_draw_center)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`get_draw_center`](#get_draw_center)** **(** **)** const + * void **[set_texture](#set_texture)** **(** [Texture](class_texture) texture **)** + * [Texture](class_texture) **[get_texture](#get_texture)** **(** **)** const + * void **[set_margin_size](#set_margin_size)** **(** [int](class_int) margin, [real](class_real) size **)** + * [real](class_real) **[get_margin_size](#get_margin_size)** **(** [int](class_int) arg0 **)** const + * void **[set_expand_margin_size](#set_expand_margin_size)** **(** [int](class_int) margin, [real](class_real) size **)** + * [real](class_real) **[get_expand_margin_size](#get_expand_margin_size)** **(** [int](class_int) arg0 **)** const + * void **[set_draw_center](#set_draw_center)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[get_draw_center](#get_draw_center)** **(** **)** const ### Description Texture Based 3x3 scale style. This stylebox performs a 3x3 scaling of a texture, where only the center cell is fully stretched. This allows for the easy creation of bordered styles. diff --git a/class_surfacetool.md b/class_surfacetool.md index e9da601..969023f 100644 --- a/class_surfacetool.md +++ b/class_surfacetool.md @@ -6,23 +6,23 @@ Helper tool to create geometry. ### Member Functions - * void **[`begin`](#begin)** **(** [int](class_int) primitive **)** - * void **[`add_vertex`](#add_vertex)** **(** [Vector3](class_vector3) vertex **)** - * void **[`add_color`](#add_color)** **(** [Color](class_color) color **)** - * void **[`add_normal`](#add_normal)** **(** [Vector3](class_vector3) normal **)** - * void **[`add_tangent`](#add_tangent)** **(** [Plane](class_plane) tangent **)** - * void **[`add_uv`](#add_uv)** **(** [Vector2](class_vector2) uv **)** - * void **[`add_uv2`](#add_uv2)** **(** [Vector2](class_vector2) uv2 **)** - * void **[`add_bones`](#add_bones)** **(** [IntArray](class_intarray) bones **)** - * void **[`add_weights`](#add_weights)** **(** [RealArray](class_realarray) weights **)** - * void **[`set_material`](#set_material)** **(** [Material](class_material) material **)** - * void **[`index`](#index)** **(** **)** - * void **[`deindex`](#deindex)** **(** **)** - * void **[`generate_flat_normals`](#generate_flat_normals)** **(** **)** - * void **[`generate_smooth_normals`](#generate_smooth_normals)** **(** **)** - * void **[`generate_tangents`](#generate_tangents)** **(** **)** - * [Mesh](class_mesh) **[`commit`](#commit)** **(** [Mesh](class_mesh) existing=Object() **)** - * void **[`clear`](#clear)** **(** **)** + * void **[begin](#begin)** **(** [int](class_int) primitive **)** + * void **[add_vertex](#add_vertex)** **(** [Vector3](class_vector3) vertex **)** + * void **[add_color](#add_color)** **(** [Color](class_color) color **)** + * void **[add_normal](#add_normal)** **(** [Vector3](class_vector3) normal **)** + * void **[add_tangent](#add_tangent)** **(** [Plane](class_plane) tangent **)** + * void **[add_uv](#add_uv)** **(** [Vector2](class_vector2) uv **)** + * void **[add_uv2](#add_uv2)** **(** [Vector2](class_vector2) uv2 **)** + * void **[add_bones](#add_bones)** **(** [IntArray](class_intarray) bones **)** + * void **[add_weights](#add_weights)** **(** [RealArray](class_realarray) weights **)** + * void **[set_material](#set_material)** **(** [Material](class_material) material **)** + * void **[index](#index)** **(** **)** + * void **[deindex](#deindex)** **(** **)** + * void **[generate_flat_normals](#generate_flat_normals)** **(** **)** + * void **[generate_smooth_normals](#generate_smooth_normals)** **(** **)** + * void **[generate_tangents](#generate_tangents)** **(** **)** + * [Mesh](class_mesh) **[commit](#commit)** **(** [Mesh](class_mesh) existing=Object() **)** + * void **[clear](#clear)** **(** **)** ### Description Helper tool to create geometry. diff --git a/class_tabcontainer.md b/class_tabcontainer.md index 3d15a82..cbdfe62 100644 --- a/class_tabcontainer.md +++ b/class_tabcontainer.md @@ -6,20 +6,20 @@ Tabbed Container. ### Member Functions - * [int](class_int) **[`get_tab_count`](#get_tab_count)** **(** **)** const - * void **[`set_current_tab`](#set_current_tab)** **(** [int](class_int) tab_idx **)** - * [int](class_int) **[`get_current_tab`](#get_current_tab)** **(** **)** const - * void **[`set_tab_align`](#set_tab_align)** **(** [int](class_int) align **)** - * [int](class_int) **[`get_tab_align`](#get_tab_align)** **(** **)** const - * void **[`set_tabs_visible`](#set_tabs_visible)** **(** [bool](class_bool) visible **)** - * [bool](class_bool) **[`are_tabs_visible`](#are_tabs_visible)** **(** **)** const - * void **[`set_tab_title`](#set_tab_title)** **(** [int](class_int) tab_idx, [String](class_string) title **)** - * [String](class_string) **[`get_tab_title`](#get_tab_title)** **(** [int](class_int) tab_idx **)** const - * void **[`set_tab_icon`](#set_tab_icon)** **(** [int](class_int) tab_idx, [Texture](class_texture) icon **)** - * [Texture](class_texture) **[`get_tab_icon`](#get_tab_icon)** **(** [int](class_int) tab_idx **)** const + * [int](class_int) **[get_tab_count](#get_tab_count)** **(** **)** const + * void **[set_current_tab](#set_current_tab)** **(** [int](class_int) tab_idx **)** + * [int](class_int) **[get_current_tab](#get_current_tab)** **(** **)** const + * void **[set_tab_align](#set_tab_align)** **(** [int](class_int) align **)** + * [int](class_int) **[get_tab_align](#get_tab_align)** **(** **)** const + * void **[set_tabs_visible](#set_tabs_visible)** **(** [bool](class_bool) visible **)** + * [bool](class_bool) **[are_tabs_visible](#are_tabs_visible)** **(** **)** const + * void **[set_tab_title](#set_tab_title)** **(** [int](class_int) tab_idx, [String](class_string) title **)** + * [String](class_string) **[get_tab_title](#get_tab_title)** **(** [int](class_int) tab_idx **)** const + * void **[set_tab_icon](#set_tab_icon)** **(** [int](class_int) tab_idx, [Texture](class_texture) icon **)** + * [Texture](class_texture) **[get_tab_icon](#get_tab_icon)** **(** [int](class_int) tab_idx **)** const ### Signals - * **`tab_changed`** **(** [int](class_int) tab **)** + * **tab_changed** **(** [int](class_int) tab **)** ### Description Tabbed Container. Contains several children controls, but shows only one at the same time. Clicking ont he top tabs allows to change the current visible one. @@ -29,51 +29,51 @@ Tabbed Container. Contains several children controls, but shows only one at the ### Member Function Description #### get_tab_count - * [int](class_int) **`get_tab_count`** **(** **)** const + * [int](class_int) **get_tab_count** **(** **)** const Return the amount of tabs. #### set_current_tab - * void **`set_current_tab`** **(** [int](class_int) tab_idx **)** + * void **set_current_tab** **(** [int](class_int) tab_idx **)** Bring a tab (and the Control it represents) to the front, and hide the rest. #### get_current_tab - * [int](class_int) **`get_current_tab`** **(** **)** const + * [int](class_int) **get_current_tab** **(** **)** const Return the current tab that is being showed. #### set_tab_align - * void **`set_tab_align`** **(** [int](class_int) align **)** + * void **set_tab_align** **(** [int](class_int) align **)** Set tab alignment, from the ALIGN_* enum. Moves tabs to the left, right or center. #### get_tab_align - * [int](class_int) **`get_tab_align`** **(** **)** const + * [int](class_int) **get_tab_align** **(** **)** const Return tab alignment, from the ALIGN_* enum #### set_tabs_visible - * void **`set_tabs_visible`** **(** [bool](class_bool) visible **)** + * void **set_tabs_visible** **(** [bool](class_bool) visible **)** Set whether the tabs should be visible or hidden. #### are_tabs_visible - * [bool](class_bool) **`are_tabs_visible`** **(** **)** const + * [bool](class_bool) **are_tabs_visible** **(** **)** const Return whether the tabs should be visible or hidden. #### set_tab_title - * void **`set_tab_title`** **(** [int](class_int) tab_idx, [String](class_string) title **)** + * void **set_tab_title** **(** [int](class_int) tab_idx, [String](class_string) title **)** Set a title for the tab. Tab titles are by default the children node name, but this can be overriden. #### get_tab_title - * [String](class_string) **`get_tab_title`** **(** [int](class_int) tab_idx **)** const + * [String](class_string) **get_tab_title** **(** [int](class_int) tab_idx **)** const Return the title for the tab. Tab titles are by default the children node name, but this can be overriden. #### set_tab_icon - * void **`set_tab_icon`** **(** [int](class_int) tab_idx, [Texture](class_texture) icon **)** + * void **set_tab_icon** **(** [int](class_int) tab_idx, [Texture](class_texture) icon **)** Set an icon for a tab. diff --git a/class_tabs.md b/class_tabs.md index e7635d6..1762a92 100644 --- a/class_tabs.md +++ b/class_tabs.md @@ -6,17 +6,17 @@ Tabs Control. ### Member Functions - * [int](class_int) **[`get_tab_count`](#get_tab_count)** **(** **)** const - * void **[`set_current_tab`](#set_current_tab)** **(** [int](class_int) tab_idx **)** - * [int](class_int) **[`get_current_tab`](#get_current_tab)** **(** **)** const - * void **[`set_tab_title`](#set_tab_title)** **(** [int](class_int) tab_idx, [String](class_string) title **)** - * [String](class_string) **[`get_tab_title`](#get_tab_title)** **(** [int](class_int) tab_idx **)** const - * void **[`set_tab_icon`](#set_tab_icon)** **(** [int](class_int) tab_idx, [Texture](class_texture) icon **)** - * [Texture](class_texture) **[`get_tab_icon`](#get_tab_icon)** **(** [int](class_int) tab_idx **)** const - * void **[`remove_tab`](#remove_tab)** **(** [int](class_int) tab_idx **)** + * [int](class_int) **[get_tab_count](#get_tab_count)** **(** **)** const + * void **[set_current_tab](#set_current_tab)** **(** [int](class_int) tab_idx **)** + * [int](class_int) **[get_current_tab](#get_current_tab)** **(** **)** const + * void **[set_tab_title](#set_tab_title)** **(** [int](class_int) tab_idx, [String](class_string) title **)** + * [String](class_string) **[get_tab_title](#get_tab_title)** **(** [int](class_int) tab_idx **)** const + * void **[set_tab_icon](#set_tab_icon)** **(** [int](class_int) tab_idx, [Texture](class_texture) icon **)** + * [Texture](class_texture) **[get_tab_icon](#get_tab_icon)** **(** [int](class_int) tab_idx **)** const + * void **[remove_tab](#remove_tab)** **(** [int](class_int) tab_idx **)** ### Signals - * **`tab_changed`** **(** [int](class_int) tab **)** + * **tab_changed** **(** [int](class_int) tab **)** ### Description Simple tabs control, similar to [TabContainer](class_tabcontainer) but is only in charge of drawing tabs, not interact with children. diff --git a/class_tcp_server.md b/class_tcp_server.md index 8d60304..cb52b79 100644 --- a/class_tcp_server.md +++ b/class_tcp_server.md @@ -6,10 +6,10 @@ TCP Server. ### Member Functions - * [int](class_int) **[`listen`](#listen)** **(** [int](class_int) port, [StringArray](class_stringarray) accepted_hosts=StringArray() **)** - * [bool](class_bool) **[`is_connection_available`](#is_connection_available)** **(** **)** const - * [Object](class_object) **[`take_connection`](#take_connection)** **(** **)** - * void **[`stop`](#stop)** **(** **)** + * [int](class_int) **[listen](#listen)** **(** [int](class_int) port, [StringArray](class_stringarray) accepted_hosts=StringArray() **)** + * [bool](class_bool) **[is_connection_available](#is_connection_available)** **(** **)** const + * [Object](class_object) **[take_connection](#take_connection)** **(** **)** + * void **[stop](#stop)** **(** **)** ### Description TCP Server class. Listens to connections on a port and returns a StreamPeerTCP when got a connection. @@ -17,21 +17,21 @@ TCP Server class. Listens to connections on a port and returns a StreamPeerTCP w ### Member Function Description #### listen - * [int](class_int) **`listen`** **(** [int](class_int) port, [StringArray](class_stringarray) accepted_hosts=StringArray() **)** + * [int](class_int) **listen** **(** [int](class_int) port, [StringArray](class_stringarray) accepted_hosts=StringArray() **)** Listen on a port, alternatively give a white-list of accepted hosts. #### is_connection_available - * [bool](class_bool) **`is_connection_available`** **(** **)** const + * [bool](class_bool) **is_connection_available** **(** **)** const Return true if a connection is available for taking. #### take_connection - * [Object](class_object) **`take_connection`** **(** **)** + * [Object](class_object) **take_connection** **(** **)** If a connection is available, return a StreamPeerTCP with the connection/ #### stop - * void **`stop`** **(** **)** + * void **stop** **(** **)** Stop listening. diff --git a/class_textedit.md b/class_textedit.md index e8614ec..e1e0ab1 100644 --- a/class_textedit.md +++ b/class_textedit.md @@ -6,45 +6,45 @@ Multiline text editing control. ### Member Functions - * void **[`set_text`](#set_text)** **(** [String](class_string) text **)** - * void **[`insert_text_at_cursor`](#insert_text_at_cursor)** **(** [String](class_string) text **)** - * [int](class_int) **[`get_line_count`](#get_line_count)** **(** **)** const - * [String](class_string) **[`get_text`](#get_text)** **(** **)** - * [String](class_string) **[`get_line`](#get_line)** **(** [int](class_int) arg0 **)** const - * void **[`cursor_set_column`](#cursor_set_column)** **(** [int](class_int) column **)** - * void **[`cursor_set_line`](#cursor_set_line)** **(** [int](class_int) line **)** - * [int](class_int) **[`cursor_get_column`](#cursor_get_column)** **(** **)** const - * [int](class_int) **[`cursor_get_line`](#cursor_get_line)** **(** **)** const - * void **[`set_readonly`](#set_readonly)** **(** [bool](class_bool) enable **)** - * void **[`set_wrap`](#set_wrap)** **(** [bool](class_bool) enable **)** - * void **[`set_max_chars`](#set_max_chars)** **(** [int](class_int) amount **)** - * void **[`cut`](#cut)** **(** **)** - * void **[`copy`](#copy)** **(** **)** - * void **[`paste`](#paste)** **(** **)** - * void **[`select_all`](#select_all)** **(** **)** - * void **[`select`](#select)** **(** [int](class_int) from_line, [int](class_int) from_column, [int](class_int) to_line, [int](class_int) to_column **)** - * [bool](class_bool) **[`is_selection_active`](#is_selection_active)** **(** **)** const - * [int](class_int) **[`get_selection_from_line`](#get_selection_from_line)** **(** **)** const - * [int](class_int) **[`get_selection_from_column`](#get_selection_from_column)** **(** **)** const - * [int](class_int) **[`get_selection_to_line`](#get_selection_to_line)** **(** **)** const - * [int](class_int) **[`get_selection_to_column`](#get_selection_to_column)** **(** **)** const - * [String](class_string) **[`get_selection_text`](#get_selection_text)** **(** **)** const - * [IntArray](class_intarray) **[`search`](#search)** **(** [String](class_string) flags, [int](class_int) from_line, [int](class_int) from_column, [int](class_int) to_line **)** const - * void **[`undo`](#undo)** **(** **)** - * void **[`redo`](#redo)** **(** **)** - * void **[`clear_undo_history`](#clear_undo_history)** **(** **)** - * void **[`set_syntax_coloring`](#set_syntax_coloring)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_syntax_coloring_enabled`](#is_syntax_coloring_enabled)** **(** **)** const - * void **[`add_keyword_color`](#add_keyword_color)** **(** [String](class_string) keyword, [Color](class_color) color **)** - * void **[`add_color_region`](#add_color_region)** **(** [String](class_string) begin_key, [String](class_string) end_key, [Color](class_color) color, [bool](class_bool) line_only=false **)** - * void **[`set_symbol_color`](#set_symbol_color)** **(** [Color](class_color) color **)** - * void **[`set_custom_bg_color`](#set_custom_bg_color)** **(** [Color](class_color) color **)** - * void **[`clear_colors`](#clear_colors)** **(** **)** + * void **[set_text](#set_text)** **(** [String](class_string) text **)** + * void **[insert_text_at_cursor](#insert_text_at_cursor)** **(** [String](class_string) text **)** + * [int](class_int) **[get_line_count](#get_line_count)** **(** **)** const + * [String](class_string) **[get_text](#get_text)** **(** **)** + * [String](class_string) **[get_line](#get_line)** **(** [int](class_int) arg0 **)** const + * void **[cursor_set_column](#cursor_set_column)** **(** [int](class_int) column **)** + * void **[cursor_set_line](#cursor_set_line)** **(** [int](class_int) line **)** + * [int](class_int) **[cursor_get_column](#cursor_get_column)** **(** **)** const + * [int](class_int) **[cursor_get_line](#cursor_get_line)** **(** **)** const + * void **[set_readonly](#set_readonly)** **(** [bool](class_bool) enable **)** + * void **[set_wrap](#set_wrap)** **(** [bool](class_bool) enable **)** + * void **[set_max_chars](#set_max_chars)** **(** [int](class_int) amount **)** + * void **[cut](#cut)** **(** **)** + * void **[copy](#copy)** **(** **)** + * void **[paste](#paste)** **(** **)** + * void **[select_all](#select_all)** **(** **)** + * void **[select](#select)** **(** [int](class_int) from_line, [int](class_int) from_column, [int](class_int) to_line, [int](class_int) to_column **)** + * [bool](class_bool) **[is_selection_active](#is_selection_active)** **(** **)** const + * [int](class_int) **[get_selection_from_line](#get_selection_from_line)** **(** **)** const + * [int](class_int) **[get_selection_from_column](#get_selection_from_column)** **(** **)** const + * [int](class_int) **[get_selection_to_line](#get_selection_to_line)** **(** **)** const + * [int](class_int) **[get_selection_to_column](#get_selection_to_column)** **(** **)** const + * [String](class_string) **[get_selection_text](#get_selection_text)** **(** **)** const + * [IntArray](class_intarray) **[search](#search)** **(** [String](class_string) flags, [int](class_int) from_line, [int](class_int) from_column, [int](class_int) to_line **)** const + * void **[undo](#undo)** **(** **)** + * void **[redo](#redo)** **(** **)** + * void **[clear_undo_history](#clear_undo_history)** **(** **)** + * void **[set_syntax_coloring](#set_syntax_coloring)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_syntax_coloring_enabled](#is_syntax_coloring_enabled)** **(** **)** const + * void **[add_keyword_color](#add_keyword_color)** **(** [String](class_string) keyword, [Color](class_color) color **)** + * void **[add_color_region](#add_color_region)** **(** [String](class_string) begin_key, [String](class_string) end_key, [Color](class_color) color, [bool](class_bool) line_only=false **)** + * void **[set_symbol_color](#set_symbol_color)** **(** [Color](class_color) color **)** + * void **[set_custom_bg_color](#set_custom_bg_color)** **(** [Color](class_color) color **)** + * void **[clear_colors](#clear_colors)** **(** **)** ### Signals - * **`text_changed`** **(** **)** - * **`cursor_changed`** **(** **)** - * **`request_completion`** **(** [String](class_string) keyword, [int](class_int) line **)** + * **text_changed** **(** **)** + * **cursor_changed** **(** **)** + * **request_completion** **(** [String](class_string) keyword, [int](class_int) line **)** ### Numeric Constants * **SEARCH_MATCH_CASE** = **1** - Match case when searching. @@ -57,171 +57,171 @@ TextEdit is meant for editing large, multiline text. It also has facilities for ### Member Function Description #### set_text - * void **`set_text`** **(** [String](class_string) text **)** + * void **set_text** **(** [String](class_string) text **)** Set the entire text. #### insert_text_at_cursor - * void **`insert_text_at_cursor`** **(** [String](class_string) text **)** + * void **insert_text_at_cursor** **(** [String](class_string) text **)** Insert a given text at the cursor position. #### get_line_count - * [int](class_int) **`get_line_count`** **(** **)** const + * [int](class_int) **get_line_count** **(** **)** const Return the amount of total lines in the text. #### get_text - * [String](class_string) **`get_text`** **(** **)** + * [String](class_string) **get_text** **(** **)** Return the whole text. #### get_line - * [String](class_string) **`get_line`** **(** [int](class_int) arg0 **)** const + * [String](class_string) **get_line** **(** [int](class_int) arg0 **)** const Return the text of a specific line. #### cursor_set_column - * void **`cursor_set_column`** **(** [int](class_int) column **)** + * void **cursor_set_column** **(** [int](class_int) column **)** Set the current column of the text editor. #### cursor_set_line - * void **`cursor_set_line`** **(** [int](class_int) line **)** + * void **cursor_set_line** **(** [int](class_int) line **)** Set the current line of the text editor. #### cursor_get_column - * [int](class_int) **`cursor_get_column`** **(** **)** const + * [int](class_int) **cursor_get_column** **(** **)** const Return the column the editing cursor is at. #### cursor_get_line - * [int](class_int) **`cursor_get_line`** **(** **)** const + * [int](class_int) **cursor_get_line** **(** **)** const Return the line the editing cursor is at. #### set_readonly - * void **`set_readonly`** **(** [bool](class_bool) enable **)** + * void **set_readonly** **(** [bool](class_bool) enable **)** Set the text editor as read-only. Text can be displayed but not edited. #### set_wrap - * void **`set_wrap`** **(** [bool](class_bool) enable **)** + * void **set_wrap** **(** [bool](class_bool) enable **)** Enable text wrapping when it goes beyond he edge of what is visible. #### set_max_chars - * void **`set_max_chars`** **(** [int](class_int) amount **)** + * void **set_max_chars** **(** [int](class_int) amount **)** Set the maximum amount of characters editable. #### cut - * void **`cut`** **(** **)** + * void **cut** **(** **)** Cut the current selection. #### copy - * void **`copy`** **(** **)** + * void **copy** **(** **)** Copy the current selection. #### paste - * void **`paste`** **(** **)** + * void **paste** **(** **)** Paste the current selection. #### select_all - * void **`select_all`** **(** **)** + * void **select_all** **(** **)** Select all the text. #### select - * void **`select`** **(** [int](class_int) from_line, [int](class_int) from_column, [int](class_int) to_line, [int](class_int) to_column **)** + * void **select** **(** [int](class_int) from_line, [int](class_int) from_column, [int](class_int) to_line, [int](class_int) to_column **)** Perform selection, from line/column to line/column. #### is_selection_active - * [bool](class_bool) **`is_selection_active`** **(** **)** const + * [bool](class_bool) **is_selection_active** **(** **)** const Return true if the selection is active. #### get_selection_from_line - * [int](class_int) **`get_selection_from_line`** **(** **)** const + * [int](class_int) **get_selection_from_line** **(** **)** const Return the selection begin line. #### get_selection_from_column - * [int](class_int) **`get_selection_from_column`** **(** **)** const + * [int](class_int) **get_selection_from_column** **(** **)** const Return the selection begin column. #### get_selection_to_line - * [int](class_int) **`get_selection_to_line`** **(** **)** const + * [int](class_int) **get_selection_to_line** **(** **)** const Return the selection end line. #### get_selection_to_column - * [int](class_int) **`get_selection_to_column`** **(** **)** const + * [int](class_int) **get_selection_to_column** **(** **)** const Return the selection end column. #### get_selection_text - * [String](class_string) **`get_selection_text`** **(** **)** const + * [String](class_string) **get_selection_text** **(** **)** const Return the text inside the selection. #### search - * [IntArray](class_intarray) **`search`** **(** [String](class_string) flags, [int](class_int) from_line, [int](class_int) from_column, [int](class_int) to_line **)** const + * [IntArray](class_intarray) **search** **(** [String](class_string) flags, [int](class_int) from_line, [int](class_int) from_column, [int](class_int) to_line **)** const Perform a search inside the text. Search flags can be specified in the SEARCH_* enum. #### undo - * void **`undo`** **(** **)** + * void **undo** **(** **)** Perform undo operation. #### redo - * void **`redo`** **(** **)** + * void **redo** **(** **)** Perform redo operation. #### clear_undo_history - * void **`clear_undo_history`** **(** **)** + * void **clear_undo_history** **(** **)** Clear the undo history. #### set_syntax_coloring - * void **`set_syntax_coloring`** **(** [bool](class_bool) enable **)** + * void **set_syntax_coloring** **(** [bool](class_bool) enable **)** Set to enable the syntax coloring. #### is_syntax_coloring_enabled - * [bool](class_bool) **`is_syntax_coloring_enabled`** **(** **)** const + * [bool](class_bool) **is_syntax_coloring_enabled** **(** **)** const Return true if the syntax coloring is enabled. #### add_keyword_color - * void **`add_keyword_color`** **(** [String](class_string) keyword, [Color](class_color) color **)** + * void **add_keyword_color** **(** [String](class_string) keyword, [Color](class_color) color **)** Add a keyword and it's color. #### add_color_region - * void **`add_color_region`** **(** [String](class_string) begin_key, [String](class_string) end_key, [Color](class_color) color, [bool](class_bool) line_only=false **)** + * void **add_color_region** **(** [String](class_string) begin_key, [String](class_string) end_key, [Color](class_color) color, [bool](class_bool) line_only=false **)** Add color region (given the delimiters) and it's colors. #### set_symbol_color - * void **`set_symbol_color`** **(** [Color](class_color) color **)** + * void **set_symbol_color** **(** [Color](class_color) color **)** Set the color for symbols. #### set_custom_bg_color - * void **`set_custom_bg_color`** **(** [Color](class_color) color **)** + * void **set_custom_bg_color** **(** [Color](class_color) color **)** Set a custom background color. A background color with alpha==0 disables this. #### clear_colors - * void **`clear_colors`** **(** **)** + * void **clear_colors** **(** **)** Clear all the syntax coloring information. diff --git a/class_texture.md b/class_texture.md index af0fb21..7b84377 100644 --- a/class_texture.md +++ b/class_texture.md @@ -6,16 +6,16 @@ Texture for 2D and 3D. ### Member Functions - * [int](class_int) **[`get_width`](#get_width)** **(** **)** const - * [int](class_int) **[`get_height`](#get_height)** **(** **)** const - * [Vector2](class_vector2) **[`get_size`](#get_size)** **(** **)** const - * [RID](class_rid) **[`get_rid`](#get_rid)** **(** **)** const - * [bool](class_bool) **[`has_alpha`](#has_alpha)** **(** **)** const - * void **[`set_flags`](#set_flags)** **(** [int](class_int) flags **)** - * [int](class_int) **[`get_flags`](#get_flags)** **(** **)** const - * void **[`draw`](#draw)** **(** [RID](class_rid) canvas_item, [Vector2](class_vector2) pos, [Color](class_color) modulate=Color(1,1,1,1) **)** const - * void **[`draw_rect`](#draw_rect)** **(** [RID](class_rid) canvas_item, [Rect2](class_rect2) rect, [bool](class_bool) tile, [Color](class_color) modulate=Color(1,1,1,1) **)** const - * void **[`draw_rect_region`](#draw_rect_region)** **(** [RID](class_rid) canvas_item, [Rect2](class_rect2) rect, [Rect2](class_rect2) src_rect, [Color](class_color) modulate=Color(1,1,1,1) **)** const + * [int](class_int) **[get_width](#get_width)** **(** **)** const + * [int](class_int) **[get_height](#get_height)** **(** **)** const + * [Vector2](class_vector2) **[get_size](#get_size)** **(** **)** const + * [RID](class_rid) **[get_rid](#get_rid)** **(** **)** const + * [bool](class_bool) **[has_alpha](#has_alpha)** **(** **)** const + * void **[set_flags](#set_flags)** **(** [int](class_int) flags **)** + * [int](class_int) **[get_flags](#get_flags)** **(** **)** const + * void **[draw](#draw)** **(** [RID](class_rid) canvas_item, [Vector2](class_vector2) pos, [Color](class_color) modulate=Color(1,1,1,1) **)** const + * void **[draw_rect](#draw_rect)** **(** [RID](class_rid) canvas_item, [Rect2](class_rect2) rect, [bool](class_bool) tile, [Color](class_color) modulate=Color(1,1,1,1) **)** const + * void **[draw_rect_region](#draw_rect_region)** **(** [RID](class_rid) canvas_item, [Rect2](class_rect2) rect, [Rect2](class_rect2) src_rect, [Color](class_color) modulate=Color(1,1,1,1) **)** const ### Numeric Constants * **FLAG_MIPMAPS** = **1** - Generate mipmaps. @@ -30,36 +30,36 @@ A texture works by registering an image in the video hardware, which then can be ### Member Function Description #### get_width - * [int](class_int) **`get_width`** **(** **)** const + * [int](class_int) **get_width** **(** **)** const Return the texture width. #### get_height - * [int](class_int) **`get_height`** **(** **)** const + * [int](class_int) **get_height** **(** **)** const Return the texture height. #### get_size - * [Vector2](class_vector2) **`get_size`** **(** **)** const + * [Vector2](class_vector2) **get_size** **(** **)** const Return the texture size. #### get_rid - * [RID](class_rid) **`get_rid`** **(** **)** const + * [RID](class_rid) **get_rid** **(** **)** const Return the texture RID as used in the [VisualServer](class_visualserver). #### set_flags - * void **`set_flags`** **(** [int](class_int) flags **)** + * void **set_flags** **(** [int](class_int) flags **)** Change the texture flags. #### get_flags - * [int](class_int) **`get_flags`** **(** **)** const + * [int](class_int) **get_flags** **(** **)** const Return the current texture flags. #### draw - * void **`draw`** **(** [RID](class_rid) canvas_item, [Vector2](class_vector2) pos, [Color](class_color) modulate=Color(1,1,1,1) **)** const + * void **draw** **(** [RID](class_rid) canvas_item, [Vector2](class_vector2) pos, [Color](class_color) modulate=Color(1,1,1,1) **)** const Draw the texture into a a [VisualServer](class_visualserver) canvas item. diff --git a/class_texturebutton.md b/class_texturebutton.md index cce4cae..d14b660 100644 --- a/class_texturebutton.md +++ b/class_texturebutton.md @@ -6,18 +6,18 @@ Button that can be themed with textures. ### Member Functions - * void **[`set_normal_texture`](#set_normal_texture)** **(** [Texture](class_texture) texture **)** - * void **[`set_pressed_texture`](#set_pressed_texture)** **(** [Texture](class_texture) texture **)** - * void **[`set_hover_texture`](#set_hover_texture)** **(** [Texture](class_texture) texture **)** - * void **[`set_disabled_texture`](#set_disabled_texture)** **(** [Texture](class_texture) texture **)** - * void **[`set_focused_texture`](#set_focused_texture)** **(** [Texture](class_texture) texture **)** - * void **[`set_click_mask`](#set_click_mask)** **(** [BitMap](class_bitmap) mask **)** - * [Texture](class_texture) **[`get_normal_texture`](#get_normal_texture)** **(** **)** const - * [Texture](class_texture) **[`get_pressed_texture`](#get_pressed_texture)** **(** **)** const - * [Texture](class_texture) **[`get_hover_texture`](#get_hover_texture)** **(** **)** const - * [Texture](class_texture) **[`get_disabled_texture`](#get_disabled_texture)** **(** **)** const - * [Texture](class_texture) **[`get_focused_texture`](#get_focused_texture)** **(** **)** const - * [BitMap](class_bitmap) **[`get_click_mask`](#get_click_mask)** **(** **)** const + * void **[set_normal_texture](#set_normal_texture)** **(** [Texture](class_texture) texture **)** + * void **[set_pressed_texture](#set_pressed_texture)** **(** [Texture](class_texture) texture **)** + * void **[set_hover_texture](#set_hover_texture)** **(** [Texture](class_texture) texture **)** + * void **[set_disabled_texture](#set_disabled_texture)** **(** [Texture](class_texture) texture **)** + * void **[set_focused_texture](#set_focused_texture)** **(** [Texture](class_texture) texture **)** + * void **[set_click_mask](#set_click_mask)** **(** [BitMap](class_bitmap) mask **)** + * [Texture](class_texture) **[get_normal_texture](#get_normal_texture)** **(** **)** const + * [Texture](class_texture) **[get_pressed_texture](#get_pressed_texture)** **(** **)** const + * [Texture](class_texture) **[get_hover_texture](#get_hover_texture)** **(** **)** const + * [Texture](class_texture) **[get_disabled_texture](#get_disabled_texture)** **(** **)** const + * [Texture](class_texture) **[get_focused_texture](#get_focused_texture)** **(** **)** const + * [BitMap](class_bitmap) **[get_click_mask](#get_click_mask)** **(** **)** const ### Description Button that can be themed with textures. This is like a regular [Button](class_button) but can be themed by assigning textures to it. This button is intended to be easy to theme, however a regular button can expand (that uses styleboxes) and still be better if the interface is expect to have internationalization of texts. diff --git a/class_textureframe.md b/class_textureframe.md index ff8fa91..08744db 100644 --- a/class_textureframe.md +++ b/class_textureframe.md @@ -6,12 +6,12 @@ Control Frame that draws a texture. ### Member Functions - * void **[`set_texture`](#set_texture)** **(** [Object](class_object) texture **)** - * [Object](class_object) **[`get_texture`](#get_texture)** **(** **)** const - * void **[`set_modulate`](#set_modulate)** **(** [Color](class_color) modulate **)** - * [Color](class_color) **[`get_modulate`](#get_modulate)** **(** **)** const - * void **[`set_expand`](#set_expand)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`has_expand`](#has_expand)** **(** **)** const + * void **[set_texture](#set_texture)** **(** [Object](class_object) texture **)** + * [Object](class_object) **[get_texture](#get_texture)** **(** **)** const + * void **[set_modulate](#set_modulate)** **(** [Color](class_color) modulate **)** + * [Color](class_color) **[get_modulate](#get_modulate)** **(** **)** const + * void **[set_expand](#set_expand)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[has_expand](#has_expand)** **(** **)** const ### Description Control frame that simply draws an assigned texture. It can stretch or not. It's a simple way to just show an image in a UI. diff --git a/class_textureprogress.md b/class_textureprogress.md index ba55f76..c7245cd 100644 --- a/class_textureprogress.md +++ b/class_textureprogress.md @@ -6,12 +6,12 @@ Textured progress bar implementation. ### Member Functions - * void **[`set_under_texture`](#set_under_texture)** **(** [Object](class_object) tex **)** - * [Object](class_object) **[`get_under_texture`](#get_under_texture)** **(** **)** const - * void **[`set_progress_texture`](#set_progress_texture)** **(** [Object](class_object) tex **)** - * [Object](class_object) **[`get_progress_texture`](#get_progress_texture)** **(** **)** const - * void **[`set_over_texture`](#set_over_texture)** **(** [Object](class_object) tex **)** - * [Object](class_object) **[`get_over_texture`](#get_over_texture)** **(** **)** const + * void **[set_under_texture](#set_under_texture)** **(** [Object](class_object) tex **)** + * [Object](class_object) **[get_under_texture](#get_under_texture)** **(** **)** const + * void **[set_progress_texture](#set_progress_texture)** **(** [Object](class_object) tex **)** + * [Object](class_object) **[get_progress_texture](#get_progress_texture)** **(** **)** const + * void **[set_over_texture](#set_over_texture)** **(** [Object](class_object) tex **)** + * [Object](class_object) **[get_over_texture](#get_over_texture)** **(** **)** const ### Description [ProgressBar](class_progressbar) implementation that is easier to theme (by just passing a few textures). diff --git a/class_theme.md b/class_theme.md index 2523fcd..c19a132 100644 --- a/class_theme.md +++ b/class_theme.md @@ -6,33 +6,33 @@ Theme for controls. ### Member Functions - * void **[`set_icon`](#set_icon)** **(** [String](class_string) name, [String](class_string) type, [Texture](class_texture) texture **)** - * [Texture](class_texture) **[`get_icon`](#get_icon)** **(** [String](class_string) name, [String](class_string) type **)** const - * [bool](class_bool) **[`has_icon`](#has_icon)** **(** [String](class_string) name, [String](class_string) type **)** const - * void **[`clear_icon`](#clear_icon)** **(** [String](class_string) name, [String](class_string) type **)** - * [StringArray](class_stringarray) **[`get_icon_list`](#get_icon_list)** **(** [String](class_string) arg0 **)** const - * void **[`set_stylebox`](#set_stylebox)** **(** [String](class_string) name, [String](class_string) type, [StyleBox](class_stylebox) texture **)** - * [StyleBox](class_stylebox) **[`get_stylebox`](#get_stylebox)** **(** [String](class_string) name, [String](class_string) type **)** const - * [bool](class_bool) **[`has_stylebox`](#has_stylebox)** **(** [String](class_string) name, [String](class_string) type **)** const - * void **[`clear_stylebox`](#clear_stylebox)** **(** [String](class_string) name, [String](class_string) type **)** - * [StringArray](class_stringarray) **[`get_stylebox_list`](#get_stylebox_list)** **(** [String](class_string) arg0 **)** const - * void **[`set_font`](#set_font)** **(** [String](class_string) name, [String](class_string) type, [Font](class_font) font **)** - * [Font](class_font) **[`get_font`](#get_font)** **(** [String](class_string) name, [String](class_string) type **)** const - * [bool](class_bool) **[`has_font`](#has_font)** **(** [String](class_string) name, [String](class_string) type **)** const - * void **[`clear_font`](#clear_font)** **(** [String](class_string) name, [String](class_string) type **)** - * [StringArray](class_stringarray) **[`get_font_list`](#get_font_list)** **(** [String](class_string) arg0 **)** const - * void **[`set_color`](#set_color)** **(** [String](class_string) name, [String](class_string) type, [Color](class_color) color **)** - * [Color](class_color) **[`get_color`](#get_color)** **(** [String](class_string) name, [String](class_string) type **)** const - * [bool](class_bool) **[`has_color`](#has_color)** **(** [String](class_string) name, [String](class_string) type **)** const - * void **[`clear_color`](#clear_color)** **(** [String](class_string) name, [String](class_string) type **)** - * [StringArray](class_stringarray) **[`get_color_list`](#get_color_list)** **(** [String](class_string) arg0 **)** const - * void **[`set_constant`](#set_constant)** **(** [String](class_string) name, [String](class_string) type, [int](class_int) constant **)** - * [int](class_int) **[`get_constant`](#get_constant)** **(** [String](class_string) name, [String](class_string) type **)** const - * [bool](class_bool) **[`has_constant`](#has_constant)** **(** [String](class_string) name, [String](class_string) type **)** const - * void **[`clear_constant`](#clear_constant)** **(** [String](class_string) name, [String](class_string) type **)** - * [StringArray](class_stringarray) **[`get_constant_list`](#get_constant_list)** **(** [String](class_string) arg0 **)** const - * [StringArray](class_stringarray) **[`get_type_list`](#get_type_list)** **(** [String](class_string) arg0 **)** const - * void **[`copy_default_theme`](#copy_default_theme)** **(** **)** + * void **[set_icon](#set_icon)** **(** [String](class_string) name, [String](class_string) type, [Texture](class_texture) texture **)** + * [Texture](class_texture) **[get_icon](#get_icon)** **(** [String](class_string) name, [String](class_string) type **)** const + * [bool](class_bool) **[has_icon](#has_icon)** **(** [String](class_string) name, [String](class_string) type **)** const + * void **[clear_icon](#clear_icon)** **(** [String](class_string) name, [String](class_string) type **)** + * [StringArray](class_stringarray) **[get_icon_list](#get_icon_list)** **(** [String](class_string) arg0 **)** const + * void **[set_stylebox](#set_stylebox)** **(** [String](class_string) name, [String](class_string) type, [StyleBox](class_stylebox) texture **)** + * [StyleBox](class_stylebox) **[get_stylebox](#get_stylebox)** **(** [String](class_string) name, [String](class_string) type **)** const + * [bool](class_bool) **[has_stylebox](#has_stylebox)** **(** [String](class_string) name, [String](class_string) type **)** const + * void **[clear_stylebox](#clear_stylebox)** **(** [String](class_string) name, [String](class_string) type **)** + * [StringArray](class_stringarray) **[get_stylebox_list](#get_stylebox_list)** **(** [String](class_string) arg0 **)** const + * void **[set_font](#set_font)** **(** [String](class_string) name, [String](class_string) type, [Font](class_font) font **)** + * [Font](class_font) **[get_font](#get_font)** **(** [String](class_string) name, [String](class_string) type **)** const + * [bool](class_bool) **[has_font](#has_font)** **(** [String](class_string) name, [String](class_string) type **)** const + * void **[clear_font](#clear_font)** **(** [String](class_string) name, [String](class_string) type **)** + * [StringArray](class_stringarray) **[get_font_list](#get_font_list)** **(** [String](class_string) arg0 **)** const + * void **[set_color](#set_color)** **(** [String](class_string) name, [String](class_string) type, [Color](class_color) color **)** + * [Color](class_color) **[get_color](#get_color)** **(** [String](class_string) name, [String](class_string) type **)** const + * [bool](class_bool) **[has_color](#has_color)** **(** [String](class_string) name, [String](class_string) type **)** const + * void **[clear_color](#clear_color)** **(** [String](class_string) name, [String](class_string) type **)** + * [StringArray](class_stringarray) **[get_color_list](#get_color_list)** **(** [String](class_string) arg0 **)** const + * void **[set_constant](#set_constant)** **(** [String](class_string) name, [String](class_string) type, [int](class_int) constant **)** + * [int](class_int) **[get_constant](#get_constant)** **(** [String](class_string) name, [String](class_string) type **)** const + * [bool](class_bool) **[has_constant](#has_constant)** **(** [String](class_string) name, [String](class_string) type **)** const + * void **[clear_constant](#clear_constant)** **(** [String](class_string) name, [String](class_string) type **)** + * [StringArray](class_stringarray) **[get_constant_list](#get_constant_list)** **(** [String](class_string) arg0 **)** const + * [StringArray](class_stringarray) **[get_type_list](#get_type_list)** **(** [String](class_string) arg0 **)** const + * void **[copy_default_theme](#copy_default_theme)** **(** **)** ### Description Theme for skinning controls. Controls can be skinned individually, but for complex applications it's more efficient to just create a global theme that defines everything. This theme can be applied to any [Control](class_control), and it and the children will automatically use it. diff --git a/class_thread.md b/class_thread.md index 430e7d0..fdfe646 100644 --- a/class_thread.md +++ b/class_thread.md @@ -6,10 +6,10 @@ ### Member Functions - * [int](class_int) **[`start`](#start)** **(** [Object](class_object) instance, [String](class_string) method, var userdata=NULL, [int](class_int) priority=1 **)** - * [String](class_string) **[`get_id`](#get_id)** **(** **)** const - * [bool](class_bool) **[`is_active`](#is_active)** **(** **)** const - * void **[`wait_to_finish`](#wait_to_finish)** **(** **)** + * [int](class_int) **[start](#start)** **(** [Object](class_object) instance, [String](class_string) method, var userdata=NULL, [int](class_int) priority=1 **)** + * [String](class_string) **[get_id](#get_id)** **(** **)** const + * [bool](class_bool) **[is_active](#is_active)** **(** **)** const + * void **[wait_to_finish](#wait_to_finish)** **(** **)** ### Numeric Constants * **PRIORITY_LOW** = **0** diff --git a/class_tilemap.md b/class_tilemap.md index 735becc..ce1aa04 100644 --- a/class_tilemap.md +++ b/class_tilemap.md @@ -6,21 +6,21 @@ Node for 2D Tile-Based games. ### Member Functions - * void **[`set_tileset`](#set_tileset)** **(** [TileSet](class_tileset) tileset **)** - * [TileSet](class_tileset) **[`get_tileset`](#get_tileset)** **(** **)** const - * void **[`set_cell_size`](#set_cell_size)** **(** [int](class_int) size **)** - * [int](class_int) **[`get_cell_size`](#get_cell_size)** **(** **)** const - * void **[`set_quadrant_size`](#set_quadrant_size)** **(** [int](class_int) size **)** - * [int](class_int) **[`get_quadrant_size`](#get_quadrant_size)** **(** **)** const - * void **[`set_center_x`](#set_center_x)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`get_center_x`](#get_center_x)** **(** **)** const - * void **[`set_center_y`](#set_center_y)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`get_center_y`](#get_center_y)** **(** **)** const - * void **[`set_cell`](#set_cell)** **(** [int](class_int) x, [int](class_int) y, [int](class_int) tile, [bool](class_bool) flip_x=false, [bool](class_bool) flip_y=false **)** - * [int](class_int) **[`get_cell`](#get_cell)** **(** [int](class_int) x, [int](class_int) y **)** const - * [bool](class_bool) **[`is_cell_x_flipped`](#is_cell_x_flipped)** **(** [int](class_int) x, [int](class_int) y **)** const - * [bool](class_bool) **[`is_cell_y_flipped`](#is_cell_y_flipped)** **(** [int](class_int) x, [int](class_int) y **)** const - * void **[`clear`](#clear)** **(** **)** + * void **[set_tileset](#set_tileset)** **(** [TileSet](class_tileset) tileset **)** + * [TileSet](class_tileset) **[get_tileset](#get_tileset)** **(** **)** const + * void **[set_cell_size](#set_cell_size)** **(** [int](class_int) size **)** + * [int](class_int) **[get_cell_size](#get_cell_size)** **(** **)** const + * void **[set_quadrant_size](#set_quadrant_size)** **(** [int](class_int) size **)** + * [int](class_int) **[get_quadrant_size](#get_quadrant_size)** **(** **)** const + * void **[set_center_x](#set_center_x)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[get_center_x](#get_center_x)** **(** **)** const + * void **[set_center_y](#set_center_y)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[get_center_y](#get_center_y)** **(** **)** const + * void **[set_cell](#set_cell)** **(** [int](class_int) x, [int](class_int) y, [int](class_int) tile, [bool](class_bool) flip_x=false, [bool](class_bool) flip_y=false **)** + * [int](class_int) **[get_cell](#get_cell)** **(** [int](class_int) x, [int](class_int) y **)** const + * [bool](class_bool) **[is_cell_x_flipped](#is_cell_x_flipped)** **(** [int](class_int) x, [int](class_int) y **)** const + * [bool](class_bool) **[is_cell_y_flipped](#is_cell_y_flipped)** **(** [int](class_int) x, [int](class_int) y **)** const + * void **[clear](#clear)** **(** **)** ### Numeric Constants * **INVALID_CELL** = **-1** - Returned when a cell doesn't exist. @@ -32,76 +32,76 @@ Node for 2D Tile-Based games. Tilemaps use a TileSet which contain a list of til ### Member Function Description #### set_tileset - * void **`set_tileset`** **(** [TileSet](class_tileset) tileset **)** + * void **set_tileset** **(** [TileSet](class_tileset) tileset **)** Set the current tileset. #### get_tileset - * [TileSet](class_tileset) **`get_tileset`** **(** **)** const + * [TileSet](class_tileset) **get_tileset** **(** **)** const Return the current tileset. #### set_cell_size - * void **`set_cell_size`** **(** [int](class_int) size **)** + * void **set_cell_size** **(** [int](class_int) size **)** Set the cell size. #### get_cell_size - * [int](class_int) **`get_cell_size`** **(** **)** const + * [int](class_int) **get_cell_size** **(** **)** const Return the cell size. #### set_quadrant_size - * void **`set_quadrant_size`** **(** [int](class_int) size **)** + * void **set_quadrant_size** **(** [int](class_int) size **)** Set the quadrant size, this optimizes drawing by batching chunks of map at draw/cull time. #### get_quadrant_size - * [int](class_int) **`get_quadrant_size`** **(** **)** const + * [int](class_int) **get_quadrant_size** **(** **)** const Return the quadrant size, this optimizes drawing by batching chunks of map at draw/cull time. #### set_center_x - * void **`set_center_x`** **(** [bool](class_bool) enable **)** + * void **set_center_x** **(** [bool](class_bool) enable **)** Set tiles to be centered in x coordinate. (by default this is false and they are drawn from upper left cell corner). #### get_center_x - * [bool](class_bool) **`get_center_x`** **(** **)** const + * [bool](class_bool) **get_center_x** **(** **)** const Return true if tiles are to be centered in x coordinate (by default this is false and they are drawn from upper left cell corner). #### set_center_y - * void **`set_center_y`** **(** [bool](class_bool) enable **)** + * void **set_center_y** **(** [bool](class_bool) enable **)** Set tiles to be centered in y coordinate. (by default this is false and they are drawn from upper left cell corner). #### get_center_y - * [bool](class_bool) **`get_center_y`** **(** **)** const + * [bool](class_bool) **get_center_y** **(** **)** const Return true if tiles are to be centered in y coordinate (by default this is false and they are drawn from upper left cell corner). #### set_cell - * void **`set_cell`** **(** [int](class_int) x, [int](class_int) y, [int](class_int) tile, [bool](class_bool) flip_x=false, [bool](class_bool) flip_y=false **)** + * void **set_cell** **(** [int](class_int) x, [int](class_int) y, [int](class_int) tile, [bool](class_bool) flip_x=false, [bool](class_bool) flip_y=false **)** Set the contents of a cell. Cells can be optionally flipped in y or x. #### get_cell - * [int](class_int) **`get_cell`** **(** [int](class_int) x, [int](class_int) y **)** const + * [int](class_int) **get_cell** **(** [int](class_int) x, [int](class_int) y **)** const Return the contents of a cell. #### is_cell_x_flipped - * [bool](class_bool) **`is_cell_x_flipped`** **(** [int](class_int) x, [int](class_int) y **)** const + * [bool](class_bool) **is_cell_x_flipped** **(** [int](class_int) x, [int](class_int) y **)** const Return if a given cell is flipped in x axis. #### is_cell_y_flipped - * [bool](class_bool) **`is_cell_y_flipped`** **(** [int](class_int) x, [int](class_int) y **)** const + * [bool](class_bool) **is_cell_y_flipped** **(** [int](class_int) x, [int](class_int) y **)** const Return if a given cell is flipped in y axis. #### clear - * void **`clear`** **(** **)** + * void **clear** **(** **)** Clear all cells. diff --git a/class_tileset.md b/class_tileset.md index 64c8863..5cb4648 100644 --- a/class_tileset.md +++ b/class_tileset.md @@ -6,23 +6,23 @@ Tile library for tilemaps. ### Member Functions - * void **[`create_tile`](#create_tile)** **(** [int](class_int) id **)** - * void **[`tile_set_name`](#tile_set_name)** **(** [int](class_int) id, [String](class_string) name **)** - * [String](class_string) **[`tile_get_name`](#tile_get_name)** **(** [int](class_int) id **)** const - * void **[`tile_set_texture`](#tile_set_texture)** **(** [int](class_int) id, [Texture](class_texture) texture **)** - * [Texture](class_texture) **[`tile_get_texture`](#tile_get_texture)** **(** [int](class_int) id **)** const - * void **[`tile_set_offset`](#tile_set_offset)** **(** [int](class_int) id, [Vector2](class_vector2) offset **)** - * [Vector2](class_vector2) **[`tile_get_offset`](#tile_get_offset)** **(** [int](class_int) id **)** const - * void **[`tile_set_region`](#tile_set_region)** **(** [int](class_int) id, [Rect2](class_rect2) region **)** - * [Rect2](class_rect2) **[`tile_get_region`](#tile_get_region)** **(** [int](class_int) id **)** const - * void **[`tile_set_shape`](#tile_set_shape)** **(** [int](class_int) id, [Shape2D](class_shape2d) shape **)** - * [Shape2D](class_shape2d) **[`tile_get_shape`](#tile_get_shape)** **(** [int](class_int) id **)** const - * void **[`tile_set_shapes`](#tile_set_shapes)** **(** [int](class_int) id, [Array](class_array) shapes **)** - * [Array](class_array) **[`tile_get_shapes`](#tile_get_shapes)** **(** [int](class_int) id **)** const - * void **[`remove_tile`](#remove_tile)** **(** [int](class_int) id **)** - * void **[`clear`](#clear)** **(** **)** - * [int](class_int) **[`get_last_unused_tile_id`](#get_last_unused_tile_id)** **(** **)** const - * [int](class_int) **[`find_tile_by_name`](#find_tile_by_name)** **(** [String](class_string) name **)** const + * void **[create_tile](#create_tile)** **(** [int](class_int) id **)** + * void **[tile_set_name](#tile_set_name)** **(** [int](class_int) id, [String](class_string) name **)** + * [String](class_string) **[tile_get_name](#tile_get_name)** **(** [int](class_int) id **)** const + * void **[tile_set_texture](#tile_set_texture)** **(** [int](class_int) id, [Texture](class_texture) texture **)** + * [Texture](class_texture) **[tile_get_texture](#tile_get_texture)** **(** [int](class_int) id **)** const + * void **[tile_set_offset](#tile_set_offset)** **(** [int](class_int) id, [Vector2](class_vector2) offset **)** + * [Vector2](class_vector2) **[tile_get_offset](#tile_get_offset)** **(** [int](class_int) id **)** const + * void **[tile_set_region](#tile_set_region)** **(** [int](class_int) id, [Rect2](class_rect2) region **)** + * [Rect2](class_rect2) **[tile_get_region](#tile_get_region)** **(** [int](class_int) id **)** const + * void **[tile_set_shape](#tile_set_shape)** **(** [int](class_int) id, [Shape2D](class_shape2d) shape **)** + * [Shape2D](class_shape2d) **[tile_get_shape](#tile_get_shape)** **(** [int](class_int) id **)** const + * void **[tile_set_shapes](#tile_set_shapes)** **(** [int](class_int) id, [Array](class_array) shapes **)** + * [Array](class_array) **[tile_get_shapes](#tile_get_shapes)** **(** [int](class_int) id **)** const + * void **[remove_tile](#remove_tile)** **(** [int](class_int) id **)** + * void **[clear](#clear)** **(** **)** + * [int](class_int) **[get_last_unused_tile_id](#get_last_unused_tile_id)** **(** **)** const + * [int](class_int) **[find_tile_by_name](#find_tile_by_name)** **(** [String](class_string) name **)** const ### Description A TileSet is a library of tiles for a [TileMap](class_tilemap). It contains a list of tiles, each consisting of a sprite and optional collision shapes. @@ -30,76 +30,76 @@ A TileSet is a library of tiles for a [TileMap](class_tilemap). It contains a li ### Member Function Description #### create_tile - * void **`create_tile`** **(** [int](class_int) id **)** + * void **create_tile** **(** [int](class_int) id **)** Create a new tile, the ID must be specified. #### tile_set_name - * void **`tile_set_name`** **(** [int](class_int) id, [String](class_string) name **)** + * void **tile_set_name** **(** [int](class_int) id, [String](class_string) name **)** Set the name of a tile, for decriptive purposes. #### tile_get_name - * [String](class_string) **`tile_get_name`** **(** [int](class_int) id **)** const + * [String](class_string) **tile_get_name** **(** [int](class_int) id **)** const Return the name of a tile, for decriptive purposes. #### tile_set_texture - * void **`tile_set_texture`** **(** [int](class_int) id, [Texture](class_texture) texture **)** + * void **tile_set_texture** **(** [int](class_int) id, [Texture](class_texture) texture **)** Set the texture of the tile. #### tile_get_texture - * [Texture](class_texture) **`tile_get_texture`** **(** [int](class_int) id **)** const + * [Texture](class_texture) **tile_get_texture** **(** [int](class_int) id **)** const Return the texture of the tile. #### tile_set_offset - * void **`tile_set_offset`** **(** [int](class_int) id, [Vector2](class_vector2) offset **)** + * void **tile_set_offset** **(** [int](class_int) id, [Vector2](class_vector2) offset **)** Set the offset to draw the tile. #### tile_get_offset - * [Vector2](class_vector2) **`tile_get_offset`** **(** [int](class_int) id **)** const + * [Vector2](class_vector2) **tile_get_offset** **(** [int](class_int) id **)** const Return the offset to draw the tile. #### tile_set_region - * void **`tile_set_region`** **(** [int](class_int) id, [Rect2](class_rect2) region **)** + * void **tile_set_region** **(** [int](class_int) id, [Rect2](class_rect2) region **)** Set the tile sub-region in the texture. This is common in texture atlases. #### tile_get_region - * [Rect2](class_rect2) **`tile_get_region`** **(** [int](class_int) id **)** const + * [Rect2](class_rect2) **tile_get_region** **(** [int](class_int) id **)** const Return the tile sub-region in the texture. This is common in texture atlases. #### tile_set_shape - * void **`tile_set_shape`** **(** [int](class_int) id, [Shape2D](class_shape2d) shape **)** + * void **tile_set_shape** **(** [int](class_int) id, [Shape2D](class_shape2d) shape **)** Set a shape for the tile, enabling physics to collide it. #### tile_get_shape - * [Shape2D](class_shape2d) **`tile_get_shape`** **(** [int](class_int) id **)** const + * [Shape2D](class_shape2d) **tile_get_shape** **(** [int](class_int) id **)** const Return the shape of the tile. #### remove_tile - * void **`remove_tile`** **(** [int](class_int) id **)** + * void **remove_tile** **(** [int](class_int) id **)** Remove a tile, by integer id. #### clear - * void **`clear`** **(** **)** + * void **clear** **(** **)** Clear all tiles. #### get_last_unused_tile_id - * [int](class_int) **`get_last_unused_tile_id`** **(** **)** const + * [int](class_int) **get_last_unused_tile_id** **(** **)** const Find an empty id for creating a new tile. #### find_tile_by_name - * [int](class_int) **`find_tile_by_name`** **(** [String](class_string) name **)** const + * [int](class_int) **find_tile_by_name** **(** [String](class_string) name **)** const Find the first tile with the given name. diff --git a/class_timer.md b/class_timer.md index fcc42f9..85a1005 100644 --- a/class_timer.md +++ b/class_timer.md @@ -6,18 +6,18 @@ ### Member Functions - * void **[`set_wait_time`](#set_wait_time)** **(** [real](class_real) time_sec **)** - * [real](class_real) **[`get_wait_time`](#get_wait_time)** **(** **)** const - * void **[`set_one_shot`](#set_one_shot)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_one_shot`](#is_one_shot)** **(** **)** const - * void **[`set_autostart`](#set_autostart)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`has_autostart`](#has_autostart)** **(** **)** const - * void **[`start`](#start)** **(** **)** - * void **[`stop`](#stop)** **(** **)** - * [real](class_real) **[`get_time_left`](#get_time_left)** **(** **)** const + * void **[set_wait_time](#set_wait_time)** **(** [real](class_real) time_sec **)** + * [real](class_real) **[get_wait_time](#get_wait_time)** **(** **)** const + * void **[set_one_shot](#set_one_shot)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_one_shot](#is_one_shot)** **(** **)** const + * void **[set_autostart](#set_autostart)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[has_autostart](#has_autostart)** **(** **)** const + * void **[start](#start)** **(** **)** + * void **[stop](#stop)** **(** **)** + * [real](class_real) **[get_time_left](#get_time_left)** **(** **)** const ### Signals - * **`timeout`** **(** **)** + * **timeout** **(** **)** ### Description Timer node. This is a simple node that will emit a timeout callback when the timer runs out. It can optinally be set to loop. @@ -25,46 +25,46 @@ Timer node. This is a simple node that will emit a timeout callback when the tim ### Member Function Description #### set_wait_time - * void **`set_wait_time`** **(** [real](class_real) time_sec **)** + * void **set_wait_time** **(** [real](class_real) time_sec **)** Set wait time. When the time is over, it will emit timeout signal. #### get_wait_time - * [real](class_real) **`get_wait_time`** **(** **)** const + * [real](class_real) **get_wait_time** **(** **)** const Return the wait time. When the time is over, it will emit timeout signal. #### set_one_shot - * void **`set_one_shot`** **(** [bool](class_bool) enable **)** + * void **set_one_shot** **(** [bool](class_bool) enable **)** Set as one-shot. If true, timer will stop after timeout, otherwise it will automatically restart. #### is_one_shot - * [bool](class_bool) **`is_one_shot`** **(** **)** const + * [bool](class_bool) **is_one_shot** **(** **)** const Return true if is set as one-shot. If true, timer will stop after timeout, otherwise it will automatically restart. #### set_autostart - * void **`set_autostart`** **(** [bool](class_bool) enable **)** + * void **set_autostart** **(** [bool](class_bool) enable **)** Set to automatically start when entering the scene. #### has_autostart - * [bool](class_bool) **`has_autostart`** **(** **)** const + * [bool](class_bool) **has_autostart** **(** **)** const Return true if set to automatically start when entering the scene. #### start - * void **`start`** **(** **)** + * void **start** **(** **)** Start the timer. #### stop - * void **`stop`** **(** **)** + * void **stop** **(** **)** Stop (cancel) the timer. #### get_time_left - * [real](class_real) **`get_time_left`** **(** **)** const + * [real](class_real) **get_time_left** **(** **)** const Return the time left for timeout if the timer is active. diff --git a/class_touchscreenbutton.md b/class_touchscreenbutton.md index c63d01c..aaccd2d 100644 --- a/class_touchscreenbutton.md +++ b/class_touchscreenbutton.md @@ -6,22 +6,22 @@ ### Member Functions - * void **[`set_texture`](#set_texture)** **(** [Object](class_object) texture **)** - * [Object](class_object) **[`get_texture`](#get_texture)** **(** **)** const - * void **[`set_texture_pressed`](#set_texture_pressed)** **(** [Object](class_object) texture_pressed **)** - * [Object](class_object) **[`get_texture_pressed`](#get_texture_pressed)** **(** **)** const - * void **[`set_bitmask`](#set_bitmask)** **(** [Object](class_object) bitmask **)** - * [Object](class_object) **[`get_bitmask`](#get_bitmask)** **(** **)** const - * void **[`set_action`](#set_action)** **(** [String](class_string) action **)** - * [String](class_string) **[`get_action`](#get_action)** **(** **)** const - * void **[`set_visibility_mode`](#set_visibility_mode)** **(** [int](class_int) mode **)** - * [int](class_int) **[`get_visibility_mode`](#get_visibility_mode)** **(** **)** const - * void **[`set_passby_press`](#set_passby_press)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`is_passby_press_enabled`](#is_passby_press_enabled)** **(** **)** const - * [bool](class_bool) **[`is_pressed`](#is_pressed)** **(** **)** const + * void **[set_texture](#set_texture)** **(** [Object](class_object) texture **)** + * [Object](class_object) **[get_texture](#get_texture)** **(** **)** const + * void **[set_texture_pressed](#set_texture_pressed)** **(** [Object](class_object) texture_pressed **)** + * [Object](class_object) **[get_texture_pressed](#get_texture_pressed)** **(** **)** const + * void **[set_bitmask](#set_bitmask)** **(** [Object](class_object) bitmask **)** + * [Object](class_object) **[get_bitmask](#get_bitmask)** **(** **)** const + * void **[set_action](#set_action)** **(** [String](class_string) action **)** + * [String](class_string) **[get_action](#get_action)** **(** **)** const + * void **[set_visibility_mode](#set_visibility_mode)** **(** [int](class_int) mode **)** + * [int](class_int) **[get_visibility_mode](#get_visibility_mode)** **(** **)** const + * void **[set_passby_press](#set_passby_press)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[is_passby_press_enabled](#is_passby_press_enabled)** **(** **)** const + * [bool](class_bool) **[is_pressed](#is_pressed)** **(** **)** const ### Signals - * **`pressed`** **(** **)** - * **`release`** **(** **)** + * **pressed** **(** **)** + * **release** **(** **)** ### Member Function Description diff --git a/class_transform.md b/class_transform.md index 864329c..fb2b1f0 100644 --- a/class_transform.md +++ b/class_transform.md @@ -5,20 +5,20 @@ 3D Transformation. ### Member Functions - * [Transform](class_transform) **[`affine_inverse`](#affine_inverse)** **(** **)** - * [Transform](class_transform) **[`inverse`](#inverse)** **(** **)** - * [Transform](class_transform) **[`looking_at`](#looking_at)** **(** [Vector3](class_vector3) target, [Vector3](class_vector3) up **)** - * [Transform](class_transform) **[`orthonormalized`](#orthonormalized)** **(** **)** - * [Transform](class_transform) **[`rotated`](#rotated)** **(** [Vector3](class_vector3) axis, [real](class_real) phi **)** - * [Transform](class_transform) **[`scaled`](#scaled)** **(** [Vector3](class_vector3) scale **)** - * [Transform](class_transform) **[`translated`](#translated)** **(** [Vector3](class_vector3) ofs **)** - * var **[`xform`](#xform)** **(** var v **)** - * var **[`xform_inv`](#xform_inv)** **(** var v **)** - * void **[`Transform`](#Transform)** **(** [Vector3](class_vector3) x_axis, [Vector3](class_vector3) y_axis, [Vector3](class_vector3) z_axis, [Vector3](class_vector3) origin **)** - * void **[`Transform`](#Transform)** **(** [Matrix3](class_matrix3) basis, [Vector3](class_vector3) origin **)** - * void **[`Transform`](#Transform)** **(** [Matrix32](class_matrix32) from **)** - * void **[`Transform`](#Transform)** **(** [Quat](class_quat) from **)** - * void **[`Transform`](#Transform)** **(** [Matrix3](class_matrix3) from **)** + * [Transform](class_transform) **[affine_inverse](#affine_inverse)** **(** **)** + * [Transform](class_transform) **[inverse](#inverse)** **(** **)** + * [Transform](class_transform) **[looking_at](#looking_at)** **(** [Vector3](class_vector3) target, [Vector3](class_vector3) up **)** + * [Transform](class_transform) **[orthonormalized](#orthonormalized)** **(** **)** + * [Transform](class_transform) **[rotated](#rotated)** **(** [Vector3](class_vector3) axis, [real](class_real) phi **)** + * [Transform](class_transform) **[scaled](#scaled)** **(** [Vector3](class_vector3) scale **)** + * [Transform](class_transform) **[translated](#translated)** **(** [Vector3](class_vector3) ofs **)** + * var **[xform](#xform)** **(** var v **)** + * var **[xform_inv](#xform_inv)** **(** var v **)** + * void **[Transform](#Transform)** **(** [Vector3](class_vector3) x_axis, [Vector3](class_vector3) y_axis, [Vector3](class_vector3) z_axis, [Vector3](class_vector3) origin **)** + * void **[Transform](#Transform)** **(** [Matrix3](class_matrix3) basis, [Vector3](class_vector3) origin **)** + * void **[Transform](#Transform)** **(** [Matrix32](class_matrix32) from **)** + * void **[Transform](#Transform)** **(** [Quat](class_quat) from **)** + * void **[Transform](#Transform)** **(** [Matrix3](class_matrix3) from **)** ### Member Variables * [Matrix3](class_matrix3) **basis** @@ -30,16 +30,16 @@ Transform is used to store transformations, including translations. It consists ### Member Function Description #### inverse - * [Transform](class_transform) **`inverse`** **(** **)** + * [Transform](class_transform) **inverse** **(** **)** Returns the inverse of the transform. #### xform - * var **`xform`** **(** var v **)** + * var **xform** **(** var v **)** Transforms vector "v" by this transform. #### xform_inv - * var **`xform_inv`** **(** var v **)** + * var **xform_inv** **(** var v **)** Inverse-transforms vector "v" by this transform. diff --git a/class_translation.md b/class_translation.md index 441c0a6..ec3b4b2 100644 --- a/class_translation.md +++ b/class_translation.md @@ -6,12 +6,12 @@ Language Translation. ### Member Functions - * void **[`set_locale`](#set_locale)** **(** [String](class_string) locale **)** - * [String](class_string) **[`get_locale`](#get_locale)** **(** **)** const - * void **[`add_message`](#add_message)** **(** [String](class_string) src_message, [String](class_string) xlated_message **)** - * [String](class_string) **[`get_message`](#get_message)** **(** [String](class_string) src_message **)** const - * void **[`erase_message`](#erase_message)** **(** [String](class_string) src_message **)** - * [StringArray](class_stringarray) **[`get_message_list`](#get_message_list)** **(** **)** const + * void **[set_locale](#set_locale)** **(** [String](class_string) locale **)** + * [String](class_string) **[get_locale](#get_locale)** **(** **)** const + * void **[add_message](#add_message)** **(** [String](class_string) src_message, [String](class_string) xlated_message **)** + * [String](class_string) **[get_message](#get_message)** **(** [String](class_string) src_message **)** const + * void **[erase_message](#erase_message)** **(** [String](class_string) src_message **)** + * [StringArray](class_stringarray) **[get_message_list](#get_message_list)** **(** **)** const ### Description Translations are resources that can be loaded/unloaded on demand. They map a string to another string. @@ -19,31 +19,31 @@ Translations are resources that can be loaded/unloaded on demand. They map a str ### Member Function Description #### set_locale - * void **`set_locale`** **(** [String](class_string) locale **)** + * void **set_locale** **(** [String](class_string) locale **)** Set the locale of the translation. #### get_locale - * [String](class_string) **`get_locale`** **(** **)** const + * [String](class_string) **get_locale** **(** **)** const Return the locale of the translation. #### add_message - * void **`add_message`** **(** [String](class_string) src_message, [String](class_string) xlated_message **)** + * void **add_message** **(** [String](class_string) src_message, [String](class_string) xlated_message **)** Add a message for translation. #### get_message - * [String](class_string) **`get_message`** **(** [String](class_string) src_message **)** const + * [String](class_string) **get_message** **(** [String](class_string) src_message **)** const Return a message for translation. #### erase_message - * void **`erase_message`** **(** [String](class_string) src_message **)** + * void **erase_message** **(** [String](class_string) src_message **)** Erase a message. #### get_message_list - * [StringArray](class_stringarray) **`get_message_list`** **(** **)** const + * [StringArray](class_stringarray) **get_message_list** **(** **)** const Return all the messages (keys). diff --git a/class_translationserver.md b/class_translationserver.md index 6a35b80..1e200f8 100644 --- a/class_translationserver.md +++ b/class_translationserver.md @@ -6,10 +6,10 @@ Server that manages all translations. Translations can be set to it and removed from it. ### Member Functions - * void **[`set_locale`](#set_locale)** **(** [String](class_string) locale **)** - * [String](class_string) **[`get_locale`](#get_locale)** **(** **)** const - * [String](class_string) **[`translate`](#translate)** **(** [String](class_string) arg0 **)** const - * void **[`add_translation`](#add_translation)** **(** [Object](class_object) arg0 **)** - * void **[`remove_translation`](#remove_translation)** **(** [Object](class_object) arg0 **)** + * void **[set_locale](#set_locale)** **(** [String](class_string) locale **)** + * [String](class_string) **[get_locale](#get_locale)** **(** **)** const + * [String](class_string) **[translate](#translate)** **(** [String](class_string) arg0 **)** const + * void **[add_translation](#add_translation)** **(** [Object](class_object) arg0 **)** + * void **[remove_translation](#remove_translation)** **(** [Object](class_object) arg0 **)** ### Member Function Description diff --git a/class_tree.md b/class_tree.md index d4d2146..d73fd9f 100644 --- a/class_tree.md +++ b/class_tree.md @@ -6,40 +6,40 @@ ### Member Functions - * void **[`clear`](#clear)** **(** **)** - * [TreeItem](class_treeitem) **[`create_item`](#create_item)** **(** [TreeItem](class_treeitem) parent=Object() **)** - * [TreeItem](class_treeitem) **[`get_root`](#get_root)** **(** **)** - * void **[`set_column_min_width`](#set_column_min_width)** **(** [int](class_int) arg0, [int](class_int) arg1 **)** - * void **[`set_column_expand`](#set_column_expand)** **(** [int](class_int) arg0, [bool](class_bool) arg1 **)** - * [int](class_int) **[`get_column_width`](#get_column_width)** **(** [int](class_int) arg0 **)** const - * void **[`set_hide_root`](#set_hide_root)** **(** [bool](class_bool) arg0 **)** - * [TreeItem](class_treeitem) **[`get_next_selected`](#get_next_selected)** **(** [TreeItem](class_treeitem) from **)** - * [TreeItem](class_treeitem) **[`get_selected`](#get_selected)** **(** **)** const - * [int](class_int) **[`get_selected_column`](#get_selected_column)** **(** **)** const - * [int](class_int) **[`get_pressed_button`](#get_pressed_button)** **(** **)** const - * void **[`set_select_mode`](#set_select_mode)** **(** [int](class_int) mode **)** - * void **[`set_columns`](#set_columns)** **(** [int](class_int) amount **)** - * [int](class_int) **[`get_columns`](#get_columns)** **(** **)** const - * [TreeItem](class_treeitem) **[`get_edited`](#get_edited)** **(** **)** const - * [int](class_int) **[`get_edited_column`](#get_edited_column)** **(** **)** const - * [Rect2](class_rect2) **[`get_custom_popup_rect`](#get_custom_popup_rect)** **(** **)** const - * [Rect2](class_rect2) **[`get_item_area_rect`](#get_item_area_rect)** **(** [TreeItem](class_treeitem) item, [int](class_int) column=-1 **)** const - * void **[`ensure_cursor_is_visible`](#ensure_cursor_is_visible)** **(** **)** - * void **[`set_column_titles_visible`](#set_column_titles_visible)** **(** [bool](class_bool) visible **)** - * [bool](class_bool) **[`are_column_titles_visible`](#are_column_titles_visible)** **(** **)** const - * void **[`set_column_title`](#set_column_title)** **(** [int](class_int) column, [String](class_string) title **)** - * [String](class_string) **[`get_column_title`](#get_column_title)** **(** [int](class_int) column **)** const - * [Vector2](class_vector2) **[`get_scroll`](#get_scroll)** **(** **)** const + * void **[clear](#clear)** **(** **)** + * [TreeItem](class_treeitem) **[create_item](#create_item)** **(** [TreeItem](class_treeitem) parent=Object() **)** + * [TreeItem](class_treeitem) **[get_root](#get_root)** **(** **)** + * void **[set_column_min_width](#set_column_min_width)** **(** [int](class_int) arg0, [int](class_int) arg1 **)** + * void **[set_column_expand](#set_column_expand)** **(** [int](class_int) arg0, [bool](class_bool) arg1 **)** + * [int](class_int) **[get_column_width](#get_column_width)** **(** [int](class_int) arg0 **)** const + * void **[set_hide_root](#set_hide_root)** **(** [bool](class_bool) arg0 **)** + * [TreeItem](class_treeitem) **[get_next_selected](#get_next_selected)** **(** [TreeItem](class_treeitem) from **)** + * [TreeItem](class_treeitem) **[get_selected](#get_selected)** **(** **)** const + * [int](class_int) **[get_selected_column](#get_selected_column)** **(** **)** const + * [int](class_int) **[get_pressed_button](#get_pressed_button)** **(** **)** const + * void **[set_select_mode](#set_select_mode)** **(** [int](class_int) mode **)** + * void **[set_columns](#set_columns)** **(** [int](class_int) amount **)** + * [int](class_int) **[get_columns](#get_columns)** **(** **)** const + * [TreeItem](class_treeitem) **[get_edited](#get_edited)** **(** **)** const + * [int](class_int) **[get_edited_column](#get_edited_column)** **(** **)** const + * [Rect2](class_rect2) **[get_custom_popup_rect](#get_custom_popup_rect)** **(** **)** const + * [Rect2](class_rect2) **[get_item_area_rect](#get_item_area_rect)** **(** [TreeItem](class_treeitem) item, [int](class_int) column=-1 **)** const + * void **[ensure_cursor_is_visible](#ensure_cursor_is_visible)** **(** **)** + * void **[set_column_titles_visible](#set_column_titles_visible)** **(** [bool](class_bool) visible **)** + * [bool](class_bool) **[are_column_titles_visible](#are_column_titles_visible)** **(** **)** const + * void **[set_column_title](#set_column_title)** **(** [int](class_int) column, [String](class_string) title **)** + * [String](class_string) **[get_column_title](#get_column_title)** **(** [int](class_int) column **)** const + * [Vector2](class_vector2) **[get_scroll](#get_scroll)** **(** **)** const ### Signals - * **`item_activated`** **(** **)** - * **`multi_selected`** **(** [Object](class_object) item, [int](class_int) column, [bool](class_bool) selected **)** - * **`custom_popup_edited`** **(** [bool](class_bool) arrow_clicked **)** - * **`item_collapsed`** **(** [Object](class_object) item **)** - * **`item_edited`** **(** **)** - * **`item_selected`** **(** **)** - * **`cell_selected`** **(** **)** - * **`button_pressed`** **(** [Object](class_object) item, [int](class_int) column, [int](class_int) id **)** + * **item_activated** **(** **)** + * **multi_selected** **(** [Object](class_object) item, [int](class_int) column, [bool](class_bool) selected **)** + * **custom_popup_edited** **(** [bool](class_bool) arrow_clicked **)** + * **item_collapsed** **(** [Object](class_object) item **)** + * **item_edited** **(** **)** + * **item_selected** **(** **)** + * **cell_selected** **(** **)** + * **button_pressed** **(** [Object](class_object) item, [int](class_int) column, [int](class_int) id **)** ### Numeric Constants * **SELECT_SINGLE** = **0** diff --git a/class_treeitem.md b/class_treeitem.md index 953c92e..fe820a4 100644 --- a/class_treeitem.md +++ b/class_treeitem.md @@ -6,54 +6,54 @@ ### Member Functions - * void **[`set_cell_mode`](#set_cell_mode)** **(** [int](class_int) column, [int](class_int) mode **)** - * [int](class_int) **[`get_cell_mode`](#get_cell_mode)** **(** [int](class_int) column **)** const - * void **[`set_checked`](#set_checked)** **(** [int](class_int) column, [bool](class_bool) checked **)** - * [bool](class_bool) **[`is_checked`](#is_checked)** **(** [int](class_int) column **)** const - * void **[`set_text`](#set_text)** **(** [int](class_int) column, [String](class_string) text **)** - * [String](class_string) **[`get_text`](#get_text)** **(** [int](class_int) column **)** const - * void **[`set_icon`](#set_icon)** **(** [int](class_int) column, [Texture](class_texture) texture **)** - * [Texture](class_texture) **[`get_icon`](#get_icon)** **(** [int](class_int) column **)** const - * void **[`set_icon_region`](#set_icon_region)** **(** [int](class_int) column, [Rect2](class_rect2) region **)** - * [Rect2](class_rect2) **[`get_icon_region`](#get_icon_region)** **(** [int](class_int) column **)** const - * void **[`set_icon_max_width`](#set_icon_max_width)** **(** [int](class_int) column, [int](class_int) width **)** - * [int](class_int) **[`get_icon_max_width`](#get_icon_max_width)** **(** [int](class_int) column **)** const - * void **[`set_range`](#set_range)** **(** [int](class_int) column, [real](class_real) value **)** - * [real](class_real) **[`get_range`](#get_range)** **(** [int](class_int) column **)** const - * void **[`set_range_config`](#set_range_config)** **(** [int](class_int) column, [real](class_real) min, [real](class_real) max, [real](class_real) step, [bool](class_bool) expr=false **)** - * [Dictionary](class_dictionary) **[`get_range_config`](#get_range_config)** **(** [int](class_int) column **)** - * void **[`set_metadata`](#set_metadata)** **(** [int](class_int) column, var meta **)** - * void **[`get_metadata`](#get_metadata)** **(** [int](class_int) column **)** const - * void **[`set_custom_draw`](#set_custom_draw)** **(** [int](class_int) column, [Object](class_object) object, [String](class_string) callback **)** - * void **[`set_collapsed`](#set_collapsed)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_collapsed`](#is_collapsed)** **(** **)** - * [TreeItem](class_treeitem) **[`get_next`](#get_next)** **(** **)** - * [TreeItem](class_treeitem) **[`get_prev`](#get_prev)** **(** **)** - * [TreeItem](class_treeitem) **[`get_parent`](#get_parent)** **(** **)** - * [TreeItem](class_treeitem) **[`get_children`](#get_children)** **(** **)** - * [TreeItem](class_treeitem) **[`get_next_visible`](#get_next_visible)** **(** **)** - * [TreeItem](class_treeitem) **[`get_prev_visible`](#get_prev_visible)** **(** **)** - * void **[`remove_child`](#remove_child)** **(** [Object](class_object) child **)** - * void **[`set_selectable`](#set_selectable)** **(** [int](class_int) column, [bool](class_bool) selectable **)** - * [bool](class_bool) **[`is_selectable`](#is_selectable)** **(** [int](class_int) column **)** const - * [bool](class_bool) **[`is_selected`](#is_selected)** **(** [int](class_int) column **)** - * void **[`select`](#select)** **(** [int](class_int) column **)** - * void **[`deselect`](#deselect)** **(** [int](class_int) column **)** - * void **[`set_editable`](#set_editable)** **(** [int](class_int) column, [bool](class_bool) enabled **)** - * [bool](class_bool) **[`is_editable`](#is_editable)** **(** [int](class_int) column **)** - * void **[`set_custom_color`](#set_custom_color)** **(** [int](class_int) column, [Color](class_color) color **)** - * void **[`clear_custom_color`](#clear_custom_color)** **(** [int](class_int) column **)** - * void **[`set_custom_bg_color`](#set_custom_bg_color)** **(** [int](class_int) column, [Color](class_color) color **)** - * void **[`clear_custom_bg_color`](#clear_custom_bg_color)** **(** [int](class_int) column **)** - * [Color](class_color) **[`get_custom_bg_color`](#get_custom_bg_color)** **(** [int](class_int) column **)** const - * void **[`add_button`](#add_button)** **(** [int](class_int) column, [Texture](class_texture) button, [int](class_int) arg2 **)** - * [int](class_int) **[`get_button_count`](#get_button_count)** **(** [int](class_int) column **)** const - * [Texture](class_texture) **[`get_button`](#get_button)** **(** [int](class_int) column, [int](class_int) button_idx **)** const - * void **[`erase_button`](#erase_button)** **(** [int](class_int) column, [int](class_int) button_idx **)** - * void **[`set_tooltip`](#set_tooltip)** **(** [int](class_int) column, [String](class_string) tooltip **)** - * [String](class_string) **[`get_tooltip`](#get_tooltip)** **(** [int](class_int) column **)** const - * void **[`move_to_top`](#move_to_top)** **(** **)** - * void **[`move_to_bottom`](#move_to_bottom)** **(** **)** + * void **[set_cell_mode](#set_cell_mode)** **(** [int](class_int) column, [int](class_int) mode **)** + * [int](class_int) **[get_cell_mode](#get_cell_mode)** **(** [int](class_int) column **)** const + * void **[set_checked](#set_checked)** **(** [int](class_int) column, [bool](class_bool) checked **)** + * [bool](class_bool) **[is_checked](#is_checked)** **(** [int](class_int) column **)** const + * void **[set_text](#set_text)** **(** [int](class_int) column, [String](class_string) text **)** + * [String](class_string) **[get_text](#get_text)** **(** [int](class_int) column **)** const + * void **[set_icon](#set_icon)** **(** [int](class_int) column, [Texture](class_texture) texture **)** + * [Texture](class_texture) **[get_icon](#get_icon)** **(** [int](class_int) column **)** const + * void **[set_icon_region](#set_icon_region)** **(** [int](class_int) column, [Rect2](class_rect2) region **)** + * [Rect2](class_rect2) **[get_icon_region](#get_icon_region)** **(** [int](class_int) column **)** const + * void **[set_icon_max_width](#set_icon_max_width)** **(** [int](class_int) column, [int](class_int) width **)** + * [int](class_int) **[get_icon_max_width](#get_icon_max_width)** **(** [int](class_int) column **)** const + * void **[set_range](#set_range)** **(** [int](class_int) column, [real](class_real) value **)** + * [real](class_real) **[get_range](#get_range)** **(** [int](class_int) column **)** const + * void **[set_range_config](#set_range_config)** **(** [int](class_int) column, [real](class_real) min, [real](class_real) max, [real](class_real) step, [bool](class_bool) expr=false **)** + * [Dictionary](class_dictionary) **[get_range_config](#get_range_config)** **(** [int](class_int) column **)** + * void **[set_metadata](#set_metadata)** **(** [int](class_int) column, var meta **)** + * void **[get_metadata](#get_metadata)** **(** [int](class_int) column **)** const + * void **[set_custom_draw](#set_custom_draw)** **(** [int](class_int) column, [Object](class_object) object, [String](class_string) callback **)** + * void **[set_collapsed](#set_collapsed)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_collapsed](#is_collapsed)** **(** **)** + * [TreeItem](class_treeitem) **[get_next](#get_next)** **(** **)** + * [TreeItem](class_treeitem) **[get_prev](#get_prev)** **(** **)** + * [TreeItem](class_treeitem) **[get_parent](#get_parent)** **(** **)** + * [TreeItem](class_treeitem) **[get_children](#get_children)** **(** **)** + * [TreeItem](class_treeitem) **[get_next_visible](#get_next_visible)** **(** **)** + * [TreeItem](class_treeitem) **[get_prev_visible](#get_prev_visible)** **(** **)** + * void **[remove_child](#remove_child)** **(** [Object](class_object) child **)** + * void **[set_selectable](#set_selectable)** **(** [int](class_int) column, [bool](class_bool) selectable **)** + * [bool](class_bool) **[is_selectable](#is_selectable)** **(** [int](class_int) column **)** const + * [bool](class_bool) **[is_selected](#is_selected)** **(** [int](class_int) column **)** + * void **[select](#select)** **(** [int](class_int) column **)** + * void **[deselect](#deselect)** **(** [int](class_int) column **)** + * void **[set_editable](#set_editable)** **(** [int](class_int) column, [bool](class_bool) enabled **)** + * [bool](class_bool) **[is_editable](#is_editable)** **(** [int](class_int) column **)** + * void **[set_custom_color](#set_custom_color)** **(** [int](class_int) column, [Color](class_color) color **)** + * void **[clear_custom_color](#clear_custom_color)** **(** [int](class_int) column **)** + * void **[set_custom_bg_color](#set_custom_bg_color)** **(** [int](class_int) column, [Color](class_color) color **)** + * void **[clear_custom_bg_color](#clear_custom_bg_color)** **(** [int](class_int) column **)** + * [Color](class_color) **[get_custom_bg_color](#get_custom_bg_color)** **(** [int](class_int) column **)** const + * void **[add_button](#add_button)** **(** [int](class_int) column, [Texture](class_texture) button, [int](class_int) arg2 **)** + * [int](class_int) **[get_button_count](#get_button_count)** **(** [int](class_int) column **)** const + * [Texture](class_texture) **[get_button](#get_button)** **(** [int](class_int) column, [int](class_int) button_idx **)** const + * void **[erase_button](#erase_button)** **(** [int](class_int) column, [int](class_int) button_idx **)** + * void **[set_tooltip](#set_tooltip)** **(** [int](class_int) column, [String](class_string) tooltip **)** + * [String](class_string) **[get_tooltip](#get_tooltip)** **(** [int](class_int) column **)** const + * void **[move_to_top](#move_to_top)** **(** **)** + * void **[move_to_bottom](#move_to_bottom)** **(** **)** ### Numeric Constants * **CELL_MODE_STRING** = **0** diff --git a/class_unshadedmaterial.md b/class_unshadedmaterial.md index 1e3fb78..eb80dac 100644 --- a/class_unshadedmaterial.md +++ b/class_unshadedmaterial.md @@ -6,11 +6,11 @@ ### Member Functions - * void **[`set_texture`](#set_texture)** **(** [Object](class_object) texture **)** - * [Texture](class_texture) **[`get_texture`](#get_texture)** **(** **)** const - * void **[`set_use_alpha`](#set_use_alpha)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_using_alpha`](#is_using_alpha)** **(** **)** const - * void **[`set_use_color_array`](#set_use_color_array)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_using_color_array`](#is_using_color_array)** **(** **)** const + * void **[set_texture](#set_texture)** **(** [Object](class_object) texture **)** + * [Texture](class_texture) **[get_texture](#get_texture)** **(** **)** const + * void **[set_use_alpha](#set_use_alpha)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_using_alpha](#is_using_alpha)** **(** **)** const + * void **[set_use_color_array](#set_use_color_array)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_using_color_array](#is_using_color_array)** **(** **)** const ### Member Function Description diff --git a/class_vector2.md b/class_vector2.md index 1d9c541..5751090 100644 --- a/class_vector2.md +++ b/class_vector2.md @@ -5,22 +5,22 @@ Vector used for 2D Math. ### Member Functions - * [real](class_real) **[`angle_to`](#angle_to)** **(** [Vector2](class_vector2) to **)** - * [Vector2](class_vector2) **[`cubic_interpolate`](#cubic_interpolate)** **(** [Vector2](class_vector2) b, [Vector2](class_vector2) pre_a, [Vector2](class_vector2) post_b, [real](class_real) t **)** - * [real](class_real) **[`distance_squared_to`](#distance_squared_to)** **(** [Vector2](class_vector2) to **)** - * [real](class_real) **[`distance_to`](#distance_to)** **(** [Vector2](class_vector2) to **)** - * [real](class_real) **[`dot`](#dot)** **(** [Vector2](class_vector2) with **)** - * [Vector2](class_vector2) **[`floor`](#floor)** **(** **)** - * [Vector2](class_vector2) **[`floorf`](#floorf)** **(** **)** - * [real](class_real) **[`get_aspect`](#get_aspect)** **(** **)** - * [real](class_real) **[`length`](#length)** **(** **)** - * [real](class_real) **[`length_squared`](#length_squared)** **(** **)** - * [Vector2](class_vector2) **[`linear_interpolate`](#linear_interpolate)** **(** [Vector2](class_vector2) b, [real](class_real) t **)** - * [Vector2](class_vector2) **[`normalized`](#normalized)** **(** **)** - * [Vector2](class_vector2) **[`rotated`](#rotated)** **(** [real](class_real) phi **)** - * [Vector2](class_vector2) **[`snapped`](#snapped)** **(** [Vector2](class_vector2) by **)** - * [Vector2](class_vector2) **[`tangent`](#tangent)** **(** **)** - * void **[`Vector2`](#Vector2)** **(** [real](class_real) x, [real](class_real) y **)** + * [real](class_real) **[angle_to](#angle_to)** **(** [Vector2](class_vector2) to **)** + * [Vector2](class_vector2) **[cubic_interpolate](#cubic_interpolate)** **(** [Vector2](class_vector2) b, [Vector2](class_vector2) pre_a, [Vector2](class_vector2) post_b, [real](class_real) t **)** + * [real](class_real) **[distance_squared_to](#distance_squared_to)** **(** [Vector2](class_vector2) to **)** + * [real](class_real) **[distance_to](#distance_to)** **(** [Vector2](class_vector2) to **)** + * [real](class_real) **[dot](#dot)** **(** [Vector2](class_vector2) with **)** + * [Vector2](class_vector2) **[floor](#floor)** **(** **)** + * [Vector2](class_vector2) **[floorf](#floorf)** **(** **)** + * [real](class_real) **[get_aspect](#get_aspect)** **(** **)** + * [real](class_real) **[length](#length)** **(** **)** + * [real](class_real) **[length_squared](#length_squared)** **(** **)** + * [Vector2](class_vector2) **[linear_interpolate](#linear_interpolate)** **(** [Vector2](class_vector2) b, [real](class_real) t **)** + * [Vector2](class_vector2) **[normalized](#normalized)** **(** **)** + * [Vector2](class_vector2) **[rotated](#rotated)** **(** [real](class_real) phi **)** + * [Vector2](class_vector2) **[snapped](#snapped)** **(** [Vector2](class_vector2) by **)** + * [Vector2](class_vector2) **[tangent](#tangent)** **(** **)** + * void **[Vector2](#Vector2)** **(** [real](class_real) x, [real](class_real) y **)** ### Member Variables * [real](class_real) **x** @@ -31,31 +31,31 @@ Vector used for 2D Math. ### Member Function Description #### distance_to - * [real](class_real) **`distance_to`** **(** [Vector2](class_vector2) to **)** + * [real](class_real) **distance_to** **(** [Vector2](class_vector2) to **)** Returns the distance to vector "b". #### dot - * [real](class_real) **`dot`** **(** [Vector2](class_vector2) with **)** + * [real](class_real) **dot** **(** [Vector2](class_vector2) with **)** Returns the dot product with vector "b". #### floor - * [Vector2](class_vector2) **`floor`** **(** **)** + * [Vector2](class_vector2) **floor** **(** **)** Remove the fractional part of x and y. #### length - * [real](class_real) **`length`** **(** **)** + * [real](class_real) **length** **(** **)** Returns the length of the vector. #### linear_interpolate - * [Vector2](class_vector2) **`linear_interpolate`** **(** [Vector2](class_vector2) b, [real](class_real) t **)** + * [Vector2](class_vector2) **linear_interpolate** **(** [Vector2](class_vector2) b, [real](class_real) t **)** Returns the result of the linear interpolation between this vector and "b", by amount "i". #### normalized - * [Vector2](class_vector2) **`normalized`** **(** **)** + * [Vector2](class_vector2) **normalized** **(** **)** Returns a normalized vector to unit length. diff --git a/class_vector2array.md b/class_vector2array.md index dbd317d..df29a98 100644 --- a/class_vector2array.md +++ b/class_vector2array.md @@ -5,11 +5,11 @@ ### Member Functions - * [Vector2](class_vector2) **[`get`](#get)** **(** [int](class_int) idx **)** - * void **[`push_back`](#push_back)** **(** [Vector2](class_vector2) vector2 **)** - * void **[`resize`](#resize)** **(** [int](class_int) idx **)** - * void **[`set`](#set)** **(** [int](class_int) idx, [Vector2](class_vector2) vector2 **)** - * [int](class_int) **[`size`](#size)** **(** **)** - * void **[`Vector2Array`](#Vector2Array)** **(** [Array](class_array) from **)** + * [Vector2](class_vector2) **[get](#get)** **(** [int](class_int) idx **)** + * void **[push_back](#push_back)** **(** [Vector2](class_vector2) vector2 **)** + * void **[resize](#resize)** **(** [int](class_int) idx **)** + * void **[set](#set)** **(** [int](class_int) idx, [Vector2](class_vector2) vector2 **)** + * [int](class_int) **[size](#size)** **(** **)** + * void **[Vector2Array](#Vector2Array)** **(** [Array](class_array) from **)** ### Member Function Description diff --git a/class_vector3.md b/class_vector3.md index 9918e3a..8317d6e 100644 --- a/class_vector3.md +++ b/class_vector3.md @@ -5,22 +5,22 @@ Vector class, which performs basic 3D vector math operations. ### Member Functions - * [Vector3](class_vector3) **[`abs`](#abs)** **(** **)** - * [Vector3](class_vector3) **[`cross`](#cross)** **(** [Vector3](class_vector3) b **)** - * [Vector3](class_vector3) **[`cubic_interpolate`](#cubic_interpolate)** **(** [Vector3](class_vector3) b, [Vector3](class_vector3) pre_a, [Vector3](class_vector3) post_b, [real](class_real) t **)** - * [real](class_real) **[`distance_squared_to`](#distance_squared_to)** **(** [Vector3](class_vector3) b **)** - * [real](class_real) **[`distance_to`](#distance_to)** **(** [Vector3](class_vector3) b **)** - * [real](class_real) **[`dot`](#dot)** **(** [Vector3](class_vector3) b **)** - * [Vector3](class_vector3) **[`inverse`](#inverse)** **(** **)** - * [real](class_real) **[`length`](#length)** **(** **)** - * [real](class_real) **[`length_squared`](#length_squared)** **(** **)** - * [Vector3](class_vector3) **[`linear_interpolate`](#linear_interpolate)** **(** [Vector3](class_vector3) b, [real](class_real) t **)** - * [int](class_int) **[`max_axis`](#max_axis)** **(** **)** - * [int](class_int) **[`min_axis`](#min_axis)** **(** **)** - * [Vector3](class_vector3) **[`normalized`](#normalized)** **(** **)** - * [Vector3](class_vector3) **[`rotated`](#rotated)** **(** [Vector3](class_vector3) axis, [real](class_real) phi **)** - * [Vector3](class_vector3) **[`snapped`](#snapped)** **(** [real](class_real) by **)** - * void **[`Vector3`](#Vector3)** **(** [real](class_real) x, [real](class_real) y, [real](class_real) z **)** + * [Vector3](class_vector3) **[abs](#abs)** **(** **)** + * [Vector3](class_vector3) **[cross](#cross)** **(** [Vector3](class_vector3) b **)** + * [Vector3](class_vector3) **[cubic_interpolate](#cubic_interpolate)** **(** [Vector3](class_vector3) b, [Vector3](class_vector3) pre_a, [Vector3](class_vector3) post_b, [real](class_real) t **)** + * [real](class_real) **[distance_squared_to](#distance_squared_to)** **(** [Vector3](class_vector3) b **)** + * [real](class_real) **[distance_to](#distance_to)** **(** [Vector3](class_vector3) b **)** + * [real](class_real) **[dot](#dot)** **(** [Vector3](class_vector3) b **)** + * [Vector3](class_vector3) **[inverse](#inverse)** **(** **)** + * [real](class_real) **[length](#length)** **(** **)** + * [real](class_real) **[length_squared](#length_squared)** **(** **)** + * [Vector3](class_vector3) **[linear_interpolate](#linear_interpolate)** **(** [Vector3](class_vector3) b, [real](class_real) t **)** + * [int](class_int) **[max_axis](#max_axis)** **(** **)** + * [int](class_int) **[min_axis](#min_axis)** **(** **)** + * [Vector3](class_vector3) **[normalized](#normalized)** **(** **)** + * [Vector3](class_vector3) **[rotated](#rotated)** **(** [Vector3](class_vector3) axis, [real](class_real) phi **)** + * [Vector3](class_vector3) **[snapped](#snapped)** **(** [real](class_real) by **)** + * void **[Vector3](#Vector3)** **(** [real](class_real) x, [real](class_real) y, [real](class_real) z **)** ### Member Variables * [real](class_real) **x** @@ -38,56 +38,56 @@ Vector3 is one of the core classes of the engine, and includes several built-in ### Member Function Description #### cross - * [Vector3](class_vector3) **`cross`** **(** [Vector3](class_vector3) b **)** + * [Vector3](class_vector3) **cross** **(** [Vector3](class_vector3) b **)** Return the cross product with b. #### cubic_interpolate - * [Vector3](class_vector3) **`cubic_interpolate`** **(** [Vector3](class_vector3) b, [Vector3](class_vector3) pre_a, [Vector3](class_vector3) post_b, [real](class_real) t **)** + * [Vector3](class_vector3) **cubic_interpolate** **(** [Vector3](class_vector3) b, [Vector3](class_vector3) pre_a, [Vector3](class_vector3) post_b, [real](class_real) t **)** Perform a cubic interpolation between vectors a,b,c,d (b is current), by the given amount (i). #### distance_squared_to - * [real](class_real) **`distance_squared_to`** **(** [Vector3](class_vector3) b **)** + * [real](class_real) **distance_squared_to** **(** [Vector3](class_vector3) b **)** Return the squared distance (distance minus the last square root) to b. #### distance_to - * [real](class_real) **`distance_to`** **(** [Vector3](class_vector3) b **)** + * [real](class_real) **distance_to** **(** [Vector3](class_vector3) b **)** Return the distance to b. #### dot - * [real](class_real) **`dot`** **(** [Vector3](class_vector3) b **)** + * [real](class_real) **dot** **(** [Vector3](class_vector3) b **)** Return the dot product with b. #### inverse - * [Vector3](class_vector3) **`inverse`** **(** **)** + * [Vector3](class_vector3) **inverse** **(** **)** Returns the inverse of the vector. this is the same as Vector3( 1.0 / v.x, 1.0 / v.y, 1.0 / v.z ) #### length - * [real](class_real) **`length`** **(** **)** + * [real](class_real) **length** **(** **)** Return the length of the vector. #### length_squared - * [real](class_real) **`length_squared`** **(** **)** + * [real](class_real) **length_squared** **(** **)** Return the length of the vector, without the square root step. #### linear_interpolate - * [Vector3](class_vector3) **`linear_interpolate`** **(** [Vector3](class_vector3) b, [real](class_real) t **)** + * [Vector3](class_vector3) **linear_interpolate** **(** [Vector3](class_vector3) b, [real](class_real) t **)** Linearly interpolates the vector to a given one (b), by the given amount (i) #### normalized - * [Vector3](class_vector3) **`normalized`** **(** **)** + * [Vector3](class_vector3) **normalized** **(** **)** Return a copy of the normalized vector to unit length. This is the same as v / v.length() #### snapped - * [Vector3](class_vector3) **`snapped`** **(** [real](class_real) by **)** + * [Vector3](class_vector3) **snapped** **(** [real](class_real) by **)** Return a copy of the vector, snapped to the lowest neared multiple. diff --git a/class_vector3array.md b/class_vector3array.md index 91f308d..b332216 100644 --- a/class_vector3array.md +++ b/class_vector3array.md @@ -5,11 +5,11 @@ ### Member Functions - * [Vector3](class_vector3) **[`get`](#get)** **(** [int](class_int) idx **)** - * void **[`push_back`](#push_back)** **(** [Vector3](class_vector3) vector3 **)** - * void **[`resize`](#resize)** **(** [int](class_int) idx **)** - * void **[`set`](#set)** **(** [int](class_int) idx, [Vector3](class_vector3) vector3 **)** - * [int](class_int) **[`size`](#size)** **(** **)** - * void **[`Vector3Array`](#Vector3Array)** **(** [Array](class_array) from **)** + * [Vector3](class_vector3) **[get](#get)** **(** [int](class_int) idx **)** + * void **[push_back](#push_back)** **(** [Vector3](class_vector3) vector3 **)** + * void **[resize](#resize)** **(** [int](class_int) idx **)** + * void **[set](#set)** **(** [int](class_int) idx, [Vector3](class_vector3) vector3 **)** + * [int](class_int) **[size](#size)** **(** **)** + * void **[Vector3Array](#Vector3Array)** **(** [Array](class_array) from **)** ### Member Function Description diff --git a/class_videoplayer.md b/class_videoplayer.md index d9985ec..71c8fd9 100644 --- a/class_videoplayer.md +++ b/class_videoplayer.md @@ -6,22 +6,22 @@ ### Member Functions - * void **[`set_stream`](#set_stream)** **(** Stream stream **)** - * Stream **[`get_stream`](#get_stream)** **(** **)** const - * void **[`play`](#play)** **(** **)** - * void **[`stop`](#stop)** **(** **)** - * [bool](class_bool) **[`is_playing`](#is_playing)** **(** **)** const - * void **[`set_paused`](#set_paused)** **(** [bool](class_bool) paused **)** - * [bool](class_bool) **[`is_paused`](#is_paused)** **(** **)** const - * void **[`set_volume`](#set_volume)** **(** [real](class_real) volume **)** - * [real](class_real) **[`get_volume`](#get_volume)** **(** **)** const - * void **[`set_volume_db`](#set_volume_db)** **(** [real](class_real) db **)** - * [real](class_real) **[`get_volume_db`](#get_volume_db)** **(** **)** const - * [String](class_string) **[`get_stream_name`](#get_stream_name)** **(** **)** const - * [real](class_real) **[`get_pos`](#get_pos)** **(** **)** const - * void **[`set_autoplay`](#set_autoplay)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`has_autoplay`](#has_autoplay)** **(** **)** const - * void **[`set_expand`](#set_expand)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`has_expand`](#has_expand)** **(** **)** const + * void **[set_stream](#set_stream)** **(** Stream stream **)** + * Stream **[get_stream](#get_stream)** **(** **)** const + * void **[play](#play)** **(** **)** + * void **[stop](#stop)** **(** **)** + * [bool](class_bool) **[is_playing](#is_playing)** **(** **)** const + * void **[set_paused](#set_paused)** **(** [bool](class_bool) paused **)** + * [bool](class_bool) **[is_paused](#is_paused)** **(** **)** const + * void **[set_volume](#set_volume)** **(** [real](class_real) volume **)** + * [real](class_real) **[get_volume](#get_volume)** **(** **)** const + * void **[set_volume_db](#set_volume_db)** **(** [real](class_real) db **)** + * [real](class_real) **[get_volume_db](#get_volume_db)** **(** **)** const + * [String](class_string) **[get_stream_name](#get_stream_name)** **(** **)** const + * [real](class_real) **[get_pos](#get_pos)** **(** **)** const + * void **[set_autoplay](#set_autoplay)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[has_autoplay](#has_autoplay)** **(** **)** const + * void **[set_expand](#set_expand)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[has_expand](#has_expand)** **(** **)** const ### Member Function Description diff --git a/class_videostream.md b/class_videostream.md index 29f8088..7d9da12 100644 --- a/class_videostream.md +++ b/class_videostream.md @@ -6,8 +6,8 @@ ### Member Functions - * [int](class_int) **[`get_pending_frame_count`](#get_pending_frame_count)** **(** **)** const - * [Image](class_image) **[`pop_frame`](#pop_frame)** **(** **)** - * [Image](class_image) **[`peek_frame`](#peek_frame)** **(** **)** const + * [int](class_int) **[get_pending_frame_count](#get_pending_frame_count)** **(** **)** const + * [Image](class_image) **[pop_frame](#pop_frame)** **(** **)** + * [Image](class_image) **[peek_frame](#peek_frame)** **(** **)** const ### Member Function Description diff --git a/class_viewport.md b/class_viewport.md index 2732850..25a66e3 100644 --- a/class_viewport.md +++ b/class_viewport.md @@ -6,34 +6,34 @@ Creates a sub-view into the screen. ### Member Functions - * void **[`set_rect`](#set_rect)** **(** [Rect2](class_rect2) rect **)** - * [Rect2](class_rect2) **[`get_rect`](#get_rect)** **(** **)** const - * [World2D](class_world2d) **[`find_world_2d`](#find_world_2d)** **(** **)** const - * void **[`set_world`](#set_world)** **(** [World](class_world) world **)** - * [World](class_world) **[`get_world`](#get_world)** **(** **)** const - * [World](class_world) **[`find_world`](#find_world)** **(** **)** const - * void **[`set_canvas_transform`](#set_canvas_transform)** **(** [Matrix32](class_matrix32) xform **)** - * [Matrix32](class_matrix32) **[`get_canvas_transform`](#get_canvas_transform)** **(** **)** const - * void **[`set_global_canvas_transform`](#set_global_canvas_transform)** **(** [Matrix32](class_matrix32) xform **)** - * [Matrix32](class_matrix32) **[`get_global_canvas_transform`](#get_global_canvas_transform)** **(** **)** const - * [Matrix32](class_matrix32) **[`get_final_transform`](#get_final_transform)** **(** **)** const - * [Rect2](class_rect2) **[`get_visible_rect`](#get_visible_rect)** **(** **)** const - * void **[`set_transparent_background`](#set_transparent_background)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`has_transparent_background`](#has_transparent_background)** **(** **)** const - * void **[`set_size_override`](#set_size_override)** **(** [bool](class_bool) enable, [Vector2](class_vector2) size=Vector2(-1,-1), [Vector2](class_vector2) margin=Vector2(0,0) **)** - * [Vector2](class_vector2) **[`get_size_override`](#get_size_override)** **(** **)** const - * [bool](class_bool) **[`is_size_override_enabled`](#is_size_override_enabled)** **(** **)** const - * void **[`set_size_override_stretch`](#set_size_override_stretch)** **(** [bool](class_bool) enabled **)** - * [bool](class_bool) **[`is_size_override_stretch_enabled`](#is_size_override_stretch_enabled)** **(** **)** const - * void **[`queue_screen_capture`](#queue_screen_capture)** **(** **)** - * [Image](class_image) **[`get_screen_capture`](#get_screen_capture)** **(** **)** const - * void **[`set_as_render_target`](#set_as_render_target)** **(** [bool](class_bool) enable **)** - * [bool](class_bool) **[`is_set_as_render_target`](#is_set_as_render_target)** **(** **)** const - * [RID](class_rid) **[`get_viewport`](#get_viewport)** **(** **)** const - * void **[`update_worlds`](#update_worlds)** **(** **)** + * void **[set_rect](#set_rect)** **(** [Rect2](class_rect2) rect **)** + * [Rect2](class_rect2) **[get_rect](#get_rect)** **(** **)** const + * [World2D](class_world2d) **[find_worldθd](#find_world_2d)** **(** **)** const + * void **[set_world](#set_world)** **(** [World](class_world) world **)** + * [World](class_world) **[get_world](#get_world)** **(** **)** const + * [World](class_world) **[find_world](#find_world)** **(** **)** const + * void **[set_canvas_transform](#set_canvas_transform)** **(** [Matrix32](class_matrix32) xform **)** + * [Matrix32](class_matrix32) **[get_canvas_transform](#get_canvas_transform)** **(** **)** const + * void **[set_global_canvas_transform](#set_global_canvas_transform)** **(** [Matrix32](class_matrix32) xform **)** + * [Matrix32](class_matrix32) **[get_global_canvas_transform](#get_global_canvas_transform)** **(** **)** const + * [Matrix32](class_matrix32) **[get_final_transform](#get_final_transform)** **(** **)** const + * [Rect2](class_rect2) **[get_visible_rect](#get_visible_rect)** **(** **)** const + * void **[set_transparent_background](#set_transparent_background)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[has_transparent_background](#has_transparent_background)** **(** **)** const + * void **[set_size_override](#set_size_override)** **(** [bool](class_bool) enable, [Vector2](class_vector2) size=Vector2(-1,-1), [Vector2](class_vector2) margin=Vector2(0,0) **)** + * [Vector2](class_vector2) **[get_size_override](#get_size_override)** **(** **)** const + * [bool](class_bool) **[is_size_override_enabled](#is_size_override_enabled)** **(** **)** const + * void **[set_size_override_stretch](#set_size_override_stretch)** **(** [bool](class_bool) enabled **)** + * [bool](class_bool) **[is_size_override_stretch_enabled](#is_size_override_stretch_enabled)** **(** **)** const + * void **[queue_screen_capture](#queue_screen_capture)** **(** **)** + * [Image](class_image) **[get_screen_capture](#get_screen_capture)** **(** **)** const + * void **[set_as_render_target](#set_as_render_target)** **(** [bool](class_bool) enable **)** + * [bool](class_bool) **[is_set_as_render_target](#is_set_as_render_target)** **(** **)** const + * [RID](class_rid) **[get_viewport](#get_viewport)** **(** **)** const + * void **[update_worlds](#update_worlds)** **(** **)** ### Signals - * **`size_changed`** **(** **)** + * **size_changed** **(** **)** ### Description A Viewport creates a different view into the screen, or a sub-view inside another viewport. Children 2D Nodes will display on it, and children Camera 3D nodes will renderon it too. @@ -51,31 +51,31 @@ A Viewport creates a different view into the screen, or a sub-view inside anothe ### Member Function Description #### set_rect - * void **`set_rect`** **(** [Rect2](class_rect2) rect **)** + * void **set_rect** **(** [Rect2](class_rect2) rect **)** Set the viewport rect. If the viewport is child of a control, it will use the same as the parent. #### get_rect - * [Rect2](class_rect2) **`get_rect`** **(** **)** const + * [Rect2](class_rect2) **get_rect** **(** **)** const Return the viewport rect. If the viewport is child of a control, it will use the same as the parent, otherwise if the rect is empty, the viewport will use all the allowed space. #### get_visible_rect - * [Rect2](class_rect2) **`get_visible_rect`** **(** **)** const + * [Rect2](class_rect2) **get_visible_rect** **(** **)** const Return the final, visuble rect in global screen coordinates. #### set_transparent_background - * void **`set_transparent_background`** **(** [bool](class_bool) enable **)** + * void **set_transparent_background** **(** [bool](class_bool) enable **)** Keep whathver the parent viewport has drawn #### has_transparent_background - * [bool](class_bool) **`has_transparent_background`** **(** **)** const + * [bool](class_bool) **has_transparent_background** **(** **)** const If this viewport is a child of another viewport, keep the previously drawn background visible. #### get_viewport - * [RID](class_rid) **`get_viewport`** **(** **)** const + * [RID](class_rid) **get_viewport** **(** **)** const Get the viewport RID from the visual server. diff --git a/class_visibilityenabler.md b/class_visibilityenabler.md index 902c70a..648c423 100644 --- a/class_visibilityenabler.md +++ b/class_visibilityenabler.md @@ -6,8 +6,8 @@ ### Member Functions - * void **[`set_enabler`](#set_enabler)** **(** [int](class_int) enabler, [bool](class_bool) enabled **)** - * [bool](class_bool) **[`is_enabler_enabled`](#is_enabler_enabled)** **(** [int](class_int) enabler **)** const + * void **[set_enabler](#set_enabler)** **(** [int](class_int) enabler, [bool](class_bool) enabled **)** + * [bool](class_bool) **[is_enabler_enabled](#is_enabler_enabled)** **(** [int](class_int) enabler **)** const ### Numeric Constants * **ENABLER_FREEZE_BODIES** = **1** diff --git a/class_visibilityenabler2d.md b/class_visibilityenabler2d.md index 6de36aa..7e6545c 100644 --- a/class_visibilityenabler2d.md +++ b/class_visibilityenabler2d.md @@ -6,8 +6,8 @@ ### Member Functions - * void **[`set_enabler`](#set_enabler)** **(** [int](class_int) enabler, [bool](class_bool) enabled **)** - * [bool](class_bool) **[`is_enabler_enabled`](#is_enabler_enabled)** **(** [int](class_int) enabler **)** const + * void **[set_enabler](#set_enabler)** **(** [int](class_int) enabler, [bool](class_bool) enabled **)** + * [bool](class_bool) **[is_enabler_enabled](#is_enabler_enabled)** **(** [int](class_int) enabler **)** const ### Numeric Constants * **ENABLER_FREEZE_BODIES** = **1** diff --git a/class_visibilitynotifier.md b/class_visibilitynotifier.md index f7385d1..5e6f0f3 100644 --- a/class_visibilitynotifier.md +++ b/class_visibilitynotifier.md @@ -6,14 +6,14 @@ ### Member Functions - * void **[`set_aabb`](#set_aabb)** **(** [AABB](class_aabb) rect **)** - * [AABB](class_aabb) **[`get_aabb`](#get_aabb)** **(** **)** const - * [bool](class_bool) **[`is_on_screen`](#is_on_screen)** **(** **)** const + * void **[set_aabb](#set_aabb)** **(** [AABB](class_aabb) rect **)** + * [AABB](class_aabb) **[get_aabb](#get_aabb)** **(** **)** const + * [bool](class_bool) **[is_on_screen](#is_on_screen)** **(** **)** const ### Signals - * **`enter_screen`** **(** **)** - * **`enter_camera`** **(** [Object](class_object) camera **)** - * **`exit_screen`** **(** **)** - * **`exit_camera`** **(** [Object](class_object) camera **)** + * **enter_screen** **(** **)** + * **enter_camera** **(** [Object](class_object) camera **)** + * **exit_screen** **(** **)** + * **exit_camera** **(** [Object](class_object) camera **)** ### Member Function Description diff --git a/class_visibilitynotifier2d.md b/class_visibilitynotifier2d.md index 1a6d8fe..f223bc2 100644 --- a/class_visibilitynotifier2d.md +++ b/class_visibilitynotifier2d.md @@ -6,14 +6,14 @@ ### Member Functions - * void **[`set_rect`](#set_rect)** **(** [Rect2](class_rect2) rect **)** - * [Rect2](class_rect2) **[`get_rect`](#get_rect)** **(** **)** const - * [bool](class_bool) **[`is_on_screen`](#is_on_screen)** **(** **)** const + * void **[set_rect](#set_rect)** **(** [Rect2](class_rect2) rect **)** + * [Rect2](class_rect2) **[get_rect](#get_rect)** **(** **)** const + * [bool](class_bool) **[is_on_screen](#is_on_screen)** **(** **)** const ### Signals - * **`enter_screen`** **(** **)** - * **`enter_viewport`** **(** [Object](class_object) viewport **)** - * **`exit_screen`** **(** **)** - * **`exit_viewport`** **(** [Object](class_object) viewport **)** + * **enter_screen** **(** **)** + * **enter_viewport** **(** [Object](class_object) viewport **)** + * **exit_screen** **(** **)** + * **exit_viewport** **(** [Object](class_object) viewport **)** ### Member Function Description diff --git a/class_visualinstance.md b/class_visualinstance.md index 6a05e40..0c5504f 100644 --- a/class_visualinstance.md +++ b/class_visualinstance.md @@ -6,8 +6,8 @@ ### Member Functions - * void **[`set_base`](#set_base)** **(** [RID](class_rid) base **)** - * void **[`set_layer_mask`](#set_layer_mask)** **(** [int](class_int) mask **)** - * [int](class_int) **[`get_layer_mask`](#get_layer_mask)** **(** **)** const + * void **[set_base](#set_base)** **(** [RID](class_rid) base **)** + * void **[set_layer_mask](#set_layer_mask)** **(** [int](class_int) mask **)** + * [int](class_int) **[get_layer_mask](#get_layer_mask)** **(** **)** const ### Member Function Description diff --git a/class_visualserver.md b/class_visualserver.md index 8346ded..d2e51f9 100644 --- a/class_visualserver.md +++ b/class_visualserver.md @@ -6,164 +6,164 @@ Server for anything visible. ### Member Functions - * [RID](class_rid) **[`texture_create`](#texture_create)** **(** **)** - * [RID](class_rid) **[`texture_create_from_image`](#texture_create_from_image)** **(** [Image](class_image) arg0, [int](class_int) arg1=7 **)** - * void **[`texture_set_flags`](#texture_set_flags)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** - * [int](class_int) **[`texture_get_flags`](#texture_get_flags)** **(** [RID](class_rid) arg0 **)** const - * [int](class_int) **[`texture_get_width`](#texture_get_width)** **(** [RID](class_rid) arg0 **)** const - * [int](class_int) **[`texture_get_height`](#texture_get_height)** **(** [RID](class_rid) arg0 **)** const - * [RID](class_rid) **[`shader_create`](#shader_create)** **(** [int](class_int) mode=0 **)** - * void **[`shader_set_mode`](#shader_set_mode)** **(** [RID](class_rid) shader, [int](class_int) mode **)** - * [RID](class_rid) **[`material_create`](#material_create)** **(** **)** - * void **[`material_set_shader`](#material_set_shader)** **(** [RID](class_rid) shader, [RID](class_rid) arg1 **)** - * [RID](class_rid) **[`material_get_shader`](#material_get_shader)** **(** [RID](class_rid) arg0 **)** const - * void **[`material_set_param`](#material_set_param)** **(** [RID](class_rid) arg0, [String](class_string) arg1, var arg2 **)** - * void **[`material_get_param`](#material_get_param)** **(** [RID](class_rid) arg0, [String](class_string) arg1 **)** const - * void **[`material_set_flag`](#material_set_flag)** **(** [RID](class_rid) arg0, [int](class_int) arg1, [bool](class_bool) arg2 **)** - * [bool](class_bool) **[`material_get_flag`](#material_get_flag)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const - * void **[`material_set_blend_mode`](#material_set_blend_mode)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** - * [int](class_int) **[`material_get_blend_mode`](#material_get_blend_mode)** **(** [RID](class_rid) arg0 **)** const - * void **[`material_set_line_width`](#material_set_line_width)** **(** [RID](class_rid) arg0, [real](class_real) arg1 **)** - * [real](class_real) **[`material_get_line_width`](#material_get_line_width)** **(** [RID](class_rid) arg0 **)** const - * [RID](class_rid) **[`mesh_create`](#mesh_create)** **(** **)** - * void **[`mesh_add_surface`](#mesh_add_surface)** **(** [RID](class_rid) arg0, [int](class_int) arg1, [Array](class_array) arg2, [Array](class_array) arg3, [bool](class_bool) arg4=-1 **)** - * void **[`mesh_surface_set_material`](#mesh_surface_set_material)** **(** [RID](class_rid) arg0, [int](class_int) arg1, [RID](class_rid) arg2, [bool](class_bool) arg3=false **)** - * [RID](class_rid) **[`mesh_surface_get_material`](#mesh_surface_get_material)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const - * [int](class_int) **[`mesh_surface_get_array_len`](#mesh_surface_get_array_len)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const - * [int](class_int) **[`mesh_surface_get_array_index_len`](#mesh_surface_get_array_index_len)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const - * [int](class_int) **[`mesh_surface_get_format`](#mesh_surface_get_format)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const - * [int](class_int) **[`mesh_surface_get_primitive_type`](#mesh_surface_get_primitive_type)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const - * void **[`mesh_remove_surface`](#mesh_remove_surface)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** - * [int](class_int) **[`mesh_get_surface_count`](#mesh_get_surface_count)** **(** [RID](class_rid) arg0 **)** const - * [RID](class_rid) **[`multimesh_create`](#multimesh_create)** **(** **)** - * void **[`multimesh_set_mesh`](#multimesh_set_mesh)** **(** [RID](class_rid) arg0, [RID](class_rid) arg1 **)** - * void **[`multimesh_set_aabb`](#multimesh_set_aabb)** **(** [RID](class_rid) arg0, [AABB](class_aabb) arg1 **)** - * void **[`multimesh_instance_set_transform`](#multimesh_instance_set_transform)** **(** [RID](class_rid) arg0, [int](class_int) arg1, [Transform](class_transform) arg2 **)** - * void **[`multimesh_instance_set_color`](#multimesh_instance_set_color)** **(** [RID](class_rid) arg0, [int](class_int) arg1, [Color](class_color) arg2 **)** - * [RID](class_rid) **[`multimesh_get_mesh`](#multimesh_get_mesh)** **(** [RID](class_rid) arg0 **)** const - * [AABB](class_aabb) **[`multimesh_get_aabb`](#multimesh_get_aabb)** **(** [RID](class_rid) arg0, [AABB](class_aabb) arg1 **)** const - * [Transform](class_transform) **[`multimesh_instance_get_transform`](#multimesh_instance_get_transform)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const - * [Color](class_color) **[`multimesh_instance_get_color`](#multimesh_instance_get_color)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const - * [RID](class_rid) **[`particles_create`](#particles_create)** **(** **)** - * void **[`particles_set_amount`](#particles_set_amount)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** - * [int](class_int) **[`particles_get_amount`](#particles_get_amount)** **(** [RID](class_rid) arg0 **)** const - * void **[`particles_set_emitting`](#particles_set_emitting)** **(** [RID](class_rid) arg0, [bool](class_bool) arg1 **)** - * [bool](class_bool) **[`particles_is_emitting`](#particles_is_emitting)** **(** [RID](class_rid) arg0 **)** const - * void **[`particles_set_visibility_aabb`](#particles_set_visibility_aabb)** **(** [RID](class_rid) arg0, [AABB](class_aabb) arg1 **)** - * [AABB](class_aabb) **[`particles_get_visibility_aabb`](#particles_get_visibility_aabb)** **(** [RID](class_rid) arg0 **)** const - * void **[`particles_set_variable`](#particles_set_variable)** **(** [RID](class_rid) arg0, [int](class_int) arg1, [real](class_real) arg2 **)** - * [real](class_real) **[`particles_get_variable`](#particles_get_variable)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const - * void **[`particles_set_randomness`](#particles_set_randomness)** **(** [RID](class_rid) arg0, [int](class_int) arg1, [real](class_real) arg2 **)** - * [real](class_real) **[`particles_get_randomness`](#particles_get_randomness)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const - * void **[`particles_set_color_phases`](#particles_set_color_phases)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** - * [int](class_int) **[`particles_get_color_phases`](#particles_get_color_phases)** **(** [RID](class_rid) arg0 **)** const - * void **[`particles_set_color_phase_pos`](#particles_set_color_phase_pos)** **(** [RID](class_rid) arg0, [int](class_int) arg1, [real](class_real) arg2 **)** - * [real](class_real) **[`particles_get_color_phase_pos`](#particles_get_color_phase_pos)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const - * void **[`particles_set_color_phase_color`](#particles_set_color_phase_color)** **(** [RID](class_rid) arg0, [int](class_int) arg1, [Color](class_color) arg2 **)** - * [Color](class_color) **[`particles_get_color_phase_color`](#particles_get_color_phase_color)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const - * void **[`particles_set_attractors`](#particles_set_attractors)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** - * [int](class_int) **[`particles_get_attractors`](#particles_get_attractors)** **(** [RID](class_rid) arg0 **)** const - * void **[`particles_set_attractor_pos`](#particles_set_attractor_pos)** **(** [RID](class_rid) arg0, [int](class_int) arg1, [Vector3](class_vector3) arg2 **)** - * [Vector3](class_vector3) **[`particles_get_attractor_pos`](#particles_get_attractor_pos)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const - * void **[`particles_set_attractor_strength`](#particles_set_attractor_strength)** **(** [RID](class_rid) arg0, [int](class_int) arg1, [real](class_real) arg2 **)** - * [real](class_real) **[`particles_get_attractor_strength`](#particles_get_attractor_strength)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const - * void **[`particles_set_material`](#particles_set_material)** **(** [RID](class_rid) arg0, [RID](class_rid) arg1, [bool](class_bool) arg2=false **)** - * void **[`particles_set_height_from_velocity`](#particles_set_height_from_velocity)** **(** [RID](class_rid) arg0, [bool](class_bool) arg1 **)** - * [bool](class_bool) **[`particles_has_height_from_velocity`](#particles_has_height_from_velocity)** **(** [RID](class_rid) arg0 **)** const - * [RID](class_rid) **[`light_create`](#light_create)** **(** [int](class_int) arg0 **)** - * [int](class_int) **[`light_get_type`](#light_get_type)** **(** [RID](class_rid) arg0 **)** const - * void **[`light_set_color`](#light_set_color)** **(** [RID](class_rid) arg0, [int](class_int) arg1, [Color](class_color) arg2 **)** - * [Color](class_color) **[`light_get_color`](#light_get_color)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const - * void **[`light_set_shadow`](#light_set_shadow)** **(** [RID](class_rid) arg0, [bool](class_bool) arg1 **)** - * [bool](class_bool) **[`light_has_shadow`](#light_has_shadow)** **(** [RID](class_rid) arg0 **)** const - * void **[`light_set_volumetric`](#light_set_volumetric)** **(** [RID](class_rid) arg0, [bool](class_bool) arg1 **)** - * [bool](class_bool) **[`light_is_volumetric`](#light_is_volumetric)** **(** [RID](class_rid) arg0 **)** const - * void **[`light_set_projector`](#light_set_projector)** **(** [RID](class_rid) arg0, [RID](class_rid) arg1 **)** - * [RID](class_rid) **[`light_get_projector`](#light_get_projector)** **(** [RID](class_rid) arg0 **)** const - * void **[`light_set_var`](#light_set_var)** **(** [RID](class_rid) arg0, [int](class_int) arg1, [real](class_real) arg2 **)** - * [real](class_real) **[`light_get_var`](#light_get_var)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const - * [RID](class_rid) **[`skeleton_create`](#skeleton_create)** **(** **)** - * void **[`skeleton_resize`](#skeleton_resize)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** - * [int](class_int) **[`skeleton_get_bone_count`](#skeleton_get_bone_count)** **(** [RID](class_rid) arg0 **)** const - * void **[`skeleton_bone_set_transform`](#skeleton_bone_set_transform)** **(** [RID](class_rid) arg0, [int](class_int) arg1, [Transform](class_transform) arg2 **)** - * [Transform](class_transform) **[`skeleton_bone_get_transform`](#skeleton_bone_get_transform)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** - * [RID](class_rid) **[`room_create`](#room_create)** **(** **)** - * void **[`room_set_bounds`](#room_set_bounds)** **(** [RID](class_rid) arg0, [Dictionary](class_dictionary) arg1 **)** - * [Dictionary](class_dictionary) **[`room_get_bounds`](#room_get_bounds)** **(** [RID](class_rid) arg0 **)** const - * [RID](class_rid) **[`portal_create`](#portal_create)** **(** **)** - * void **[`portal_set_shape`](#portal_set_shape)** **(** [RID](class_rid) arg0, [Vector2Array](class_vector2array) arg1 **)** - * [Vector2Array](class_vector2array) **[`portal_get_shape`](#portal_get_shape)** **(** [RID](class_rid) arg0 **)** const - * void **[`portal_set_enabled`](#portal_set_enabled)** **(** [RID](class_rid) arg0, [bool](class_bool) arg1 **)** - * [bool](class_bool) **[`portal_is_enabled`](#portal_is_enabled)** **(** [RID](class_rid) arg0 **)** const - * void **[`portal_set_disable_distance`](#portal_set_disable_distance)** **(** [RID](class_rid) arg0, [real](class_real) arg1 **)** - * [real](class_real) **[`portal_get_disable_distance`](#portal_get_disable_distance)** **(** [RID](class_rid) arg0 **)** const - * void **[`portal_set_disabled_color`](#portal_set_disabled_color)** **(** [RID](class_rid) arg0, [Color](class_color) arg1 **)** - * [Color](class_color) **[`portal_get_disabled_color`](#portal_get_disabled_color)** **(** [RID](class_rid) arg0 **)** const - * [RID](class_rid) **[`camera_create`](#camera_create)** **(** **)** - * void **[`camera_set_perspective`](#camera_set_perspective)** **(** [RID](class_rid) arg0, [real](class_real) arg1, [real](class_real) arg2, [real](class_real) arg3 **)** - * void **[`camera_set_orthogonal`](#camera_set_orthogonal)** **(** [RID](class_rid) arg0, [real](class_real) arg1, [real](class_real) arg2, [real](class_real) arg3 **)** - * void **[`camera_set_transform`](#camera_set_transform)** **(** [RID](class_rid) arg0, [Transform](class_transform) arg1 **)** - * [RID](class_rid) **[`viewport_create`](#viewport_create)** **(** **)** - * void **[`viewport_set_rect`](#viewport_set_rect)** **(** [RID](class_rid) arg0, [Rect2](class_rect2) arg1 **)** - * [Rect2](class_rect2) **[`viewport_get_rect`](#viewport_get_rect)** **(** [RID](class_rid) arg0 **)** const - * void **[`viewport_attach_camera`](#viewport_attach_camera)** **(** [RID](class_rid) arg0, [RID](class_rid) arg1=RID() **)** - * [RID](class_rid) **[`viewport_get_attached_camera`](#viewport_get_attached_camera)** **(** [RID](class_rid) arg0 **)** const - * [RID](class_rid) **[`viewport_get_scenario`](#viewport_get_scenario)** **(** [RID](class_rid) arg0 **)** const - * void **[`viewport_attach_canvas`](#viewport_attach_canvas)** **(** [RID](class_rid) arg0, [RID](class_rid) arg1 **)** - * void **[`viewport_remove_canvas`](#viewport_remove_canvas)** **(** [RID](class_rid) arg0, [RID](class_rid) arg1 **)** - * void **[`viewport_set_global_canvas_transform`](#viewport_set_global_canvas_transform)** **(** [RID](class_rid) arg0, [Matrix32](class_matrix32) arg1 **)** - * [RID](class_rid) **[`scenario_create`](#scenario_create)** **(** **)** - * void **[`scenario_set_debug`](#scenario_set_debug)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** - * [RID](class_rid) **[`instance_create`](#instance_create)** **(** **)** - * [RID](class_rid) **[`instance_get_base`](#instance_get_base)** **(** [RID](class_rid) arg0 **)** const - * [RID](class_rid) **[`instance_get_base_aabb`](#instance_get_base_aabb)** **(** [RID](class_rid) arg0 **)** const - * void **[`instance_set_transform`](#instance_set_transform)** **(** [RID](class_rid) arg0, [Transform](class_transform) arg1 **)** - * [Transform](class_transform) **[`instance_get_transform`](#instance_get_transform)** **(** [RID](class_rid) arg0 **)** const - * void **[`instance_attach_object_instance_ID`](#instance_attach_object_instance_ID)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** - * [int](class_int) **[`instance_get_object_instance_ID`](#instance_get_object_instance_ID)** **(** [RID](class_rid) arg0 **)** const - * void **[`instance_attach_skeleton`](#instance_attach_skeleton)** **(** [RID](class_rid) arg0, [RID](class_rid) arg1 **)** - * [RID](class_rid) **[`instance_get_skeleton`](#instance_get_skeleton)** **(** [RID](class_rid) arg0 **)** const - * void **[`instance_set_room`](#instance_set_room)** **(** [RID](class_rid) arg0, [RID](class_rid) arg1 **)** - * [RID](class_rid) **[`instance_get_room`](#instance_get_room)** **(** [RID](class_rid) arg0 **)** const - * void **[`instance_set_exterior`](#instance_set_exterior)** **(** [RID](class_rid) arg0, [bool](class_bool) arg1 **)** - * [bool](class_bool) **[`instance_is_exterior`](#instance_is_exterior)** **(** [RID](class_rid) arg0 **)** const - * [Array](class_array) **[`instances_cull_aabb`](#instances_cull_aabb)** **(** [AABB](class_aabb) arg0, [RID](class_rid) arg1 **)** const - * [Array](class_array) **[`instances_cull_ray`](#instances_cull_ray)** **(** [Vector3](class_vector3) arg0, [Vector3](class_vector3) arg1, [RID](class_rid) arg2 **)** const - * [Array](class_array) **[`instances_cull_convex`](#instances_cull_convex)** **(** [Vector3](class_vector3) arg0, [Vector3](class_vector3) arg1, [RID](class_rid) arg2 **)** const - * [RID](class_rid) **[`instance_geometry_override_material_param`](#instance_geometry_override_material_param)** **(** [RID](class_rid) arg0 **)** const - * [RID](class_rid) **[`instance_geometry_get_material_param`](#instance_geometry_get_material_param)** **(** [RID](class_rid) arg0 **)** const - * [RID](class_rid) **[`get_test_cube`](#get_test_cube)** **(** **)** - * [RID](class_rid) **[`canvas_create`](#canvas_create)** **(** **)** - * [RID](class_rid) **[`canvas_item_create`](#canvas_item_create)** **(** **)** - * void **[`canvas_item_set_parent`](#canvas_item_set_parent)** **(** [RID](class_rid) arg0, [RID](class_rid) arg1 **)** - * [RID](class_rid) **[`canvas_item_get_parent`](#canvas_item_get_parent)** **(** [RID](class_rid) arg0 **)** const - * void **[`canvas_item_set_transform`](#canvas_item_set_transform)** **(** [RID](class_rid) arg0, [Matrix32](class_matrix32) arg1 **)** - * void **[`canvas_item_set_custom_rect`](#canvas_item_set_custom_rect)** **(** [RID](class_rid) arg0, [bool](class_bool) arg1, [Rect2](class_rect2) arg2 **)** - * void **[`canvas_item_set_clip`](#canvas_item_set_clip)** **(** [RID](class_rid) arg0, [bool](class_bool) arg1 **)** - * void **[`canvas_item_set_opacity`](#canvas_item_set_opacity)** **(** [RID](class_rid) arg0, [real](class_real) arg1 **)** - * [real](class_real) **[`canvas_item_get_opacity`](#canvas_item_get_opacity)** **(** [RID](class_rid) arg0, [real](class_real) arg1 **)** const - * void **[`canvas_item_set_self_opacity`](#canvas_item_set_self_opacity)** **(** [RID](class_rid) arg0, [real](class_real) arg1 **)** - * [real](class_real) **[`canvas_item_get_self_opacity`](#canvas_item_get_self_opacity)** **(** [RID](class_rid) arg0, [real](class_real) arg1 **)** const - * void **[`canvas_item_add_line`](#canvas_item_add_line)** **(** [RID](class_rid) arg0, [Vector2](class_vector2) arg1, [Vector2](class_vector2) arg2, [Color](class_color) arg3, [real](class_real) arg4=1 **)** - * void **[`canvas_item_add_rect`](#canvas_item_add_rect)** **(** [RID](class_rid) arg0, [Rect2](class_rect2) arg1, [Color](class_color) arg2 **)** - * void **[`canvas_item_add_texture_rect`](#canvas_item_add_texture_rect)** **(** [RID](class_rid) arg0, [Rect2](class_rect2) arg1, [RID](class_rid) arg2, [bool](class_bool) arg3, [Color](class_color) arg4=Color(1,1,1,1) **)** - * void **[`canvas_item_add_texture_rect_region`](#canvas_item_add_texture_rect_region)** **(** [RID](class_rid) arg0, [Rect2](class_rect2) arg1, [RID](class_rid) arg2, [Rect2](class_rect2) arg3, [Color](class_color) arg4=Color(1,1,1,1) **)** - * void **[`canvas_item_add_style_box`](#canvas_item_add_style_box)** **(** [RID](class_rid) arg0, [Rect2](class_rect2) arg1, [RID](class_rid) arg2, [RealArray](class_realarray) arg3, [Color](class_color) arg4=Color(1,1,1,1) **)** - * void **[`canvas_item_add_circle`](#canvas_item_add_circle)** **(** [RID](class_rid) arg0, [Vector2](class_vector2) arg1, [real](class_real) arg2, [Color](class_color) arg3 **)** - * void **[`viewport_set_canvas_transform`](#viewport_set_canvas_transform)** **(** [RID](class_rid) arg0, [RID](class_rid) arg1, [Matrix32](class_matrix32) arg2 **)** - * void **[`canvas_item_clear`](#canvas_item_clear)** **(** [RID](class_rid) arg0 **)** - * void **[`canvas_item_raise`](#canvas_item_raise)** **(** [RID](class_rid) arg0 **)** - * void **[`cursor_set_rotation`](#cursor_set_rotation)** **(** [real](class_real) arg0, [int](class_int) arg1 **)** - * void **[`cursor_set_texture`](#cursor_set_texture)** **(** [RID](class_rid) arg0, [Vector2](class_vector2) arg1, [int](class_int) arg2 **)** - * void **[`cursor_set_visible`](#cursor_set_visible)** **(** [bool](class_bool) arg0, [int](class_int) arg1 **)** - * void **[`cursor_set_pos`](#cursor_set_pos)** **(** [Vector2](class_vector2) arg0, [int](class_int) arg1 **)** - * void **[`black_bars_set_margins`](#black_bars_set_margins)** **(** [int](class_int) left, [int](class_int) top, [int](class_int) right, [int](class_int) bottom **)** - * [RID](class_rid) **[`make_sphere_mesh`](#make_sphere_mesh)** **(** [int](class_int) arg0, [int](class_int) arg1, [real](class_real) arg2 **)** - * void **[`mesh_add_surface_from_planes`](#mesh_add_surface_from_planes)** **(** [RID](class_rid) arg0, [Array](class_array) arg1 **)** - * void **[`draw`](#draw)** **(** **)** - * void **[`free`](#free)** **(** [RID](class_rid) arg0 **)** - * void **[`set_default_clear_color`](#set_default_clear_color)** **(** [Color](class_color) arg0 **)** - * [int](class_int) **[`get_render_info`](#get_render_info)** **(** [int](class_int) arg0 **)** + * [RID](class_rid) **[texture_create](#texture_create)** **(** **)** + * [RID](class_rid) **[texture_create_from_image](#texture_create_from_image)** **(** [Image](class_image) arg0, [int](class_int) arg1=7 **)** + * void **[texture_set_flags](#texture_set_flags)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** + * [int](class_int) **[texture_get_flags](#texture_get_flags)** **(** [RID](class_rid) arg0 **)** const + * [int](class_int) **[texture_get_width](#texture_get_width)** **(** [RID](class_rid) arg0 **)** const + * [int](class_int) **[texture_get_height](#texture_get_height)** **(** [RID](class_rid) arg0 **)** const + * [RID](class_rid) **[shader_create](#shader_create)** **(** [int](class_int) mode=0 **)** + * void **[shader_set_mode](#shader_set_mode)** **(** [RID](class_rid) shader, [int](class_int) mode **)** + * [RID](class_rid) **[material_create](#material_create)** **(** **)** + * void **[material_set_shader](#material_set_shader)** **(** [RID](class_rid) shader, [RID](class_rid) arg1 **)** + * [RID](class_rid) **[material_get_shader](#material_get_shader)** **(** [RID](class_rid) arg0 **)** const + * void **[material_set_param](#material_set_param)** **(** [RID](class_rid) arg0, [String](class_string) arg1, var arg2 **)** + * void **[material_get_param](#material_get_param)** **(** [RID](class_rid) arg0, [String](class_string) arg1 **)** const + * void **[material_set_flag](#material_set_flag)** **(** [RID](class_rid) arg0, [int](class_int) arg1, [bool](class_bool) arg2 **)** + * [bool](class_bool) **[material_get_flag](#material_get_flag)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const + * void **[material_set_blend_mode](#material_set_blend_mode)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** + * [int](class_int) **[material_get_blend_mode](#material_get_blend_mode)** **(** [RID](class_rid) arg0 **)** const + * void **[material_set_line_width](#material_set_line_width)** **(** [RID](class_rid) arg0, [real](class_real) arg1 **)** + * [real](class_real) **[material_get_line_width](#material_get_line_width)** **(** [RID](class_rid) arg0 **)** const + * [RID](class_rid) **[mesh_create](#mesh_create)** **(** **)** + * void **[mesh_add_surface](#mesh_add_surface)** **(** [RID](class_rid) arg0, [int](class_int) arg1, [Array](class_array) arg2, [Array](class_array) arg3, [bool](class_bool) arg4=-1 **)** + * void **[mesh_surface_set_material](#mesh_surface_set_material)** **(** [RID](class_rid) arg0, [int](class_int) arg1, [RID](class_rid) arg2, [bool](class_bool) arg3=false **)** + * [RID](class_rid) **[mesh_surface_get_material](#mesh_surface_get_material)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const + * [int](class_int) **[mesh_surface_get_array_len](#mesh_surface_get_array_len)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const + * [int](class_int) **[mesh_surface_get_array_index_len](#mesh_surface_get_array_index_len)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const + * [int](class_int) **[mesh_surface_get_format](#mesh_surface_get_format)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const + * [int](class_int) **[mesh_surface_get_primitive_type](#mesh_surface_get_primitive_type)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const + * void **[mesh_remove_surface](#mesh_remove_surface)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** + * [int](class_int) **[mesh_get_surface_count](#mesh_get_surface_count)** **(** [RID](class_rid) arg0 **)** const + * [RID](class_rid) **[multimesh_create](#multimesh_create)** **(** **)** + * void **[multimesh_set_mesh](#multimesh_set_mesh)** **(** [RID](class_rid) arg0, [RID](class_rid) arg1 **)** + * void **[multimesh_set_aabb](#multimesh_set_aabb)** **(** [RID](class_rid) arg0, [AABB](class_aabb) arg1 **)** + * void **[multimesh_instance_set_transform](#multimesh_instance_set_transform)** **(** [RID](class_rid) arg0, [int](class_int) arg1, [Transform](class_transform) arg2 **)** + * void **[multimesh_instance_set_color](#multimesh_instance_set_color)** **(** [RID](class_rid) arg0, [int](class_int) arg1, [Color](class_color) arg2 **)** + * [RID](class_rid) **[multimesh_get_mesh](#multimesh_get_mesh)** **(** [RID](class_rid) arg0 **)** const + * [AABB](class_aabb) **[multimesh_get_aabb](#multimesh_get_aabb)** **(** [RID](class_rid) arg0, [AABB](class_aabb) arg1 **)** const + * [Transform](class_transform) **[multimesh_instance_get_transform](#multimesh_instance_get_transform)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const + * [Color](class_color) **[multimesh_instance_get_color](#multimesh_instance_get_color)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const + * [RID](class_rid) **[particles_create](#particles_create)** **(** **)** + * void **[particles_set_amount](#particles_set_amount)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** + * [int](class_int) **[particles_get_amount](#particles_get_amount)** **(** [RID](class_rid) arg0 **)** const + * void **[particles_set_emitting](#particles_set_emitting)** **(** [RID](class_rid) arg0, [bool](class_bool) arg1 **)** + * [bool](class_bool) **[particles_is_emitting](#particles_is_emitting)** **(** [RID](class_rid) arg0 **)** const + * void **[particles_set_visibility_aabb](#particles_set_visibility_aabb)** **(** [RID](class_rid) arg0, [AABB](class_aabb) arg1 **)** + * [AABB](class_aabb) **[particles_get_visibility_aabb](#particles_get_visibility_aabb)** **(** [RID](class_rid) arg0 **)** const + * void **[particles_set_variable](#particles_set_variable)** **(** [RID](class_rid) arg0, [int](class_int) arg1, [real](class_real) arg2 **)** + * [real](class_real) **[particles_get_variable](#particles_get_variable)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const + * void **[particles_set_randomness](#particles_set_randomness)** **(** [RID](class_rid) arg0, [int](class_int) arg1, [real](class_real) arg2 **)** + * [real](class_real) **[particles_get_randomness](#particles_get_randomness)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const + * void **[particles_set_color_phases](#particles_set_color_phases)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** + * [int](class_int) **[particles_get_color_phases](#particles_get_color_phases)** **(** [RID](class_rid) arg0 **)** const + * void **[particles_set_color_phase_pos](#particles_set_color_phase_pos)** **(** [RID](class_rid) arg0, [int](class_int) arg1, [real](class_real) arg2 **)** + * [real](class_real) **[particles_get_color_phase_pos](#particles_get_color_phase_pos)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const + * void **[particles_set_color_phase_color](#particles_set_color_phase_color)** **(** [RID](class_rid) arg0, [int](class_int) arg1, [Color](class_color) arg2 **)** + * [Color](class_color) **[particles_get_color_phase_color](#particles_get_color_phase_color)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const + * void **[particles_set_attractors](#particles_set_attractors)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** + * [int](class_int) **[particles_get_attractors](#particles_get_attractors)** **(** [RID](class_rid) arg0 **)** const + * void **[particles_set_attractor_pos](#particles_set_attractor_pos)** **(** [RID](class_rid) arg0, [int](class_int) arg1, [Vector3](class_vector3) arg2 **)** + * [Vector3](class_vector3) **[particles_get_attractor_pos](#particles_get_attractor_pos)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const + * void **[particles_set_attractor_strength](#particles_set_attractor_strength)** **(** [RID](class_rid) arg0, [int](class_int) arg1, [real](class_real) arg2 **)** + * [real](class_real) **[particles_get_attractor_strength](#particles_get_attractor_strength)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const + * void **[particles_set_material](#particles_set_material)** **(** [RID](class_rid) arg0, [RID](class_rid) arg1, [bool](class_bool) arg2=false **)** + * void **[particles_set_height_from_velocity](#particles_set_height_from_velocity)** **(** [RID](class_rid) arg0, [bool](class_bool) arg1 **)** + * [bool](class_bool) **[particles_has_height_from_velocity](#particles_has_height_from_velocity)** **(** [RID](class_rid) arg0 **)** const + * [RID](class_rid) **[light_create](#light_create)** **(** [int](class_int) arg0 **)** + * [int](class_int) **[light_get_type](#light_get_type)** **(** [RID](class_rid) arg0 **)** const + * void **[light_set_color](#light_set_color)** **(** [RID](class_rid) arg0, [int](class_int) arg1, [Color](class_color) arg2 **)** + * [Color](class_color) **[light_get_color](#light_get_color)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const + * void **[light_set_shadow](#light_set_shadow)** **(** [RID](class_rid) arg0, [bool](class_bool) arg1 **)** + * [bool](class_bool) **[light_has_shadow](#light_has_shadow)** **(** [RID](class_rid) arg0 **)** const + * void **[light_set_volumetric](#light_set_volumetric)** **(** [RID](class_rid) arg0, [bool](class_bool) arg1 **)** + * [bool](class_bool) **[light_is_volumetric](#light_is_volumetric)** **(** [RID](class_rid) arg0 **)** const + * void **[light_set_projector](#light_set_projector)** **(** [RID](class_rid) arg0, [RID](class_rid) arg1 **)** + * [RID](class_rid) **[light_get_projector](#light_get_projector)** **(** [RID](class_rid) arg0 **)** const + * void **[light_set_var](#light_set_var)** **(** [RID](class_rid) arg0, [int](class_int) arg1, [real](class_real) arg2 **)** + * [real](class_real) **[light_get_var](#light_get_var)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** const + * [RID](class_rid) **[skeleton_create](#skeleton_create)** **(** **)** + * void **[skeleton_resize](#skeleton_resize)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** + * [int](class_int) **[skeleton_get_bone_count](#skeleton_get_bone_count)** **(** [RID](class_rid) arg0 **)** const + * void **[skeleton_bone_set_transform](#skeleton_bone_set_transform)** **(** [RID](class_rid) arg0, [int](class_int) arg1, [Transform](class_transform) arg2 **)** + * [Transform](class_transform) **[skeleton_bone_get_transform](#skeleton_bone_get_transform)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** + * [RID](class_rid) **[room_create](#room_create)** **(** **)** + * void **[room_set_bounds](#room_set_bounds)** **(** [RID](class_rid) arg0, [Dictionary](class_dictionary) arg1 **)** + * [Dictionary](class_dictionary) **[room_get_bounds](#room_get_bounds)** **(** [RID](class_rid) arg0 **)** const + * [RID](class_rid) **[portal_create](#portal_create)** **(** **)** + * void **[portal_set_shape](#portal_set_shape)** **(** [RID](class_rid) arg0, [Vector2Array](class_vector2array) arg1 **)** + * [Vector2Array](class_vector2array) **[portal_get_shape](#portal_get_shape)** **(** [RID](class_rid) arg0 **)** const + * void **[portal_set_enabled](#portal_set_enabled)** **(** [RID](class_rid) arg0, [bool](class_bool) arg1 **)** + * [bool](class_bool) **[portal_is_enabled](#portal_is_enabled)** **(** [RID](class_rid) arg0 **)** const + * void **[portal_set_disable_distance](#portal_set_disable_distance)** **(** [RID](class_rid) arg0, [real](class_real) arg1 **)** + * [real](class_real) **[portal_get_disable_distance](#portal_get_disable_distance)** **(** [RID](class_rid) arg0 **)** const + * void **[portal_set_disabled_color](#portal_set_disabled_color)** **(** [RID](class_rid) arg0, [Color](class_color) arg1 **)** + * [Color](class_color) **[portal_get_disabled_color](#portal_get_disabled_color)** **(** [RID](class_rid) arg0 **)** const + * [RID](class_rid) **[camera_create](#camera_create)** **(** **)** + * void **[camera_set_perspective](#camera_set_perspective)** **(** [RID](class_rid) arg0, [real](class_real) arg1, [real](class_real) arg2, [real](class_real) arg3 **)** + * void **[camera_set_orthogonal](#camera_set_orthogonal)** **(** [RID](class_rid) arg0, [real](class_real) arg1, [real](class_real) arg2, [real](class_real) arg3 **)** + * void **[camera_set_transform](#camera_set_transform)** **(** [RID](class_rid) arg0, [Transform](class_transform) arg1 **)** + * [RID](class_rid) **[viewport_create](#viewport_create)** **(** **)** + * void **[viewport_set_rect](#viewport_set_rect)** **(** [RID](class_rid) arg0, [Rect2](class_rect2) arg1 **)** + * [Rect2](class_rect2) **[viewport_get_rect](#viewport_get_rect)** **(** [RID](class_rid) arg0 **)** const + * void **[viewport_attach_camera](#viewport_attach_camera)** **(** [RID](class_rid) arg0, [RID](class_rid) arg1=RID() **)** + * [RID](class_rid) **[viewport_get_attached_camera](#viewport_get_attached_camera)** **(** [RID](class_rid) arg0 **)** const + * [RID](class_rid) **[viewport_get_scenario](#viewport_get_scenario)** **(** [RID](class_rid) arg0 **)** const + * void **[viewport_attach_canvas](#viewport_attach_canvas)** **(** [RID](class_rid) arg0, [RID](class_rid) arg1 **)** + * void **[viewport_remove_canvas](#viewport_remove_canvas)** **(** [RID](class_rid) arg0, [RID](class_rid) arg1 **)** + * void **[viewport_set_global_canvas_transform](#viewport_set_global_canvas_transform)** **(** [RID](class_rid) arg0, [Matrix32](class_matrix32) arg1 **)** + * [RID](class_rid) **[scenario_create](#scenario_create)** **(** **)** + * void **[scenario_set_debug](#scenario_set_debug)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** + * [RID](class_rid) **[instance_create](#instance_create)** **(** **)** + * [RID](class_rid) **[instance_get_base](#instance_get_base)** **(** [RID](class_rid) arg0 **)** const + * [RID](class_rid) **[instance_get_base_aabb](#instance_get_base_aabb)** **(** [RID](class_rid) arg0 **)** const + * void **[instance_set_transform](#instance_set_transform)** **(** [RID](class_rid) arg0, [Transform](class_transform) arg1 **)** + * [Transform](class_transform) **[instance_get_transform](#instance_get_transform)** **(** [RID](class_rid) arg0 **)** const + * void **[instance_attach_object_instance_ID](#instance_attach_object_instance_ID)** **(** [RID](class_rid) arg0, [int](class_int) arg1 **)** + * [int](class_int) **[instance_get_object_instance_ID](#instance_get_object_instance_ID)** **(** [RID](class_rid) arg0 **)** const + * void **[instance_attach_skeleton](#instance_attach_skeleton)** **(** [RID](class_rid) arg0, [RID](class_rid) arg1 **)** + * [RID](class_rid) **[instance_get_skeleton](#instance_get_skeleton)** **(** [RID](class_rid) arg0 **)** const + * void **[instance_set_room](#instance_set_room)** **(** [RID](class_rid) arg0, [RID](class_rid) arg1 **)** + * [RID](class_rid) **[instance_get_room](#instance_get_room)** **(** [RID](class_rid) arg0 **)** const + * void **[instance_set_exterior](#instance_set_exterior)** **(** [RID](class_rid) arg0, [bool](class_bool) arg1 **)** + * [bool](class_bool) **[instance_is_exterior](#instance_is_exterior)** **(** [RID](class_rid) arg0 **)** const + * [Array](class_array) **[instances_cull_aabb](#instances_cull_aabb)** **(** [AABB](class_aabb) arg0, [RID](class_rid) arg1 **)** const + * [Array](class_array) **[instances_cull_ray](#instances_cull_ray)** **(** [Vector3](class_vector3) arg0, [Vector3](class_vector3) arg1, [RID](class_rid) arg2 **)** const + * [Array](class_array) **[instances_cull_convex](#instances_cull_convex)** **(** [Vector3](class_vector3) arg0, [Vector3](class_vector3) arg1, [RID](class_rid) arg2 **)** const + * [RID](class_rid) **[instance_geometry_override_material_param](#instance_geometry_override_material_param)** **(** [RID](class_rid) arg0 **)** const + * [RID](class_rid) **[instance_geometry_get_material_param](#instance_geometry_get_material_param)** **(** [RID](class_rid) arg0 **)** const + * [RID](class_rid) **[get_test_cube](#get_test_cube)** **(** **)** + * [RID](class_rid) **[canvas_create](#canvas_create)** **(** **)** + * [RID](class_rid) **[canvas_item_create](#canvas_item_create)** **(** **)** + * void **[canvas_item_set_parent](#canvas_item_set_parent)** **(** [RID](class_rid) arg0, [RID](class_rid) arg1 **)** + * [RID](class_rid) **[canvas_item_get_parent](#canvas_item_get_parent)** **(** [RID](class_rid) arg0 **)** const + * void **[canvas_item_set_transform](#canvas_item_set_transform)** **(** [RID](class_rid) arg0, [Matrix32](class_matrix32) arg1 **)** + * void **[canvas_item_set_custom_rect](#canvas_item_set_custom_rect)** **(** [RID](class_rid) arg0, [bool](class_bool) arg1, [Rect2](class_rect2) arg2 **)** + * void **[canvas_item_set_clip](#canvas_item_set_clip)** **(** [RID](class_rid) arg0, [bool](class_bool) arg1 **)** + * void **[canvas_item_set_opacity](#canvas_item_set_opacity)** **(** [RID](class_rid) arg0, [real](class_real) arg1 **)** + * [real](class_real) **[canvas_item_get_opacity](#canvas_item_get_opacity)** **(** [RID](class_rid) arg0, [real](class_real) arg1 **)** const + * void **[canvas_item_set_self_opacity](#canvas_item_set_self_opacity)** **(** [RID](class_rid) arg0, [real](class_real) arg1 **)** + * [real](class_real) **[canvas_item_get_self_opacity](#canvas_item_get_self_opacity)** **(** [RID](class_rid) arg0, [real](class_real) arg1 **)** const + * void **[canvas_item_add_line](#canvas_item_add_line)** **(** [RID](class_rid) arg0, [Vector2](class_vector2) arg1, [Vector2](class_vector2) arg2, [Color](class_color) arg3, [real](class_real) arg4=1 **)** + * void **[canvas_item_add_rect](#canvas_item_add_rect)** **(** [RID](class_rid) arg0, [Rect2](class_rect2) arg1, [Color](class_color) arg2 **)** + * void **[canvas_item_add_texture_rect](#canvas_item_add_texture_rect)** **(** [RID](class_rid) arg0, [Rect2](class_rect2) arg1, [RID](class_rid) arg2, [bool](class_bool) arg3, [Color](class_color) arg4=Color(1,1,1,1) **)** + * void **[canvas_item_add_texture_rect_region](#canvas_item_add_texture_rect_region)** **(** [RID](class_rid) arg0, [Rect2](class_rect2) arg1, [RID](class_rid) arg2, [Rect2](class_rect2) arg3, [Color](class_color) arg4=Color(1,1,1,1) **)** + * void **[canvas_item_add_style_box](#canvas_item_add_style_box)** **(** [RID](class_rid) arg0, [Rect2](class_rect2) arg1, [RID](class_rid) arg2, [RealArray](class_realarray) arg3, [Color](class_color) arg4=Color(1,1,1,1) **)** + * void **[canvas_item_add_circle](#canvas_item_add_circle)** **(** [RID](class_rid) arg0, [Vector2](class_vector2) arg1, [real](class_real) arg2, [Color](class_color) arg3 **)** + * void **[viewport_set_canvas_transform](#viewport_set_canvas_transform)** **(** [RID](class_rid) arg0, [RID](class_rid) arg1, [Matrix32](class_matrix32) arg2 **)** + * void **[canvas_item_clear](#canvas_item_clear)** **(** [RID](class_rid) arg0 **)** + * void **[canvas_item_raise](#canvas_item_raise)** **(** [RID](class_rid) arg0 **)** + * void **[cursor_set_rotation](#cursor_set_rotation)** **(** [real](class_real) arg0, [int](class_int) arg1 **)** + * void **[cursor_set_texture](#cursor_set_texture)** **(** [RID](class_rid) arg0, [Vector2](class_vector2) arg1, [int](class_int) arg2 **)** + * void **[cursor_set_visible](#cursor_set_visible)** **(** [bool](class_bool) arg0, [int](class_int) arg1 **)** + * void **[cursor_set_pos](#cursor_set_pos)** **(** [Vector2](class_vector2) arg0, [int](class_int) arg1 **)** + * void **[black_bars_set_margins](#black_bars_set_margins)** **(** [int](class_int) left, [int](class_int) top, [int](class_int) right, [int](class_int) bottom **)** + * [RID](class_rid) **[make_sphere_mesh](#make_sphere_mesh)** **(** [int](class_int) arg0, [int](class_int) arg1, [real](class_real) arg2 **)** + * void **[mesh_add_surface_from_planes](#mesh_add_surface_from_planes)** **(** [RID](class_rid) arg0, [Array](class_array) arg1 **)** + * void **[draw](#draw)** **(** **)** + * void **[free](#free)** **(** [RID](class_rid) arg0 **)** + * void **[set_default_clear_color](#set_default_clear_color)** **(** [Color](class_color) arg0 **)** + * [int](class_int) **[get_render_info](#get_render_info)** **(** [int](class_int) arg0 **)** ### Numeric Constants * **NO_INDEX_ARRAY** = **-1** diff --git a/class_windowdialog.md b/class_windowdialog.md index 116a7f1..bd59670 100644 --- a/class_windowdialog.md +++ b/class_windowdialog.md @@ -6,9 +6,9 @@ Base class for window dialogs. ### Member Functions - * void **[`set_title`](#set_title)** **(** [String](class_string) title **)** - * [String](class_string) **[`get_title`](#get_title)** **(** **)** const - * [TextureButton](class_texturebutton) **[`get_close_button`](#get_close_button)** **(** **)** + * void **[set_title](#set_title)** **(** [String](class_string) title **)** + * [String](class_string) **[get_title](#get_title)** **(** **)** const + * [TextureButton](class_texturebutton) **[get_close_button](#get_close_button)** **(** **)** ### Description Windowdialog is the base class for all window-based dialogs. It's a by-default toplevel [Control](class_control) that draws a window decoration and allows motion and resizing. @@ -16,16 +16,16 @@ Windowdialog is the base class for all window-based dialogs. It's a by-default t ### Member Function Description #### set_title - * void **`set_title`** **(** [String](class_string) title **)** + * void **set_title** **(** [String](class_string) title **)** Set the title of the window. #### get_title - * [String](class_string) **`get_title`** **(** **)** const + * [String](class_string) **get_title** **(** **)** const Return the title of the window. #### get_close_button - * [TextureButton](class_texturebutton) **`get_close_button`** **(** **)** + * [TextureButton](class_texturebutton) **get_close_button** **(** **)** Return the close [TextureButton](class_texturebutton). diff --git a/class_world.md b/class_world.md index 8f82b4c..e7c5a7a 100644 --- a/class_world.md +++ b/class_world.md @@ -6,11 +6,11 @@ Class that has everything pertaining to a world. ### Member Functions - * [RID](class_rid) **[`get_space`](#get_space)** **(** **)** const - * [RID](class_rid) **[`get_scenario`](#get_scenario)** **(** **)** const - * [RID](class_rid) **[`get_sound_space`](#get_sound_space)** **(** **)** const - * void **[`set_environment`](#set_environment)** **(** [Environment](class_environment) env **)** - * [Environment](class_environment) **[`get_environment`](#get_environment)** **(** **)** const + * [RID](class_rid) **[get_space](#get_space)** **(** **)** const + * [RID](class_rid) **[get_scenario](#get_scenario)** **(** **)** const + * [RID](class_rid) **[get_sound_space](#get_sound_space)** **(** **)** const + * void **[set_environment](#set_environment)** **(** [Environment](class_environment) env **)** + * [Environment](class_environment) **[get_environment](#get_environment)** **(** **)** const ### Description Class that has everything pertaining to a world. A physics space, a visual scenario and a sound space. Spatial nodes register their resources into the current world. diff --git a/class_world2d.md b/class_world2d.md index 039423e..98e328d 100644 --- a/class_world2d.md +++ b/class_world2d.md @@ -6,9 +6,9 @@ Class that has everything pertaining to a 2D world. ### Member Functions - * [RID](class_rid) **[`get_canvas`](#get_canvas)** **(** **)** - * [RID](class_rid) **[`get_space`](#get_space)** **(** **)** - * [RID](class_rid) **[`get_sound_space`](#get_sound_space)** **(** **)** + * [RID](class_rid) **[get_canvas](#get_canvas)** **(** **)** + * [RID](class_rid) **[get_space](#get_space)** **(** **)** + * [RID](class_rid) **[get_sound_space](#get_sound_space)** **(** **)** ### Description Class that has everything pertaining to a 2D world. A physics space, a visual scenario and a sound space. 2D nodes register their resources into the current 2D world. diff --git a/class_worldenvironment.md b/class_worldenvironment.md index f4c8c82..23ad1a5 100644 --- a/class_worldenvironment.md +++ b/class_worldenvironment.md @@ -6,7 +6,7 @@ ### Member Functions - * void **[`set_environment`](#set_environment)** **(** [Environment](class_environment) env **)** - * [Environment](class_environment) **[`get_environment`](#get_environment)** **(** **)** const + * void **[set_environment](#set_environment)** **(** [Environment](class_environment) env **)** + * [Environment](class_environment) **[get_environment](#get_environment)** **(** **)** const ### Member Function Description diff --git a/class_xmlparser.md b/class_xmlparser.md index 28c7014..b9f0c35 100644 --- a/class_xmlparser.md +++ b/class_xmlparser.md @@ -6,22 +6,22 @@ ### Member Functions - * [int](class_int) **[`read`](#read)** **(** **)** - * [int](class_int) **[`get_node_type`](#get_node_type)** **(** **)** - * [String](class_string) **[`get_node_name`](#get_node_name)** **(** **)** const - * [String](class_string) **[`get_node_data`](#get_node_data)** **(** **)** const - * [int](class_int) **[`get_node_offset`](#get_node_offset)** **(** **)** const - * [int](class_int) **[`get_attribute_count`](#get_attribute_count)** **(** **)** const - * [String](class_string) **[`get_attribute_name`](#get_attribute_name)** **(** [int](class_int) arg0 **)** const - * [String](class_string) **[`get_attribute_value`](#get_attribute_value)** **(** [int](class_int) arg0 **)** const - * [bool](class_bool) **[`has_attribute`](#has_attribute)** **(** [String](class_string) arg0 **)** const - * [String](class_string) **[`get_named_attribute_value`](#get_named_attribute_value)** **(** [String](class_string) arg0 **)** const - * [String](class_string) **[`get_named_attribute_value_safe`](#get_named_attribute_value_safe)** **(** [String](class_string) arg0 **)** const - * [bool](class_bool) **[`is_empty`](#is_empty)** **(** **)** const - * [int](class_int) **[`get_current_line`](#get_current_line)** **(** **)** const - * void **[`skip_section`](#skip_section)** **(** **)** - * [int](class_int) **[`seek`](#seek)** **(** [int](class_int) arg0 **)** - * [int](class_int) **[`open`](#open)** **(** [String](class_string) arg0 **)** + * [int](class_int) **[read](#read)** **(** **)** + * [int](class_int) **[get_node_type](#get_node_type)** **(** **)** + * [String](class_string) **[get_node_name](#get_node_name)** **(** **)** const + * [String](class_string) **[get_node_data](#get_node_data)** **(** **)** const + * [int](class_int) **[get_node_offset](#get_node_offset)** **(** **)** const + * [int](class_int) **[get_attribute_count](#get_attribute_count)** **(** **)** const + * [String](class_string) **[get_attribute_name](#get_attribute_name)** **(** [int](class_int) arg0 **)** const + * [String](class_string) **[get_attribute_value](#get_attribute_value)** **(** [int](class_int) arg0 **)** const + * [bool](class_bool) **[has_attribute](#has_attribute)** **(** [String](class_string) arg0 **)** const + * [String](class_string) **[get_named_attribute_value](#get_named_attribute_value)** **(** [String](class_string) arg0 **)** const + * [String](class_string) **[get_named_attribute_value_safe](#get_named_attribute_value_safe)** **(** [String](class_string) arg0 **)** const + * [bool](class_bool) **[is_empty](#is_empty)** **(** **)** const + * [int](class_int) **[get_current_line](#get_current_line)** **(** **)** const + * void **[skip_section](#skip_section)** **(** **)** + * [int](class_int) **[seek](#seek)** **(** [int](class_int) arg0 **)** + * [int](class_int) **[open](#open)** **(** [String](class_string) arg0 **)** ### Numeric Constants * **NODE_NONE** = **0**