Documentation
¶
Overview ¶
A ParallaxLayer must be the child of a ParallaxBackground node. Each ParallaxLayer can be set to move at different speeds relative to the camera movement or the ParallaxBackground.ScrollOffset value.
This node's children will be affected by its scroll offset.
Note: Any changes to this node's position and scale made after it enters the scene will be ignored.
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) AsParallaxLayer() Instance
- func (self Instance) ID() ID
- func (self Instance) MotionMirroring() Vector2.XY
- func (self Instance) MotionOffset() Vector2.XY
- func (self Instance) MotionScale() Vector2.XY
- func (self Instance) SetMotionMirroring(value Vector2.XY)
- func (self Instance) SetMotionOffset(value Vector2.XY)
- func (self Instance) SetMotionScale(value Vector2.XY)
- func (self *Instance) SetObject(obj [1]gd.Object) 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]) AsParallaxLayer ¶
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.ParallaxLayer
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) AsParallaxLayer ¶
func (Instance) MotionMirroring ¶
The interval, in pixels, at which the ParallaxLayer is drawn repeatedly. Useful for creating an infinitely scrolling background. If an axis is set to 0, the ParallaxLayer will be drawn only once along that direction.
Note: If you want the repetition to pixel-perfect match a Texture2D displayed by a child node, you should account for any scale applied to the texture when defining this interval. For example, if you use a child Sprite2D scaled to 0.5 to display a 600x600 texture, and want this sprite to be repeated continuously horizontally, you should set the mirroring to Vector2(300, 0).
Note: If the length of the viewport axis is bigger than twice the repeated axis size, it will not repeat infinitely, as the parallax layer only draws 2 instances of the layer at any given time. The visibility window is calculated from the parent ParallaxBackground's position, not the layer's own position. So, if you use mirroring, do not change the ParallaxLayer position relative to its parent. Instead, if you need to adjust the background's position, set the CanvasLayer.Offset property in the parent ParallaxBackground.
Note: Despite the name, the layer will not be mirrored, it will only be repeated.
func (Instance) MotionOffset ¶
The ParallaxLayer's offset relative to the parent ParallaxBackground's ParallaxBackground.ScrollOffset.
func (Instance) MotionScale ¶
Multiplies the ParallaxLayer's motion. If an axis is set to 0, it will not scroll.
func (Instance) SetMotionMirroring ¶
SetMotionMirroring sets the property returned by [GetMirroring].
func (Instance) SetMotionOffset ¶
SetMotionOffset sets the property returned by [GetMotionOffset].
func (Instance) SetMotionScale ¶
SetMotionScale sets the property returned by [GetMotionScale].
Source Files