AudioEffect

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
	AsAudioEffect() 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 (self *Extension[T]) AsAudioEffect() Instance

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

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

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 ID) Instance() (Instance, bool)

type Implementation ¶

type Implementation = implementation

Implementation implements Interface with empty methods.

type Instance ¶

type Instance [1]gdclass.AudioEffect

The base [Resource] for every audio effect. In the editor, an audio effect can be added to the current bus layout through the Audio panel. At run-time, it is also possible to manipulate audio effects through [method AudioServer.add_bus_effect], [method AudioServer.remove_bus_effect], and [method AudioServer.get_bus_effect]. When applied on a bus, an audio effect creates a corresponding [AudioEffectInstance]. The instance is directly responsible for manipulating the sound, based on the original audio effect's properties.

See [Interface] for methods that can be overridden by a [Class] that extends it.

var Nil Instance

func New() Instance

func (self Instance) AsAudioEffect() Instance

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

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

func (self Instance) AsResource() Resource.Instance

func (self Instance) ID() ID

func (self *Instance) UnsafePointer() unsafe.Pointer

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

type Interface ¶

type Interface interface {
	//Override this method to customize the [AudioEffectInstance] created when this effect is applied on a bus in the editor's Audio panel, or through [method AudioServer.add_bus_effect].
	//[codeblock]
	//extends AudioEffect
	//
	//@export var strength = 4.0
	//
	//func _instantiate():
	//    var effect = CustomAudioEffectInstance.new()
	//    effect.base = self
	//
	//    return effect
	//[/codeblock]
	//[b]Note:[/b] It is recommended to keep a reference to the original [AudioEffect] in the new instance. Depending on the implementation this allows the effect instance to listen for changes at run-time and be modified accordingly.
	Instantiate() AudioEffectInstance.Instance
}