class_node.rst 212 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288
  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/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Node.xml.
  6. .. _class_Node:
  7. Node
  8. ====
  9. **Inherits:** :ref:`Object<class_Object>`
  10. **Inherited By:** :ref:`AnimationMixer<class_AnimationMixer>`, :ref:`AudioStreamPlayer<class_AudioStreamPlayer>`, :ref:`CanvasItem<class_CanvasItem>`, :ref:`CanvasLayer<class_CanvasLayer>`, :ref:`EditorFileSystem<class_EditorFileSystem>`, :ref:`EditorPlugin<class_EditorPlugin>`, :ref:`EditorResourcePreview<class_EditorResourcePreview>`, :ref:`HTTPRequest<class_HTTPRequest>`, :ref:`InstancePlaceholder<class_InstancePlaceholder>`, :ref:`MissingNode<class_MissingNode>`, :ref:`MultiplayerSpawner<class_MultiplayerSpawner>`, :ref:`MultiplayerSynchronizer<class_MultiplayerSynchronizer>`, :ref:`NavigationAgent2D<class_NavigationAgent2D>`, :ref:`NavigationAgent3D<class_NavigationAgent3D>`, :ref:`Node3D<class_Node3D>`, :ref:`ResourcePreloader<class_ResourcePreloader>`, :ref:`ShaderGlobalsOverride<class_ShaderGlobalsOverride>`, :ref:`StatusIndicator<class_StatusIndicator>`, :ref:`Timer<class_Timer>`, :ref:`Viewport<class_Viewport>`, :ref:`WorldEnvironment<class_WorldEnvironment>`
  11. Base class for all scene objects.
  12. .. rst-class:: classref-introduction-group
  13. Description
  14. -----------
  15. Nodes are Godot's building blocks. They can be assigned as the child of another node, resulting in a tree arrangement. A given node can contain any number of nodes as children with the requirement that all siblings (direct children of a node) should have unique names.
  16. A tree of nodes is called a *scene*. Scenes can be saved to the disk and then instantiated into other scenes. This allows for very high flexibility in the architecture and data model of Godot projects.
  17. \ **Scene tree:** The :ref:`SceneTree<class_SceneTree>` contains the active tree of nodes. When a node is added to the scene tree, it receives the :ref:`NOTIFICATION_ENTER_TREE<class_Node_constant_NOTIFICATION_ENTER_TREE>` notification and its :ref:`_enter_tree()<class_Node_private_method__enter_tree>` callback is triggered. Child nodes are always added *after* their parent node, i.e. the :ref:`_enter_tree()<class_Node_private_method__enter_tree>` callback of a parent node will be triggered before its child's.
  18. Once all nodes have been added in the scene tree, they receive the :ref:`NOTIFICATION_READY<class_Node_constant_NOTIFICATION_READY>` notification and their respective :ref:`_ready()<class_Node_private_method__ready>` callbacks are triggered. For groups of nodes, the :ref:`_ready()<class_Node_private_method__ready>` callback is called in reverse order, starting with the children and moving up to the parent nodes.
  19. This means that when adding a node to the scene tree, the following order will be used for the callbacks: :ref:`_enter_tree()<class_Node_private_method__enter_tree>` of the parent, :ref:`_enter_tree()<class_Node_private_method__enter_tree>` of the children, :ref:`_ready()<class_Node_private_method__ready>` of the children and finally :ref:`_ready()<class_Node_private_method__ready>` of the parent (recursively for the entire scene tree).
  20. \ **Processing:** Nodes can override the "process" state, so that they receive a callback on each frame requesting them to process (do something). Normal processing (callback :ref:`_process()<class_Node_private_method__process>`, toggled with :ref:`set_process()<class_Node_method_set_process>`) happens as fast as possible and is dependent on the frame rate, so the processing time *delta* (in seconds) is passed as an argument. Physics processing (callback :ref:`_physics_process()<class_Node_private_method__physics_process>`, toggled with :ref:`set_physics_process()<class_Node_method_set_physics_process>`) happens a fixed number of times per second (60 by default) and is useful for code related to the physics engine.
  21. Nodes can also process input events. When present, the :ref:`_input()<class_Node_private_method__input>` function will be called for each input that the program receives. In many cases, this can be overkill (unless used for simple projects), and the :ref:`_unhandled_input()<class_Node_private_method__unhandled_input>` function might be preferred; it is called when the input event was not handled by anyone else (typically, GUI :ref:`Control<class_Control>` nodes), ensuring that the node only receives the events that were meant for it.
  22. To keep track of the scene hierarchy (especially when instantiating scenes into other scenes), an "owner" can be set for the node with the :ref:`owner<class_Node_property_owner>` property. This keeps track of who instantiated what. This is mostly useful when writing editors and tools, though.
  23. Finally, when a node is freed with :ref:`Object.free()<class_Object_method_free>` or :ref:`queue_free()<class_Node_method_queue_free>`, it will also free all its children.
  24. \ **Groups:** Nodes can be added to as many groups as you want to be easy to manage, you could create groups like "enemies" or "collectables" for example, depending on your game. See :ref:`add_to_group()<class_Node_method_add_to_group>`, :ref:`is_in_group()<class_Node_method_is_in_group>` and :ref:`remove_from_group()<class_Node_method_remove_from_group>`. You can then retrieve all nodes in these groups, iterate them and even call methods on groups via the methods on :ref:`SceneTree<class_SceneTree>`.
  25. \ **Networking with nodes:** After connecting to a server (or making one, see :ref:`ENetMultiplayerPeer<class_ENetMultiplayerPeer>`), it is possible to use the built-in RPC (remote procedure call) system to communicate over the network. By calling :ref:`rpc()<class_Node_method_rpc>` with a method name, it will be called locally and in all connected peers (peers = clients and the server that accepts connections). To identify which node receives the RPC call, Godot will use its :ref:`NodePath<class_NodePath>` (make sure node names are the same on all peers). Also, take a look at the high-level networking tutorial and corresponding demos.
  26. \ **Note:** The ``script`` property is part of the :ref:`Object<class_Object>` class, not **Node**. It isn't exposed like most properties but does have a setter and getter (see :ref:`Object.set_script()<class_Object_method_set_script>` and :ref:`Object.get_script()<class_Object_method_get_script>`).
  27. .. rst-class:: classref-introduction-group
  28. Tutorials
  29. ---------
  30. - :doc:`Nodes and scenes <../getting_started/step_by_step/nodes_and_scenes>`
  31. - `All Demos <https://github.com/godotengine/godot-demo-projects/>`__
  32. .. rst-class:: classref-reftable-group
  33. Properties
  34. ----------
  35. .. table::
  36. :widths: auto
  37. +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+
  38. | :ref:`Array<class_Array>`\[:ref:`NodePath<class_NodePath>`\] | :ref:`accessibility_controls_nodes<class_Node_property_accessibility_controls_nodes>` | ``[]`` |
  39. +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+
  40. | :ref:`Array<class_Array>`\[:ref:`NodePath<class_NodePath>`\] | :ref:`accessibility_described_by_nodes<class_Node_property_accessibility_described_by_nodes>` | ``[]`` |
  41. +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+
  42. | :ref:`String<class_String>` | :ref:`accessibility_description<class_Node_property_accessibility_description>` | ``""`` |
  43. +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+
  44. | :ref:`Array<class_Array>`\[:ref:`NodePath<class_NodePath>`\] | :ref:`accessibility_flow_to_nodes<class_Node_property_accessibility_flow_to_nodes>` | ``[]`` |
  45. +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+
  46. | :ref:`Array<class_Array>`\[:ref:`NodePath<class_NodePath>`\] | :ref:`accessibility_labeled_by_nodes<class_Node_property_accessibility_labeled_by_nodes>` | ``[]`` |
  47. +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+
  48. | :ref:`AccessibilityLiveMode<enum_DisplayServer_AccessibilityLiveMode>` | :ref:`accessibility_live<class_Node_property_accessibility_live>` | ``0`` |
  49. +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+
  50. | :ref:`String<class_String>` | :ref:`accessibility_name<class_Node_property_accessibility_name>` | ``""`` |
  51. +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+
  52. | :ref:`AutoTranslateMode<enum_Node_AutoTranslateMode>` | :ref:`auto_translate_mode<class_Node_property_auto_translate_mode>` | ``0`` |
  53. +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+
  54. | :ref:`String<class_String>` | :ref:`editor_description<class_Node_property_editor_description>` | ``""`` |
  55. +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+
  56. | :ref:`MultiplayerAPI<class_MultiplayerAPI>` | :ref:`multiplayer<class_Node_property_multiplayer>` | |
  57. +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+
  58. | :ref:`StringName<class_StringName>` | :ref:`name<class_Node_property_name>` | |
  59. +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+
  60. | :ref:`Node<class_Node>` | :ref:`owner<class_Node_property_owner>` | |
  61. +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+
  62. | :ref:`PhysicsInterpolationMode<enum_Node_PhysicsInterpolationMode>` | :ref:`physics_interpolation_mode<class_Node_property_physics_interpolation_mode>` | ``0`` |
  63. +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+
  64. | :ref:`ProcessMode<enum_Node_ProcessMode>` | :ref:`process_mode<class_Node_property_process_mode>` | ``0`` |
  65. +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+
  66. | :ref:`int<class_int>` | :ref:`process_physics_priority<class_Node_property_process_physics_priority>` | ``0`` |
  67. +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+
  68. | :ref:`int<class_int>` | :ref:`process_priority<class_Node_property_process_priority>` | ``0`` |
  69. +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+
  70. | :ref:`ProcessThreadGroup<enum_Node_ProcessThreadGroup>` | :ref:`process_thread_group<class_Node_property_process_thread_group>` | ``0`` |
  71. +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+
  72. | :ref:`int<class_int>` | :ref:`process_thread_group_order<class_Node_property_process_thread_group_order>` | |
  73. +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+
  74. | |bitfield|\[:ref:`ProcessThreadMessages<enum_Node_ProcessThreadMessages>`\] | :ref:`process_thread_messages<class_Node_property_process_thread_messages>` | |
  75. +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+
  76. | :ref:`String<class_String>` | :ref:`scene_file_path<class_Node_property_scene_file_path>` | |
  77. +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+
  78. | :ref:`bool<class_bool>` | :ref:`unique_name_in_owner<class_Node_property_unique_name_in_owner>` | ``false`` |
  79. +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+
  80. .. rst-class:: classref-reftable-group
  81. Methods
  82. -------
  83. .. table::
  84. :widths: auto
  85. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  86. | |void| | :ref:`_enter_tree<class_Node_private_method__enter_tree>`\ (\ ) |virtual| |
  87. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  88. | |void| | :ref:`_exit_tree<class_Node_private_method__exit_tree>`\ (\ ) |virtual| |
  89. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  90. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`_get_accessibility_configuration_warnings<class_Node_private_method__get_accessibility_configuration_warnings>`\ (\ ) |virtual| |const| |
  91. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  92. | :ref:`String<class_String>` | :ref:`_get_accessibility_container_name<class_Node_private_method__get_accessibility_container_name>`\ (\ node\: :ref:`Node<class_Node>`\ ) |virtual| |const| |
  93. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  94. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`_get_configuration_warnings<class_Node_private_method__get_configuration_warnings>`\ (\ ) |virtual| |const| |
  95. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  96. | :ref:`RID<class_RID>` | :ref:`_get_focused_accessibility_element<class_Node_private_method__get_focused_accessibility_element>`\ (\ ) |virtual| |const| |
  97. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  98. | |void| | :ref:`_input<class_Node_private_method__input>`\ (\ event\: :ref:`InputEvent<class_InputEvent>`\ ) |virtual| |
  99. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  100. | |void| | :ref:`_physics_process<class_Node_private_method__physics_process>`\ (\ delta\: :ref:`float<class_float>`\ ) |virtual| |
  101. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  102. | |void| | :ref:`_process<class_Node_private_method__process>`\ (\ delta\: :ref:`float<class_float>`\ ) |virtual| |
  103. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  104. | |void| | :ref:`_ready<class_Node_private_method__ready>`\ (\ ) |virtual| |
  105. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  106. | |void| | :ref:`_shortcut_input<class_Node_private_method__shortcut_input>`\ (\ event\: :ref:`InputEvent<class_InputEvent>`\ ) |virtual| |
  107. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  108. | |void| | :ref:`_unhandled_input<class_Node_private_method__unhandled_input>`\ (\ event\: :ref:`InputEvent<class_InputEvent>`\ ) |virtual| |
  109. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  110. | |void| | :ref:`_unhandled_key_input<class_Node_private_method__unhandled_key_input>`\ (\ event\: :ref:`InputEvent<class_InputEvent>`\ ) |virtual| |
  111. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  112. | |void| | :ref:`add_child<class_Node_method_add_child>`\ (\ node\: :ref:`Node<class_Node>`, force_readable_name\: :ref:`bool<class_bool>` = false, internal\: :ref:`InternalMode<enum_Node_InternalMode>` = 0\ ) |
  113. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  114. | |void| | :ref:`add_sibling<class_Node_method_add_sibling>`\ (\ sibling\: :ref:`Node<class_Node>`, force_readable_name\: :ref:`bool<class_bool>` = false\ ) |
  115. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  116. | |void| | :ref:`add_to_group<class_Node_method_add_to_group>`\ (\ group\: :ref:`StringName<class_StringName>`, persistent\: :ref:`bool<class_bool>` = false\ ) |
  117. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  118. | :ref:`String<class_String>` | :ref:`atr<class_Node_method_atr>`\ (\ message\: :ref:`String<class_String>`, context\: :ref:`StringName<class_StringName>` = ""\ ) |const| |
  119. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  120. | :ref:`String<class_String>` | :ref:`atr_n<class_Node_method_atr_n>`\ (\ message\: :ref:`String<class_String>`, plural_message\: :ref:`StringName<class_StringName>`, n\: :ref:`int<class_int>`, context\: :ref:`StringName<class_StringName>` = ""\ ) |const| |
  121. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  122. | :ref:`Variant<class_Variant>` | :ref:`call_deferred_thread_group<class_Node_method_call_deferred_thread_group>`\ (\ method\: :ref:`StringName<class_StringName>`, ...\ ) |vararg| |
  123. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  124. | :ref:`Variant<class_Variant>` | :ref:`call_thread_safe<class_Node_method_call_thread_safe>`\ (\ method\: :ref:`StringName<class_StringName>`, ...\ ) |vararg| |
  125. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  126. | :ref:`bool<class_bool>` | :ref:`can_process<class_Node_method_can_process>`\ (\ ) |const| |
  127. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  128. | :ref:`Tween<class_Tween>` | :ref:`create_tween<class_Node_method_create_tween>`\ (\ ) |
  129. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  130. | :ref:`Node<class_Node>` | :ref:`duplicate<class_Node_method_duplicate>`\ (\ flags\: :ref:`int<class_int>` = 15\ ) |const| |
  131. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  132. | :ref:`Node<class_Node>` | :ref:`find_child<class_Node_method_find_child>`\ (\ pattern\: :ref:`String<class_String>`, recursive\: :ref:`bool<class_bool>` = true, owned\: :ref:`bool<class_bool>` = true\ ) |const| |
  133. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  134. | :ref:`Array<class_Array>`\[:ref:`Node<class_Node>`\] | :ref:`find_children<class_Node_method_find_children>`\ (\ pattern\: :ref:`String<class_String>`, type\: :ref:`String<class_String>` = "", recursive\: :ref:`bool<class_bool>` = true, owned\: :ref:`bool<class_bool>` = true\ ) |const| |
  135. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  136. | :ref:`Node<class_Node>` | :ref:`find_parent<class_Node_method_find_parent>`\ (\ pattern\: :ref:`String<class_String>`\ ) |const| |
  137. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  138. | :ref:`RID<class_RID>` | :ref:`get_accessibility_element<class_Node_method_get_accessibility_element>`\ (\ ) |const| |
  139. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  140. | :ref:`Node<class_Node>` | :ref:`get_child<class_Node_method_get_child>`\ (\ idx\: :ref:`int<class_int>`, include_internal\: :ref:`bool<class_bool>` = false\ ) |const| |
  141. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  142. | :ref:`int<class_int>` | :ref:`get_child_count<class_Node_method_get_child_count>`\ (\ include_internal\: :ref:`bool<class_bool>` = false\ ) |const| |
  143. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  144. | :ref:`Array<class_Array>`\[:ref:`Node<class_Node>`\] | :ref:`get_children<class_Node_method_get_children>`\ (\ include_internal\: :ref:`bool<class_bool>` = false\ ) |const| |
  145. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  146. | :ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\] | :ref:`get_groups<class_Node_method_get_groups>`\ (\ ) |const| |
  147. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  148. | :ref:`int<class_int>` | :ref:`get_index<class_Node_method_get_index>`\ (\ include_internal\: :ref:`bool<class_bool>` = false\ ) |const| |
  149. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  150. | :ref:`Window<class_Window>` | :ref:`get_last_exclusive_window<class_Node_method_get_last_exclusive_window>`\ (\ ) |const| |
  151. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  152. | :ref:`int<class_int>` | :ref:`get_multiplayer_authority<class_Node_method_get_multiplayer_authority>`\ (\ ) |const| |
  153. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  154. | :ref:`Node<class_Node>` | :ref:`get_node<class_Node_method_get_node>`\ (\ path\: :ref:`NodePath<class_NodePath>`\ ) |const| |
  155. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  156. | :ref:`Array<class_Array>` | :ref:`get_node_and_resource<class_Node_method_get_node_and_resource>`\ (\ path\: :ref:`NodePath<class_NodePath>`\ ) |
  157. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  158. | :ref:`Node<class_Node>` | :ref:`get_node_or_null<class_Node_method_get_node_or_null>`\ (\ path\: :ref:`NodePath<class_NodePath>`\ ) |const| |
  159. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  160. | :ref:`Node<class_Node>` | :ref:`get_parent<class_Node_method_get_parent>`\ (\ ) |const| |
  161. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  162. | :ref:`NodePath<class_NodePath>` | :ref:`get_path<class_Node_method_get_path>`\ (\ ) |const| |
  163. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  164. | :ref:`NodePath<class_NodePath>` | :ref:`get_path_to<class_Node_method_get_path_to>`\ (\ node\: :ref:`Node<class_Node>`, use_unique_path\: :ref:`bool<class_bool>` = false\ ) |const| |
  165. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  166. | :ref:`float<class_float>` | :ref:`get_physics_process_delta_time<class_Node_method_get_physics_process_delta_time>`\ (\ ) |const| |
  167. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  168. | :ref:`float<class_float>` | :ref:`get_process_delta_time<class_Node_method_get_process_delta_time>`\ (\ ) |const| |
  169. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  170. | :ref:`Variant<class_Variant>` | :ref:`get_rpc_config<class_Node_method_get_rpc_config>`\ (\ ) |const| |
  171. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  172. | :ref:`bool<class_bool>` | :ref:`get_scene_instance_load_placeholder<class_Node_method_get_scene_instance_load_placeholder>`\ (\ ) |const| |
  173. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  174. | :ref:`SceneTree<class_SceneTree>` | :ref:`get_tree<class_Node_method_get_tree>`\ (\ ) |const| |
  175. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  176. | :ref:`String<class_String>` | :ref:`get_tree_string<class_Node_method_get_tree_string>`\ (\ ) |
  177. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  178. | :ref:`String<class_String>` | :ref:`get_tree_string_pretty<class_Node_method_get_tree_string_pretty>`\ (\ ) |
  179. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  180. | :ref:`Viewport<class_Viewport>` | :ref:`get_viewport<class_Node_method_get_viewport>`\ (\ ) |const| |
  181. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  182. | :ref:`Window<class_Window>` | :ref:`get_window<class_Node_method_get_window>`\ (\ ) |const| |
  183. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  184. | :ref:`bool<class_bool>` | :ref:`has_node<class_Node_method_has_node>`\ (\ path\: :ref:`NodePath<class_NodePath>`\ ) |const| |
  185. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  186. | :ref:`bool<class_bool>` | :ref:`has_node_and_resource<class_Node_method_has_node_and_resource>`\ (\ path\: :ref:`NodePath<class_NodePath>`\ ) |const| |
  187. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  188. | :ref:`bool<class_bool>` | :ref:`is_ancestor_of<class_Node_method_is_ancestor_of>`\ (\ node\: :ref:`Node<class_Node>`\ ) |const| |
  189. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  190. | :ref:`bool<class_bool>` | :ref:`is_displayed_folded<class_Node_method_is_displayed_folded>`\ (\ ) |const| |
  191. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  192. | :ref:`bool<class_bool>` | :ref:`is_editable_instance<class_Node_method_is_editable_instance>`\ (\ node\: :ref:`Node<class_Node>`\ ) |const| |
  193. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  194. | :ref:`bool<class_bool>` | :ref:`is_greater_than<class_Node_method_is_greater_than>`\ (\ node\: :ref:`Node<class_Node>`\ ) |const| |
  195. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  196. | :ref:`bool<class_bool>` | :ref:`is_in_group<class_Node_method_is_in_group>`\ (\ group\: :ref:`StringName<class_StringName>`\ ) |const| |
  197. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  198. | :ref:`bool<class_bool>` | :ref:`is_inside_tree<class_Node_method_is_inside_tree>`\ (\ ) |const| |
  199. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  200. | :ref:`bool<class_bool>` | :ref:`is_multiplayer_authority<class_Node_method_is_multiplayer_authority>`\ (\ ) |const| |
  201. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  202. | :ref:`bool<class_bool>` | :ref:`is_node_ready<class_Node_method_is_node_ready>`\ (\ ) |const| |
  203. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  204. | :ref:`bool<class_bool>` | :ref:`is_part_of_edited_scene<class_Node_method_is_part_of_edited_scene>`\ (\ ) |const| |
  205. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  206. | :ref:`bool<class_bool>` | :ref:`is_physics_interpolated<class_Node_method_is_physics_interpolated>`\ (\ ) |const| |
  207. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  208. | :ref:`bool<class_bool>` | :ref:`is_physics_interpolated_and_enabled<class_Node_method_is_physics_interpolated_and_enabled>`\ (\ ) |const| |
  209. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  210. | :ref:`bool<class_bool>` | :ref:`is_physics_processing<class_Node_method_is_physics_processing>`\ (\ ) |const| |
  211. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  212. | :ref:`bool<class_bool>` | :ref:`is_physics_processing_internal<class_Node_method_is_physics_processing_internal>`\ (\ ) |const| |
  213. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  214. | :ref:`bool<class_bool>` | :ref:`is_processing<class_Node_method_is_processing>`\ (\ ) |const| |
  215. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  216. | :ref:`bool<class_bool>` | :ref:`is_processing_input<class_Node_method_is_processing_input>`\ (\ ) |const| |
  217. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  218. | :ref:`bool<class_bool>` | :ref:`is_processing_internal<class_Node_method_is_processing_internal>`\ (\ ) |const| |
  219. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  220. | :ref:`bool<class_bool>` | :ref:`is_processing_shortcut_input<class_Node_method_is_processing_shortcut_input>`\ (\ ) |const| |
  221. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  222. | :ref:`bool<class_bool>` | :ref:`is_processing_unhandled_input<class_Node_method_is_processing_unhandled_input>`\ (\ ) |const| |
  223. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  224. | :ref:`bool<class_bool>` | :ref:`is_processing_unhandled_key_input<class_Node_method_is_processing_unhandled_key_input>`\ (\ ) |const| |
  225. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  226. | |void| | :ref:`move_child<class_Node_method_move_child>`\ (\ child_node\: :ref:`Node<class_Node>`, to_index\: :ref:`int<class_int>`\ ) |
  227. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  228. | |void| | :ref:`notify_deferred_thread_group<class_Node_method_notify_deferred_thread_group>`\ (\ what\: :ref:`int<class_int>`\ ) |
  229. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  230. | |void| | :ref:`notify_thread_safe<class_Node_method_notify_thread_safe>`\ (\ what\: :ref:`int<class_int>`\ ) |
  231. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  232. | |void| | :ref:`print_orphan_nodes<class_Node_method_print_orphan_nodes>`\ (\ ) |static| |
  233. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  234. | |void| | :ref:`print_tree<class_Node_method_print_tree>`\ (\ ) |
  235. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  236. | |void| | :ref:`print_tree_pretty<class_Node_method_print_tree_pretty>`\ (\ ) |
  237. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  238. | |void| | :ref:`propagate_call<class_Node_method_propagate_call>`\ (\ method\: :ref:`StringName<class_StringName>`, args\: :ref:`Array<class_Array>` = [], parent_first\: :ref:`bool<class_bool>` = false\ ) |
  239. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  240. | |void| | :ref:`propagate_notification<class_Node_method_propagate_notification>`\ (\ what\: :ref:`int<class_int>`\ ) |
  241. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  242. | |void| | :ref:`queue_accessibility_update<class_Node_method_queue_accessibility_update>`\ (\ ) |
  243. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  244. | |void| | :ref:`queue_free<class_Node_method_queue_free>`\ (\ ) |
  245. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  246. | |void| | :ref:`remove_child<class_Node_method_remove_child>`\ (\ node\: :ref:`Node<class_Node>`\ ) |
  247. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  248. | |void| | :ref:`remove_from_group<class_Node_method_remove_from_group>`\ (\ group\: :ref:`StringName<class_StringName>`\ ) |
  249. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  250. | |void| | :ref:`reparent<class_Node_method_reparent>`\ (\ new_parent\: :ref:`Node<class_Node>`, keep_global_transform\: :ref:`bool<class_bool>` = true\ ) |
  251. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  252. | |void| | :ref:`replace_by<class_Node_method_replace_by>`\ (\ node\: :ref:`Node<class_Node>`, keep_groups\: :ref:`bool<class_bool>` = false\ ) |
  253. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  254. | |void| | :ref:`request_ready<class_Node_method_request_ready>`\ (\ ) |
  255. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  256. | |void| | :ref:`reset_physics_interpolation<class_Node_method_reset_physics_interpolation>`\ (\ ) |
  257. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  258. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`rpc<class_Node_method_rpc>`\ (\ method\: :ref:`StringName<class_StringName>`, ...\ ) |vararg| |
  259. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  260. | |void| | :ref:`rpc_config<class_Node_method_rpc_config>`\ (\ method\: :ref:`StringName<class_StringName>`, config\: :ref:`Variant<class_Variant>`\ ) |
  261. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  262. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`rpc_id<class_Node_method_rpc_id>`\ (\ peer_id\: :ref:`int<class_int>`, method\: :ref:`StringName<class_StringName>`, ...\ ) |vararg| |
  263. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  264. | |void| | :ref:`set_deferred_thread_group<class_Node_method_set_deferred_thread_group>`\ (\ property\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) |
  265. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  266. | |void| | :ref:`set_display_folded<class_Node_method_set_display_folded>`\ (\ fold\: :ref:`bool<class_bool>`\ ) |
  267. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  268. | |void| | :ref:`set_editable_instance<class_Node_method_set_editable_instance>`\ (\ node\: :ref:`Node<class_Node>`, is_editable\: :ref:`bool<class_bool>`\ ) |
  269. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  270. | |void| | :ref:`set_multiplayer_authority<class_Node_method_set_multiplayer_authority>`\ (\ id\: :ref:`int<class_int>`, recursive\: :ref:`bool<class_bool>` = true\ ) |
  271. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  272. | |void| | :ref:`set_physics_process<class_Node_method_set_physics_process>`\ (\ enable\: :ref:`bool<class_bool>`\ ) |
  273. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  274. | |void| | :ref:`set_physics_process_internal<class_Node_method_set_physics_process_internal>`\ (\ enable\: :ref:`bool<class_bool>`\ ) |
  275. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  276. | |void| | :ref:`set_process<class_Node_method_set_process>`\ (\ enable\: :ref:`bool<class_bool>`\ ) |
  277. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  278. | |void| | :ref:`set_process_input<class_Node_method_set_process_input>`\ (\ enable\: :ref:`bool<class_bool>`\ ) |
  279. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  280. | |void| | :ref:`set_process_internal<class_Node_method_set_process_internal>`\ (\ enable\: :ref:`bool<class_bool>`\ ) |
  281. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  282. | |void| | :ref:`set_process_shortcut_input<class_Node_method_set_process_shortcut_input>`\ (\ enable\: :ref:`bool<class_bool>`\ ) |
  283. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  284. | |void| | :ref:`set_process_unhandled_input<class_Node_method_set_process_unhandled_input>`\ (\ enable\: :ref:`bool<class_bool>`\ ) |
  285. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  286. | |void| | :ref:`set_process_unhandled_key_input<class_Node_method_set_process_unhandled_key_input>`\ (\ enable\: :ref:`bool<class_bool>`\ ) |
  287. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  288. | |void| | :ref:`set_scene_instance_load_placeholder<class_Node_method_set_scene_instance_load_placeholder>`\ (\ load_placeholder\: :ref:`bool<class_bool>`\ ) |
  289. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  290. | |void| | :ref:`set_thread_safe<class_Node_method_set_thread_safe>`\ (\ property\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) |
  291. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  292. | |void| | :ref:`set_translation_domain_inherited<class_Node_method_set_translation_domain_inherited>`\ (\ ) |
  293. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  294. | |void| | :ref:`update_configuration_warnings<class_Node_method_update_configuration_warnings>`\ (\ ) |
  295. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  296. .. rst-class:: classref-section-separator
  297. ----
  298. .. rst-class:: classref-descriptions-group
  299. Signals
  300. -------
  301. .. _class_Node_signal_child_entered_tree:
  302. .. rst-class:: classref-signal
  303. **child_entered_tree**\ (\ node\: :ref:`Node<class_Node>`\ ) :ref:`🔗<class_Node_signal_child_entered_tree>`
  304. Emitted when the child ``node`` enters the :ref:`SceneTree<class_SceneTree>`, usually because this node entered the tree (see :ref:`tree_entered<class_Node_signal_tree_entered>`), or :ref:`add_child()<class_Node_method_add_child>` has been called.
  305. This signal is emitted *after* the child node's own :ref:`NOTIFICATION_ENTER_TREE<class_Node_constant_NOTIFICATION_ENTER_TREE>` and :ref:`tree_entered<class_Node_signal_tree_entered>`.
  306. .. rst-class:: classref-item-separator
  307. ----
  308. .. _class_Node_signal_child_exiting_tree:
  309. .. rst-class:: classref-signal
  310. **child_exiting_tree**\ (\ node\: :ref:`Node<class_Node>`\ ) :ref:`🔗<class_Node_signal_child_exiting_tree>`
  311. Emitted when the child ``node`` is about to exit the :ref:`SceneTree<class_SceneTree>`, usually because this node is exiting the tree (see :ref:`tree_exiting<class_Node_signal_tree_exiting>`), or because the child ``node`` is being removed or freed.
  312. When this signal is received, the child ``node`` is still accessible inside the tree. This signal is emitted *after* the child node's own :ref:`tree_exiting<class_Node_signal_tree_exiting>` and :ref:`NOTIFICATION_EXIT_TREE<class_Node_constant_NOTIFICATION_EXIT_TREE>`.
  313. .. rst-class:: classref-item-separator
  314. ----
  315. .. _class_Node_signal_child_order_changed:
  316. .. rst-class:: classref-signal
  317. **child_order_changed**\ (\ ) :ref:`🔗<class_Node_signal_child_order_changed>`
  318. Emitted when the list of children is changed. This happens when child nodes are added, moved or removed.
  319. .. rst-class:: classref-item-separator
  320. ----
  321. .. _class_Node_signal_editor_description_changed:
  322. .. rst-class:: classref-signal
  323. **editor_description_changed**\ (\ node\: :ref:`Node<class_Node>`\ ) :ref:`🔗<class_Node_signal_editor_description_changed>`
  324. Emitted when the node's editor description field changed.
  325. .. rst-class:: classref-item-separator
  326. ----
  327. .. _class_Node_signal_editor_state_changed:
  328. .. rst-class:: classref-signal
  329. **editor_state_changed**\ (\ ) :ref:`🔗<class_Node_signal_editor_state_changed>`
  330. Emitted when an attribute of the node that is relevant to the editor is changed. Only emitted in the editor.
  331. .. rst-class:: classref-item-separator
  332. ----
  333. .. _class_Node_signal_ready:
  334. .. rst-class:: classref-signal
  335. **ready**\ (\ ) :ref:`🔗<class_Node_signal_ready>`
  336. Emitted when the node is considered ready, after :ref:`_ready()<class_Node_private_method__ready>` is called.
  337. .. rst-class:: classref-item-separator
  338. ----
  339. .. _class_Node_signal_renamed:
  340. .. rst-class:: classref-signal
  341. **renamed**\ (\ ) :ref:`🔗<class_Node_signal_renamed>`
  342. Emitted when the node's :ref:`name<class_Node_property_name>` is changed, if the node is inside the tree.
  343. .. rst-class:: classref-item-separator
  344. ----
  345. .. _class_Node_signal_replacing_by:
  346. .. rst-class:: classref-signal
  347. **replacing_by**\ (\ node\: :ref:`Node<class_Node>`\ ) :ref:`🔗<class_Node_signal_replacing_by>`
  348. Emitted when this node is being replaced by the ``node``, see :ref:`replace_by()<class_Node_method_replace_by>`.
  349. This signal is emitted *after* ``node`` has been added as a child of the original parent node, but *before* all original child nodes have been reparented to ``node``.
  350. .. rst-class:: classref-item-separator
  351. ----
  352. .. _class_Node_signal_tree_entered:
  353. .. rst-class:: classref-signal
  354. **tree_entered**\ (\ ) :ref:`🔗<class_Node_signal_tree_entered>`
  355. Emitted when the node enters the tree.
  356. This signal is emitted *after* the related :ref:`NOTIFICATION_ENTER_TREE<class_Node_constant_NOTIFICATION_ENTER_TREE>` notification.
  357. .. rst-class:: classref-item-separator
  358. ----
  359. .. _class_Node_signal_tree_exited:
  360. .. rst-class:: classref-signal
  361. **tree_exited**\ (\ ) :ref:`🔗<class_Node_signal_tree_exited>`
  362. Emitted after the node exits the tree and is no longer active.
  363. This signal is emitted *after* the related :ref:`NOTIFICATION_EXIT_TREE<class_Node_constant_NOTIFICATION_EXIT_TREE>` notification.
  364. .. rst-class:: classref-item-separator
  365. ----
  366. .. _class_Node_signal_tree_exiting:
  367. .. rst-class:: classref-signal
  368. **tree_exiting**\ (\ ) :ref:`🔗<class_Node_signal_tree_exiting>`
  369. Emitted when the node is just about to exit the tree. The node is still valid. As such, this is the right place for de-initialization (or a "destructor", if you will).
  370. This signal is emitted *after* the node's :ref:`_exit_tree()<class_Node_private_method__exit_tree>`, and *before* the related :ref:`NOTIFICATION_EXIT_TREE<class_Node_constant_NOTIFICATION_EXIT_TREE>`.
  371. .. rst-class:: classref-section-separator
  372. ----
  373. .. rst-class:: classref-descriptions-group
  374. Enumerations
  375. ------------
  376. .. _enum_Node_ProcessMode:
  377. .. rst-class:: classref-enumeration
  378. enum **ProcessMode**: :ref:`🔗<enum_Node_ProcessMode>`
  379. .. _class_Node_constant_PROCESS_MODE_INHERIT:
  380. .. rst-class:: classref-enumeration-constant
  381. :ref:`ProcessMode<enum_Node_ProcessMode>` **PROCESS_MODE_INHERIT** = ``0``
  382. Inherits :ref:`process_mode<class_Node_property_process_mode>` from the node's parent. This is the default for any newly created node.
  383. .. _class_Node_constant_PROCESS_MODE_PAUSABLE:
  384. .. rst-class:: classref-enumeration-constant
  385. :ref:`ProcessMode<enum_Node_ProcessMode>` **PROCESS_MODE_PAUSABLE** = ``1``
  386. Stops processing when :ref:`SceneTree.paused<class_SceneTree_property_paused>` is ``true``. This is the inverse of :ref:`PROCESS_MODE_WHEN_PAUSED<class_Node_constant_PROCESS_MODE_WHEN_PAUSED>`, and the default for the root node.
  387. .. _class_Node_constant_PROCESS_MODE_WHEN_PAUSED:
  388. .. rst-class:: classref-enumeration-constant
  389. :ref:`ProcessMode<enum_Node_ProcessMode>` **PROCESS_MODE_WHEN_PAUSED** = ``2``
  390. Process **only** when :ref:`SceneTree.paused<class_SceneTree_property_paused>` is ``true``. This is the inverse of :ref:`PROCESS_MODE_PAUSABLE<class_Node_constant_PROCESS_MODE_PAUSABLE>`.
  391. .. _class_Node_constant_PROCESS_MODE_ALWAYS:
  392. .. rst-class:: classref-enumeration-constant
  393. :ref:`ProcessMode<enum_Node_ProcessMode>` **PROCESS_MODE_ALWAYS** = ``3``
  394. Always process. Keeps processing, ignoring :ref:`SceneTree.paused<class_SceneTree_property_paused>`. This is the inverse of :ref:`PROCESS_MODE_DISABLED<class_Node_constant_PROCESS_MODE_DISABLED>`.
  395. .. _class_Node_constant_PROCESS_MODE_DISABLED:
  396. .. rst-class:: classref-enumeration-constant
  397. :ref:`ProcessMode<enum_Node_ProcessMode>` **PROCESS_MODE_DISABLED** = ``4``
  398. Never process. Completely disables processing, ignoring :ref:`SceneTree.paused<class_SceneTree_property_paused>`. This is the inverse of :ref:`PROCESS_MODE_ALWAYS<class_Node_constant_PROCESS_MODE_ALWAYS>`.
  399. .. rst-class:: classref-item-separator
  400. ----
  401. .. _enum_Node_ProcessThreadGroup:
  402. .. rst-class:: classref-enumeration
  403. enum **ProcessThreadGroup**: :ref:`🔗<enum_Node_ProcessThreadGroup>`
  404. .. _class_Node_constant_PROCESS_THREAD_GROUP_INHERIT:
  405. .. rst-class:: classref-enumeration-constant
  406. :ref:`ProcessThreadGroup<enum_Node_ProcessThreadGroup>` **PROCESS_THREAD_GROUP_INHERIT** = ``0``
  407. Process this node based on the thread group mode of the first parent (or grandparent) node that has a thread group mode that is not inherit. See :ref:`process_thread_group<class_Node_property_process_thread_group>` for more information.
  408. .. _class_Node_constant_PROCESS_THREAD_GROUP_MAIN_THREAD:
  409. .. rst-class:: classref-enumeration-constant
  410. :ref:`ProcessThreadGroup<enum_Node_ProcessThreadGroup>` **PROCESS_THREAD_GROUP_MAIN_THREAD** = ``1``
  411. Process this node (and child nodes set to inherit) on the main thread. See :ref:`process_thread_group<class_Node_property_process_thread_group>` for more information.
  412. .. _class_Node_constant_PROCESS_THREAD_GROUP_SUB_THREAD:
  413. .. rst-class:: classref-enumeration-constant
  414. :ref:`ProcessThreadGroup<enum_Node_ProcessThreadGroup>` **PROCESS_THREAD_GROUP_SUB_THREAD** = ``2``
  415. Process this node (and child nodes set to inherit) on a sub-thread. See :ref:`process_thread_group<class_Node_property_process_thread_group>` for more information.
  416. .. rst-class:: classref-item-separator
  417. ----
  418. .. _enum_Node_ProcessThreadMessages:
  419. .. rst-class:: classref-enumeration
  420. flags **ProcessThreadMessages**: :ref:`🔗<enum_Node_ProcessThreadMessages>`
  421. .. _class_Node_constant_FLAG_PROCESS_THREAD_MESSAGES:
  422. .. rst-class:: classref-enumeration-constant
  423. :ref:`ProcessThreadMessages<enum_Node_ProcessThreadMessages>` **FLAG_PROCESS_THREAD_MESSAGES** = ``1``
  424. Allows this node to process threaded messages created with :ref:`call_deferred_thread_group()<class_Node_method_call_deferred_thread_group>` right before :ref:`_process()<class_Node_private_method__process>` is called.
  425. .. _class_Node_constant_FLAG_PROCESS_THREAD_MESSAGES_PHYSICS:
  426. .. rst-class:: classref-enumeration-constant
  427. :ref:`ProcessThreadMessages<enum_Node_ProcessThreadMessages>` **FLAG_PROCESS_THREAD_MESSAGES_PHYSICS** = ``2``
  428. Allows this node to process threaded messages created with :ref:`call_deferred_thread_group()<class_Node_method_call_deferred_thread_group>` right before :ref:`_physics_process()<class_Node_private_method__physics_process>` is called.
  429. .. _class_Node_constant_FLAG_PROCESS_THREAD_MESSAGES_ALL:
  430. .. rst-class:: classref-enumeration-constant
  431. :ref:`ProcessThreadMessages<enum_Node_ProcessThreadMessages>` **FLAG_PROCESS_THREAD_MESSAGES_ALL** = ``3``
  432. Allows this node to process threaded messages created with :ref:`call_deferred_thread_group()<class_Node_method_call_deferred_thread_group>` right before either :ref:`_process()<class_Node_private_method__process>` or :ref:`_physics_process()<class_Node_private_method__physics_process>` are called.
  433. .. rst-class:: classref-item-separator
  434. ----
  435. .. _enum_Node_PhysicsInterpolationMode:
  436. .. rst-class:: classref-enumeration
  437. enum **PhysicsInterpolationMode**: :ref:`🔗<enum_Node_PhysicsInterpolationMode>`
  438. .. _class_Node_constant_PHYSICS_INTERPOLATION_MODE_INHERIT:
  439. .. rst-class:: classref-enumeration-constant
  440. :ref:`PhysicsInterpolationMode<enum_Node_PhysicsInterpolationMode>` **PHYSICS_INTERPOLATION_MODE_INHERIT** = ``0``
  441. Inherits :ref:`physics_interpolation_mode<class_Node_property_physics_interpolation_mode>` from the node's parent. This is the default for any newly created node.
  442. .. _class_Node_constant_PHYSICS_INTERPOLATION_MODE_ON:
  443. .. rst-class:: classref-enumeration-constant
  444. :ref:`PhysicsInterpolationMode<enum_Node_PhysicsInterpolationMode>` **PHYSICS_INTERPOLATION_MODE_ON** = ``1``
  445. Enables physics interpolation for this node and for children set to :ref:`PHYSICS_INTERPOLATION_MODE_INHERIT<class_Node_constant_PHYSICS_INTERPOLATION_MODE_INHERIT>`. This is the default for the root node.
  446. .. _class_Node_constant_PHYSICS_INTERPOLATION_MODE_OFF:
  447. .. rst-class:: classref-enumeration-constant
  448. :ref:`PhysicsInterpolationMode<enum_Node_PhysicsInterpolationMode>` **PHYSICS_INTERPOLATION_MODE_OFF** = ``2``
  449. Disables physics interpolation for this node and for children set to :ref:`PHYSICS_INTERPOLATION_MODE_INHERIT<class_Node_constant_PHYSICS_INTERPOLATION_MODE_INHERIT>`.
  450. .. rst-class:: classref-item-separator
  451. ----
  452. .. _enum_Node_DuplicateFlags:
  453. .. rst-class:: classref-enumeration
  454. enum **DuplicateFlags**: :ref:`🔗<enum_Node_DuplicateFlags>`
  455. .. _class_Node_constant_DUPLICATE_SIGNALS:
  456. .. rst-class:: classref-enumeration-constant
  457. :ref:`DuplicateFlags<enum_Node_DuplicateFlags>` **DUPLICATE_SIGNALS** = ``1``
  458. Duplicate the node's signal connections that are connected with the :ref:`Object.CONNECT_PERSIST<class_Object_constant_CONNECT_PERSIST>` flag.
  459. .. _class_Node_constant_DUPLICATE_GROUPS:
  460. .. rst-class:: classref-enumeration-constant
  461. :ref:`DuplicateFlags<enum_Node_DuplicateFlags>` **DUPLICATE_GROUPS** = ``2``
  462. Duplicate the node's groups.
  463. .. _class_Node_constant_DUPLICATE_SCRIPTS:
  464. .. rst-class:: classref-enumeration-constant
  465. :ref:`DuplicateFlags<enum_Node_DuplicateFlags>` **DUPLICATE_SCRIPTS** = ``4``
  466. Duplicate the node's script (also overriding the duplicated children's scripts, if combined with :ref:`DUPLICATE_USE_INSTANTIATION<class_Node_constant_DUPLICATE_USE_INSTANTIATION>`).
  467. .. _class_Node_constant_DUPLICATE_USE_INSTANTIATION:
  468. .. rst-class:: classref-enumeration-constant
  469. :ref:`DuplicateFlags<enum_Node_DuplicateFlags>` **DUPLICATE_USE_INSTANTIATION** = ``8``
  470. Duplicate using :ref:`PackedScene.instantiate()<class_PackedScene_method_instantiate>`. If the node comes from a scene saved on disk, reuses :ref:`PackedScene.instantiate()<class_PackedScene_method_instantiate>` as the base for the duplicated node and its children.
  471. .. rst-class:: classref-item-separator
  472. ----
  473. .. _enum_Node_InternalMode:
  474. .. rst-class:: classref-enumeration
  475. enum **InternalMode**: :ref:`🔗<enum_Node_InternalMode>`
  476. .. _class_Node_constant_INTERNAL_MODE_DISABLED:
  477. .. rst-class:: classref-enumeration-constant
  478. :ref:`InternalMode<enum_Node_InternalMode>` **INTERNAL_MODE_DISABLED** = ``0``
  479. The node will not be internal.
  480. .. _class_Node_constant_INTERNAL_MODE_FRONT:
  481. .. rst-class:: classref-enumeration-constant
  482. :ref:`InternalMode<enum_Node_InternalMode>` **INTERNAL_MODE_FRONT** = ``1``
  483. The node will be placed at the beginning of the parent's children, before any non-internal sibling.
  484. .. _class_Node_constant_INTERNAL_MODE_BACK:
  485. .. rst-class:: classref-enumeration-constant
  486. :ref:`InternalMode<enum_Node_InternalMode>` **INTERNAL_MODE_BACK** = ``2``
  487. The node will be placed at the end of the parent's children, after any non-internal sibling.
  488. .. rst-class:: classref-item-separator
  489. ----
  490. .. _enum_Node_AutoTranslateMode:
  491. .. rst-class:: classref-enumeration
  492. enum **AutoTranslateMode**: :ref:`🔗<enum_Node_AutoTranslateMode>`
  493. .. _class_Node_constant_AUTO_TRANSLATE_MODE_INHERIT:
  494. .. rst-class:: classref-enumeration-constant
  495. :ref:`AutoTranslateMode<enum_Node_AutoTranslateMode>` **AUTO_TRANSLATE_MODE_INHERIT** = ``0``
  496. Inherits :ref:`auto_translate_mode<class_Node_property_auto_translate_mode>` from the node's parent. This is the default for any newly created node.
  497. .. _class_Node_constant_AUTO_TRANSLATE_MODE_ALWAYS:
  498. .. rst-class:: classref-enumeration-constant
  499. :ref:`AutoTranslateMode<enum_Node_AutoTranslateMode>` **AUTO_TRANSLATE_MODE_ALWAYS** = ``1``
  500. Always automatically translate. This is the inverse of :ref:`AUTO_TRANSLATE_MODE_DISABLED<class_Node_constant_AUTO_TRANSLATE_MODE_DISABLED>`, and the default for the root node.
  501. .. _class_Node_constant_AUTO_TRANSLATE_MODE_DISABLED:
  502. .. rst-class:: classref-enumeration-constant
  503. :ref:`AutoTranslateMode<enum_Node_AutoTranslateMode>` **AUTO_TRANSLATE_MODE_DISABLED** = ``2``
  504. Never automatically translate. This is the inverse of :ref:`AUTO_TRANSLATE_MODE_ALWAYS<class_Node_constant_AUTO_TRANSLATE_MODE_ALWAYS>`.
  505. String parsing for POT generation will be skipped for this node and children that are set to :ref:`AUTO_TRANSLATE_MODE_INHERIT<class_Node_constant_AUTO_TRANSLATE_MODE_INHERIT>`.
  506. .. rst-class:: classref-section-separator
  507. ----
  508. .. rst-class:: classref-descriptions-group
  509. Constants
  510. ---------
  511. .. _class_Node_constant_NOTIFICATION_ENTER_TREE:
  512. .. rst-class:: classref-constant
  513. **NOTIFICATION_ENTER_TREE** = ``10`` :ref:`🔗<class_Node_constant_NOTIFICATION_ENTER_TREE>`
  514. Notification received when the node enters a :ref:`SceneTree<class_SceneTree>`. See :ref:`_enter_tree()<class_Node_private_method__enter_tree>`.
  515. This notification is received *before* the related :ref:`tree_entered<class_Node_signal_tree_entered>` signal.
  516. .. _class_Node_constant_NOTIFICATION_EXIT_TREE:
  517. .. rst-class:: classref-constant
  518. **NOTIFICATION_EXIT_TREE** = ``11`` :ref:`🔗<class_Node_constant_NOTIFICATION_EXIT_TREE>`
  519. Notification received when the node is about to exit a :ref:`SceneTree<class_SceneTree>`. See :ref:`_exit_tree()<class_Node_private_method__exit_tree>`.
  520. This notification is received *after* the related :ref:`tree_exiting<class_Node_signal_tree_exiting>` signal.
  521. .. _class_Node_constant_NOTIFICATION_MOVED_IN_PARENT:
  522. .. rst-class:: classref-constant
  523. **NOTIFICATION_MOVED_IN_PARENT** = ``12`` :ref:`🔗<class_Node_constant_NOTIFICATION_MOVED_IN_PARENT>`
  524. **Deprecated:** This notification is no longer sent by the engine. Use :ref:`NOTIFICATION_CHILD_ORDER_CHANGED<class_Node_constant_NOTIFICATION_CHILD_ORDER_CHANGED>` instead.
  525. .. _class_Node_constant_NOTIFICATION_READY:
  526. .. rst-class:: classref-constant
  527. **NOTIFICATION_READY** = ``13`` :ref:`🔗<class_Node_constant_NOTIFICATION_READY>`
  528. Notification received when the node is ready. See :ref:`_ready()<class_Node_private_method__ready>`.
  529. .. _class_Node_constant_NOTIFICATION_PAUSED:
  530. .. rst-class:: classref-constant
  531. **NOTIFICATION_PAUSED** = ``14`` :ref:`🔗<class_Node_constant_NOTIFICATION_PAUSED>`
  532. Notification received when the node is paused. See :ref:`process_mode<class_Node_property_process_mode>`.
  533. .. _class_Node_constant_NOTIFICATION_UNPAUSED:
  534. .. rst-class:: classref-constant
  535. **NOTIFICATION_UNPAUSED** = ``15`` :ref:`🔗<class_Node_constant_NOTIFICATION_UNPAUSED>`
  536. Notification received when the node is unpaused. See :ref:`process_mode<class_Node_property_process_mode>`.
  537. .. _class_Node_constant_NOTIFICATION_PHYSICS_PROCESS:
  538. .. rst-class:: classref-constant
  539. **NOTIFICATION_PHYSICS_PROCESS** = ``16`` :ref:`🔗<class_Node_constant_NOTIFICATION_PHYSICS_PROCESS>`
  540. Notification received from the tree every physics frame when :ref:`is_physics_processing()<class_Node_method_is_physics_processing>` returns ``true``. See :ref:`_physics_process()<class_Node_private_method__physics_process>`.
  541. .. _class_Node_constant_NOTIFICATION_PROCESS:
  542. .. rst-class:: classref-constant
  543. **NOTIFICATION_PROCESS** = ``17`` :ref:`🔗<class_Node_constant_NOTIFICATION_PROCESS>`
  544. Notification received from the tree every rendered frame when :ref:`is_processing()<class_Node_method_is_processing>` returns ``true``. See :ref:`_process()<class_Node_private_method__process>`.
  545. .. _class_Node_constant_NOTIFICATION_PARENTED:
  546. .. rst-class:: classref-constant
  547. **NOTIFICATION_PARENTED** = ``18`` :ref:`🔗<class_Node_constant_NOTIFICATION_PARENTED>`
  548. Notification received when the node is set as a child of another node (see :ref:`add_child()<class_Node_method_add_child>` and :ref:`add_sibling()<class_Node_method_add_sibling>`).
  549. \ **Note:** This does *not* mean that the node entered the :ref:`SceneTree<class_SceneTree>`.
  550. .. _class_Node_constant_NOTIFICATION_UNPARENTED:
  551. .. rst-class:: classref-constant
  552. **NOTIFICATION_UNPARENTED** = ``19`` :ref:`🔗<class_Node_constant_NOTIFICATION_UNPARENTED>`
  553. Notification received when the parent node calls :ref:`remove_child()<class_Node_method_remove_child>` on this node.
  554. \ **Note:** This does *not* mean that the node exited the :ref:`SceneTree<class_SceneTree>`.
  555. .. _class_Node_constant_NOTIFICATION_SCENE_INSTANTIATED:
  556. .. rst-class:: classref-constant
  557. **NOTIFICATION_SCENE_INSTANTIATED** = ``20`` :ref:`🔗<class_Node_constant_NOTIFICATION_SCENE_INSTANTIATED>`
  558. Notification received *only* by the newly instantiated scene root node, when :ref:`PackedScene.instantiate()<class_PackedScene_method_instantiate>` is completed.
  559. .. _class_Node_constant_NOTIFICATION_DRAG_BEGIN:
  560. .. rst-class:: classref-constant
  561. **NOTIFICATION_DRAG_BEGIN** = ``21`` :ref:`🔗<class_Node_constant_NOTIFICATION_DRAG_BEGIN>`
  562. Notification received when a drag operation begins. All nodes receive this notification, not only the dragged one.
  563. Can be triggered either by dragging a :ref:`Control<class_Control>` that provides drag data (see :ref:`Control._get_drag_data()<class_Control_private_method__get_drag_data>`) or using :ref:`Control.force_drag()<class_Control_method_force_drag>`.
  564. Use :ref:`Viewport.gui_get_drag_data()<class_Viewport_method_gui_get_drag_data>` to get the dragged data.
  565. .. _class_Node_constant_NOTIFICATION_DRAG_END:
  566. .. rst-class:: classref-constant
  567. **NOTIFICATION_DRAG_END** = ``22`` :ref:`🔗<class_Node_constant_NOTIFICATION_DRAG_END>`
  568. Notification received when a drag operation ends.
  569. Use :ref:`Viewport.gui_is_drag_successful()<class_Viewport_method_gui_is_drag_successful>` to check if the drag succeeded.
  570. .. _class_Node_constant_NOTIFICATION_PATH_RENAMED:
  571. .. rst-class:: classref-constant
  572. **NOTIFICATION_PATH_RENAMED** = ``23`` :ref:`🔗<class_Node_constant_NOTIFICATION_PATH_RENAMED>`
  573. Notification received when the node's :ref:`name<class_Node_property_name>` or one of its ancestors' :ref:`name<class_Node_property_name>` is changed. This notification is *not* received when the node is removed from the :ref:`SceneTree<class_SceneTree>`.
  574. .. _class_Node_constant_NOTIFICATION_CHILD_ORDER_CHANGED:
  575. .. rst-class:: classref-constant
  576. **NOTIFICATION_CHILD_ORDER_CHANGED** = ``24`` :ref:`🔗<class_Node_constant_NOTIFICATION_CHILD_ORDER_CHANGED>`
  577. Notification received when the list of children is changed. This happens when child nodes are added, moved or removed.
  578. .. _class_Node_constant_NOTIFICATION_INTERNAL_PROCESS:
  579. .. rst-class:: classref-constant
  580. **NOTIFICATION_INTERNAL_PROCESS** = ``25`` :ref:`🔗<class_Node_constant_NOTIFICATION_INTERNAL_PROCESS>`
  581. Notification received from the tree every rendered frame when :ref:`is_processing_internal()<class_Node_method_is_processing_internal>` returns ``true``.
  582. .. _class_Node_constant_NOTIFICATION_INTERNAL_PHYSICS_PROCESS:
  583. .. rst-class:: classref-constant
  584. **NOTIFICATION_INTERNAL_PHYSICS_PROCESS** = ``26`` :ref:`🔗<class_Node_constant_NOTIFICATION_INTERNAL_PHYSICS_PROCESS>`
  585. Notification received from the tree every physics frame when :ref:`is_physics_processing_internal()<class_Node_method_is_physics_processing_internal>` returns ``true``.
  586. .. _class_Node_constant_NOTIFICATION_POST_ENTER_TREE:
  587. .. rst-class:: classref-constant
  588. **NOTIFICATION_POST_ENTER_TREE** = ``27`` :ref:`🔗<class_Node_constant_NOTIFICATION_POST_ENTER_TREE>`
  589. Notification received when the node enters the tree, just before :ref:`NOTIFICATION_READY<class_Node_constant_NOTIFICATION_READY>` may be received. Unlike the latter, it is sent every time the node enters tree, not just once.
  590. .. _class_Node_constant_NOTIFICATION_DISABLED:
  591. .. rst-class:: classref-constant
  592. **NOTIFICATION_DISABLED** = ``28`` :ref:`🔗<class_Node_constant_NOTIFICATION_DISABLED>`
  593. Notification received when the node is disabled. See :ref:`PROCESS_MODE_DISABLED<class_Node_constant_PROCESS_MODE_DISABLED>`.
  594. .. _class_Node_constant_NOTIFICATION_ENABLED:
  595. .. rst-class:: classref-constant
  596. **NOTIFICATION_ENABLED** = ``29`` :ref:`🔗<class_Node_constant_NOTIFICATION_ENABLED>`
  597. Notification received when the node is enabled again after being disabled. See :ref:`PROCESS_MODE_DISABLED<class_Node_constant_PROCESS_MODE_DISABLED>`.
  598. .. _class_Node_constant_NOTIFICATION_RESET_PHYSICS_INTERPOLATION:
  599. .. rst-class:: classref-constant
  600. **NOTIFICATION_RESET_PHYSICS_INTERPOLATION** = ``2001`` :ref:`🔗<class_Node_constant_NOTIFICATION_RESET_PHYSICS_INTERPOLATION>`
  601. Notification received when :ref:`reset_physics_interpolation()<class_Node_method_reset_physics_interpolation>` is called on the node or its ancestors.
  602. .. _class_Node_constant_NOTIFICATION_EDITOR_PRE_SAVE:
  603. .. rst-class:: classref-constant
  604. **NOTIFICATION_EDITOR_PRE_SAVE** = ``9001`` :ref:`🔗<class_Node_constant_NOTIFICATION_EDITOR_PRE_SAVE>`
  605. Notification received right before the scene with the node is saved in the editor. This notification is only sent in the Godot editor and will not occur in exported projects.
  606. .. _class_Node_constant_NOTIFICATION_EDITOR_POST_SAVE:
  607. .. rst-class:: classref-constant
  608. **NOTIFICATION_EDITOR_POST_SAVE** = ``9002`` :ref:`🔗<class_Node_constant_NOTIFICATION_EDITOR_POST_SAVE>`
  609. Notification received right after the scene with the node is saved in the editor. This notification is only sent in the Godot editor and will not occur in exported projects.
  610. .. _class_Node_constant_NOTIFICATION_WM_MOUSE_ENTER:
  611. .. rst-class:: classref-constant
  612. **NOTIFICATION_WM_MOUSE_ENTER** = ``1002`` :ref:`🔗<class_Node_constant_NOTIFICATION_WM_MOUSE_ENTER>`
  613. Notification received when the mouse enters the window.
  614. Implemented for embedded windows and on desktop and web platforms.
  615. .. _class_Node_constant_NOTIFICATION_WM_MOUSE_EXIT:
  616. .. rst-class:: classref-constant
  617. **NOTIFICATION_WM_MOUSE_EXIT** = ``1003`` :ref:`🔗<class_Node_constant_NOTIFICATION_WM_MOUSE_EXIT>`
  618. Notification received when the mouse leaves the window.
  619. Implemented for embedded windows and on desktop and web platforms.
  620. .. _class_Node_constant_NOTIFICATION_WM_WINDOW_FOCUS_IN:
  621. .. rst-class:: classref-constant
  622. **NOTIFICATION_WM_WINDOW_FOCUS_IN** = ``1004`` :ref:`🔗<class_Node_constant_NOTIFICATION_WM_WINDOW_FOCUS_IN>`
  623. Notification received from the OS when the node's :ref:`Window<class_Window>` ancestor is focused. This may be a change of focus between two windows of the same engine instance, or from the OS desktop or a third-party application to a window of the game (in which case :ref:`NOTIFICATION_APPLICATION_FOCUS_IN<class_Node_constant_NOTIFICATION_APPLICATION_FOCUS_IN>` is also received).
  624. A :ref:`Window<class_Window>` node receives this notification when it is focused.
  625. .. _class_Node_constant_NOTIFICATION_WM_WINDOW_FOCUS_OUT:
  626. .. rst-class:: classref-constant
  627. **NOTIFICATION_WM_WINDOW_FOCUS_OUT** = ``1005`` :ref:`🔗<class_Node_constant_NOTIFICATION_WM_WINDOW_FOCUS_OUT>`
  628. Notification received from the OS when the node's :ref:`Window<class_Window>` ancestor is defocused. This may be a change of focus between two windows of the same engine instance, or from a window of the game to the OS desktop or a third-party application (in which case :ref:`NOTIFICATION_APPLICATION_FOCUS_OUT<class_Node_constant_NOTIFICATION_APPLICATION_FOCUS_OUT>` is also received).
  629. A :ref:`Window<class_Window>` node receives this notification when it is defocused.
  630. .. _class_Node_constant_NOTIFICATION_WM_CLOSE_REQUEST:
  631. .. rst-class:: classref-constant
  632. **NOTIFICATION_WM_CLOSE_REQUEST** = ``1006`` :ref:`🔗<class_Node_constant_NOTIFICATION_WM_CLOSE_REQUEST>`
  633. Notification received from the OS when a close request is sent (e.g. closing the window with a "Close" button or :kbd:`Alt + F4`).
  634. Implemented on desktop platforms.
  635. .. _class_Node_constant_NOTIFICATION_WM_GO_BACK_REQUEST:
  636. .. rst-class:: classref-constant
  637. **NOTIFICATION_WM_GO_BACK_REQUEST** = ``1007`` :ref:`🔗<class_Node_constant_NOTIFICATION_WM_GO_BACK_REQUEST>`
  638. Notification received from the OS when a go back request is sent (e.g. pressing the "Back" button on Android).
  639. Implemented only on Android.
  640. .. _class_Node_constant_NOTIFICATION_WM_SIZE_CHANGED:
  641. .. rst-class:: classref-constant
  642. **NOTIFICATION_WM_SIZE_CHANGED** = ``1008`` :ref:`🔗<class_Node_constant_NOTIFICATION_WM_SIZE_CHANGED>`
  643. Notification received when the window is resized.
  644. \ **Note:** Only the resized :ref:`Window<class_Window>` node receives this notification, and it's not propagated to the child nodes.
  645. .. _class_Node_constant_NOTIFICATION_WM_DPI_CHANGE:
  646. .. rst-class:: classref-constant
  647. **NOTIFICATION_WM_DPI_CHANGE** = ``1009`` :ref:`🔗<class_Node_constant_NOTIFICATION_WM_DPI_CHANGE>`
  648. Notification received from the OS when the screen's dots per inch (DPI) scale is changed. Only implemented on macOS.
  649. .. _class_Node_constant_NOTIFICATION_VP_MOUSE_ENTER:
  650. .. rst-class:: classref-constant
  651. **NOTIFICATION_VP_MOUSE_ENTER** = ``1010`` :ref:`🔗<class_Node_constant_NOTIFICATION_VP_MOUSE_ENTER>`
  652. Notification received when the mouse cursor enters the :ref:`Viewport<class_Viewport>`'s visible area, that is not occluded behind other :ref:`Control<class_Control>`\ s or :ref:`Window<class_Window>`\ s, provided its :ref:`Viewport.gui_disable_input<class_Viewport_property_gui_disable_input>` is ``false`` and regardless if it's currently focused or not.
  653. .. _class_Node_constant_NOTIFICATION_VP_MOUSE_EXIT:
  654. .. rst-class:: classref-constant
  655. **NOTIFICATION_VP_MOUSE_EXIT** = ``1011`` :ref:`🔗<class_Node_constant_NOTIFICATION_VP_MOUSE_EXIT>`
  656. Notification received when the mouse cursor leaves the :ref:`Viewport<class_Viewport>`'s visible area, that is not occluded behind other :ref:`Control<class_Control>`\ s or :ref:`Window<class_Window>`\ s, provided its :ref:`Viewport.gui_disable_input<class_Viewport_property_gui_disable_input>` is ``false`` and regardless if it's currently focused or not.
  657. .. _class_Node_constant_NOTIFICATION_WM_POSITION_CHANGED:
  658. .. rst-class:: classref-constant
  659. **NOTIFICATION_WM_POSITION_CHANGED** = ``1012`` :ref:`🔗<class_Node_constant_NOTIFICATION_WM_POSITION_CHANGED>`
  660. Notification received when the window is moved.
  661. .. _class_Node_constant_NOTIFICATION_OS_MEMORY_WARNING:
  662. .. rst-class:: classref-constant
  663. **NOTIFICATION_OS_MEMORY_WARNING** = ``2009`` :ref:`🔗<class_Node_constant_NOTIFICATION_OS_MEMORY_WARNING>`
  664. Notification received from the OS when the application is exceeding its allocated memory.
  665. Implemented only on iOS.
  666. .. _class_Node_constant_NOTIFICATION_TRANSLATION_CHANGED:
  667. .. rst-class:: classref-constant
  668. **NOTIFICATION_TRANSLATION_CHANGED** = ``2010`` :ref:`🔗<class_Node_constant_NOTIFICATION_TRANSLATION_CHANGED>`
  669. Notification received when translations may have changed. Can be triggered by the user changing the locale, changing :ref:`auto_translate_mode<class_Node_property_auto_translate_mode>` or when the node enters the scene tree. Can be used to respond to language changes, for example to change the UI strings on the fly. Useful when working with the built-in translation support, like :ref:`Object.tr()<class_Object_method_tr>`.
  670. \ **Note:** This notification is received alongside :ref:`NOTIFICATION_ENTER_TREE<class_Node_constant_NOTIFICATION_ENTER_TREE>`, so if you are instantiating a scene, the child nodes will not be initialized yet. You can use it to setup translations for this node, child nodes created from script, or if you want to access child nodes added in the editor, make sure the node is ready using :ref:`is_node_ready()<class_Node_method_is_node_ready>`.
  671. ::
  672. func _notification(what):
  673. if what == NOTIFICATION_TRANSLATION_CHANGED:
  674. if not is_node_ready():
  675. await ready # Wait until ready signal.
  676. $Label.text = atr("%d Bananas") % banana_counter
  677. .. _class_Node_constant_NOTIFICATION_WM_ABOUT:
  678. .. rst-class:: classref-constant
  679. **NOTIFICATION_WM_ABOUT** = ``2011`` :ref:`🔗<class_Node_constant_NOTIFICATION_WM_ABOUT>`
  680. Notification received from the OS when a request for "About" information is sent.
  681. Implemented only on macOS.
  682. .. _class_Node_constant_NOTIFICATION_CRASH:
  683. .. rst-class:: classref-constant
  684. **NOTIFICATION_CRASH** = ``2012`` :ref:`🔗<class_Node_constant_NOTIFICATION_CRASH>`
  685. Notification received from Godot's crash handler when the engine is about to crash.
  686. Implemented on desktop platforms, if the crash handler is enabled.
  687. .. _class_Node_constant_NOTIFICATION_OS_IME_UPDATE:
  688. .. rst-class:: classref-constant
  689. **NOTIFICATION_OS_IME_UPDATE** = ``2013`` :ref:`🔗<class_Node_constant_NOTIFICATION_OS_IME_UPDATE>`
  690. Notification received from the OS when an update of the Input Method Engine occurs (e.g. change of IME cursor position or composition string).
  691. Implemented only on macOS.
  692. .. _class_Node_constant_NOTIFICATION_APPLICATION_RESUMED:
  693. .. rst-class:: classref-constant
  694. **NOTIFICATION_APPLICATION_RESUMED** = ``2014`` :ref:`🔗<class_Node_constant_NOTIFICATION_APPLICATION_RESUMED>`
  695. Notification received from the OS when the application is resumed.
  696. Specific to the Android and iOS platforms.
  697. .. _class_Node_constant_NOTIFICATION_APPLICATION_PAUSED:
  698. .. rst-class:: classref-constant
  699. **NOTIFICATION_APPLICATION_PAUSED** = ``2015`` :ref:`🔗<class_Node_constant_NOTIFICATION_APPLICATION_PAUSED>`
  700. Notification received from the OS when the application is paused.
  701. Specific to the Android and iOS platforms.
  702. \ **Note:** On iOS, you only have approximately 5 seconds to finish a task started by this signal. If you go over this allotment, iOS will kill the app instead of pausing it.
  703. .. _class_Node_constant_NOTIFICATION_APPLICATION_FOCUS_IN:
  704. .. rst-class:: classref-constant
  705. **NOTIFICATION_APPLICATION_FOCUS_IN** = ``2016`` :ref:`🔗<class_Node_constant_NOTIFICATION_APPLICATION_FOCUS_IN>`
  706. Notification received from the OS when the application is focused, i.e. when changing the focus from the OS desktop or a thirdparty application to any open window of the Godot instance.
  707. Implemented on desktop and mobile platforms.
  708. .. _class_Node_constant_NOTIFICATION_APPLICATION_FOCUS_OUT:
  709. .. rst-class:: classref-constant
  710. **NOTIFICATION_APPLICATION_FOCUS_OUT** = ``2017`` :ref:`🔗<class_Node_constant_NOTIFICATION_APPLICATION_FOCUS_OUT>`
  711. Notification received from the OS when the application is defocused, i.e. when changing the focus from any open window of the Godot instance to the OS desktop or a thirdparty application.
  712. Implemented on desktop and mobile platforms.
  713. .. _class_Node_constant_NOTIFICATION_TEXT_SERVER_CHANGED:
  714. .. rst-class:: classref-constant
  715. **NOTIFICATION_TEXT_SERVER_CHANGED** = ``2018`` :ref:`🔗<class_Node_constant_NOTIFICATION_TEXT_SERVER_CHANGED>`
  716. Notification received when the :ref:`TextServer<class_TextServer>` is changed.
  717. .. _class_Node_constant_NOTIFICATION_ACCESSIBILITY_UPDATE:
  718. .. rst-class:: classref-constant
  719. **NOTIFICATION_ACCESSIBILITY_UPDATE** = ``3000`` :ref:`🔗<class_Node_constant_NOTIFICATION_ACCESSIBILITY_UPDATE>`
  720. Notification received when an accessibility information update is required.
  721. .. _class_Node_constant_NOTIFICATION_ACCESSIBILITY_INVALIDATE:
  722. .. rst-class:: classref-constant
  723. **NOTIFICATION_ACCESSIBILITY_INVALIDATE** = ``3001`` :ref:`🔗<class_Node_constant_NOTIFICATION_ACCESSIBILITY_INVALIDATE>`
  724. Notification received when accessibility elements are invalidated. All node accessibility elements are automatically deleted after receiving this message, therefore all existing references to such elements should be discarded.
  725. .. rst-class:: classref-section-separator
  726. ----
  727. .. rst-class:: classref-descriptions-group
  728. Property Descriptions
  729. ---------------------
  730. .. _class_Node_property_accessibility_controls_nodes:
  731. .. rst-class:: classref-property
  732. :ref:`Array<class_Array>`\[:ref:`NodePath<class_NodePath>`\] **accessibility_controls_nodes** = ``[]`` :ref:`🔗<class_Node_property_accessibility_controls_nodes>`
  733. .. rst-class:: classref-property-setget
  734. - |void| **set_accessibility_controls_nodes**\ (\ value\: :ref:`Array<class_Array>`\[:ref:`NodePath<class_NodePath>`\]\ )
  735. - :ref:`Array<class_Array>`\[:ref:`NodePath<class_NodePath>`\] **get_accessibility_controls_nodes**\ (\ )
  736. The list of nodes which are controlled by this node.
  737. .. rst-class:: classref-item-separator
  738. ----
  739. .. _class_Node_property_accessibility_described_by_nodes:
  740. .. rst-class:: classref-property
  741. :ref:`Array<class_Array>`\[:ref:`NodePath<class_NodePath>`\] **accessibility_described_by_nodes** = ``[]`` :ref:`🔗<class_Node_property_accessibility_described_by_nodes>`
  742. .. rst-class:: classref-property-setget
  743. - |void| **set_accessibility_described_by_nodes**\ (\ value\: :ref:`Array<class_Array>`\[:ref:`NodePath<class_NodePath>`\]\ )
  744. - :ref:`Array<class_Array>`\[:ref:`NodePath<class_NodePath>`\] **get_accessibility_described_by_nodes**\ (\ )
  745. The list of nodes which are describing this node.
  746. .. rst-class:: classref-item-separator
  747. ----
  748. .. _class_Node_property_accessibility_description:
  749. .. rst-class:: classref-property
  750. :ref:`String<class_String>` **accessibility_description** = ``""`` :ref:`🔗<class_Node_property_accessibility_description>`
  751. .. rst-class:: classref-property-setget
  752. - |void| **set_accessibility_description**\ (\ value\: :ref:`String<class_String>`\ )
  753. - :ref:`String<class_String>` **get_accessibility_description**\ (\ )
  754. The human-readable node description that is reported to assistive apps.
  755. .. rst-class:: classref-item-separator
  756. ----
  757. .. _class_Node_property_accessibility_flow_to_nodes:
  758. .. rst-class:: classref-property
  759. :ref:`Array<class_Array>`\[:ref:`NodePath<class_NodePath>`\] **accessibility_flow_to_nodes** = ``[]`` :ref:`🔗<class_Node_property_accessibility_flow_to_nodes>`
  760. .. rst-class:: classref-property-setget
  761. - |void| **set_accessibility_flow_to_nodes**\ (\ value\: :ref:`Array<class_Array>`\[:ref:`NodePath<class_NodePath>`\]\ )
  762. - :ref:`Array<class_Array>`\[:ref:`NodePath<class_NodePath>`\] **get_accessibility_flow_to_nodes**\ (\ )
  763. The list of nodes which this node flows into.
  764. .. rst-class:: classref-item-separator
  765. ----
  766. .. _class_Node_property_accessibility_labeled_by_nodes:
  767. .. rst-class:: classref-property
  768. :ref:`Array<class_Array>`\[:ref:`NodePath<class_NodePath>`\] **accessibility_labeled_by_nodes** = ``[]`` :ref:`🔗<class_Node_property_accessibility_labeled_by_nodes>`
  769. .. rst-class:: classref-property-setget
  770. - |void| **set_accessibility_labeled_by_nodes**\ (\ value\: :ref:`Array<class_Array>`\[:ref:`NodePath<class_NodePath>`\]\ )
  771. - :ref:`Array<class_Array>`\[:ref:`NodePath<class_NodePath>`\] **get_accessibility_labeled_by_nodes**\ (\ )
  772. The list of nodes which label this node.
  773. .. rst-class:: classref-item-separator
  774. ----
  775. .. _class_Node_property_accessibility_live:
  776. .. rst-class:: classref-property
  777. :ref:`AccessibilityLiveMode<enum_DisplayServer_AccessibilityLiveMode>` **accessibility_live** = ``0`` :ref:`🔗<class_Node_property_accessibility_live>`
  778. .. rst-class:: classref-property-setget
  779. - |void| **set_accessibility_live**\ (\ value\: :ref:`AccessibilityLiveMode<enum_DisplayServer_AccessibilityLiveMode>`\ )
  780. - :ref:`AccessibilityLiveMode<enum_DisplayServer_AccessibilityLiveMode>` **get_accessibility_live**\ (\ )
  781. Live region update mode, a live region is **Node** that is updated as a result of an external event when user focus may be elsewhere.
  782. .. rst-class:: classref-item-separator
  783. ----
  784. .. _class_Node_property_accessibility_name:
  785. .. rst-class:: classref-property
  786. :ref:`String<class_String>` **accessibility_name** = ``""`` :ref:`🔗<class_Node_property_accessibility_name>`
  787. .. rst-class:: classref-property-setget
  788. - |void| **set_accessibility_name**\ (\ value\: :ref:`String<class_String>`\ )
  789. - :ref:`String<class_String>` **get_accessibility_name**\ (\ )
  790. The human-readable node name that is reported to assistive apps.
  791. .. rst-class:: classref-item-separator
  792. ----
  793. .. _class_Node_property_auto_translate_mode:
  794. .. rst-class:: classref-property
  795. :ref:`AutoTranslateMode<enum_Node_AutoTranslateMode>` **auto_translate_mode** = ``0`` :ref:`🔗<class_Node_property_auto_translate_mode>`
  796. .. rst-class:: classref-property-setget
  797. - |void| **set_auto_translate_mode**\ (\ value\: :ref:`AutoTranslateMode<enum_Node_AutoTranslateMode>`\ )
  798. - :ref:`AutoTranslateMode<enum_Node_AutoTranslateMode>` **get_auto_translate_mode**\ (\ )
  799. Defines if any text should automatically change to its translated version depending on the current locale (for nodes such as :ref:`Label<class_Label>`, :ref:`RichTextLabel<class_RichTextLabel>`, :ref:`Window<class_Window>`, etc.). Also decides if the node's strings should be parsed for POT generation.
  800. \ **Note:** For the root node, auto translate mode can also be set via :ref:`ProjectSettings.internationalization/rendering/root_node_auto_translate<class_ProjectSettings_property_internationalization/rendering/root_node_auto_translate>`.
  801. .. rst-class:: classref-item-separator
  802. ----
  803. .. _class_Node_property_editor_description:
  804. .. rst-class:: classref-property
  805. :ref:`String<class_String>` **editor_description** = ``""`` :ref:`🔗<class_Node_property_editor_description>`
  806. .. rst-class:: classref-property-setget
  807. - |void| **set_editor_description**\ (\ value\: :ref:`String<class_String>`\ )
  808. - :ref:`String<class_String>` **get_editor_description**\ (\ )
  809. An optional description to the node. It will be displayed as a tooltip when hovering over the node in the editor's Scene dock.
  810. .. rst-class:: classref-item-separator
  811. ----
  812. .. _class_Node_property_multiplayer:
  813. .. rst-class:: classref-property
  814. :ref:`MultiplayerAPI<class_MultiplayerAPI>` **multiplayer** :ref:`🔗<class_Node_property_multiplayer>`
  815. .. rst-class:: classref-property-setget
  816. - :ref:`MultiplayerAPI<class_MultiplayerAPI>` **get_multiplayer**\ (\ )
  817. The :ref:`MultiplayerAPI<class_MultiplayerAPI>` instance associated with this node. See :ref:`SceneTree.get_multiplayer()<class_SceneTree_method_get_multiplayer>`.
  818. \ **Note:** Renaming the node, or moving it in the tree, will not move the :ref:`MultiplayerAPI<class_MultiplayerAPI>` to the new path, you will have to update this manually.
  819. .. rst-class:: classref-item-separator
  820. ----
  821. .. _class_Node_property_name:
  822. .. rst-class:: classref-property
  823. :ref:`StringName<class_StringName>` **name** :ref:`🔗<class_Node_property_name>`
  824. .. rst-class:: classref-property-setget
  825. - |void| **set_name**\ (\ value\: :ref:`StringName<class_StringName>`\ )
  826. - :ref:`StringName<class_StringName>` **get_name**\ (\ )
  827. The name of the node. This name must be unique among the siblings (other child nodes from the same parent). When set to an existing sibling's name, the node is automatically renamed.
  828. \ **Note:** When changing the name, the following characters will be replaced with an underscore: (``.`` ``:`` ``@`` ``/`` ``"`` ``%``). In particular, the ``@`` character is reserved for auto-generated names. See also :ref:`String.validate_node_name()<class_String_method_validate_node_name>`.
  829. .. rst-class:: classref-item-separator
  830. ----
  831. .. _class_Node_property_owner:
  832. .. rst-class:: classref-property
  833. :ref:`Node<class_Node>` **owner** :ref:`🔗<class_Node_property_owner>`
  834. .. rst-class:: classref-property-setget
  835. - |void| **set_owner**\ (\ value\: :ref:`Node<class_Node>`\ )
  836. - :ref:`Node<class_Node>` **get_owner**\ (\ )
  837. The owner of this node. The owner must be an ancestor of this node. When packing the owner node in a :ref:`PackedScene<class_PackedScene>`, all the nodes it owns are also saved with it. See also :ref:`unique_name_in_owner<class_Node_property_unique_name_in_owner>`.
  838. \ **Note:** In the editor, nodes not owned by the scene root are usually not displayed in the Scene dock, and will **not** be saved. To prevent this, remember to set the owner after calling :ref:`add_child()<class_Node_method_add_child>`.
  839. .. rst-class:: classref-item-separator
  840. ----
  841. .. _class_Node_property_physics_interpolation_mode:
  842. .. rst-class:: classref-property
  843. :ref:`PhysicsInterpolationMode<enum_Node_PhysicsInterpolationMode>` **physics_interpolation_mode** = ``0`` :ref:`🔗<class_Node_property_physics_interpolation_mode>`
  844. .. rst-class:: classref-property-setget
  845. - |void| **set_physics_interpolation_mode**\ (\ value\: :ref:`PhysicsInterpolationMode<enum_Node_PhysicsInterpolationMode>`\ )
  846. - :ref:`PhysicsInterpolationMode<enum_Node_PhysicsInterpolationMode>` **get_physics_interpolation_mode**\ (\ )
  847. Allows enabling or disabling physics interpolation per node, offering a finer grain of control than turning physics interpolation on and off globally. See :ref:`ProjectSettings.physics/common/physics_interpolation<class_ProjectSettings_property_physics/common/physics_interpolation>` and :ref:`SceneTree.physics_interpolation<class_SceneTree_property_physics_interpolation>` for the global setting.
  848. \ **Note:** When teleporting a node to a distant position you should temporarily disable interpolation with :ref:`reset_physics_interpolation()<class_Node_method_reset_physics_interpolation>`.
  849. .. rst-class:: classref-item-separator
  850. ----
  851. .. _class_Node_property_process_mode:
  852. .. rst-class:: classref-property
  853. :ref:`ProcessMode<enum_Node_ProcessMode>` **process_mode** = ``0`` :ref:`🔗<class_Node_property_process_mode>`
  854. .. rst-class:: classref-property-setget
  855. - |void| **set_process_mode**\ (\ value\: :ref:`ProcessMode<enum_Node_ProcessMode>`\ )
  856. - :ref:`ProcessMode<enum_Node_ProcessMode>` **get_process_mode**\ (\ )
  857. The node's processing behavior (see :ref:`ProcessMode<enum_Node_ProcessMode>`). To check if the node can process in its current mode, use :ref:`can_process()<class_Node_method_can_process>`.
  858. .. rst-class:: classref-item-separator
  859. ----
  860. .. _class_Node_property_process_physics_priority:
  861. .. rst-class:: classref-property
  862. :ref:`int<class_int>` **process_physics_priority** = ``0`` :ref:`🔗<class_Node_property_process_physics_priority>`
  863. .. rst-class:: classref-property-setget
  864. - |void| **set_physics_process_priority**\ (\ value\: :ref:`int<class_int>`\ )
  865. - :ref:`int<class_int>` **get_physics_process_priority**\ (\ )
  866. Similar to :ref:`process_priority<class_Node_property_process_priority>` but for :ref:`NOTIFICATION_PHYSICS_PROCESS<class_Node_constant_NOTIFICATION_PHYSICS_PROCESS>`, :ref:`_physics_process()<class_Node_private_method__physics_process>`, or :ref:`NOTIFICATION_INTERNAL_PHYSICS_PROCESS<class_Node_constant_NOTIFICATION_INTERNAL_PHYSICS_PROCESS>`.
  867. .. rst-class:: classref-item-separator
  868. ----
  869. .. _class_Node_property_process_priority:
  870. .. rst-class:: classref-property
  871. :ref:`int<class_int>` **process_priority** = ``0`` :ref:`🔗<class_Node_property_process_priority>`
  872. .. rst-class:: classref-property-setget
  873. - |void| **set_process_priority**\ (\ value\: :ref:`int<class_int>`\ )
  874. - :ref:`int<class_int>` **get_process_priority**\ (\ )
  875. The node's execution order of the process callbacks (:ref:`_process()<class_Node_private_method__process>`, :ref:`NOTIFICATION_PROCESS<class_Node_constant_NOTIFICATION_PROCESS>`, and :ref:`NOTIFICATION_INTERNAL_PROCESS<class_Node_constant_NOTIFICATION_INTERNAL_PROCESS>`). Nodes whose priority value is *lower* call their process callbacks first, regardless of tree order.
  876. .. rst-class:: classref-item-separator
  877. ----
  878. .. _class_Node_property_process_thread_group:
  879. .. rst-class:: classref-property
  880. :ref:`ProcessThreadGroup<enum_Node_ProcessThreadGroup>` **process_thread_group** = ``0`` :ref:`🔗<class_Node_property_process_thread_group>`
  881. .. rst-class:: classref-property-setget
  882. - |void| **set_process_thread_group**\ (\ value\: :ref:`ProcessThreadGroup<enum_Node_ProcessThreadGroup>`\ )
  883. - :ref:`ProcessThreadGroup<enum_Node_ProcessThreadGroup>` **get_process_thread_group**\ (\ )
  884. Set the process thread group for this node (basically, whether it receives :ref:`NOTIFICATION_PROCESS<class_Node_constant_NOTIFICATION_PROCESS>`, :ref:`NOTIFICATION_PHYSICS_PROCESS<class_Node_constant_NOTIFICATION_PHYSICS_PROCESS>`, :ref:`_process()<class_Node_private_method__process>` or :ref:`_physics_process()<class_Node_private_method__physics_process>` (and the internal versions) on the main thread or in a sub-thread.
  885. By default, the thread group is :ref:`PROCESS_THREAD_GROUP_INHERIT<class_Node_constant_PROCESS_THREAD_GROUP_INHERIT>`, which means that this node belongs to the same thread group as the parent node. The thread groups means that nodes in a specific thread group will process together, separate to other thread groups (depending on :ref:`process_thread_group_order<class_Node_property_process_thread_group_order>`). If the value is set is :ref:`PROCESS_THREAD_GROUP_SUB_THREAD<class_Node_constant_PROCESS_THREAD_GROUP_SUB_THREAD>`, this thread group will occur on a sub thread (not the main thread), otherwise if set to :ref:`PROCESS_THREAD_GROUP_MAIN_THREAD<class_Node_constant_PROCESS_THREAD_GROUP_MAIN_THREAD>` it will process on the main thread. If there is not a parent or grandparent node set to something other than inherit, the node will belong to the *default thread group*. This default group will process on the main thread and its group order is 0.
  886. During processing in a sub-thread, accessing most functions in nodes outside the thread group is forbidden (and it will result in an error in debug mode). Use :ref:`Object.call_deferred()<class_Object_method_call_deferred>`, :ref:`call_thread_safe()<class_Node_method_call_thread_safe>`, :ref:`call_deferred_thread_group()<class_Node_method_call_deferred_thread_group>` and the likes in order to communicate from the thread groups to the main thread (or to other thread groups).
  887. To better understand process thread groups, the idea is that any node set to any other value than :ref:`PROCESS_THREAD_GROUP_INHERIT<class_Node_constant_PROCESS_THREAD_GROUP_INHERIT>` will include any child (and grandchild) nodes set to inherit into its process thread group. This means that the processing of all the nodes in the group will happen together, at the same time as the node including them.
  888. .. rst-class:: classref-item-separator
  889. ----
  890. .. _class_Node_property_process_thread_group_order:
  891. .. rst-class:: classref-property
  892. :ref:`int<class_int>` **process_thread_group_order** :ref:`🔗<class_Node_property_process_thread_group_order>`
  893. .. rst-class:: classref-property-setget
  894. - |void| **set_process_thread_group_order**\ (\ value\: :ref:`int<class_int>`\ )
  895. - :ref:`int<class_int>` **get_process_thread_group_order**\ (\ )
  896. Change the process thread group order. Groups with a lesser order will process before groups with a greater order. This is useful when a large amount of nodes process in sub thread and, afterwards, another group wants to collect their result in the main thread, as an example.
  897. .. rst-class:: classref-item-separator
  898. ----
  899. .. _class_Node_property_process_thread_messages:
  900. .. rst-class:: classref-property
  901. |bitfield|\[:ref:`ProcessThreadMessages<enum_Node_ProcessThreadMessages>`\] **process_thread_messages** :ref:`🔗<class_Node_property_process_thread_messages>`
  902. .. rst-class:: classref-property-setget
  903. - |void| **set_process_thread_messages**\ (\ value\: |bitfield|\[:ref:`ProcessThreadMessages<enum_Node_ProcessThreadMessages>`\]\ )
  904. - |bitfield|\[:ref:`ProcessThreadMessages<enum_Node_ProcessThreadMessages>`\] **get_process_thread_messages**\ (\ )
  905. Set whether the current thread group will process messages (calls to :ref:`call_deferred_thread_group()<class_Node_method_call_deferred_thread_group>` on threads), and whether it wants to receive them during regular process or physics process callbacks.
  906. .. rst-class:: classref-item-separator
  907. ----
  908. .. _class_Node_property_scene_file_path:
  909. .. rst-class:: classref-property
  910. :ref:`String<class_String>` **scene_file_path** :ref:`🔗<class_Node_property_scene_file_path>`
  911. .. rst-class:: classref-property-setget
  912. - |void| **set_scene_file_path**\ (\ value\: :ref:`String<class_String>`\ )
  913. - :ref:`String<class_String>` **get_scene_file_path**\ (\ )
  914. The original scene's file path, if the node has been instantiated from a :ref:`PackedScene<class_PackedScene>` file. Only scene root nodes contains this.
  915. .. rst-class:: classref-item-separator
  916. ----
  917. .. _class_Node_property_unique_name_in_owner:
  918. .. rst-class:: classref-property
  919. :ref:`bool<class_bool>` **unique_name_in_owner** = ``false`` :ref:`🔗<class_Node_property_unique_name_in_owner>`
  920. .. rst-class:: classref-property-setget
  921. - |void| **set_unique_name_in_owner**\ (\ value\: :ref:`bool<class_bool>`\ )
  922. - :ref:`bool<class_bool>` **is_unique_name_in_owner**\ (\ )
  923. If ``true``, the node can be accessed from any node sharing the same :ref:`owner<class_Node_property_owner>` or from the :ref:`owner<class_Node_property_owner>` itself, with special ``%Name`` syntax in :ref:`get_node()<class_Node_method_get_node>`.
  924. \ **Note:** If another node with the same :ref:`owner<class_Node_property_owner>` shares the same :ref:`name<class_Node_property_name>` as this node, the other node will no longer be accessible as unique.
  925. .. rst-class:: classref-section-separator
  926. ----
  927. .. rst-class:: classref-descriptions-group
  928. Method Descriptions
  929. -------------------
  930. .. _class_Node_private_method__enter_tree:
  931. .. rst-class:: classref-method
  932. |void| **_enter_tree**\ (\ ) |virtual| :ref:`🔗<class_Node_private_method__enter_tree>`
  933. Called when the node enters the :ref:`SceneTree<class_SceneTree>` (e.g. upon instantiating, scene changing, or after calling :ref:`add_child()<class_Node_method_add_child>` in a script). If the node has children, its :ref:`_enter_tree()<class_Node_private_method__enter_tree>` callback will be called first, and then that of the children.
  934. Corresponds to the :ref:`NOTIFICATION_ENTER_TREE<class_Node_constant_NOTIFICATION_ENTER_TREE>` notification in :ref:`Object._notification()<class_Object_private_method__notification>`.
  935. .. rst-class:: classref-item-separator
  936. ----
  937. .. _class_Node_private_method__exit_tree:
  938. .. rst-class:: classref-method
  939. |void| **_exit_tree**\ (\ ) |virtual| :ref:`🔗<class_Node_private_method__exit_tree>`
  940. Called when the node is about to leave the :ref:`SceneTree<class_SceneTree>` (e.g. upon freeing, scene changing, or after calling :ref:`remove_child()<class_Node_method_remove_child>` in a script). If the node has children, its :ref:`_exit_tree()<class_Node_private_method__exit_tree>` callback will be called last, after all its children have left the tree.
  941. Corresponds to the :ref:`NOTIFICATION_EXIT_TREE<class_Node_constant_NOTIFICATION_EXIT_TREE>` notification in :ref:`Object._notification()<class_Object_private_method__notification>` and signal :ref:`tree_exiting<class_Node_signal_tree_exiting>`. To get notified when the node has already left the active tree, connect to the :ref:`tree_exited<class_Node_signal_tree_exited>`.
  942. .. rst-class:: classref-item-separator
  943. ----
  944. .. _class_Node_private_method__get_accessibility_configuration_warnings:
  945. .. rst-class:: classref-method
  946. :ref:`PackedStringArray<class_PackedStringArray>` **_get_accessibility_configuration_warnings**\ (\ ) |virtual| |const| :ref:`🔗<class_Node_private_method__get_accessibility_configuration_warnings>`
  947. The elements in the array returned from this method are displayed as warnings in the Scene dock if the script that overrides it is a ``tool`` script, and accessibility warnings are enabled in the editor settings.
  948. Returning an empty array produces no warnings.
  949. .. rst-class:: classref-item-separator
  950. ----
  951. .. _class_Node_private_method__get_accessibility_container_name:
  952. .. rst-class:: classref-method
  953. :ref:`String<class_String>` **_get_accessibility_container_name**\ (\ node\: :ref:`Node<class_Node>`\ ) |virtual| |const| :ref:`🔗<class_Node_private_method__get_accessibility_container_name>`
  954. Return a human-readable description of the position of ``node`` child in the custom container, added to the node name.
  955. .. rst-class:: classref-item-separator
  956. ----
  957. .. _class_Node_private_method__get_configuration_warnings:
  958. .. rst-class:: classref-method
  959. :ref:`PackedStringArray<class_PackedStringArray>` **_get_configuration_warnings**\ (\ ) |virtual| |const| :ref:`🔗<class_Node_private_method__get_configuration_warnings>`
  960. The elements in the array returned from this method are displayed as warnings in the Scene dock if the script that overrides it is a ``tool`` script.
  961. Returning an empty array produces no warnings.
  962. Call :ref:`update_configuration_warnings()<class_Node_method_update_configuration_warnings>` when the warnings need to be updated for this node.
  963. ::
  964. @export var energy = 0:
  965. set(value):
  966. energy = value
  967. update_configuration_warnings()
  968. func _get_configuration_warnings():
  969. if energy < 0:
  970. return ["Energy must be 0 or greater."]
  971. else:
  972. return []
  973. .. rst-class:: classref-item-separator
  974. ----
  975. .. _class_Node_private_method__get_focused_accessibility_element:
  976. .. rst-class:: classref-method
  977. :ref:`RID<class_RID>` **_get_focused_accessibility_element**\ (\ ) |virtual| |const| :ref:`🔗<class_Node_private_method__get_focused_accessibility_element>`
  978. Called during accessibility information updates to determine the currently focused sub-element, should return a sub-element RID or the value returned by :ref:`get_accessibility_element()<class_Node_method_get_accessibility_element>`.
  979. .. rst-class:: classref-item-separator
  980. ----
  981. .. _class_Node_private_method__input:
  982. .. rst-class:: classref-method
  983. |void| **_input**\ (\ event\: :ref:`InputEvent<class_InputEvent>`\ ) |virtual| :ref:`🔗<class_Node_private_method__input>`
  984. Called when there is an input event. The input event propagates up through the node tree until a node consumes it.
  985. It is only called if input processing is enabled, which is done automatically if this method is overridden, and can be toggled with :ref:`set_process_input()<class_Node_method_set_process_input>`.
  986. To consume the input event and stop it propagating further to other nodes, :ref:`Viewport.set_input_as_handled()<class_Viewport_method_set_input_as_handled>` can be called.
  987. For gameplay input, :ref:`_unhandled_input()<class_Node_private_method__unhandled_input>` and :ref:`_unhandled_key_input()<class_Node_private_method__unhandled_key_input>` are usually a better fit as they allow the GUI to intercept the events first.
  988. \ **Note:** This method is only called if the node is present in the scene tree (i.e. if it's not an orphan).
  989. .. rst-class:: classref-item-separator
  990. ----
  991. .. _class_Node_private_method__physics_process:
  992. .. rst-class:: classref-method
  993. |void| **_physics_process**\ (\ delta\: :ref:`float<class_float>`\ ) |virtual| :ref:`🔗<class_Node_private_method__physics_process>`
  994. Called during the physics processing step of the main loop. Physics processing means that the frame rate is synced to the physics, i.e. the ``delta`` parameter will *generally* be constant (see exceptions below). ``delta`` is in seconds.
  995. It is only called if physics processing is enabled, which is done automatically if this method is overridden, and can be toggled with :ref:`set_physics_process()<class_Node_method_set_physics_process>`.
  996. Processing happens in order of :ref:`process_physics_priority<class_Node_property_process_physics_priority>`, lower priority values are called first. Nodes with the same priority are processed in tree order, or top to bottom as seen in the editor (also known as pre-order traversal).
  997. Corresponds to the :ref:`NOTIFICATION_PHYSICS_PROCESS<class_Node_constant_NOTIFICATION_PHYSICS_PROCESS>` notification in :ref:`Object._notification()<class_Object_private_method__notification>`.
  998. \ **Note:** This method is only called if the node is present in the scene tree (i.e. if it's not an orphan).
  999. \ **Note:** ``delta`` will be larger than expected if running at a framerate lower than :ref:`Engine.physics_ticks_per_second<class_Engine_property_physics_ticks_per_second>` / :ref:`Engine.max_physics_steps_per_frame<class_Engine_property_max_physics_steps_per_frame>` FPS. This is done to avoid "spiral of death" scenarios where performance would plummet due to an ever-increasing number of physics steps per frame. This behavior affects both :ref:`_process()<class_Node_private_method__process>` and :ref:`_physics_process()<class_Node_private_method__physics_process>`. As a result, avoid using ``delta`` for time measurements in real-world seconds. Use the :ref:`Time<class_Time>` singleton's methods for this purpose instead, such as :ref:`Time.get_ticks_usec()<class_Time_method_get_ticks_usec>`.
  1000. .. rst-class:: classref-item-separator
  1001. ----
  1002. .. _class_Node_private_method__process:
  1003. .. rst-class:: classref-method
  1004. |void| **_process**\ (\ delta\: :ref:`float<class_float>`\ ) |virtual| :ref:`🔗<class_Node_private_method__process>`
  1005. Called during the processing step of the main loop. Processing happens at every frame and as fast as possible, so the ``delta`` time since the previous frame is not constant. ``delta`` is in seconds.
  1006. It is only called if processing is enabled, which is done automatically if this method is overridden, and can be toggled with :ref:`set_process()<class_Node_method_set_process>`.
  1007. Processing happens in order of :ref:`process_priority<class_Node_property_process_priority>`, lower priority values are called first. Nodes with the same priority are processed in tree order, or top to bottom as seen in the editor (also known as pre-order traversal).
  1008. Corresponds to the :ref:`NOTIFICATION_PROCESS<class_Node_constant_NOTIFICATION_PROCESS>` notification in :ref:`Object._notification()<class_Object_private_method__notification>`.
  1009. \ **Note:** This method is only called if the node is present in the scene tree (i.e. if it's not an orphan).
  1010. \ **Note:** ``delta`` will be larger than expected if running at a framerate lower than :ref:`Engine.physics_ticks_per_second<class_Engine_property_physics_ticks_per_second>` / :ref:`Engine.max_physics_steps_per_frame<class_Engine_property_max_physics_steps_per_frame>` FPS. This is done to avoid "spiral of death" scenarios where performance would plummet due to an ever-increasing number of physics steps per frame. This behavior affects both :ref:`_process()<class_Node_private_method__process>` and :ref:`_physics_process()<class_Node_private_method__physics_process>`. As a result, avoid using ``delta`` for time measurements in real-world seconds. Use the :ref:`Time<class_Time>` singleton's methods for this purpose instead, such as :ref:`Time.get_ticks_usec()<class_Time_method_get_ticks_usec>`.
  1011. .. rst-class:: classref-item-separator
  1012. ----
  1013. .. _class_Node_private_method__ready:
  1014. .. rst-class:: classref-method
  1015. |void| **_ready**\ (\ ) |virtual| :ref:`🔗<class_Node_private_method__ready>`
  1016. Called when the node is "ready", i.e. when both the node and its children have entered the scene tree. If the node has children, their :ref:`_ready()<class_Node_private_method__ready>` callbacks get triggered first, and the parent node will receive the ready notification afterwards.
  1017. Corresponds to the :ref:`NOTIFICATION_READY<class_Node_constant_NOTIFICATION_READY>` notification in :ref:`Object._notification()<class_Object_private_method__notification>`. See also the ``@onready`` annotation for variables.
  1018. Usually used for initialization. For even earlier initialization, :ref:`Object._init()<class_Object_private_method__init>` may be used. See also :ref:`_enter_tree()<class_Node_private_method__enter_tree>`.
  1019. \ **Note:** This method may be called only once for each node. After removing a node from the scene tree and adding it again, :ref:`_ready()<class_Node_private_method__ready>` will **not** be called a second time. This can be bypassed by requesting another call with :ref:`request_ready()<class_Node_method_request_ready>`, which may be called anywhere before adding the node again.
  1020. .. rst-class:: classref-item-separator
  1021. ----
  1022. .. _class_Node_private_method__shortcut_input:
  1023. .. rst-class:: classref-method
  1024. |void| **_shortcut_input**\ (\ event\: :ref:`InputEvent<class_InputEvent>`\ ) |virtual| :ref:`🔗<class_Node_private_method__shortcut_input>`
  1025. Called when an :ref:`InputEventKey<class_InputEventKey>`, :ref:`InputEventShortcut<class_InputEventShortcut>`, or :ref:`InputEventJoypadButton<class_InputEventJoypadButton>` hasn't been consumed by :ref:`_input()<class_Node_private_method__input>` or any GUI :ref:`Control<class_Control>` item. It is called before :ref:`_unhandled_key_input()<class_Node_private_method__unhandled_key_input>` and :ref:`_unhandled_input()<class_Node_private_method__unhandled_input>`. The input event propagates up through the node tree until a node consumes it.
  1026. It is only called if shortcut processing is enabled, which is done automatically if this method is overridden, and can be toggled with :ref:`set_process_shortcut_input()<class_Node_method_set_process_shortcut_input>`.
  1027. To consume the input event and stop it propagating further to other nodes, :ref:`Viewport.set_input_as_handled()<class_Viewport_method_set_input_as_handled>` can be called.
  1028. This method can be used to handle shortcuts. For generic GUI events, use :ref:`_input()<class_Node_private_method__input>` instead. Gameplay events should usually be handled with either :ref:`_unhandled_input()<class_Node_private_method__unhandled_input>` or :ref:`_unhandled_key_input()<class_Node_private_method__unhandled_key_input>`.
  1029. \ **Note:** This method is only called if the node is present in the scene tree (i.e. if it's not orphan).
  1030. .. rst-class:: classref-item-separator
  1031. ----
  1032. .. _class_Node_private_method__unhandled_input:
  1033. .. rst-class:: classref-method
  1034. |void| **_unhandled_input**\ (\ event\: :ref:`InputEvent<class_InputEvent>`\ ) |virtual| :ref:`🔗<class_Node_private_method__unhandled_input>`
  1035. Called when an :ref:`InputEvent<class_InputEvent>` hasn't been consumed by :ref:`_input()<class_Node_private_method__input>` or any GUI :ref:`Control<class_Control>` item. It is called after :ref:`_shortcut_input()<class_Node_private_method__shortcut_input>` and after :ref:`_unhandled_key_input()<class_Node_private_method__unhandled_key_input>`. The input event propagates up through the node tree until a node consumes it.
  1036. It is only called if unhandled input processing is enabled, which is done automatically if this method is overridden, and can be toggled with :ref:`set_process_unhandled_input()<class_Node_method_set_process_unhandled_input>`.
  1037. To consume the input event and stop it propagating further to other nodes, :ref:`Viewport.set_input_as_handled()<class_Viewport_method_set_input_as_handled>` can be called.
  1038. For gameplay input, this method is usually a better fit than :ref:`_input()<class_Node_private_method__input>`, as GUI events need a higher priority. For keyboard shortcuts, consider using :ref:`_shortcut_input()<class_Node_private_method__shortcut_input>` instead, as it is called before this method. Finally, to handle keyboard events, consider using :ref:`_unhandled_key_input()<class_Node_private_method__unhandled_key_input>` for performance reasons.
  1039. \ **Note:** This method is only called if the node is present in the scene tree (i.e. if it's not an orphan).
  1040. .. rst-class:: classref-item-separator
  1041. ----
  1042. .. _class_Node_private_method__unhandled_key_input:
  1043. .. rst-class:: classref-method
  1044. |void| **_unhandled_key_input**\ (\ event\: :ref:`InputEvent<class_InputEvent>`\ ) |virtual| :ref:`🔗<class_Node_private_method__unhandled_key_input>`
  1045. Called when an :ref:`InputEventKey<class_InputEventKey>` hasn't been consumed by :ref:`_input()<class_Node_private_method__input>` or any GUI :ref:`Control<class_Control>` item. It is called after :ref:`_shortcut_input()<class_Node_private_method__shortcut_input>` but before :ref:`_unhandled_input()<class_Node_private_method__unhandled_input>`. The input event propagates up through the node tree until a node consumes it.
  1046. It is only called if unhandled key input processing is enabled, which is done automatically if this method is overridden, and can be toggled with :ref:`set_process_unhandled_key_input()<class_Node_method_set_process_unhandled_key_input>`.
  1047. To consume the input event and stop it propagating further to other nodes, :ref:`Viewport.set_input_as_handled()<class_Viewport_method_set_input_as_handled>` can be called.
  1048. This method can be used to handle Unicode character input with :kbd:`Alt`, :kbd:`Alt + Ctrl`, and :kbd:`Alt + Shift` modifiers, after shortcuts were handled.
  1049. For gameplay input, this and :ref:`_unhandled_input()<class_Node_private_method__unhandled_input>` are usually a better fit than :ref:`_input()<class_Node_private_method__input>`, as GUI events should be handled first. This method also performs better than :ref:`_unhandled_input()<class_Node_private_method__unhandled_input>`, since unrelated events such as :ref:`InputEventMouseMotion<class_InputEventMouseMotion>` are automatically filtered. For shortcuts, consider using :ref:`_shortcut_input()<class_Node_private_method__shortcut_input>` instead.
  1050. \ **Note:** This method is only called if the node is present in the scene tree (i.e. if it's not an orphan).
  1051. .. rst-class:: classref-item-separator
  1052. ----
  1053. .. _class_Node_method_add_child:
  1054. .. rst-class:: classref-method
  1055. |void| **add_child**\ (\ node\: :ref:`Node<class_Node>`, force_readable_name\: :ref:`bool<class_bool>` = false, internal\: :ref:`InternalMode<enum_Node_InternalMode>` = 0\ ) :ref:`🔗<class_Node_method_add_child>`
  1056. Adds a child ``node``. Nodes can have any number of children, but every child must have a unique name. Child nodes are automatically deleted when the parent node is deleted, so an entire scene can be removed by deleting its topmost node.
  1057. If ``force_readable_name`` is ``true``, improves the readability of the added ``node``. If not named, the ``node`` is renamed to its type, and if it shares :ref:`name<class_Node_property_name>` with a sibling, a number is suffixed more appropriately. This operation is very slow. As such, it is recommended leaving this to ``false``, which assigns a dummy name featuring ``@`` in both situations.
  1058. If ``internal`` is different than :ref:`INTERNAL_MODE_DISABLED<class_Node_constant_INTERNAL_MODE_DISABLED>`, the child will be added as internal node. These nodes are ignored by methods like :ref:`get_children()<class_Node_method_get_children>`, unless their parameter ``include_internal`` is ``true``. It also prevents these nodes being duplicated with their parent. The intended usage is to hide the internal nodes from the user, so the user won't accidentally delete or modify them. Used by some GUI nodes, e.g. :ref:`ColorPicker<class_ColorPicker>`. See :ref:`InternalMode<enum_Node_InternalMode>` for available modes.
  1059. \ **Note:** If ``node`` already has a parent, this method will fail. Use :ref:`remove_child()<class_Node_method_remove_child>` first to remove ``node`` from its current parent. For example:
  1060. .. tabs::
  1061. .. code-tab:: gdscript
  1062. var child_node = get_child(0)
  1063. if child_node.get_parent():
  1064. child_node.get_parent().remove_child(child_node)
  1065. add_child(child_node)
  1066. .. code-tab:: csharp
  1067. Node childNode = GetChild(0);
  1068. if (childNode.GetParent() != null)
  1069. {
  1070. childNode.GetParent().RemoveChild(childNode);
  1071. }
  1072. AddChild(childNode);
  1073. If you need the child node to be added below a specific node in the list of children, use :ref:`add_sibling()<class_Node_method_add_sibling>` instead of this method.
  1074. \ **Note:** If you want a child to be persisted to a :ref:`PackedScene<class_PackedScene>`, you must set :ref:`owner<class_Node_property_owner>` in addition to calling :ref:`add_child()<class_Node_method_add_child>`. This is typically relevant for :doc:`tool scripts <../tutorials/plugins/running_code_in_the_editor>` and :doc:`editor plugins <../tutorials/plugins/editor/index>`. If :ref:`add_child()<class_Node_method_add_child>` is called without setting :ref:`owner<class_Node_property_owner>`, the newly added **Node** will not be visible in the scene tree, though it will be visible in the 2D/3D view.
  1075. .. rst-class:: classref-item-separator
  1076. ----
  1077. .. _class_Node_method_add_sibling:
  1078. .. rst-class:: classref-method
  1079. |void| **add_sibling**\ (\ sibling\: :ref:`Node<class_Node>`, force_readable_name\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_Node_method_add_sibling>`
  1080. Adds a ``sibling`` node to this node's parent, and moves the added sibling right below this node.
  1081. If ``force_readable_name`` is ``true``, improves the readability of the added ``sibling``. If not named, the ``sibling`` is renamed to its type, and if it shares :ref:`name<class_Node_property_name>` with a sibling, a number is suffixed more appropriately. This operation is very slow. As such, it is recommended leaving this to ``false``, which assigns a dummy name featuring ``@`` in both situations.
  1082. Use :ref:`add_child()<class_Node_method_add_child>` instead of this method if you don't need the child node to be added below a specific node in the list of children.
  1083. \ **Note:** If this node is internal, the added sibling will be internal too (see :ref:`add_child()<class_Node_method_add_child>`'s ``internal`` parameter).
  1084. .. rst-class:: classref-item-separator
  1085. ----
  1086. .. _class_Node_method_add_to_group:
  1087. .. rst-class:: classref-method
  1088. |void| **add_to_group**\ (\ group\: :ref:`StringName<class_StringName>`, persistent\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_Node_method_add_to_group>`
  1089. Adds the node to the ``group``. Groups can be helpful to organize a subset of nodes, for example ``"enemies"`` or ``"collectables"``. See notes in the description, and the group methods in :ref:`SceneTree<class_SceneTree>`.
  1090. If ``persistent`` is ``true``, the group will be stored when saved inside a :ref:`PackedScene<class_PackedScene>`. All groups created and displayed in the Node dock are persistent.
  1091. \ **Note:** To improve performance, the order of group names is *not* guaranteed and may vary between project runs. Therefore, do not rely on the group order.
  1092. \ **Note:** :ref:`SceneTree<class_SceneTree>`'s group methods will *not* work on this node if not inside the tree (see :ref:`is_inside_tree()<class_Node_method_is_inside_tree>`).
  1093. .. rst-class:: classref-item-separator
  1094. ----
  1095. .. _class_Node_method_atr:
  1096. .. rst-class:: classref-method
  1097. :ref:`String<class_String>` **atr**\ (\ message\: :ref:`String<class_String>`, context\: :ref:`StringName<class_StringName>` = ""\ ) |const| :ref:`🔗<class_Node_method_atr>`
  1098. Translates a ``message``, using the translation catalogs configured in the Project Settings. Further ``context`` can be specified to help with the translation. Note that most :ref:`Control<class_Control>` nodes automatically translate their strings, so this method is mostly useful for formatted strings or custom drawn text.
  1099. This method works the same as :ref:`Object.tr()<class_Object_method_tr>`, with the addition of respecting the :ref:`auto_translate_mode<class_Node_property_auto_translate_mode>` state.
  1100. If :ref:`Object.can_translate_messages()<class_Object_method_can_translate_messages>` is ``false``, or no translation is available, this method returns the ``message`` without changes. See :ref:`Object.set_message_translation()<class_Object_method_set_message_translation>`.
  1101. For detailed examples, see :doc:`Internationalizing games <../tutorials/i18n/internationalizing_games>`.
  1102. .. rst-class:: classref-item-separator
  1103. ----
  1104. .. _class_Node_method_atr_n:
  1105. .. rst-class:: classref-method
  1106. :ref:`String<class_String>` **atr_n**\ (\ message\: :ref:`String<class_String>`, plural_message\: :ref:`StringName<class_StringName>`, n\: :ref:`int<class_int>`, context\: :ref:`StringName<class_StringName>` = ""\ ) |const| :ref:`🔗<class_Node_method_atr_n>`
  1107. Translates a ``message`` or ``plural_message``, using the translation catalogs configured in the Project Settings. Further ``context`` can be specified to help with the translation.
  1108. This method works the same as :ref:`Object.tr_n()<class_Object_method_tr_n>`, with the addition of respecting the :ref:`auto_translate_mode<class_Node_property_auto_translate_mode>` state.
  1109. If :ref:`Object.can_translate_messages()<class_Object_method_can_translate_messages>` is ``false``, or no translation is available, this method returns ``message`` or ``plural_message``, without changes. See :ref:`Object.set_message_translation()<class_Object_method_set_message_translation>`.
  1110. The ``n`` is the number, or amount, of the message's subject. It is used by the translation system to fetch the correct plural form for the current language.
  1111. For detailed examples, see :doc:`Localization using gettext <../tutorials/i18n/localization_using_gettext>`.
  1112. \ **Note:** Negative and :ref:`float<class_float>` numbers may not properly apply to some countable subjects. It's recommended to handle these cases with :ref:`atr()<class_Node_method_atr>`.
  1113. .. rst-class:: classref-item-separator
  1114. ----
  1115. .. _class_Node_method_call_deferred_thread_group:
  1116. .. rst-class:: classref-method
  1117. :ref:`Variant<class_Variant>` **call_deferred_thread_group**\ (\ method\: :ref:`StringName<class_StringName>`, ...\ ) |vararg| :ref:`🔗<class_Node_method_call_deferred_thread_group>`
  1118. This function is similar to :ref:`Object.call_deferred()<class_Object_method_call_deferred>` except that the call will take place when the node thread group is processed. If the node thread group processes in sub-threads, then the call will be done on that thread, right before :ref:`NOTIFICATION_PROCESS<class_Node_constant_NOTIFICATION_PROCESS>` or :ref:`NOTIFICATION_PHYSICS_PROCESS<class_Node_constant_NOTIFICATION_PHYSICS_PROCESS>`, the :ref:`_process()<class_Node_private_method__process>` or :ref:`_physics_process()<class_Node_private_method__physics_process>` or their internal versions are called.
  1119. .. rst-class:: classref-item-separator
  1120. ----
  1121. .. _class_Node_method_call_thread_safe:
  1122. .. rst-class:: classref-method
  1123. :ref:`Variant<class_Variant>` **call_thread_safe**\ (\ method\: :ref:`StringName<class_StringName>`, ...\ ) |vararg| :ref:`🔗<class_Node_method_call_thread_safe>`
  1124. This function ensures that the calling of this function will succeed, no matter whether it's being done from a thread or not. If called from a thread that is not allowed to call the function, the call will become deferred. Otherwise, the call will go through directly.
  1125. .. rst-class:: classref-item-separator
  1126. ----
  1127. .. _class_Node_method_can_process:
  1128. .. rst-class:: classref-method
  1129. :ref:`bool<class_bool>` **can_process**\ (\ ) |const| :ref:`🔗<class_Node_method_can_process>`
  1130. Returns ``true`` if the node can receive processing notifications and input callbacks (:ref:`NOTIFICATION_PROCESS<class_Node_constant_NOTIFICATION_PROCESS>`, :ref:`_input()<class_Node_private_method__input>`, etc.) from the :ref:`SceneTree<class_SceneTree>` and :ref:`Viewport<class_Viewport>`. The returned value depends on :ref:`process_mode<class_Node_property_process_mode>`:
  1131. - If set to :ref:`PROCESS_MODE_PAUSABLE<class_Node_constant_PROCESS_MODE_PAUSABLE>`, returns ``true`` when the game is processing, i.e. :ref:`SceneTree.paused<class_SceneTree_property_paused>` is ``false``;
  1132. - If set to :ref:`PROCESS_MODE_WHEN_PAUSED<class_Node_constant_PROCESS_MODE_WHEN_PAUSED>`, returns ``true`` when the game is paused, i.e. :ref:`SceneTree.paused<class_SceneTree_property_paused>` is ``true``;
  1133. - If set to :ref:`PROCESS_MODE_ALWAYS<class_Node_constant_PROCESS_MODE_ALWAYS>`, always returns ``true``;
  1134. - If set to :ref:`PROCESS_MODE_DISABLED<class_Node_constant_PROCESS_MODE_DISABLED>`, always returns ``false``;
  1135. - If set to :ref:`PROCESS_MODE_INHERIT<class_Node_constant_PROCESS_MODE_INHERIT>`, use the parent node's :ref:`process_mode<class_Node_property_process_mode>` to determine the result.
  1136. If the node is not inside the tree, returns ``false`` no matter the value of :ref:`process_mode<class_Node_property_process_mode>`.
  1137. .. rst-class:: classref-item-separator
  1138. ----
  1139. .. _class_Node_method_create_tween:
  1140. .. rst-class:: classref-method
  1141. :ref:`Tween<class_Tween>` **create_tween**\ (\ ) :ref:`🔗<class_Node_method_create_tween>`
  1142. Creates a new :ref:`Tween<class_Tween>` and binds it to this node.
  1143. This is the equivalent of doing:
  1144. .. tabs::
  1145. .. code-tab:: gdscript
  1146. get_tree().create_tween().bind_node(self)
  1147. .. code-tab:: csharp
  1148. GetTree().CreateTween().BindNode(this);
  1149. The Tween will start automatically on the next process frame or physics frame (depending on :ref:`TweenProcessMode<enum_Tween_TweenProcessMode>`). See :ref:`Tween.bind_node()<class_Tween_method_bind_node>` for more info on Tweens bound to nodes.
  1150. \ **Note:** The method can still be used when the node is not inside :ref:`SceneTree<class_SceneTree>`. It can fail in an unlikely case of using a custom :ref:`MainLoop<class_MainLoop>`.
  1151. .. rst-class:: classref-item-separator
  1152. ----
  1153. .. _class_Node_method_duplicate:
  1154. .. rst-class:: classref-method
  1155. :ref:`Node<class_Node>` **duplicate**\ (\ flags\: :ref:`int<class_int>` = 15\ ) |const| :ref:`🔗<class_Node_method_duplicate>`
  1156. Duplicates the node, returning a new node with all of its properties, signals, groups, and children copied from the original. The behavior can be tweaked through the ``flags`` (see :ref:`DuplicateFlags<enum_Node_DuplicateFlags>`). Internal nodes are not duplicated.
  1157. \ **Note:** For nodes with a :ref:`Script<class_Script>` attached, if :ref:`Object._init()<class_Object_private_method__init>` has been defined with required parameters, the duplicated node will not have a :ref:`Script<class_Script>`.
  1158. .. rst-class:: classref-item-separator
  1159. ----
  1160. .. _class_Node_method_find_child:
  1161. .. rst-class:: classref-method
  1162. :ref:`Node<class_Node>` **find_child**\ (\ pattern\: :ref:`String<class_String>`, recursive\: :ref:`bool<class_bool>` = true, owned\: :ref:`bool<class_bool>` = true\ ) |const| :ref:`🔗<class_Node_method_find_child>`
  1163. Finds the first descendant of this node whose :ref:`name<class_Node_property_name>` matches ``pattern``, returning ``null`` if no match is found. The matching is done against node names, *not* their paths, through :ref:`String.match()<class_String_method_match>`. As such, it is case-sensitive, ``"*"`` matches zero or more characters, and ``"?"`` matches any single character.
  1164. If ``recursive`` is ``false``, only this node's direct children are checked. Nodes are checked in tree order, so this node's first direct child is checked first, then its own direct children, etc., before moving to the second direct child, and so on. Internal children are also included in the search (see ``internal`` parameter in :ref:`add_child()<class_Node_method_add_child>`).
  1165. If ``owned`` is ``true``, only descendants with a valid :ref:`owner<class_Node_property_owner>` node are checked.
  1166. \ **Note:** This method can be very slow. Consider storing a reference to the found node in a variable. Alternatively, use :ref:`get_node()<class_Node_method_get_node>` with unique names (see :ref:`unique_name_in_owner<class_Node_property_unique_name_in_owner>`).
  1167. \ **Note:** To find all descendant nodes matching a pattern or a class type, see :ref:`find_children()<class_Node_method_find_children>`.
  1168. .. rst-class:: classref-item-separator
  1169. ----
  1170. .. _class_Node_method_find_children:
  1171. .. rst-class:: classref-method
  1172. :ref:`Array<class_Array>`\[:ref:`Node<class_Node>`\] **find_children**\ (\ pattern\: :ref:`String<class_String>`, type\: :ref:`String<class_String>` = "", recursive\: :ref:`bool<class_bool>` = true, owned\: :ref:`bool<class_bool>` = true\ ) |const| :ref:`🔗<class_Node_method_find_children>`
  1173. Finds all descendants of this node whose names match ``pattern``, returning an empty :ref:`Array<class_Array>` if no match is found. The matching is done against node names, *not* their paths, through :ref:`String.match()<class_String_method_match>`. As such, it is case-sensitive, ``"*"`` matches zero or more characters, and ``"?"`` matches any single character.
  1174. If ``type`` is not empty, only ancestors inheriting from ``type`` are included (see :ref:`Object.is_class()<class_Object_method_is_class>`).
  1175. If ``recursive`` is ``false``, only this node's direct children are checked. Nodes are checked in tree order, so this node's first direct child is checked first, then its own direct children, etc., before moving to the second direct child, and so on. Internal children are also included in the search (see ``internal`` parameter in :ref:`add_child()<class_Node_method_add_child>`).
  1176. If ``owned`` is ``true``, only descendants with a valid :ref:`owner<class_Node_property_owner>` node are checked.
  1177. \ **Note:** This method can be very slow. Consider storing references to the found nodes in a variable.
  1178. \ **Note:** To find a single descendant node matching a pattern, see :ref:`find_child()<class_Node_method_find_child>`.
  1179. .. rst-class:: classref-item-separator
  1180. ----
  1181. .. _class_Node_method_find_parent:
  1182. .. rst-class:: classref-method
  1183. :ref:`Node<class_Node>` **find_parent**\ (\ pattern\: :ref:`String<class_String>`\ ) |const| :ref:`🔗<class_Node_method_find_parent>`
  1184. Finds the first ancestor of this node whose :ref:`name<class_Node_property_name>` matches ``pattern``, returning ``null`` if no match is found. The matching is done through :ref:`String.match()<class_String_method_match>`. As such, it is case-sensitive, ``"*"`` matches zero or more characters, and ``"?"`` matches any single character. See also :ref:`find_child()<class_Node_method_find_child>` and :ref:`find_children()<class_Node_method_find_children>`.
  1185. \ **Note:** As this method walks upwards in the scene tree, it can be slow in large, deeply nested nodes. Consider storing a reference to the found node in a variable. Alternatively, use :ref:`get_node()<class_Node_method_get_node>` with unique names (see :ref:`unique_name_in_owner<class_Node_property_unique_name_in_owner>`).
  1186. .. rst-class:: classref-item-separator
  1187. ----
  1188. .. _class_Node_method_get_accessibility_element:
  1189. .. rst-class:: classref-method
  1190. :ref:`RID<class_RID>` **get_accessibility_element**\ (\ ) |const| :ref:`🔗<class_Node_method_get_accessibility_element>`
  1191. Returns main accessibility element RID.
  1192. \ **Note:** This method should be called only during accessibility information updates (:ref:`NOTIFICATION_ACCESSIBILITY_UPDATE<class_Node_constant_NOTIFICATION_ACCESSIBILITY_UPDATE>`).
  1193. .. rst-class:: classref-item-separator
  1194. ----
  1195. .. _class_Node_method_get_child:
  1196. .. rst-class:: classref-method
  1197. :ref:`Node<class_Node>` **get_child**\ (\ idx\: :ref:`int<class_int>`, include_internal\: :ref:`bool<class_bool>` = false\ ) |const| :ref:`🔗<class_Node_method_get_child>`
  1198. Fetches a child node by its index. Each child node has an index relative its siblings (see :ref:`get_index()<class_Node_method_get_index>`). The first child is at index 0. Negative values can also be used to start from the end of the list. This method can be used in combination with :ref:`get_child_count()<class_Node_method_get_child_count>` to iterate over this node's children. If no child exists at the given index, this method returns ``null`` and an error is generated.
  1199. If ``include_internal`` is ``false``, internal children are ignored (see :ref:`add_child()<class_Node_method_add_child>`'s ``internal`` parameter).
  1200. ::
  1201. # Assuming the following are children of this node, in order:
  1202. # First, Middle, Last.
  1203. var a = get_child(0).name # a is "First"
  1204. var b = get_child(1).name # b is "Middle"
  1205. var b = get_child(2).name # b is "Last"
  1206. var c = get_child(-1).name # c is "Last"
  1207. \ **Note:** To fetch a node by :ref:`NodePath<class_NodePath>`, use :ref:`get_node()<class_Node_method_get_node>`.
  1208. .. rst-class:: classref-item-separator
  1209. ----
  1210. .. _class_Node_method_get_child_count:
  1211. .. rst-class:: classref-method
  1212. :ref:`int<class_int>` **get_child_count**\ (\ include_internal\: :ref:`bool<class_bool>` = false\ ) |const| :ref:`🔗<class_Node_method_get_child_count>`
  1213. Returns the number of children of this node.
  1214. If ``include_internal`` is ``false``, internal children are not counted (see :ref:`add_child()<class_Node_method_add_child>`'s ``internal`` parameter).
  1215. .. rst-class:: classref-item-separator
  1216. ----
  1217. .. _class_Node_method_get_children:
  1218. .. rst-class:: classref-method
  1219. :ref:`Array<class_Array>`\[:ref:`Node<class_Node>`\] **get_children**\ (\ include_internal\: :ref:`bool<class_bool>` = false\ ) |const| :ref:`🔗<class_Node_method_get_children>`
  1220. Returns all children of this node inside an :ref:`Array<class_Array>`.
  1221. If ``include_internal`` is ``false``, excludes internal children from the returned array (see :ref:`add_child()<class_Node_method_add_child>`'s ``internal`` parameter).
  1222. .. rst-class:: classref-item-separator
  1223. ----
  1224. .. _class_Node_method_get_groups:
  1225. .. rst-class:: classref-method
  1226. :ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\] **get_groups**\ (\ ) |const| :ref:`🔗<class_Node_method_get_groups>`
  1227. Returns an :ref:`Array<class_Array>` of group names that the node has been added to.
  1228. \ **Note:** To improve performance, the order of group names is *not* guaranteed and may vary between project runs. Therefore, do not rely on the group order.
  1229. \ **Note:** This method may also return some group names starting with an underscore (``_``). These are internally used by the engine. To avoid conflicts, do not use custom groups starting with underscores. To exclude internal groups, see the following code snippet:
  1230. .. tabs::
  1231. .. code-tab:: gdscript
  1232. # Stores the node's non-internal groups only (as an array of StringNames).
  1233. var non_internal_groups = []
  1234. for group in get_groups():
  1235. if not str(group).begins_with("_"):
  1236. non_internal_groups.push_back(group)
  1237. .. code-tab:: csharp
  1238. // Stores the node's non-internal groups only (as a List of StringNames).
  1239. List<string> nonInternalGroups = new List<string>();
  1240. foreach (string group in GetGroups())
  1241. {
  1242. if (!group.BeginsWith("_"))
  1243. nonInternalGroups.Add(group);
  1244. }
  1245. .. rst-class:: classref-item-separator
  1246. ----
  1247. .. _class_Node_method_get_index:
  1248. .. rst-class:: classref-method
  1249. :ref:`int<class_int>` **get_index**\ (\ include_internal\: :ref:`bool<class_bool>` = false\ ) |const| :ref:`🔗<class_Node_method_get_index>`
  1250. Returns this node's order among its siblings. The first node's index is ``0``. See also :ref:`get_child()<class_Node_method_get_child>`.
  1251. If ``include_internal`` is ``false``, returns the index ignoring internal children. The first, non-internal child will have an index of ``0`` (see :ref:`add_child()<class_Node_method_add_child>`'s ``internal`` parameter).
  1252. .. rst-class:: classref-item-separator
  1253. ----
  1254. .. _class_Node_method_get_last_exclusive_window:
  1255. .. rst-class:: classref-method
  1256. :ref:`Window<class_Window>` **get_last_exclusive_window**\ (\ ) |const| :ref:`🔗<class_Node_method_get_last_exclusive_window>`
  1257. Returns the :ref:`Window<class_Window>` that contains this node, or the last exclusive child in a chain of windows starting with the one that contains this node.
  1258. .. rst-class:: classref-item-separator
  1259. ----
  1260. .. _class_Node_method_get_multiplayer_authority:
  1261. .. rst-class:: classref-method
  1262. :ref:`int<class_int>` **get_multiplayer_authority**\ (\ ) |const| :ref:`🔗<class_Node_method_get_multiplayer_authority>`
  1263. Returns the peer ID of the multiplayer authority for this node. See :ref:`set_multiplayer_authority()<class_Node_method_set_multiplayer_authority>`.
  1264. .. rst-class:: classref-item-separator
  1265. ----
  1266. .. _class_Node_method_get_node:
  1267. .. rst-class:: classref-method
  1268. :ref:`Node<class_Node>` **get_node**\ (\ path\: :ref:`NodePath<class_NodePath>`\ ) |const| :ref:`🔗<class_Node_method_get_node>`
  1269. Fetches a node. The :ref:`NodePath<class_NodePath>` can either be a relative path (from this node), or an absolute path (from the :ref:`SceneTree.root<class_SceneTree_property_root>`) to a node. If ``path`` does not point to a valid node, generates an error and returns ``null``. Attempts to access methods on the return value will result in an *"Attempt to call <method> on a null instance."* error.
  1270. \ **Note:** Fetching by absolute path only works when the node is inside the scene tree (see :ref:`is_inside_tree()<class_Node_method_is_inside_tree>`).
  1271. \ **Example:** Assume this method is called from the Character node, inside the following tree:
  1272. .. code:: text
  1273. ┖╴root
  1274. ┠╴Character (you are here!)
  1275. ┃ ┠╴Sword
  1276. ┃ ┖╴Backpack
  1277. ┃ ┖╴Dagger
  1278. ┠╴MyGame
  1279. ┖╴Swamp
  1280. ┠╴Alligator
  1281. ┠╴Mosquito
  1282. ┖╴Goblin
  1283. The following calls will return a valid node:
  1284. .. tabs::
  1285. .. code-tab:: gdscript
  1286. get_node("Sword")
  1287. get_node("Backpack/Dagger")
  1288. get_node("../Swamp/Alligator")
  1289. get_node("/root/MyGame")
  1290. .. code-tab:: csharp
  1291. GetNode("Sword");
  1292. GetNode("Backpack/Dagger");
  1293. GetNode("../Swamp/Alligator");
  1294. GetNode("/root/MyGame");
  1295. .. rst-class:: classref-item-separator
  1296. ----
  1297. .. _class_Node_method_get_node_and_resource:
  1298. .. rst-class:: classref-method
  1299. :ref:`Array<class_Array>` **get_node_and_resource**\ (\ path\: :ref:`NodePath<class_NodePath>`\ ) :ref:`🔗<class_Node_method_get_node_and_resource>`
  1300. Fetches a node and its most nested resource as specified by the :ref:`NodePath<class_NodePath>`'s subname. Returns an :ref:`Array<class_Array>` of size ``3`` where:
  1301. - Element ``0`` is the **Node**, or ``null`` if not found;
  1302. - Element ``1`` is the subname's last nested :ref:`Resource<class_Resource>`, or ``null`` if not found;
  1303. - Element ``2`` is the remaining :ref:`NodePath<class_NodePath>`, referring to an existing, non-:ref:`Resource<class_Resource>` property (see :ref:`Object.get_indexed()<class_Object_method_get_indexed>`).
  1304. \ **Example:** Assume that the child's :ref:`Sprite2D.texture<class_Sprite2D_property_texture>` has been assigned a :ref:`AtlasTexture<class_AtlasTexture>`:
  1305. .. tabs::
  1306. .. code-tab:: gdscript
  1307. var a = get_node_and_resource("Area2D/Sprite2D")
  1308. print(a[0].name) # Prints Sprite2D
  1309. print(a[1]) # Prints <null>
  1310. print(a[2]) # Prints ^""
  1311. var b = get_node_and_resource("Area2D/Sprite2D:texture:atlas")
  1312. print(b[0].name) # Prints Sprite2D
  1313. print(b[1].get_class()) # Prints AtlasTexture
  1314. print(b[2]) # Prints ^""
  1315. var c = get_node_and_resource("Area2D/Sprite2D:texture:atlas:region")
  1316. print(c[0].name) # Prints Sprite2D
  1317. print(c[1].get_class()) # Prints AtlasTexture
  1318. print(c[2]) # Prints ^":region"
  1319. .. code-tab:: csharp
  1320. var a = GetNodeAndResource(NodePath("Area2D/Sprite2D"));
  1321. GD.Print(a[0].Name); // Prints Sprite2D
  1322. GD.Print(a[1]); // Prints <null>
  1323. GD.Print(a[2]); // Prints ^"
  1324. var b = GetNodeAndResource(NodePath("Area2D/Sprite2D:texture:atlas"));
  1325. GD.Print(b[0].name); // Prints Sprite2D
  1326. GD.Print(b[1].get_class()); // Prints AtlasTexture
  1327. GD.Print(b[2]); // Prints ^""
  1328. var c = GetNodeAndResource(NodePath("Area2D/Sprite2D:texture:atlas:region"));
  1329. GD.Print(c[0].name); // Prints Sprite2D
  1330. GD.Print(c[1].get_class()); // Prints AtlasTexture
  1331. GD.Print(c[2]); // Prints ^":region"
  1332. .. rst-class:: classref-item-separator
  1333. ----
  1334. .. _class_Node_method_get_node_or_null:
  1335. .. rst-class:: classref-method
  1336. :ref:`Node<class_Node>` **get_node_or_null**\ (\ path\: :ref:`NodePath<class_NodePath>`\ ) |const| :ref:`🔗<class_Node_method_get_node_or_null>`
  1337. Fetches a node by :ref:`NodePath<class_NodePath>`. Similar to :ref:`get_node()<class_Node_method_get_node>`, but does not generate an error if ``path`` does not point to a valid node.
  1338. .. rst-class:: classref-item-separator
  1339. ----
  1340. .. _class_Node_method_get_parent:
  1341. .. rst-class:: classref-method
  1342. :ref:`Node<class_Node>` **get_parent**\ (\ ) |const| :ref:`🔗<class_Node_method_get_parent>`
  1343. Returns this node's parent node, or ``null`` if the node doesn't have a parent.
  1344. .. rst-class:: classref-item-separator
  1345. ----
  1346. .. _class_Node_method_get_path:
  1347. .. rst-class:: classref-method
  1348. :ref:`NodePath<class_NodePath>` **get_path**\ (\ ) |const| :ref:`🔗<class_Node_method_get_path>`
  1349. Returns the node's absolute path, relative to the :ref:`SceneTree.root<class_SceneTree_property_root>`. If the node is not inside the scene tree, this method fails and returns an empty :ref:`NodePath<class_NodePath>`.
  1350. .. rst-class:: classref-item-separator
  1351. ----
  1352. .. _class_Node_method_get_path_to:
  1353. .. rst-class:: classref-method
  1354. :ref:`NodePath<class_NodePath>` **get_path_to**\ (\ node\: :ref:`Node<class_Node>`, use_unique_path\: :ref:`bool<class_bool>` = false\ ) |const| :ref:`🔗<class_Node_method_get_path_to>`
  1355. Returns the relative :ref:`NodePath<class_NodePath>` from this node to the specified ``node``. Both nodes must be in the same :ref:`SceneTree<class_SceneTree>` or scene hierarchy, otherwise this method fails and returns an empty :ref:`NodePath<class_NodePath>`.
  1356. If ``use_unique_path`` is ``true``, returns the shortest path accounting for this node's unique name (see :ref:`unique_name_in_owner<class_Node_property_unique_name_in_owner>`).
  1357. \ **Note:** If you get a relative path which starts from a unique node, the path may be longer than a normal relative path, due to the addition of the unique node's name.
  1358. .. rst-class:: classref-item-separator
  1359. ----
  1360. .. _class_Node_method_get_physics_process_delta_time:
  1361. .. rst-class:: classref-method
  1362. :ref:`float<class_float>` **get_physics_process_delta_time**\ (\ ) |const| :ref:`🔗<class_Node_method_get_physics_process_delta_time>`
  1363. Returns the time elapsed (in seconds) since the last physics callback. This value is identical to :ref:`_physics_process()<class_Node_private_method__physics_process>`'s ``delta`` parameter, and is often consistent at run-time, unless :ref:`Engine.physics_ticks_per_second<class_Engine_property_physics_ticks_per_second>` is changed. See also :ref:`NOTIFICATION_PHYSICS_PROCESS<class_Node_constant_NOTIFICATION_PHYSICS_PROCESS>`.
  1364. \ **Note:** The returned value will be larger than expected if running at a framerate lower than :ref:`Engine.physics_ticks_per_second<class_Engine_property_physics_ticks_per_second>` / :ref:`Engine.max_physics_steps_per_frame<class_Engine_property_max_physics_steps_per_frame>` FPS. This is done to avoid "spiral of death" scenarios where performance would plummet due to an ever-increasing number of physics steps per frame. This behavior affects both :ref:`_process()<class_Node_private_method__process>` and :ref:`_physics_process()<class_Node_private_method__physics_process>`. As a result, avoid using ``delta`` for time measurements in real-world seconds. Use the :ref:`Time<class_Time>` singleton's methods for this purpose instead, such as :ref:`Time.get_ticks_usec()<class_Time_method_get_ticks_usec>`.
  1365. .. rst-class:: classref-item-separator
  1366. ----
  1367. .. _class_Node_method_get_process_delta_time:
  1368. .. rst-class:: classref-method
  1369. :ref:`float<class_float>` **get_process_delta_time**\ (\ ) |const| :ref:`🔗<class_Node_method_get_process_delta_time>`
  1370. Returns the time elapsed (in seconds) since the last process callback. This value is identical to :ref:`_process()<class_Node_private_method__process>`'s ``delta`` parameter, and may vary from frame to frame. See also :ref:`NOTIFICATION_PROCESS<class_Node_constant_NOTIFICATION_PROCESS>`.
  1371. \ **Note:** The returned value will be larger than expected if running at a framerate lower than :ref:`Engine.physics_ticks_per_second<class_Engine_property_physics_ticks_per_second>` / :ref:`Engine.max_physics_steps_per_frame<class_Engine_property_max_physics_steps_per_frame>` FPS. This is done to avoid "spiral of death" scenarios where performance would plummet due to an ever-increasing number of physics steps per frame. This behavior affects both :ref:`_process()<class_Node_private_method__process>` and :ref:`_physics_process()<class_Node_private_method__physics_process>`. As a result, avoid using ``delta`` for time measurements in real-world seconds. Use the :ref:`Time<class_Time>` singleton's methods for this purpose instead, such as :ref:`Time.get_ticks_usec()<class_Time_method_get_ticks_usec>`.
  1372. .. rst-class:: classref-item-separator
  1373. ----
  1374. .. _class_Node_method_get_rpc_config:
  1375. .. rst-class:: classref-method
  1376. :ref:`Variant<class_Variant>` **get_rpc_config**\ (\ ) |const| :ref:`🔗<class_Node_method_get_rpc_config>`
  1377. Returns a :ref:`Dictionary<class_Dictionary>` mapping method names to their RPC configuration defined for this node using :ref:`rpc_config()<class_Node_method_rpc_config>`.
  1378. .. rst-class:: classref-item-separator
  1379. ----
  1380. .. _class_Node_method_get_scene_instance_load_placeholder:
  1381. .. rst-class:: classref-method
  1382. :ref:`bool<class_bool>` **get_scene_instance_load_placeholder**\ (\ ) |const| :ref:`🔗<class_Node_method_get_scene_instance_load_placeholder>`
  1383. Returns ``true`` if this node is an instance load placeholder. See :ref:`InstancePlaceholder<class_InstancePlaceholder>` and :ref:`set_scene_instance_load_placeholder()<class_Node_method_set_scene_instance_load_placeholder>`.
  1384. .. rst-class:: classref-item-separator
  1385. ----
  1386. .. _class_Node_method_get_tree:
  1387. .. rst-class:: classref-method
  1388. :ref:`SceneTree<class_SceneTree>` **get_tree**\ (\ ) |const| :ref:`🔗<class_Node_method_get_tree>`
  1389. Returns the :ref:`SceneTree<class_SceneTree>` that contains this node. If this node is not inside the tree, generates an error and returns ``null``. See also :ref:`is_inside_tree()<class_Node_method_is_inside_tree>`.
  1390. .. rst-class:: classref-item-separator
  1391. ----
  1392. .. _class_Node_method_get_tree_string:
  1393. .. rst-class:: classref-method
  1394. :ref:`String<class_String>` **get_tree_string**\ (\ ) :ref:`🔗<class_Node_method_get_tree_string>`
  1395. Returns the tree as a :ref:`String<class_String>`. Used mainly for debugging purposes. This version displays the path relative to the current node, and is good for copy/pasting into the :ref:`get_node()<class_Node_method_get_node>` function. It also can be used in game UI/UX.
  1396. May print, for example:
  1397. .. code:: text
  1398. TheGame
  1399. TheGame/Menu
  1400. TheGame/Menu/Label
  1401. TheGame/Menu/Camera2D
  1402. TheGame/SplashScreen
  1403. TheGame/SplashScreen/Camera2D
  1404. .. rst-class:: classref-item-separator
  1405. ----
  1406. .. _class_Node_method_get_tree_string_pretty:
  1407. .. rst-class:: classref-method
  1408. :ref:`String<class_String>` **get_tree_string_pretty**\ (\ ) :ref:`🔗<class_Node_method_get_tree_string_pretty>`
  1409. Similar to :ref:`get_tree_string()<class_Node_method_get_tree_string>`, this returns the tree as a :ref:`String<class_String>`. This version displays a more graphical representation similar to what is displayed in the Scene Dock. It is useful for inspecting larger trees.
  1410. May print, for example:
  1411. .. code:: text
  1412. ┖╴TheGame
  1413. ┠╴Menu
  1414. ┃ ┠╴Label
  1415. ┃ ┖╴Camera2D
  1416. ┖╴SplashScreen
  1417. ┖╴Camera2D
  1418. .. rst-class:: classref-item-separator
  1419. ----
  1420. .. _class_Node_method_get_viewport:
  1421. .. rst-class:: classref-method
  1422. :ref:`Viewport<class_Viewport>` **get_viewport**\ (\ ) |const| :ref:`🔗<class_Node_method_get_viewport>`
  1423. Returns the node's closest :ref:`Viewport<class_Viewport>` ancestor, if the node is inside the tree. Otherwise, returns ``null``.
  1424. .. rst-class:: classref-item-separator
  1425. ----
  1426. .. _class_Node_method_get_window:
  1427. .. rst-class:: classref-method
  1428. :ref:`Window<class_Window>` **get_window**\ (\ ) |const| :ref:`🔗<class_Node_method_get_window>`
  1429. Returns the :ref:`Window<class_Window>` that contains this node. If the node is in the main window, this is equivalent to getting the root node (``get_tree().get_root()``).
  1430. .. rst-class:: classref-item-separator
  1431. ----
  1432. .. _class_Node_method_has_node:
  1433. .. rst-class:: classref-method
  1434. :ref:`bool<class_bool>` **has_node**\ (\ path\: :ref:`NodePath<class_NodePath>`\ ) |const| :ref:`🔗<class_Node_method_has_node>`
  1435. Returns ``true`` if the ``path`` points to a valid node. See also :ref:`get_node()<class_Node_method_get_node>`.
  1436. .. rst-class:: classref-item-separator
  1437. ----
  1438. .. _class_Node_method_has_node_and_resource:
  1439. .. rst-class:: classref-method
  1440. :ref:`bool<class_bool>` **has_node_and_resource**\ (\ path\: :ref:`NodePath<class_NodePath>`\ ) |const| :ref:`🔗<class_Node_method_has_node_and_resource>`
  1441. Returns ``true`` if ``path`` points to a valid node and its subnames point to a valid :ref:`Resource<class_Resource>`, e.g. ``Area2D/CollisionShape2D:shape``. Properties that are not :ref:`Resource<class_Resource>` types (such as nodes or other :ref:`Variant<class_Variant>` types) are not considered. See also :ref:`get_node_and_resource()<class_Node_method_get_node_and_resource>`.
  1442. .. rst-class:: classref-item-separator
  1443. ----
  1444. .. _class_Node_method_is_ancestor_of:
  1445. .. rst-class:: classref-method
  1446. :ref:`bool<class_bool>` **is_ancestor_of**\ (\ node\: :ref:`Node<class_Node>`\ ) |const| :ref:`🔗<class_Node_method_is_ancestor_of>`
  1447. Returns ``true`` if the given ``node`` is a direct or indirect child of this node.
  1448. .. rst-class:: classref-item-separator
  1449. ----
  1450. .. _class_Node_method_is_displayed_folded:
  1451. .. rst-class:: classref-method
  1452. :ref:`bool<class_bool>` **is_displayed_folded**\ (\ ) |const| :ref:`🔗<class_Node_method_is_displayed_folded>`
  1453. Returns ``true`` if the node is folded (collapsed) in the Scene dock. This method is intended to be used in editor plugins and tools. See also :ref:`set_display_folded()<class_Node_method_set_display_folded>`.
  1454. .. rst-class:: classref-item-separator
  1455. ----
  1456. .. _class_Node_method_is_editable_instance:
  1457. .. rst-class:: classref-method
  1458. :ref:`bool<class_bool>` **is_editable_instance**\ (\ node\: :ref:`Node<class_Node>`\ ) |const| :ref:`🔗<class_Node_method_is_editable_instance>`
  1459. Returns ``true`` if ``node`` has editable children enabled relative to this node. This method is intended to be used in editor plugins and tools. See also :ref:`set_editable_instance()<class_Node_method_set_editable_instance>`.
  1460. .. rst-class:: classref-item-separator
  1461. ----
  1462. .. _class_Node_method_is_greater_than:
  1463. .. rst-class:: classref-method
  1464. :ref:`bool<class_bool>` **is_greater_than**\ (\ node\: :ref:`Node<class_Node>`\ ) |const| :ref:`🔗<class_Node_method_is_greater_than>`
  1465. Returns ``true`` if the given ``node`` occurs later in the scene hierarchy than this node. A node occurring later is usually processed last.
  1466. .. rst-class:: classref-item-separator
  1467. ----
  1468. .. _class_Node_method_is_in_group:
  1469. .. rst-class:: classref-method
  1470. :ref:`bool<class_bool>` **is_in_group**\ (\ group\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`🔗<class_Node_method_is_in_group>`
  1471. Returns ``true`` if this node has been added to the given ``group``. See :ref:`add_to_group()<class_Node_method_add_to_group>` and :ref:`remove_from_group()<class_Node_method_remove_from_group>`. See also notes in the description, and the :ref:`SceneTree<class_SceneTree>`'s group methods.
  1472. .. rst-class:: classref-item-separator
  1473. ----
  1474. .. _class_Node_method_is_inside_tree:
  1475. .. rst-class:: classref-method
  1476. :ref:`bool<class_bool>` **is_inside_tree**\ (\ ) |const| :ref:`🔗<class_Node_method_is_inside_tree>`
  1477. Returns ``true`` if this node is currently inside a :ref:`SceneTree<class_SceneTree>`. See also :ref:`get_tree()<class_Node_method_get_tree>`.
  1478. .. rst-class:: classref-item-separator
  1479. ----
  1480. .. _class_Node_method_is_multiplayer_authority:
  1481. .. rst-class:: classref-method
  1482. :ref:`bool<class_bool>` **is_multiplayer_authority**\ (\ ) |const| :ref:`🔗<class_Node_method_is_multiplayer_authority>`
  1483. Returns ``true`` if the local system is the multiplayer authority of this node.
  1484. .. rst-class:: classref-item-separator
  1485. ----
  1486. .. _class_Node_method_is_node_ready:
  1487. .. rst-class:: classref-method
  1488. :ref:`bool<class_bool>` **is_node_ready**\ (\ ) |const| :ref:`🔗<class_Node_method_is_node_ready>`
  1489. Returns ``true`` if the node is ready, i.e. it's inside scene tree and all its children are initialized.
  1490. \ :ref:`request_ready()<class_Node_method_request_ready>` resets it back to ``false``.
  1491. .. rst-class:: classref-item-separator
  1492. ----
  1493. .. _class_Node_method_is_part_of_edited_scene:
  1494. .. rst-class:: classref-method
  1495. :ref:`bool<class_bool>` **is_part_of_edited_scene**\ (\ ) |const| :ref:`🔗<class_Node_method_is_part_of_edited_scene>`
  1496. Returns ``true`` if the node is part of the scene currently opened in the editor.
  1497. .. rst-class:: classref-item-separator
  1498. ----
  1499. .. _class_Node_method_is_physics_interpolated:
  1500. .. rst-class:: classref-method
  1501. :ref:`bool<class_bool>` **is_physics_interpolated**\ (\ ) |const| :ref:`🔗<class_Node_method_is_physics_interpolated>`
  1502. Returns ``true`` if physics interpolation is enabled for this node (see :ref:`physics_interpolation_mode<class_Node_property_physics_interpolation_mode>`).
  1503. \ **Note:** Interpolation will only be active if both the flag is set **and** physics interpolation is enabled within the :ref:`SceneTree<class_SceneTree>`. This can be tested using :ref:`is_physics_interpolated_and_enabled()<class_Node_method_is_physics_interpolated_and_enabled>`.
  1504. .. rst-class:: classref-item-separator
  1505. ----
  1506. .. _class_Node_method_is_physics_interpolated_and_enabled:
  1507. .. rst-class:: classref-method
  1508. :ref:`bool<class_bool>` **is_physics_interpolated_and_enabled**\ (\ ) |const| :ref:`🔗<class_Node_method_is_physics_interpolated_and_enabled>`
  1509. Returns ``true`` if physics interpolation is enabled (see :ref:`physics_interpolation_mode<class_Node_property_physics_interpolation_mode>`) **and** enabled in the :ref:`SceneTree<class_SceneTree>`.
  1510. This is a convenience version of :ref:`is_physics_interpolated()<class_Node_method_is_physics_interpolated>` that also checks whether physics interpolation is enabled globally.
  1511. See :ref:`SceneTree.physics_interpolation<class_SceneTree_property_physics_interpolation>` and :ref:`ProjectSettings.physics/common/physics_interpolation<class_ProjectSettings_property_physics/common/physics_interpolation>`.
  1512. .. rst-class:: classref-item-separator
  1513. ----
  1514. .. _class_Node_method_is_physics_processing:
  1515. .. rst-class:: classref-method
  1516. :ref:`bool<class_bool>` **is_physics_processing**\ (\ ) |const| :ref:`🔗<class_Node_method_is_physics_processing>`
  1517. Returns ``true`` if physics processing is enabled (see :ref:`set_physics_process()<class_Node_method_set_physics_process>`).
  1518. .. rst-class:: classref-item-separator
  1519. ----
  1520. .. _class_Node_method_is_physics_processing_internal:
  1521. .. rst-class:: classref-method
  1522. :ref:`bool<class_bool>` **is_physics_processing_internal**\ (\ ) |const| :ref:`🔗<class_Node_method_is_physics_processing_internal>`
  1523. Returns ``true`` if internal physics processing is enabled (see :ref:`set_physics_process_internal()<class_Node_method_set_physics_process_internal>`).
  1524. .. rst-class:: classref-item-separator
  1525. ----
  1526. .. _class_Node_method_is_processing:
  1527. .. rst-class:: classref-method
  1528. :ref:`bool<class_bool>` **is_processing**\ (\ ) |const| :ref:`🔗<class_Node_method_is_processing>`
  1529. Returns ``true`` if processing is enabled (see :ref:`set_process()<class_Node_method_set_process>`).
  1530. .. rst-class:: classref-item-separator
  1531. ----
  1532. .. _class_Node_method_is_processing_input:
  1533. .. rst-class:: classref-method
  1534. :ref:`bool<class_bool>` **is_processing_input**\ (\ ) |const| :ref:`🔗<class_Node_method_is_processing_input>`
  1535. Returns ``true`` if the node is processing input (see :ref:`set_process_input()<class_Node_method_set_process_input>`).
  1536. .. rst-class:: classref-item-separator
  1537. ----
  1538. .. _class_Node_method_is_processing_internal:
  1539. .. rst-class:: classref-method
  1540. :ref:`bool<class_bool>` **is_processing_internal**\ (\ ) |const| :ref:`🔗<class_Node_method_is_processing_internal>`
  1541. Returns ``true`` if internal processing is enabled (see :ref:`set_process_internal()<class_Node_method_set_process_internal>`).
  1542. .. rst-class:: classref-item-separator
  1543. ----
  1544. .. _class_Node_method_is_processing_shortcut_input:
  1545. .. rst-class:: classref-method
  1546. :ref:`bool<class_bool>` **is_processing_shortcut_input**\ (\ ) |const| :ref:`🔗<class_Node_method_is_processing_shortcut_input>`
  1547. Returns ``true`` if the node is processing shortcuts (see :ref:`set_process_shortcut_input()<class_Node_method_set_process_shortcut_input>`).
  1548. .. rst-class:: classref-item-separator
  1549. ----
  1550. .. _class_Node_method_is_processing_unhandled_input:
  1551. .. rst-class:: classref-method
  1552. :ref:`bool<class_bool>` **is_processing_unhandled_input**\ (\ ) |const| :ref:`🔗<class_Node_method_is_processing_unhandled_input>`
  1553. Returns ``true`` if the node is processing unhandled input (see :ref:`set_process_unhandled_input()<class_Node_method_set_process_unhandled_input>`).
  1554. .. rst-class:: classref-item-separator
  1555. ----
  1556. .. _class_Node_method_is_processing_unhandled_key_input:
  1557. .. rst-class:: classref-method
  1558. :ref:`bool<class_bool>` **is_processing_unhandled_key_input**\ (\ ) |const| :ref:`🔗<class_Node_method_is_processing_unhandled_key_input>`
  1559. Returns ``true`` if the node is processing unhandled key input (see :ref:`set_process_unhandled_key_input()<class_Node_method_set_process_unhandled_key_input>`).
  1560. .. rst-class:: classref-item-separator
  1561. ----
  1562. .. _class_Node_method_move_child:
  1563. .. rst-class:: classref-method
  1564. |void| **move_child**\ (\ child_node\: :ref:`Node<class_Node>`, to_index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_Node_method_move_child>`
  1565. Moves ``child_node`` to the given index. A node's index is the order among its siblings. If ``to_index`` is negative, the index is counted from the end of the list. See also :ref:`get_child()<class_Node_method_get_child>` and :ref:`get_index()<class_Node_method_get_index>`.
  1566. \ **Note:** The processing order of several engine callbacks (:ref:`_ready()<class_Node_private_method__ready>`, :ref:`_process()<class_Node_private_method__process>`, etc.) and notifications sent through :ref:`propagate_notification()<class_Node_method_propagate_notification>` is affected by tree order. :ref:`CanvasItem<class_CanvasItem>` nodes are also rendered in tree order. See also :ref:`process_priority<class_Node_property_process_priority>`.
  1567. .. rst-class:: classref-item-separator
  1568. ----
  1569. .. _class_Node_method_notify_deferred_thread_group:
  1570. .. rst-class:: classref-method
  1571. |void| **notify_deferred_thread_group**\ (\ what\: :ref:`int<class_int>`\ ) :ref:`🔗<class_Node_method_notify_deferred_thread_group>`
  1572. Similar to :ref:`call_deferred_thread_group()<class_Node_method_call_deferred_thread_group>`, but for notifications.
  1573. .. rst-class:: classref-item-separator
  1574. ----
  1575. .. _class_Node_method_notify_thread_safe:
  1576. .. rst-class:: classref-method
  1577. |void| **notify_thread_safe**\ (\ what\: :ref:`int<class_int>`\ ) :ref:`🔗<class_Node_method_notify_thread_safe>`
  1578. Similar to :ref:`call_thread_safe()<class_Node_method_call_thread_safe>`, but for notifications.
  1579. .. rst-class:: classref-item-separator
  1580. ----
  1581. .. _class_Node_method_print_orphan_nodes:
  1582. .. rst-class:: classref-method
  1583. |void| **print_orphan_nodes**\ (\ ) |static| :ref:`🔗<class_Node_method_print_orphan_nodes>`
  1584. Prints all orphan nodes (nodes outside the :ref:`SceneTree<class_SceneTree>`). Useful for debugging.
  1585. \ **Note:** This method only works in debug builds. Does nothing in a project exported in release mode.
  1586. .. rst-class:: classref-item-separator
  1587. ----
  1588. .. _class_Node_method_print_tree:
  1589. .. rst-class:: classref-method
  1590. |void| **print_tree**\ (\ ) :ref:`🔗<class_Node_method_print_tree>`
  1591. Prints the node and its children to the console, recursively. The node does not have to be inside the tree. This method outputs :ref:`NodePath<class_NodePath>`\ s relative to this node, and is good for copy/pasting into :ref:`get_node()<class_Node_method_get_node>`. See also :ref:`print_tree_pretty()<class_Node_method_print_tree_pretty>`.
  1592. May print, for example:
  1593. .. code:: text
  1594. .
  1595. Menu
  1596. Menu/Label
  1597. Menu/Camera2D
  1598. SplashScreen
  1599. SplashScreen/Camera2D
  1600. .. rst-class:: classref-item-separator
  1601. ----
  1602. .. _class_Node_method_print_tree_pretty:
  1603. .. rst-class:: classref-method
  1604. |void| **print_tree_pretty**\ (\ ) :ref:`🔗<class_Node_method_print_tree_pretty>`
  1605. Prints the node and its children to the console, recursively. The node does not have to be inside the tree. Similar to :ref:`print_tree()<class_Node_method_print_tree>`, but the graphical representation looks like what is displayed in the editor's Scene dock. It is useful for inspecting larger trees.
  1606. May print, for example:
  1607. .. code:: text
  1608. ┖╴TheGame
  1609. ┠╴Menu
  1610. ┃ ┠╴Label
  1611. ┃ ┖╴Camera2D
  1612. ┖╴SplashScreen
  1613. ┖╴Camera2D
  1614. .. rst-class:: classref-item-separator
  1615. ----
  1616. .. _class_Node_method_propagate_call:
  1617. .. rst-class:: classref-method
  1618. |void| **propagate_call**\ (\ method\: :ref:`StringName<class_StringName>`, args\: :ref:`Array<class_Array>` = [], parent_first\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_Node_method_propagate_call>`
  1619. Calls the given ``method`` name, passing ``args`` as arguments, on this node and all of its children, recursively.
  1620. If ``parent_first`` is ``true``, the method is called on this node first, then on all of its children. If ``false``, the children's methods are called first.
  1621. .. rst-class:: classref-item-separator
  1622. ----
  1623. .. _class_Node_method_propagate_notification:
  1624. .. rst-class:: classref-method
  1625. |void| **propagate_notification**\ (\ what\: :ref:`int<class_int>`\ ) :ref:`🔗<class_Node_method_propagate_notification>`
  1626. Calls :ref:`Object.notification()<class_Object_method_notification>` with ``what`` on this node and all of its children, recursively.
  1627. .. rst-class:: classref-item-separator
  1628. ----
  1629. .. _class_Node_method_queue_accessibility_update:
  1630. .. rst-class:: classref-method
  1631. |void| **queue_accessibility_update**\ (\ ) :ref:`🔗<class_Node_method_queue_accessibility_update>`
  1632. Queues an accessibility information update for this node.
  1633. .. rst-class:: classref-item-separator
  1634. ----
  1635. .. _class_Node_method_queue_free:
  1636. .. rst-class:: classref-method
  1637. |void| **queue_free**\ (\ ) :ref:`🔗<class_Node_method_queue_free>`
  1638. Queues this node to be deleted at the end of the current frame. When deleted, all of its children are deleted as well, and all references to the node and its children become invalid.
  1639. Unlike with :ref:`Object.free()<class_Object_method_free>`, the node is not deleted instantly, and it can still be accessed before deletion. It is also safe to call :ref:`queue_free()<class_Node_method_queue_free>` multiple times. Use :ref:`Object.is_queued_for_deletion()<class_Object_method_is_queued_for_deletion>` to check if the node will be deleted at the end of the frame.
  1640. \ **Note:** The node will only be freed after all other deferred calls are finished. Using this method is not always the same as calling :ref:`Object.free()<class_Object_method_free>` through :ref:`Object.call_deferred()<class_Object_method_call_deferred>`.
  1641. .. rst-class:: classref-item-separator
  1642. ----
  1643. .. _class_Node_method_remove_child:
  1644. .. rst-class:: classref-method
  1645. |void| **remove_child**\ (\ node\: :ref:`Node<class_Node>`\ ) :ref:`🔗<class_Node_method_remove_child>`
  1646. Removes a child ``node``. The ``node``, along with its children, are **not** deleted. To delete a node, see :ref:`queue_free()<class_Node_method_queue_free>`.
  1647. \ **Note:** When this node is inside the tree, this method sets the :ref:`owner<class_Node_property_owner>` of the removed ``node`` (or its descendants) to ``null``, if their :ref:`owner<class_Node_property_owner>` is no longer an ancestor (see :ref:`is_ancestor_of()<class_Node_method_is_ancestor_of>`).
  1648. .. rst-class:: classref-item-separator
  1649. ----
  1650. .. _class_Node_method_remove_from_group:
  1651. .. rst-class:: classref-method
  1652. |void| **remove_from_group**\ (\ group\: :ref:`StringName<class_StringName>`\ ) :ref:`🔗<class_Node_method_remove_from_group>`
  1653. Removes the node from the given ``group``. Does nothing if the node is not in the ``group``. See also notes in the description, and the :ref:`SceneTree<class_SceneTree>`'s group methods.
  1654. .. rst-class:: classref-item-separator
  1655. ----
  1656. .. _class_Node_method_reparent:
  1657. .. rst-class:: classref-method
  1658. |void| **reparent**\ (\ new_parent\: :ref:`Node<class_Node>`, keep_global_transform\: :ref:`bool<class_bool>` = true\ ) :ref:`🔗<class_Node_method_reparent>`
  1659. Changes the parent of this **Node** to the ``new_parent``. The node needs to already have a parent. The node's :ref:`owner<class_Node_property_owner>` is preserved if its owner is still reachable from the new location (i.e., the node is still a descendant of the new parent after the operation).
  1660. If ``keep_global_transform`` is ``true``, the node's global transform will be preserved if supported. :ref:`Node2D<class_Node2D>`, :ref:`Node3D<class_Node3D>` and :ref:`Control<class_Control>` support this argument (but :ref:`Control<class_Control>` keeps only position).
  1661. .. rst-class:: classref-item-separator
  1662. ----
  1663. .. _class_Node_method_replace_by:
  1664. .. rst-class:: classref-method
  1665. |void| **replace_by**\ (\ node\: :ref:`Node<class_Node>`, keep_groups\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_Node_method_replace_by>`
  1666. Replaces this node by the given ``node``. All children of this node are moved to ``node``.
  1667. If ``keep_groups`` is ``true``, the ``node`` is added to the same groups that the replaced node is in (see :ref:`add_to_group()<class_Node_method_add_to_group>`).
  1668. \ **Warning:** The replaced node is removed from the tree, but it is **not** deleted. To prevent memory leaks, store a reference to the node in a variable, or use :ref:`Object.free()<class_Object_method_free>`.
  1669. .. rst-class:: classref-item-separator
  1670. ----
  1671. .. _class_Node_method_request_ready:
  1672. .. rst-class:: classref-method
  1673. |void| **request_ready**\ (\ ) :ref:`🔗<class_Node_method_request_ready>`
  1674. Requests :ref:`_ready()<class_Node_private_method__ready>` to be called again the next time the node enters the tree. Does **not** immediately call :ref:`_ready()<class_Node_private_method__ready>`.
  1675. \ **Note:** This method only affects the current node. If the node's children also need to request ready, this method needs to be called for each one of them. When the node and its children enter the tree again, the order of :ref:`_ready()<class_Node_private_method__ready>` callbacks will be the same as normal.
  1676. .. rst-class:: classref-item-separator
  1677. ----
  1678. .. _class_Node_method_reset_physics_interpolation:
  1679. .. rst-class:: classref-method
  1680. |void| **reset_physics_interpolation**\ (\ ) :ref:`🔗<class_Node_method_reset_physics_interpolation>`
  1681. When physics interpolation is active, moving a node to a radically different transform (such as placement within a level) can result in a visible glitch as the object is rendered moving from the old to new position over the physics tick.
  1682. That glitch can be prevented by calling this method, which temporarily disables interpolation until the physics tick is complete.
  1683. The notification :ref:`NOTIFICATION_RESET_PHYSICS_INTERPOLATION<class_Node_constant_NOTIFICATION_RESET_PHYSICS_INTERPOLATION>` will be received by the node and all children recursively.
  1684. \ **Note:** This function should be called **after** moving the node, rather than before.
  1685. .. rst-class:: classref-item-separator
  1686. ----
  1687. .. _class_Node_method_rpc:
  1688. .. rst-class:: classref-method
  1689. :ref:`Error<enum_@GlobalScope_Error>` **rpc**\ (\ method\: :ref:`StringName<class_StringName>`, ...\ ) |vararg| :ref:`🔗<class_Node_method_rpc>`
  1690. Sends a remote procedure call request for the given ``method`` to peers on the network (and locally), sending additional arguments to the method called by the RPC. The call request will only be received by nodes with the same :ref:`NodePath<class_NodePath>`, including the exact same :ref:`name<class_Node_property_name>`. Behavior depends on the RPC configuration for the given ``method`` (see :ref:`rpc_config()<class_Node_method_rpc_config>` and :ref:`@GDScript.@rpc<class_@GDScript_annotation_@rpc>`). By default, methods are not exposed to RPCs.
  1691. May return :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` if the call is successful, :ref:`@GlobalScope.ERR_INVALID_PARAMETER<class_@GlobalScope_constant_ERR_INVALID_PARAMETER>` if the arguments passed in the ``method`` do not match, :ref:`@GlobalScope.ERR_UNCONFIGURED<class_@GlobalScope_constant_ERR_UNCONFIGURED>` if the node's :ref:`multiplayer<class_Node_property_multiplayer>` cannot be fetched (such as when the node is not inside the tree), :ref:`@GlobalScope.ERR_CONNECTION_ERROR<class_@GlobalScope_constant_ERR_CONNECTION_ERROR>` if :ref:`multiplayer<class_Node_property_multiplayer>`'s connection is not available.
  1692. \ **Note:** You can only safely use RPCs on clients after you received the :ref:`MultiplayerAPI.connected_to_server<class_MultiplayerAPI_signal_connected_to_server>` signal from the :ref:`MultiplayerAPI<class_MultiplayerAPI>`. You also need to keep track of the connection state, either by the :ref:`MultiplayerAPI<class_MultiplayerAPI>` signals like :ref:`MultiplayerAPI.server_disconnected<class_MultiplayerAPI_signal_server_disconnected>` or by checking (``get_multiplayer().peer.get_connection_status() == CONNECTION_CONNECTED``).
  1693. .. rst-class:: classref-item-separator
  1694. ----
  1695. .. _class_Node_method_rpc_config:
  1696. .. rst-class:: classref-method
  1697. |void| **rpc_config**\ (\ method\: :ref:`StringName<class_StringName>`, config\: :ref:`Variant<class_Variant>`\ ) :ref:`🔗<class_Node_method_rpc_config>`
  1698. Changes the RPC configuration for the given ``method``. ``config`` should either be ``null`` to disable the feature (as by default), or a :ref:`Dictionary<class_Dictionary>` containing the following entries:
  1699. - ``rpc_mode``: see :ref:`RPCMode<enum_MultiplayerAPI_RPCMode>`;
  1700. - ``transfer_mode``: see :ref:`TransferMode<enum_MultiplayerPeer_TransferMode>`;
  1701. - ``call_local``: if ``true``, the method will also be called locally;
  1702. - ``channel``: an :ref:`int<class_int>` representing the channel to send the RPC on.
  1703. \ **Note:** In GDScript, this method corresponds to the :ref:`@GDScript.@rpc<class_@GDScript_annotation_@rpc>` annotation, with various parameters passed (``@rpc(any)``, ``@rpc(authority)``...). See also the :doc:`high-level multiplayer <../tutorials/networking/high_level_multiplayer>` tutorial.
  1704. .. rst-class:: classref-item-separator
  1705. ----
  1706. .. _class_Node_method_rpc_id:
  1707. .. rst-class:: classref-method
  1708. :ref:`Error<enum_@GlobalScope_Error>` **rpc_id**\ (\ peer_id\: :ref:`int<class_int>`, method\: :ref:`StringName<class_StringName>`, ...\ ) |vararg| :ref:`🔗<class_Node_method_rpc_id>`
  1709. Sends a :ref:`rpc()<class_Node_method_rpc>` to a specific peer identified by ``peer_id`` (see :ref:`MultiplayerPeer.set_target_peer()<class_MultiplayerPeer_method_set_target_peer>`).
  1710. May return :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` if the call is successful, :ref:`@GlobalScope.ERR_INVALID_PARAMETER<class_@GlobalScope_constant_ERR_INVALID_PARAMETER>` if the arguments passed in the ``method`` do not match, :ref:`@GlobalScope.ERR_UNCONFIGURED<class_@GlobalScope_constant_ERR_UNCONFIGURED>` if the node's :ref:`multiplayer<class_Node_property_multiplayer>` cannot be fetched (such as when the node is not inside the tree), :ref:`@GlobalScope.ERR_CONNECTION_ERROR<class_@GlobalScope_constant_ERR_CONNECTION_ERROR>` if :ref:`multiplayer<class_Node_property_multiplayer>`'s connection is not available.
  1711. .. rst-class:: classref-item-separator
  1712. ----
  1713. .. _class_Node_method_set_deferred_thread_group:
  1714. .. rst-class:: classref-method
  1715. |void| **set_deferred_thread_group**\ (\ property\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) :ref:`🔗<class_Node_method_set_deferred_thread_group>`
  1716. Similar to :ref:`call_deferred_thread_group()<class_Node_method_call_deferred_thread_group>`, but for setting properties.
  1717. .. rst-class:: classref-item-separator
  1718. ----
  1719. .. _class_Node_method_set_display_folded:
  1720. .. rst-class:: classref-method
  1721. |void| **set_display_folded**\ (\ fold\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_Node_method_set_display_folded>`
  1722. If set to ``true``, the node appears folded in the Scene dock. As a result, all of its children are hidden. This method is intended to be used in editor plugins and tools, but it also works in release builds. See also :ref:`is_displayed_folded()<class_Node_method_is_displayed_folded>`.
  1723. .. rst-class:: classref-item-separator
  1724. ----
  1725. .. _class_Node_method_set_editable_instance:
  1726. .. rst-class:: classref-method
  1727. |void| **set_editable_instance**\ (\ node\: :ref:`Node<class_Node>`, is_editable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_Node_method_set_editable_instance>`
  1728. Set to ``true`` to allow all nodes owned by ``node`` to be available, and editable, in the Scene dock, even if their :ref:`owner<class_Node_property_owner>` is not the scene root. This method is intended to be used in editor plugins and tools, but it also works in release builds. See also :ref:`is_editable_instance()<class_Node_method_is_editable_instance>`.
  1729. .. rst-class:: classref-item-separator
  1730. ----
  1731. .. _class_Node_method_set_multiplayer_authority:
  1732. .. rst-class:: classref-method
  1733. |void| **set_multiplayer_authority**\ (\ id\: :ref:`int<class_int>`, recursive\: :ref:`bool<class_bool>` = true\ ) :ref:`🔗<class_Node_method_set_multiplayer_authority>`
  1734. Sets the node's multiplayer authority to the peer with the given peer ``id``. The multiplayer authority is the peer that has authority over the node on the network. Defaults to peer ID 1 (the server). Useful in conjunction with :ref:`rpc_config()<class_Node_method_rpc_config>` and the :ref:`MultiplayerAPI<class_MultiplayerAPI>`.
  1735. If ``recursive`` is ``true``, the given peer is recursively set as the authority for all children of this node.
  1736. \ **Warning:** This does **not** automatically replicate the new authority to other peers. It is the developer's responsibility to do so. You may replicate the new authority's information using :ref:`MultiplayerSpawner.spawn_function<class_MultiplayerSpawner_property_spawn_function>`, an RPC, or a :ref:`MultiplayerSynchronizer<class_MultiplayerSynchronizer>`. Furthermore, the parent's authority does **not** propagate to newly added children.
  1737. .. rst-class:: classref-item-separator
  1738. ----
  1739. .. _class_Node_method_set_physics_process:
  1740. .. rst-class:: classref-method
  1741. |void| **set_physics_process**\ (\ enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_Node_method_set_physics_process>`
  1742. If set to ``true``, enables physics (fixed framerate) processing. When a node is being processed, it will receive a :ref:`NOTIFICATION_PHYSICS_PROCESS<class_Node_constant_NOTIFICATION_PHYSICS_PROCESS>` at a fixed (usually 60 FPS, see :ref:`Engine.physics_ticks_per_second<class_Engine_property_physics_ticks_per_second>` to change) interval (and the :ref:`_physics_process()<class_Node_private_method__physics_process>` callback will be called if it exists).
  1743. \ **Note:** If :ref:`_physics_process()<class_Node_private_method__physics_process>` is overridden, this will be automatically enabled before :ref:`_ready()<class_Node_private_method__ready>` is called.
  1744. .. rst-class:: classref-item-separator
  1745. ----
  1746. .. _class_Node_method_set_physics_process_internal:
  1747. .. rst-class:: classref-method
  1748. |void| **set_physics_process_internal**\ (\ enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_Node_method_set_physics_process_internal>`
  1749. If set to ``true``, enables internal physics for this node. Internal physics processing happens in isolation from the normal :ref:`_physics_process()<class_Node_private_method__physics_process>` calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or physics processing is disabled for scripting (:ref:`set_physics_process()<class_Node_method_set_physics_process>`).
  1750. \ **Warning:** Built-in nodes rely on internal processing for their internal logic. Disabling it is unsafe and may lead to unexpected behavior. Use this method if you know what you are doing.
  1751. .. rst-class:: classref-item-separator
  1752. ----
  1753. .. _class_Node_method_set_process:
  1754. .. rst-class:: classref-method
  1755. |void| **set_process**\ (\ enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_Node_method_set_process>`
  1756. If set to ``true``, enables processing. When a node is being processed, it will receive a :ref:`NOTIFICATION_PROCESS<class_Node_constant_NOTIFICATION_PROCESS>` on every drawn frame (and the :ref:`_process()<class_Node_private_method__process>` callback will be called if it exists).
  1757. \ **Note:** If :ref:`_process()<class_Node_private_method__process>` is overridden, this will be automatically enabled before :ref:`_ready()<class_Node_private_method__ready>` is called.
  1758. \ **Note:** This method only affects the :ref:`_process()<class_Node_private_method__process>` callback, i.e. it has no effect on other callbacks like :ref:`_physics_process()<class_Node_private_method__physics_process>`. If you want to disable all processing for the node, set :ref:`process_mode<class_Node_property_process_mode>` to :ref:`PROCESS_MODE_DISABLED<class_Node_constant_PROCESS_MODE_DISABLED>`.
  1759. .. rst-class:: classref-item-separator
  1760. ----
  1761. .. _class_Node_method_set_process_input:
  1762. .. rst-class:: classref-method
  1763. |void| **set_process_input**\ (\ enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_Node_method_set_process_input>`
  1764. If set to ``true``, enables input processing.
  1765. \ **Note:** If :ref:`_input()<class_Node_private_method__input>` is overridden, this will be automatically enabled before :ref:`_ready()<class_Node_private_method__ready>` is called. Input processing is also already enabled for GUI controls, such as :ref:`Button<class_Button>` and :ref:`TextEdit<class_TextEdit>`.
  1766. .. rst-class:: classref-item-separator
  1767. ----
  1768. .. _class_Node_method_set_process_internal:
  1769. .. rst-class:: classref-method
  1770. |void| **set_process_internal**\ (\ enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_Node_method_set_process_internal>`
  1771. If set to ``true``, enables internal processing for this node. Internal processing happens in isolation from the normal :ref:`_process()<class_Node_private_method__process>` calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or processing is disabled for scripting (:ref:`set_process()<class_Node_method_set_process>`).
  1772. \ **Warning:** Built-in nodes rely on internal processing for their internal logic. Disabling it is unsafe and may lead to unexpected behavior. Use this method if you know what you are doing.
  1773. .. rst-class:: classref-item-separator
  1774. ----
  1775. .. _class_Node_method_set_process_shortcut_input:
  1776. .. rst-class:: classref-method
  1777. |void| **set_process_shortcut_input**\ (\ enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_Node_method_set_process_shortcut_input>`
  1778. If set to ``true``, enables shortcut processing for this node.
  1779. \ **Note:** If :ref:`_shortcut_input()<class_Node_private_method__shortcut_input>` is overridden, this will be automatically enabled before :ref:`_ready()<class_Node_private_method__ready>` is called.
  1780. .. rst-class:: classref-item-separator
  1781. ----
  1782. .. _class_Node_method_set_process_unhandled_input:
  1783. .. rst-class:: classref-method
  1784. |void| **set_process_unhandled_input**\ (\ enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_Node_method_set_process_unhandled_input>`
  1785. If set to ``true``, enables unhandled input processing. It enables the node to receive all input that was not previously handled (usually by a :ref:`Control<class_Control>`).
  1786. \ **Note:** If :ref:`_unhandled_input()<class_Node_private_method__unhandled_input>` is overridden, this will be automatically enabled before :ref:`_ready()<class_Node_private_method__ready>` is called. Unhandled input processing is also already enabled for GUI controls, such as :ref:`Button<class_Button>` and :ref:`TextEdit<class_TextEdit>`.
  1787. .. rst-class:: classref-item-separator
  1788. ----
  1789. .. _class_Node_method_set_process_unhandled_key_input:
  1790. .. rst-class:: classref-method
  1791. |void| **set_process_unhandled_key_input**\ (\ enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_Node_method_set_process_unhandled_key_input>`
  1792. If set to ``true``, enables unhandled key input processing.
  1793. \ **Note:** If :ref:`_unhandled_key_input()<class_Node_private_method__unhandled_key_input>` is overridden, this will be automatically enabled before :ref:`_ready()<class_Node_private_method__ready>` is called.
  1794. .. rst-class:: classref-item-separator
  1795. ----
  1796. .. _class_Node_method_set_scene_instance_load_placeholder:
  1797. .. rst-class:: classref-method
  1798. |void| **set_scene_instance_load_placeholder**\ (\ load_placeholder\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_Node_method_set_scene_instance_load_placeholder>`
  1799. If set to ``true``, the node becomes a :ref:`InstancePlaceholder<class_InstancePlaceholder>` when packed and instantiated from a :ref:`PackedScene<class_PackedScene>`. See also :ref:`get_scene_instance_load_placeholder()<class_Node_method_get_scene_instance_load_placeholder>`.
  1800. .. rst-class:: classref-item-separator
  1801. ----
  1802. .. _class_Node_method_set_thread_safe:
  1803. .. rst-class:: classref-method
  1804. |void| **set_thread_safe**\ (\ property\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) :ref:`🔗<class_Node_method_set_thread_safe>`
  1805. Similar to :ref:`call_thread_safe()<class_Node_method_call_thread_safe>`, but for setting properties.
  1806. .. rst-class:: classref-item-separator
  1807. ----
  1808. .. _class_Node_method_set_translation_domain_inherited:
  1809. .. rst-class:: classref-method
  1810. |void| **set_translation_domain_inherited**\ (\ ) :ref:`🔗<class_Node_method_set_translation_domain_inherited>`
  1811. Makes this node inherit the translation domain from its parent node. If this node has no parent, the main translation domain will be used.
  1812. This is the default behavior for all nodes. Calling :ref:`Object.set_translation_domain()<class_Object_method_set_translation_domain>` disables this behavior.
  1813. .. rst-class:: classref-item-separator
  1814. ----
  1815. .. _class_Node_method_update_configuration_warnings:
  1816. .. rst-class:: classref-method
  1817. |void| **update_configuration_warnings**\ (\ ) :ref:`🔗<class_Node_method_update_configuration_warnings>`
  1818. Refreshes the warnings displayed for this node in the Scene dock. Use :ref:`_get_configuration_warnings()<class_Node_private_method__get_configuration_warnings>` to customize the warning messages to display.
  1819. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  1820. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  1821. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  1822. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  1823. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  1824. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  1825. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  1826. .. |void| replace:: :abbr:`void (No return value.)`