Documentation
¶
Overview ¶
VisibleOnScreenNotifier2D represents a rectangular region of 2D space. When any part of this region becomes visible on screen or in a viewport, it will emit a OnScreenEntered signal, and likewise it will emit a OnScreenExited signal when no part of it remains visible.
If you want a node to be enabled automatically when this region is visible on screen, use VisibleOnScreenEnabler2D.
Note: VisibleOnScreenNotifier2D uses the render culling code to determine whether it's visible on screen, so it won't function unless CanvasItem.Visible is set to true.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsCanvasItem() CanvasItem.Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsNode2D() Node2D.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsVisibleOnScreenNotifier2D() Instance
- func (self Instance) ID() ID
- func (self Instance) IsOnScreen() bool
- func (self Instance) OnScreenEntered(cb func(), flags ...Signal.Flags)
- func (self Instance) OnScreenExited(cb func(), flags ...Signal.Flags)
- func (self Instance) Rect() Rect2.PositionSize
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetRect(value Rect2.PositionSize)
- func (self Instance) SetShowRect(value bool)
- func (self Instance) ShowRect() bool
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsCanvasItem ¶
func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance
func (*Extension[T]) AsVisibleOnScreenNotifier2D ¶
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
type Instance [1]gdclass.VisibleOnScreenNotifier2D
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsCanvasItem ¶
func (self Instance) AsCanvasItem() CanvasItem.Instance
func (Instance) AsVisibleOnScreenNotifier2D ¶
func (Instance) IsOnScreen ¶
If true, the bounding rectangle is on the screen.
Note: It takes one frame for the VisibleOnScreenNotifier2D's visibility to be determined once added to the scene tree, so this method will always return false right after it is instantiated, before the draw pass.
func (Instance) OnScreenEntered ¶
func (Instance) OnScreenExited ¶
func (Instance) Rect ¶
func (self Instance) Rect() Rect2.PositionSize
func (Instance) SetRect ¶
func (self Instance) SetRect(value Rect2.PositionSize)
Source Files