ParallaxBackground

package
v0.0.0-...-a66c66c Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 12, 2025 License: MIT Imports: 25 Imported by: 0

Documentation

Overview

Package ParallaxBackground provides methods for working with ParallaxBackground object instances.

Index

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 Any

type Any interface {
	gd.IsClass
	AsParallaxBackground() Instance
}

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

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]) AsNode

func (self *Extension[T]) AsNode() Node.Instance

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsParallaxBackground

func (self *Extension[T]) AsParallaxBackground() Instance

type ID

type ID Object.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.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

type Instance

type Instance [1]gdclass.ParallaxBackground

A ParallaxBackground uses one or more [ParallaxLayer] child nodes to create a parallax effect. Each [ParallaxLayer] can move at a different speed using [member ParallaxLayer.motion_offset]. This creates an illusion of depth in a 2D game. If not used with a [Camera2D], you must manually calculate the [member scroll_offset]. [b]Note:[/b] Each [ParallaxBackground] is drawn on one specific [Viewport] and cannot be shared between multiple [Viewport]s, see [member CanvasLayer.custom_viewport]. When using multiple [Viewport]s, for example in a split-screen game, you need create an individual [ParallaxBackground] for each [Viewport] you want it to be drawn on.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AsCanvasLayer

func (self Instance) AsCanvasLayer() CanvasLayer.Instance

func (Instance) AsNode

func (self Instance) AsNode() Node.Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsParallaxBackground

func (self Instance) AsParallaxBackground() Instance

func (Instance) ID

func (self Instance) ID() ID

func (Instance) ScrollBaseOffset

func (self Instance) ScrollBaseOffset() Vector2.XY

func (Instance) ScrollBaseScale

func (self Instance) ScrollBaseScale() Vector2.XY

func (Instance) ScrollIgnoreCameraZoom

func (self Instance) ScrollIgnoreCameraZoom() bool

func (Instance) ScrollLimitBegin

func (self Instance) ScrollLimitBegin() Vector2.XY

func (Instance) ScrollLimitEnd

func (self Instance) ScrollLimitEnd() Vector2.XY

func (Instance) ScrollOffset

func (self Instance) ScrollOffset() Vector2.XY

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) SetScrollBaseOffset

func (self Instance) SetScrollBaseOffset(value Vector2.XY)

func (Instance) SetScrollBaseScale

func (self Instance) SetScrollBaseScale(value Vector2.XY)

func (Instance) SetScrollIgnoreCameraZoom

func (self Instance) SetScrollIgnoreCameraZoom(value bool)

func (Instance) SetScrollLimitBegin

func (self Instance) SetScrollLimitBegin(value Vector2.XY)

func (Instance) SetScrollLimitEnd

func (self Instance) SetScrollLimitEnd(value Vector2.XY)

func (Instance) SetScrollOffset

func (self Instance) SetScrollOffset(value Vector2.XY)

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL