diff options
Diffstat (limited to 'doc/classes/VisibilityNotifier2D.xml')
-rw-r--r-- | doc/classes/VisibilityNotifier2D.xml | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/doc/classes/VisibilityNotifier2D.xml b/doc/classes/VisibilityNotifier2D.xml new file mode 100644 index 0000000000..86227a0277 --- /dev/null +++ b/doc/classes/VisibilityNotifier2D.xml @@ -0,0 +1,71 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisibilityNotifier2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Detects when the node is visible on screen. + </brief_description> + <description> + The VisibilityNotifier2D detects when it is visible on the screen. It also notifies when its bounding rectangle enters or exits the screen or a viewport. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_rect" qualifiers="const"> + <return type="Rect2"> + </return> + <description> + Returns the bounding rectangle of the VisibilityNotifier2D. + </description> + </method> + <method name="is_on_screen" qualifiers="const"> + <return type="bool"> + </return> + <description> + If [code]true[/code] 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"> + The VisibilityNotifier2D's bounding rectangle. + </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> |