SCRIPTING API / Audio / AudioListener

AudioListener

Script access to an entity's Audio Listener, the ears of the scene.

Kindclass

NamespaceKroys.EngineScripting

Members5

SourceGenerated/NativeComponents.g.cs, NativeComponents.cs

DECLARATION

Declaration

Component access: every member takes the entity first, for example AudioListener.Has(Entity). The values are the ones the Inspector shows for this component.

Declaration

public static partial class AudioListener

REFERENCE

Members

Methods

#public static bool Has(Entity e)

Whether the entity has a Audio Listener component.

methodstatic

#public static bool IsEnabled(Entity e)

Reads the Audio Listener component's Enabled value of the entity.

methodstatic

#public static void SetEnabled(Entity e, bool value)

Sets the Audio Listener component's Enabled value on the entity.

methodstatic

#public static float GetGain(Entity e)

Reads the Audio Listener component's Gain value of the entity.

methodstatic

#public static void SetGain(Entity e, float value)

Sets the Audio Listener component's Gain value on the entity.

methodstatic

Signatures

public static bool Has(Entity e)
public static bool IsEnabled(Entity e)
public static void SetEnabled(Entity e, bool value)
public static float GetGain(Entity e)
public static void SetGain(Entity e, float value)

KroysEngine 0.1.0 documentation, built from the engine repository by Tools/BuildDocsSite.py.