Browse Source

Merge pull request #65371 from KoBeWi/pseudolayers

Improve the description of follow_viewport_enabled
Rémi Verschelde 3 years ago
parent
commit
f1f3b084ce
1 changed files with 2 additions and 1 deletions
  1. 2 1
      doc/classes/CanvasLayer.xml

+ 2 - 1
doc/classes/CanvasLayer.xml

@@ -36,7 +36,8 @@
 			The custom [Viewport] node assigned to the [CanvasLayer]. If [code]null[/code], uses the default viewport instead.
 			The custom [Viewport] node assigned to the [CanvasLayer]. If [code]null[/code], uses the default viewport instead.
 		</member>
 		</member>
 		<member name="follow_viewport_enabled" type="bool" setter="set_follow_viewport" getter="is_following_viewport" default="false">
 		<member name="follow_viewport_enabled" type="bool" setter="set_follow_viewport" getter="is_following_viewport" default="false">
-			Sets the layer to follow the viewport in order to simulate a pseudo 3D effect.
+			If enabled, the [CanvasLayer] will use the viewport's transform, so it will move when camera moves instead of being anchored in a fixed position on the screen.
+			Together with [member follow_viewport_scale] it can be used for a pseudo 3D effect.
 		</member>
 		</member>
 		<member name="follow_viewport_scale" type="float" setter="set_follow_viewport_scale" getter="get_follow_viewport_scale" default="1.0">
 		<member name="follow_viewport_scale" type="float" setter="set_follow_viewport_scale" getter="get_follow_viewport_scale" default="1.0">
 			Scales the layer when using [member follow_viewport_enabled]. Layers moving into the foreground should have increasing scales, while layers moving into the background should have decreasing scales.
 			Scales the layer when using [member follow_viewport_enabled]. Layers moving into the foreground should have increasing scales, while layers moving into the background should have decreasing scales.