diff options
| author | reduz <reduzio@gmail.com> | 2021-06-16 21:52:30 -0300 |
|---|---|---|
| committer | reduz <reduzio@gmail.com> | 2021-06-16 22:01:39 -0300 |
| commit | ab2456b7406d34bb446033de6ce76096f4502c9e (patch) | |
| tree | be50809d959c59d4378a79e7792308bc47c0cc8c /doc/classes/VisibleOnScreenNotifier2D.xml | |
| parent | bb4c464fecae268a419a91db8eec8f525e904b45 (diff) | |
| download | redot-engine-ab2456b7406d34bb446033de6ce76096f4502c9e.tar.gz | |
Rename VisibilityNotifierXD to VisibleOnScreenNotifierXD
* Renames for 2D and 3D
* Class name was confusing, given both 2D and 3D have a "visible" property that is unrelated to actual on-screen visibility.
* New name makes it clear that this is about visibility on screen.
Diffstat (limited to 'doc/classes/VisibleOnScreenNotifier2D.xml')
| -rw-r--r-- | doc/classes/VisibleOnScreenNotifier2D.xml | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/classes/VisibleOnScreenNotifier2D.xml b/doc/classes/VisibleOnScreenNotifier2D.xml new file mode 100644 index 0000000000..f2f3bc9144 --- /dev/null +++ b/doc/classes/VisibleOnScreenNotifier2D.xml @@ -0,0 +1,42 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisibleOnScreenNotifier2D" inherits="Node2D" version="4.0"> + <brief_description> + Detects when the node extents are visible on screen. + </brief_description> + <description> + The VisibleOnScreenNotifier2D detects when it is visible on the screen. It also notifies when its bounding rectangle enters or exits the screen or a viewport. + If you want nodes to be disabled automatically when they exit the screen, use [VisibleOnScreenEnabler2D] instead. + </description> + <tutorials> + <link title="2D Dodge The Creeps Demo">https://godotengine.org/asset-library/asset/515</link> + </tutorials> + <methods> + <method name="is_on_screen" qualifiers="const"> + <return type="bool"> + </return> + <description> + If [code]true[/code], the bounding rectangle is on the screen. + [b]Note:[/b] It takes one frame for the node's visibility to be assessed once added to the scene tree, so this method will return [code]false[/code] right after it is instantiated, even if it will be on screen in the draw pass. + </description> + </method> + </methods> + <members> + <member name="rect" type="Rect2" setter="set_rect" getter="get_rect" default="Rect2( -10, -10, 20, 20 )"> + The VisibleOnScreenNotifier2D's bounding rectangle. + </member> + </members> + <signals> + <signal name="screen_entered"> + <description> + Emitted when the VisibleOnScreenNotifier2D enters the screen. + </description> + </signal> + <signal name="screen_exited"> + <description> + Emitted when the VisibleOnScreenNotifier2D exits the screen. + </description> + </signal> + </signals> + <constants> + </constants> +</class> |