Documentation
¶
Overview ¶
Once added to the scene tree and enabled using MakeCurrent, this node will override the location sounds are heard from. This can be used to listen from a location different from the Camera3D.
Index ¶
- type Advanced
- type Any
- type DopplerTracking
- type Extension
- type ID
- type Instance
- func (self Instance) AsAudioListener3D() Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsNode3D() Node3D.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) ClearCurrent()
- func (self Instance) DopplerTracking() DopplerTracking
- func (self Instance) GetListenerTransform() Transform3D.BasisOrigin
- func (self Instance) ID() ID
- func (self Instance) IsCurrent() bool
- func (self Instance) MakeCurrent()
- func (self Instance) SetDopplerTracking(value DopplerTracking)
- 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 DopplerTracking ¶
type DopplerTracking int //gd:AudioListener3D.DopplerTracking
const ( // Disables [Doppler effect] simulation (default). // // [Doppler effect]: https://en.wikipedia.org/wiki/Doppler_effect DopplerTrackingDisabled DopplerTracking = 0 // Simulate [Doppler effect] by tracking positions of objects that are changed in _process. Changes in the relative velocity of this listener compared to those objects affect how audio is perceived (changing the audio's [AudioStreamPlayer3D.PitchScale]). // // [AudioStreamPlayer3D.PitchScale]: https://pkg.go.dev/graphics.gd/classdb/AudioStreamPlayer3D#Instance.PitchScale // [Doppler effect]: https://en.wikipedia.org/wiki/Doppler_effect DopplerTrackingIdleStep DopplerTracking = 1 // Simulate [Doppler effect] by tracking positions of objects that are changed in _physics_process. Changes in the relative velocity of this listener compared to those objects affect how audio is perceived (changing the audio's [AudioStreamPlayer3D.PitchScale]). // // [AudioStreamPlayer3D.PitchScale]: https://pkg.go.dev/graphics.gd/classdb/AudioStreamPlayer3D#Instance.PitchScale // [Doppler effect]: https://en.wikipedia.org/wiki/Doppler_effect DopplerTrackingPhysicsStep DopplerTracking = 2 )
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]) AsAudioListener3D ¶
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.AudioListener3D
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) AsAudioListener3D ¶
func (Instance) ClearCurrent ¶
func (self Instance) ClearCurrent()
Disables the listener to use the current camera's listener instead.
func (Instance) DopplerTracking ¶
func (self Instance) DopplerTracking() DopplerTracking
func (Instance) GetListenerTransform ¶
func (self Instance) GetListenerTransform() Transform3D.BasisOrigin
Returns the listener's global orthonormalized Transform3D.BasisOrigin.
func (Instance) IsCurrent ¶
Returns true if the listener was made current using MakeCurrent, false otherwise.
Note: There may be more than one AudioListener3D marked as "current" in the scene tree, but only the one that was made current last will be used.
func (Instance) MakeCurrent ¶
func (self Instance) MakeCurrent()
Enables the listener. This will override the current camera's listener.
func (Instance) SetDopplerTracking ¶
func (self Instance) SetDopplerTracking(value DopplerTracking)
Source Files