AudioListener2D

Overrides the location sounds are heard from.

1.0.0

class AudioListener2DReckfellSharpInherits Entity2D

Overrides the location sounds are heard from.

Once added to the scene tree and enabled using AudioListener2D.MakeCurrent, this node will override the location sounds are heard from. Only one AudioListener2D can be current. Using AudioListener2D.MakeCurrent will disable the previous AudioListener2D. If there is no active AudioListener2D in the current Viewport, center of the screen will be used as a hearing point for the audio. AudioListener2D needs to be inside EntityTree to function.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

AudioListener2DConstructor

C#
public AudioListener2D();

ClearCurrentvoid

C#
public void ClearCurrent();

Disables the AudioListener2D. If it's not set as current, this method will have no effect.

IsCurrentbool

C#
public bool IsCurrent();

Returns true if this AudioListener2D is currently active.

Returns bool

MakeCurrentvoid

C#
public void MakeCurrent();

Makes the AudioListener2D active, setting it as the hearing point for the sounds. If there is already another active AudioListener2D, it will be disabled. This method will have no effect if the AudioListener2D is not added to EntityTree.

Reckfell Engine documentationBack to top ↑