diff --git a/doc/classes/AcceptDialog.xml b/doc/classes/AcceptDialog.xml index eb56c9756d4..06e894fa9db 100644 --- a/doc/classes/AcceptDialog.xml +++ b/doc/classes/AcceptDialog.xml @@ -32,12 +32,14 @@ Returns the label used for built-in text. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. Returns the OK [Button] instance. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. diff --git a/doc/classes/ColorPickerButton.xml b/doc/classes/ColorPickerButton.xml index 8d06f854150..3d6c8d9e7ee 100644 --- a/doc/classes/ColorPickerButton.xml +++ b/doc/classes/ColorPickerButton.xml @@ -17,12 +17,14 @@ Returns the [ColorPicker] that this node toggles. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. Returns the control's [PopupPanel] which allows you to connect to popup signals. This allows you to handle events when the ColorPicker is shown or hidden. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. diff --git a/doc/classes/ConfirmationDialog.xml b/doc/classes/ConfirmationDialog.xml index bea073498a3..fb5ca2bb3da 100644 --- a/doc/classes/ConfirmationDialog.xml +++ b/doc/classes/ConfirmationDialog.xml @@ -17,6 +17,7 @@ Returns the cancel button. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. diff --git a/doc/classes/EditorFileDialog.xml b/doc/classes/EditorFileDialog.xml index a6c2ad994ce..15564976033 100644 --- a/doc/classes/EditorFileDialog.xml +++ b/doc/classes/EditorFileDialog.xml @@ -26,6 +26,7 @@ Returns the [code]VBoxContainer[/code] used to display the file system. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. diff --git a/doc/classes/EditorInterface.xml b/doc/classes/EditorInterface.xml index 93d2b71d18c..e5e10c1cfd1 100644 --- a/doc/classes/EditorInterface.xml +++ b/doc/classes/EditorInterface.xml @@ -28,6 +28,7 @@ Returns the main container of Godot editor's window. For example, you can use it to retrieve the size of the container and place your controls accordingly. + [b]Warning:[/b] Removing and freeing this node will render the editor useless and may cause a crash. @@ -60,18 +61,21 @@ Returns the main editor control. Use this as a parent for main screens. [b]Note:[/b] This returns the main editor control containing the whole editor, not the 2D or 3D viewports specifically. + [b]Warning:[/b] Removing and freeing this node will render a part of the editor useless and may cause a crash. Returns the editor's [FileSystemDock] instance. + [b]Warning:[/b] Removing and freeing this node will render a part of the editor useless and may cause a crash. Returns the editor's [EditorInspector] instance. + [b]Warning:[/b] Removing and freeing this node will render a part of the editor useless and may cause a crash. @@ -102,6 +106,7 @@ Returns the editor's [ScriptEditor] instance. + [b]Warning:[/b] Removing and freeing this node will render a part of the editor useless and may cause a crash. diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index 59306fdd298..50f1fa690ac 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -304,6 +304,7 @@ Gets the Editor's dialogue used for making scripts. [b]Note:[/b] Users can configure it before use. + [b]Warning:[/b] Removing and freeing this node will render a part of the editor useless and may cause a crash. diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml index bfbbaca1205..b884e7ed70a 100644 --- a/doc/classes/FileDialog.xml +++ b/doc/classes/FileDialog.xml @@ -32,12 +32,14 @@ Returns the LineEdit for the selected file. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. Returns the vertical box container of the dialog, custom controls can be added to it. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. diff --git a/doc/classes/GraphEdit.xml b/doc/classes/GraphEdit.xml index a4e457a1519..2380b30aedd 100644 --- a/doc/classes/GraphEdit.xml +++ b/doc/classes/GraphEdit.xml @@ -67,8 +67,8 @@ - Gets the [HBoxContainer] that contains the zooming and grid snap controls in the top left of the graph. - Warning: The intended usage of this function is to allow you to reposition or add your own custom controls to the container. This is an internal control and as such should not be freed. If you wish to hide this or any of its children, use their [member CanvasItem.visible] property instead. + Gets the [HBoxContainer] that contains the zooming and grid snap controls in the top left of the graph. You can use this method to reposition the toolbar or to add your own custom controls to it. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index f3b8848cc80..0e9fce82bef 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -122,6 +122,7 @@ Returns the [Object] ID associated with the list. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index c499cd34dcc..7bb84f053e3 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -65,6 +65,7 @@ Returns the [PopupMenu] of this [LineEdit]. By default, this menu is displayed when right-clicking on the [LineEdit]. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. diff --git a/doc/classes/MenuButton.xml b/doc/classes/MenuButton.xml index 26028aa6b7d..78e7e3da671 100644 --- a/doc/classes/MenuButton.xml +++ b/doc/classes/MenuButton.xml @@ -15,6 +15,7 @@ Returns the [PopupMenu] contained in this button. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. diff --git a/doc/classes/OptionButton.xml b/doc/classes/OptionButton.xml index 880763d95b4..24538399da6 100644 --- a/doc/classes/OptionButton.xml +++ b/doc/classes/OptionButton.xml @@ -84,6 +84,7 @@ Returns the [PopupMenu] contained in this button. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index a84b96cce1e..81151f854db 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -70,6 +70,7 @@ Returns the vertical scrollbar. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. diff --git a/doc/classes/ScrollContainer.xml b/doc/classes/ScrollContainer.xml index 21a656b1010..ca225bf2dfc 100644 --- a/doc/classes/ScrollContainer.xml +++ b/doc/classes/ScrollContainer.xml @@ -20,12 +20,14 @@ Returns the horizontal scrollbar [HScrollBar] of this [ScrollContainer]. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to disable the horizontal scrollbar, use [member scroll_horizontal_enabled]. If you want to only hide it instead, use its [member CanvasItem.visible] property. Returns the vertical scrollbar [VScrollBar] of this [ScrollContainer]. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to disable the vertical scrollbar, use [member scroll_vertical_enabled]. If you want to only hide it instead, use its [member CanvasItem.visible] property. diff --git a/doc/classes/SpinBox.xml b/doc/classes/SpinBox.xml index 8b871e24b86..2b89e82f6bf 100644 --- a/doc/classes/SpinBox.xml +++ b/doc/classes/SpinBox.xml @@ -30,6 +30,7 @@ Returns the [LineEdit] instance from this [SpinBox]. You can use it to access properties and methods of [LineEdit]. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. diff --git a/doc/classes/TabContainer.xml b/doc/classes/TabContainer.xml index 764a9c7d5f9..caf08fafb73 100644 --- a/doc/classes/TabContainer.xml +++ b/doc/classes/TabContainer.xml @@ -20,6 +20,7 @@ Returns the [Popup] node instance if one has been set already with [method set_popup]. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 09bbbd85fa5..1f856eb8723 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -147,6 +147,7 @@ Returns the [PopupMenu] of this [TextEdit]. By default, this menu is displayed when right-clicking on the [TextEdit]. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. diff --git a/doc/classes/WindowDialog.xml b/doc/classes/WindowDialog.xml index 28af4770e7a..f41ec9f9745 100644 --- a/doc/classes/WindowDialog.xml +++ b/doc/classes/WindowDialog.xml @@ -13,6 +13,7 @@ Returns the close [TextureButton]. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property.