index.rst 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
  5. .. _doc_class_reference:
  6. All classes
  7. ===========
  8. Globals
  9. =======
  10. .. toctree::
  11. :maxdepth: 1
  12. :name: toc-class-ref-globals
  13. class_@gdscript
  14. class_@globalscope
  15. Nodes
  16. =====
  17. .. toctree::
  18. :maxdepth: 1
  19. :name: toc-class-ref-nodes
  20. class_node
  21. class_acceptdialog
  22. class_animatedsprite
  23. class_animatedsprite3d
  24. class_animationplayer
  25. class_animationtree
  26. class_animationtreeplayer
  27. class_area
  28. class_area2d
  29. class_arvranchor
  30. class_arvrcamera
  31. class_arvrcontroller
  32. class_arvrorigin
  33. class_aspectratiocontainer
  34. class_audiostreamplayer
  35. class_audiostreamplayer2d
  36. class_audiostreamplayer3d
  37. class_backbuffercopy
  38. class_bakedlightmap
  39. class_basebutton
  40. class_bone2d
  41. class_boneattachment
  42. class_boxcontainer
  43. class_button
  44. class_camera
  45. class_camera2d
  46. class_canvasitem
  47. class_canvaslayer
  48. class_canvasmodulate
  49. class_centercontainer
  50. class_checkbox
  51. class_checkbutton
  52. class_clippedcamera
  53. class_collisionobject
  54. class_collisionobject2d
  55. class_collisionpolygon
  56. class_collisionpolygon2d
  57. class_collisionshape
  58. class_collisionshape2d
  59. class_colorpicker
  60. class_colorpickerbutton
  61. class_colorrect
  62. class_conetwistjoint
  63. class_confirmationdialog
  64. class_container
  65. class_control
  66. class_cpuparticles
  67. class_cpuparticles2d
  68. class_csgbox
  69. class_csgcombiner
  70. class_csgcylinder
  71. class_csgmesh
  72. class_csgpolygon
  73. class_csgprimitive
  74. class_csgshape
  75. class_csgsphere
  76. class_csgtorus
  77. class_cullinstance
  78. class_dampedspringjoint2d
  79. class_directionallight
  80. class_editorfiledialog
  81. class_editorfilesystem
  82. class_editorinspector
  83. class_editorinterface
  84. class_editorplugin
  85. class_editorproperty
  86. class_editorresourcepicker
  87. class_editorresourcepreview
  88. class_editorscriptpicker
  89. class_editorspinslider
  90. class_filedialog
  91. class_filesystemdock
  92. class_flowcontainer
  93. class_generic6dofjoint
  94. class_geometryinstance
  95. class_giprobe
  96. class_graphedit
  97. class_graphnode
  98. class_gridcontainer
  99. class_gridmap
  100. class_groovejoint2d
  101. class_hboxcontainer
  102. class_hflowcontainer
  103. class_hingejoint
  104. class_hscrollbar
  105. class_hseparator
  106. class_hslider
  107. class_hsplitcontainer
  108. class_httprequest
  109. class_immediategeometry
  110. class_instanceplaceholder
  111. class_interpolatedcamera
  112. class_itemlist
  113. class_joint
  114. class_joint2d
  115. class_kinematicbody
  116. class_kinematicbody2d
  117. class_label
  118. class_label3d
  119. class_light
  120. class_light2d
  121. class_lightoccluder2d
  122. class_line2d
  123. class_lineedit
  124. class_linkbutton
  125. class_listener
  126. class_listener2d
  127. class_lod
  128. class_margincontainer
  129. class_menubutton
  130. class_mergegroup
  131. class_meshinstance
  132. class_meshinstance2d
  133. class_multimeshinstance
  134. class_multimeshinstance2d
  135. class_navigation
  136. class_navigation2d
  137. class_navigationagent
  138. class_navigationagent2d
  139. class_navigationmeshinstance
  140. class_navigationobstacle
  141. class_navigationobstacle2d
  142. class_navigationpolygoninstance
  143. class_ninepatchrect
  144. class_node2d
  145. class_occluder
  146. class_omnilight
  147. class_optionbutton
  148. class_panel
  149. class_panelcontainer
  150. class_parallaxbackground
  151. class_parallaxlayer
  152. class_particles
  153. class_particles2d
  154. class_path
  155. class_path2d
  156. class_pathfollow
  157. class_pathfollow2d
  158. class_physicalbone
  159. class_physicsbody
  160. class_physicsbody2d
  161. class_pinjoint
  162. class_pinjoint2d
  163. class_polygon2d
  164. class_popup
  165. class_popupdialog
  166. class_popupmenu
  167. class_popuppanel
  168. class_portal
  169. class_position2d
  170. class_position3d
  171. class_progressbar
  172. class_proximitygroup
  173. class_range
  174. class_raycast
  175. class_raycast2d
  176. class_referencerect
  177. class_reflectionprobe
  178. class_remotetransform
  179. class_remotetransform2d
  180. class_resourcepreloader
  181. class_richtextlabel
  182. class_rigidbody
  183. class_rigidbody2d
  184. class_room
  185. class_roomgroup
  186. class_roommanager
  187. class_rootmotionview
  188. class_scriptcreatedialog
  189. class_scripteditor
  190. class_scrollbar
  191. class_scrollcontainer
  192. class_separator
  193. class_shapecast
  194. class_shapecast2d
  195. class_skeleton
  196. class_skeleton2d
  197. class_skeletonik
  198. class_slider
  199. class_sliderjoint
  200. class_softbody
  201. class_spatial
  202. class_spinbox
  203. class_splitcontainer
  204. class_spotlight
  205. class_springarm
  206. class_sprite
  207. class_sprite3d
  208. class_spritebase3d
  209. class_staticbody
  210. class_staticbody2d
  211. class_tabcontainer
  212. class_tabs
  213. class_textedit
  214. class_texturebutton
  215. class_textureprogress
  216. class_texturerect
  217. class_tilemap
  218. class_timer
  219. class_toolbutton
  220. class_touchscreenbutton
  221. class_tree
  222. class_tween
  223. class_vboxcontainer
  224. class_vehiclebody
  225. class_vehiclewheel
  226. class_vflowcontainer
  227. class_videoplayer
  228. class_viewport
  229. class_viewportcontainer
  230. class_visibilityenabler
  231. class_visibilityenabler2d
  232. class_visibilitynotifier
  233. class_visibilitynotifier2d
  234. class_visualinstance
  235. class_vscrollbar
  236. class_vseparator
  237. class_vslider
  238. class_vsplitcontainer
  239. class_windowdialog
  240. class_worldenvironment
  241. class_ysort
  242. Resources
  243. =========
  244. .. toctree::
  245. :maxdepth: 1
  246. :name: toc-class-ref-resources
  247. class_resource
  248. class_animatedtexture
  249. class_animation
  250. class_animationnode
  251. class_animationnodeadd2
  252. class_animationnodeadd3
  253. class_animationnodeanimation
  254. class_animationnodeblend2
  255. class_animationnodeblend3
  256. class_animationnodeblendspace1d
  257. class_animationnodeblendspace2d
  258. class_animationnodeblendtree
  259. class_animationnodeoneshot
  260. class_animationnodeoutput
  261. class_animationnodestatemachine
  262. class_animationnodestatemachineplayback
  263. class_animationnodestatemachinetransition
  264. class_animationnodetimescale
  265. class_animationnodetimeseek
  266. class_animationnodetransition
  267. class_animationrootnode
  268. class_arraymesh
  269. class_atlastexture
  270. class_audiobuslayout
  271. class_audioeffect
  272. class_audioeffectamplify
  273. class_audioeffectbandlimitfilter
  274. class_audioeffectbandpassfilter
  275. class_audioeffectcapture
  276. class_audioeffectchorus
  277. class_audioeffectcompressor
  278. class_audioeffectdelay
  279. class_audioeffectdistortion
  280. class_audioeffecteq
  281. class_audioeffecteq10
  282. class_audioeffecteq21
  283. class_audioeffecteq6
  284. class_audioeffectfilter
  285. class_audioeffecthighpassfilter
  286. class_audioeffecthighshelffilter
  287. class_audioeffectlimiter
  288. class_audioeffectlowpassfilter
  289. class_audioeffectlowshelffilter
  290. class_audioeffectnotchfilter
  291. class_audioeffectpanner
  292. class_audioeffectphaser
  293. class_audioeffectpitchshift
  294. class_audioeffectrecord
  295. class_audioeffectreverb
  296. class_audioeffectspectrumanalyzer
  297. class_audioeffectstereoenhance
  298. class_audiostream
  299. class_audiostreamgenerator
  300. class_audiostreammicrophone
  301. class_audiostreammp3
  302. class_audiostreamoggvorbis
  303. class_audiostreamrandompitch
  304. class_audiostreamsample
  305. class_bakedlightmapdata
  306. class_bitmap
  307. class_bitmapfont
  308. class_boxshape
  309. class_buttongroup
  310. class_cameratexture
  311. class_canvasitemmaterial
  312. class_capsulemesh
  313. class_capsuleshape
  314. class_capsuleshape2d
  315. class_circleshape2d
  316. class_concavepolygonshape
  317. class_concavepolygonshape2d
  318. class_convexpolygonshape
  319. class_convexpolygonshape2d
  320. class_cryptokey
  321. class_csharpscript
  322. class_cubemap
  323. class_cubemesh
  324. class_curve
  325. class_curve2d
  326. class_curve3d
  327. class_curvetexture
  328. class_cylindermesh
  329. class_cylindershape
  330. class_dynamicfont
  331. class_dynamicfontdata
  332. class_editorsettings
  333. class_editorspatialgizmoplugin
  334. class_environment
  335. class_externaltexture
  336. class_font
  337. class_gdnativelibrary
  338. class_gdscript
  339. class_giprobedata
  340. class_gltfaccessor
  341. class_gltfanimation
  342. class_gltfbufferview
  343. class_gltfcamera
  344. class_gltfcollider
  345. class_gltfdocument
  346. class_gltfdocumentextension
  347. class_gltflight
  348. class_gltfmesh
  349. class_gltfnode
  350. class_gltfphysicsbody
  351. class_gltfskeleton
  352. class_gltfskin
  353. class_gltfspecgloss
  354. class_gltfstate
  355. class_gltftexture
  356. class_gltftexturesampler
  357. class_gradient
  358. class_gradienttexture
  359. class_gradienttexture2d
  360. class_heightmapshape
  361. class_image
  362. class_imagetexture
  363. class_inputevent
  364. class_inputeventaction
  365. class_inputeventgesture
  366. class_inputeventjoypadbutton
  367. class_inputeventjoypadmotion
  368. class_inputeventkey
  369. class_inputeventmagnifygesture
  370. class_inputeventmidi
  371. class_inputeventmouse
  372. class_inputeventmousebutton
  373. class_inputeventmousemotion
  374. class_inputeventpangesture
  375. class_inputeventscreendrag
  376. class_inputeventscreentouch
  377. class_inputeventwithmodifiers
  378. class_largetexture
  379. class_lineshape2d
  380. class_material
  381. class_material3d
  382. class_mesh
  383. class_meshlibrary
  384. class_meshtexture
  385. class_multimesh
  386. class_nativescript
  387. class_navigationmesh
  388. class_navigationpolygon
  389. class_noisetexture
  390. class_occluderpolygon2d
  391. class_occludershape
  392. class_occludershapepolygon
  393. class_occludershapesphere
  394. class_opensimplexnoise
  395. class_ormspatialmaterial
  396. class_packeddatacontainer
  397. class_packedscene
  398. class_packedscenegltf
  399. class_panoramasky
  400. class_particlesmaterial
  401. class_phashtranslation
  402. class_physicsmaterial
  403. class_planemesh
  404. class_planeshape
  405. class_pluginscript
  406. class_pointmesh
  407. class_polygonpathfinder
  408. class_primitivemesh
  409. class_prismmesh
  410. class_proceduralsky
  411. class_proxytexture
  412. class_quadmesh
  413. class_rayshape
  414. class_rayshape2d
  415. class_rectangleshape2d
  416. class_richtexteffect
  417. class_script
  418. class_segmentshape2d
  419. class_shader
  420. class_shadermaterial
  421. class_shape
  422. class_shape2d
  423. class_shortcut
  424. class_skin
  425. class_sky
  426. class_spatialmaterial
  427. class_spheremesh
  428. class_sphereshape
  429. class_spriteframes
  430. class_streamtexture
  431. class_stylebox
  432. class_styleboxempty
  433. class_styleboxflat
  434. class_styleboxline
  435. class_styleboxtexture
  436. class_textfile
  437. class_textmesh
  438. class_texture
  439. class_texture3d
  440. class_texturearray
  441. class_texturelayered
  442. class_theme
  443. class_tileset
  444. class_torusmesh
  445. class_translation
  446. class_videostream
  447. class_videostreamgdnative
  448. class_videostreamtheora
  449. class_videostreamwebm
  450. class_viewporttexture
  451. class_visualscript
  452. class_visualscriptbasictypeconstant
  453. class_visualscriptbuiltinfunc
  454. class_visualscriptclassconstant
  455. class_visualscriptcomment
  456. class_visualscriptcomposearray
  457. class_visualscriptcondition
  458. class_visualscriptconstant
  459. class_visualscriptconstructor
  460. class_visualscriptcustomnode
  461. class_visualscriptdeconstruct
  462. class_visualscriptemitsignal
  463. class_visualscriptenginesingleton
  464. class_visualscriptexpression
  465. class_visualscriptfunction
  466. class_visualscriptfunctioncall
  467. class_visualscriptglobalconstant
  468. class_visualscriptindexget
  469. class_visualscriptindexset
  470. class_visualscriptinputaction
  471. class_visualscriptiterator
  472. class_visualscriptlists
  473. class_visualscriptlocalvar
  474. class_visualscriptlocalvarset
  475. class_visualscriptmathconstant
  476. class_visualscriptnode
  477. class_visualscriptoperator
  478. class_visualscriptpreload
  479. class_visualscriptpropertyget
  480. class_visualscriptpropertyset
  481. class_visualscriptresourcepath
  482. class_visualscriptreturn
  483. class_visualscriptscenenode
  484. class_visualscriptscenetree
  485. class_visualscriptselect
  486. class_visualscriptself
  487. class_visualscriptsequence
  488. class_visualscriptsubcall
  489. class_visualscriptswitch
  490. class_visualscripttypecast
  491. class_visualscriptvariableget
  492. class_visualscriptvariableset
  493. class_visualscriptwhile
  494. class_visualscriptyield
  495. class_visualscriptyieldsignal
  496. class_visualshader
  497. class_visualshadernode
  498. class_visualshadernodebooleanconstant
  499. class_visualshadernodebooleanuniform
  500. class_visualshadernodecolorconstant
  501. class_visualshadernodecolorfunc
  502. class_visualshadernodecolorop
  503. class_visualshadernodecoloruniform
  504. class_visualshadernodecompare
  505. class_visualshadernodecubemap
  506. class_visualshadernodecubemapuniform
  507. class_visualshadernodecustom
  508. class_visualshadernodedeterminant
  509. class_visualshadernodedotproduct
  510. class_visualshadernodeexpression
  511. class_visualshadernodefaceforward
  512. class_visualshadernodefresnel
  513. class_visualshadernodeglobalexpression
  514. class_visualshadernodegroupbase
  515. class_visualshadernodeif
  516. class_visualshadernodeinput
  517. class_visualshadernodeis
  518. class_visualshadernodeouterproduct
  519. class_visualshadernodeoutput
  520. class_visualshadernodescalarclamp
  521. class_visualshadernodescalarconstant
  522. class_visualshadernodescalarderivativefunc
  523. class_visualshadernodescalarfunc
  524. class_visualshadernodescalarinterp
  525. class_visualshadernodescalarop
  526. class_visualshadernodescalarsmoothstep
  527. class_visualshadernodescalarswitch
  528. class_visualshadernodescalaruniform
  529. class_visualshadernodeswitch
  530. class_visualshadernodetexture
  531. class_visualshadernodetextureuniform
  532. class_visualshadernodetextureuniformtriplanar
  533. class_visualshadernodetransformcompose
  534. class_visualshadernodetransformconstant
  535. class_visualshadernodetransformdecompose
  536. class_visualshadernodetransformfunc
  537. class_visualshadernodetransformmult
  538. class_visualshadernodetransformuniform
  539. class_visualshadernodetransformvecmult
  540. class_visualshadernodeuniform
  541. class_visualshadernodeuniformref
  542. class_visualshadernodevec3constant
  543. class_visualshadernodevec3uniform
  544. class_visualshadernodevectorclamp
  545. class_visualshadernodevectorcompose
  546. class_visualshadernodevectordecompose
  547. class_visualshadernodevectorderivativefunc
  548. class_visualshadernodevectordistance
  549. class_visualshadernodevectorfunc
  550. class_visualshadernodevectorinterp
  551. class_visualshadernodevectorlen
  552. class_visualshadernodevectorop
  553. class_visualshadernodevectorrefract
  554. class_visualshadernodevectorscalarmix
  555. class_visualshadernodevectorscalarsmoothstep
  556. class_visualshadernodevectorscalarstep
  557. class_visualshadernodevectorsmoothstep
  558. class_world
  559. class_world2d
  560. class_x509certificate
  561. Other objects
  562. =============
  563. .. toctree::
  564. :maxdepth: 1
  565. :name: toc-class-ref-objects
  566. class_object
  567. class_aescontext
  568. class_animationtrackeditplugin
  569. class_arvrinterface
  570. class_arvrinterfacegdnative
  571. class_arvrpositionaltracker
  572. class_arvrserver
  573. class_astar
  574. class_astar2d
  575. class_audioeffectinstance
  576. class_audioeffectspectrumanalyzerinstance
  577. class_audioserver
  578. class_audiostreamgeneratorplayback
  579. class_audiostreamplayback
  580. class_audiostreamplaybackresampled
  581. class_callbacktweener
  582. class_camerafeed
  583. class_cameraserver
  584. class_charfxtransform
  585. class_classdb
  586. class_configfile
  587. class_crypto
  588. class_directory
  589. class_dtlsserver
  590. class_editorexportplugin
  591. class_editorfeatureprofile
  592. class_editorfilesystemdirectory
  593. class_editorimportplugin
  594. class_editorinspectorplugin
  595. class_editorresourceconversionplugin
  596. class_editorresourcepreviewgenerator
  597. class_editorsceneimporter
  598. class_editorsceneimporterfbx
  599. class_editorsceneimportergltf
  600. class_editorscenepostimport
  601. class_editorscript
  602. class_editorselection
  603. class_editorspatialgizmo
  604. class_editorvcsinterface
  605. class_encodedobjectasid
  606. class_engine
  607. class_expression
  608. class_file
  609. class_funcref
  610. class_gdnative
  611. class_gdscriptfunctionstate
  612. class_geometry
  613. class_godotsharp
  614. class_hashingcontext
  615. class_hmaccontext
  616. class_httpclient
  617. class_input
  618. class_inputmap
  619. class_intervaltweener
  620. class_ip
  621. class_javaclass
  622. class_javaclasswrapper
  623. class_javascript
  624. class_javascriptobject
  625. class_jnisingleton
  626. class_json
  627. class_jsonparseresult
  628. class_jsonrpc
  629. class_kinematiccollision
  630. class_kinematiccollision2d
  631. class_mainloop
  632. class_marshalls
  633. class_meshdatatool
  634. class_methodtweener
  635. class_mobilevrinterface
  636. class_multiplayerapi
  637. class_multiplayerpeergdnative
  638. class_mutex
  639. class_navigation2dserver
  640. class_navigationmeshgenerator
  641. class_navigationserver
  642. class_networkedmultiplayercustom
  643. class_networkedmultiplayerenet
  644. class_networkedmultiplayerpeer
  645. class_node
  646. class_os
  647. class_packeddatacontainerref
  648. class_packetpeer
  649. class_packetpeerdtls
  650. class_packetpeergdnative
  651. class_packetpeerstream
  652. class_packetpeerudp
  653. class_pckpacker
  654. class_performance
  655. class_physics2ddirectbodystate
  656. class_physics2ddirectspacestate
  657. class_physics2dserver
  658. class_physics2dshapequeryparameters
  659. class_physics2dtestmotionresult
  660. class_physicsdirectbodystate
  661. class_physicsdirectspacestate
  662. class_physicsserver
  663. class_physicsshapequeryparameters
  664. class_physicstestmotionresult
  665. class_projectsettings
  666. class_propertytweener
  667. class_randomnumbergenerator
  668. class_reference
  669. class_regex
  670. class_regexmatch
  671. class_resource
  672. class_resourceformatloader
  673. class_resourceformatsaver
  674. class_resourceimporter
  675. class_resourceinteractiveloader
  676. class_resourceloader
  677. class_resourcesaver
  678. class_scenestate
  679. class_scenetree
  680. class_scenetreetimer
  681. class_scenetreetween
  682. class_semaphore
  683. class_skinreference
  684. class_spatialgizmo
  685. class_spatialvelocitytracker
  686. class_streampeer
  687. class_streampeerbuffer
  688. class_streampeergdnative
  689. class_streampeerssl
  690. class_streampeertcp
  691. class_surfacetool
  692. class_tcp_server
  693. class_thread
  694. class_time
  695. class_translationserver
  696. class_treeitem
  697. class_trianglemesh
  698. class_tweener
  699. class_udpserver
  700. class_undoredo
  701. class_upnp
  702. class_upnpdevice
  703. class_visualscripteditor
  704. class_visualscriptfunctionstate
  705. class_visualserver
  706. class_weakref
  707. class_webrtcdatachannel
  708. class_webrtcdatachannelgdnative
  709. class_webrtcmultiplayer
  710. class_webrtcpeerconnection
  711. class_webrtcpeerconnectiongdnative
  712. class_websocketclient
  713. class_websocketmultiplayerpeer
  714. class_websocketpeer
  715. class_websocketserver
  716. class_webxrinterface
  717. class_xmlparser
  718. Variant types
  719. =============
  720. .. toctree::
  721. :maxdepth: 1
  722. :name: toc-class-ref-variants
  723. class_aabb
  724. class_array
  725. class_basis
  726. class_bool
  727. class_color
  728. class_dictionary
  729. class_float
  730. class_int
  731. class_nodepath
  732. class_object
  733. class_plane
  734. class_poolbytearray
  735. class_poolcolorarray
  736. class_poolintarray
  737. class_poolrealarray
  738. class_poolstringarray
  739. class_poolvector2array
  740. class_poolvector3array
  741. class_quat
  742. class_rect2
  743. class_rid
  744. class_string
  745. class_transform
  746. class_transform2d
  747. class_variant
  748. class_vector2
  749. class_vector3