OccluderPolygon2D

package
v0.0.0-...-357ca8a Latest Latest
Warning

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

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

Documentation

Overview

Editor facility that helps you draw a 2D polygon used as resource for LightOccluder2D.

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
	AsOccluderPolygon2D() Instance
}

type CullMode

type CullMode int //gd:OccluderPolygon2D.CullMode
const (
	// Culling is disabled. See [CullMode].
	//
	// [CullMode]: https://pkg.go.dev/graphics.gd/classdb/#Instance.CullMode
	CullDisabled CullMode = 0
	// Culling is performed in the clockwise direction. See [CullMode].
	//
	// [CullMode]: https://pkg.go.dev/graphics.gd/classdb/#Instance.CullMode
	CullClockwise CullMode = 1
	// Culling is performed in the counterclockwise direction. See [CullMode].
	//
	// [CullMode]: https://pkg.go.dev/graphics.gd/classdb/#Instance.CullMode
	CullCounterClockwise CullMode = 2
)

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

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

func (*Extension[T]) AsOccluderPolygon2D

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

func (*Extension[T]) AsRefCounted

func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted

func (*Extension[T]) AsResource

func (self *Extension[T]) AsResource() Resource.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.OccluderPolygon2D

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 New

func New() Instance

func (Instance) AsObject

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

func (Instance) AsOccluderPolygon2D

func (self Instance) AsOccluderPolygon2D() Instance

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) AsResource

func (self Instance) AsResource() Resource.Instance

func (Instance) Closed

func (self Instance) Closed() bool

If true, closes the polygon. A closed OccluderPolygon2D occludes the light coming from any direction. An opened OccluderPolygon2D occludes the light only at its outline's direction.

func (Instance) CullMode

func (self Instance) CullMode() CullMode

The culling mode to use.

func (Instance) ID

func (self Instance) ID() ID

func (Instance) Polygon

func (self Instance) Polygon() []Vector2.XY

A Vector2.XY array with the index for polygon's vertices positions.

func (Instance) SetClosed

func (self Instance) SetClosed(value bool)

SetClosed sets the property returned by [IsClosed].

func (Instance) SetCullMode

func (self Instance) SetCullMode(value CullMode)

SetCullMode sets the property returned by [GetCullMode].

func (*Instance) SetObject

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

func (Instance) SetPolygon

func (self Instance) SetPolygon(value []Vector2.XY)

SetPolygon sets the property returned by [GetPolygon].

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