godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve visibility documentation for CanvasItem and Node3D 

This closes https://github.com/godotengine/godot-docs/issues/3840.
This commit is contained in:
Hugo Locurcio 2020-07-27 12:09:51 +02:00
parent 1ab0644532
commit 27b09dfc44
2 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/classes/CanvasItem.xml
View File

@ -525,7 +525,7 @@
<return type="bool"> <return type="bool">
</return> </return>
<description> <description>
Returns [code]true[/code] if the node is present in the [SceneTree], its [member visible] property is [code]true[/code] and its inherited visibility is also [code]true[/code]. Returns [code]true[/code] if the node is present in the [SceneTree], its [member visible] property is [code]true[/code] and all its antecedents are also visible. If any antecedent is hidden, this node will not be visible in the scene tree.
</description> </description>
</method> </method>
<method name="make_canvas_position_local" qualifiers="const"> <method name="make_canvas_position_local" qualifiers="const">
@ -617,7 +617,8 @@
If [code]true[/code], the parent [CanvasItem]'s [member material] property is used as this one's material. If [code]true[/code], the parent [CanvasItem]'s [member material] property is used as this one's material.
</member> </member>
<member name="visible" type="bool" setter="set_visible" getter="is_visible" default="true"> <member name="visible" type="bool" setter="set_visible" getter="is_visible" default="true">
If [code]true[/code], this [CanvasItem] is drawn. For controls that inherit [Popup], the correct way to make them visible is to call one of the multiple [code]popup*()[/code] functions instead. If [code]true[/code], this [CanvasItem] is drawn. The node is only visible if all of its antecedents are visible as well (in other words, [method is_visible_in_tree] must return [code]true[/code]).
[b]Note:[/b] For controls that inherit [Popup], the correct way to make them visible is to call one of the multiple [code]popup*()[/code] functions instead.
</member> </member>
</members> </members>
<signals> <signals>

4
doc/classes/Node3D.xml
View File

@ -101,7 +101,7 @@
<return type="bool"> <return type="bool">
</return> </return>
<description> <description>
Returns whether the node is visible, taking into consideration that its parents visibility. Returns [code]true[/code] if the node is present in the [SceneTree], its [member visible] property is [code]true[/code] and all its antecedents are also visible. If any antecedent is hidden, this node will not be visible in the scene tree.
</description> </description>
</method> </method>
<method name="look_at"> <method name="look_at">
@ -323,7 +323,7 @@
Local translation of this node. Local translation of this node.
</member> </member>
<member name="visible" type="bool" setter="set_visible" getter="is_visible" default="true"> <member name="visible" type="bool" setter="set_visible" getter="is_visible" default="true">
If [code]true[/code], this node is drawn. If [code]true[/code], this node is drawn. The node is only visible if all of its antecedents are visible as well (in other words, [method is_visible_in_tree] must return [code]true[/code]).
</member> </member>
</members> </members>
<signals> <signals>