Documentation
¶
Overview ¶
A ParallaxBackground uses one or more graphics.gd/classdb/ParallaxLayer child nodes to create a parallax effect. Each graphics.gd/classdb/ParallaxLayer can move at a different speed using graphics.gd/classdb/ParallaxLayer.Instance.MotionOffset. This creates an illusion of depth in a 2D game. If not used with a graphics.gd/classdb/Camera2D, you must manually calculate the Instance.ScrollOffset.
Note: Each graphics.gd/classdb/ParallaxBackground is drawn on one specific graphics.gd/classdb/Viewport and cannot be shared between multiple [graphics.gd/classdb/Viewport]s, see graphics.gd/classdb/CanvasLayer.Instance.CustomViewport. When using multiple [graphics.gd/classdb/Viewport]s, for example in a split-screen game, you need create an individual graphics.gd/classdb/ParallaxBackground for each graphics.gd/classdb/Viewport you want it to be drawn on.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsCanvasLayer() CanvasLayer.Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsParallaxBackground() Instance
- func (self Instance) ID() ID
- func (self Instance) ScrollBaseOffset() Vector2.XY
- func (self Instance) ScrollBaseScale() Vector2.XY
- func (self Instance) ScrollIgnoreCameraZoom() bool
- func (self Instance) ScrollLimitBegin() Vector2.XY
- func (self Instance) ScrollLimitEnd() Vector2.XY
- func (self Instance) ScrollOffset() Vector2.XY
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetScrollBaseOffset(value Vector2.XY)
- func (self Instance) SetScrollBaseScale(value Vector2.XY)
- func (self Instance) SetScrollIgnoreCameraZoom(value bool)
- func (self Instance) SetScrollLimitBegin(value Vector2.XY)
- func (self Instance) SetScrollLimitEnd(value Vector2.XY)
- func (self Instance) SetScrollOffset(value Vector2.XY)
- 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]) AsCanvasLayer ¶
func (self *Extension[T]) AsCanvasLayer() CanvasLayer.Instance
func (*Extension[T]) AsParallaxBackground ¶
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.ParallaxBackground
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) AsCanvasLayer ¶
func (self Instance) AsCanvasLayer() CanvasLayer.Instance
Source Files