diff options
| author | kobewi <kobewi4e@gmail.com> | 2022-09-05 18:34:52 +0200 |
|---|---|---|
| committer | kobewi <kobewi4e@gmail.com> | 2022-09-05 18:34:52 +0200 |
| commit | 229e76429059b32edd43cd2382723d71a815f296 (patch) | |
| tree | 59d823962dbe034fa47c098cb80a4ea1c460dd79 | |
| parent | 90801a415314f29eb5c590f85a7751443e54b83a (diff) | |
Improve the description of follow_viewport_enabled
| -rw-r--r-- | doc/classes/CanvasLayer.xml | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/CanvasLayer.xml b/doc/classes/CanvasLayer.xml index 555137ac45..50c0860d1f 100644 --- a/doc/classes/CanvasLayer.xml +++ b/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. </member> <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 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. |