diff options
| author | PouleyKetchoupp <pouleyketchoup@gmail.com> | 2019-10-17 12:20:35 +0200 |
|---|---|---|
| committer | PouleyKetchoupp <pouleyketchoup@gmail.com> | 2019-10-17 12:20:35 +0200 |
| commit | 139c0a4afe5c1de7ada982928438650070866847 (patch) | |
| tree | 389a6dd5ba08cff9317be2e60532fe42bbb38ead /doc/classes | |
| parent | 26bbb26738ec94d2f74ad866b79e5f44ca62ca75 (diff) | |
Expose Node::update_configuration_warning() to scripts
This method can be used to generate custom node warnings by script.
Node::_get_configuration_warning was already exposed to generate custom warnings, but it wasn't fully usable without being able to notify the scene tree when the warning needs to appear or change.
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/Node.xml | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index b206d4a4d2..1f685aab81 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -40,8 +40,9 @@ <return type="String"> </return> <description> - The string returned from this method is displayed as a warning in the "Scene Dock" if the script that overrides it is a [code]tool[/code] script. + The string returned from this method is displayed as a warning in the Scene Dock if the script that overrides it is a [code]tool[/code] script. Returning an empty string produces no warning. + Call [method update_configuration_warning] when the warning needs to be updated for this node. </description> </method> <method name="_input" qualifiers="virtual"> @@ -818,6 +819,14 @@ Sets whether this is an instance load placeholder. See [InstancePlaceholder]. </description> </method> + <method name="update_configuration_warning"> + <return type="void"> + </return> + <description> + Updates the warning displayed for this node in the Scene Dock. + Use [method _get_configuration_warning] to setup the warning message to display. + </description> + </method> </methods> <members> <member name="custom_multiplayer" type="MultiplayerAPI" setter="set_custom_multiplayer" getter="get_custom_multiplayer"> |