summaryrefslogtreecommitdiff
path: root/doc/classes/VisibilityNotifier2D.xml
blob: 1058e3d6d4a887b25c3effa1580584ed11e5f5bf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisibilityNotifier2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build">
	<brief_description>
		Detect when the node is visible on screen.
	</brief_description>
	<description>
		The VisibilityNotifier2D is used to notify when its bounding rectangle enters the screen, is visible on the screen, or when it exits the screen.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_rect" qualifiers="const">
			<return type="Rect2">
			</return>
			<description>
				Return the visibility bounding rectangle of the VisibilityNotifier2D.
			</description>
		</method>
		<method name="is_on_screen" qualifiers="const">
			<return type="bool">
			</return>
			<description>
				Return true if any part of the bounding rectangle is on the screen.
			</description>
		</method>
		<method name="set_rect">
			<return type="void">
			</return>
			<argument index="0" name="rect" type="Rect2">
			</argument>
			<description>
				Set the visibility bounding rectangle of the VisibilityNotifier2D.
			</description>
		</method>
	</methods>
	<members>
		<member name="rect" type="Rect2" setter="set_rect" getter="get_rect">
		</member>
	</members>
	<signals>
		<signal name="screen_entered">
			<description>
				Emitted when the VisibilityNotifier2D enters the screen.
			</description>
		</signal>
		<signal name="screen_exited">
			<description>
				Emitted when the VisibilityNotifier2D exits the screen.
			</description>
		</signal>
		<signal name="viewport_entered">
			<argument index="0" name="viewport" type="Object">
			</argument>
			<description>
				Emitted when the VisibilityNotifier2D enters a [Viewport]'s view.
			</description>
		</signal>
		<signal name="viewport_exited">
			<argument index="0" name="viewport" type="Object">
			</argument>
			<description>
				Emitted when the VisibilityNotifier2D exits a [Viewport]'s view.
			</description>
		</signal>
	</signals>
	<constants>
	</constants>
</class>