HammeriteAudioRuntime

Audio. Inherits RefCounted

Process-wide access to the audio managers, the game's sound-type table, and the bake.

The HammeriteAudio autoload is the friendly front door, but it cannot be the place this state lives. An autoload is only an identifier inside a running scene tree: a node that mentions one by name will not even compile in a headless tool script, which would put every node in this addon - and everything that tests them - out of reach of the test runner.

So the registry is static, here, and the autoload delegates to it. Same lifetime, same single instance, no dependency on the scene tree existing. A game reaches for this directly only where there is no tree to reach the autoload through: a headless bake, a CI run, a tool script.

Native since 2.0 (#269): its static variables are the static methods get_<name>() and set_<name>(), since GDScript reaches no static property of a native class, and GRAPH_KEY, AMBIENCE and SOUND_FILE are graph_key(), ambience() and sound_file(). Its inner class Changes is HammeriteAudioRuntimeChanges.

Methods

Returns	Method
`void`	`add_preset(preset: HammeriteAudioPreset)` `static`
`StringName`	`ambience()` `static`
`AudioStream`	`ambient_stream(id: String)` `static`
`HammeriteAudioBakeReport`	`bake(map: HammeriteMap)` `static`
`StringName`	`get_ambient_bus()` `static`
`Callable`	`get_ambient_resolver()` `static`
`HammeriteAudioRuntimeChanges`	`get_changes()` `static`
`HammeriteAudioManager`	`get_manager(context: Node = null)` `static`
`Callable`	`get_material_resolver()` `static`
`HammeriteAudioMaterials`	`get_materials()` `static`
`HammeriteAudioMixSettings`	`get_mix_settings()` `static`
`HammeriteAudioPreset[]`	`get_presets()` `static`
`HammeriteAudioSoundTypes`	`get_sound_types()` `static`
`HammeriteAssetLibrary`	`get_sounds()` `static`
`StringName`	`graph_key()` `static`
`HammeriteAudioMaterial`	`material_for_texture(texture_name: String)` `static`
`StringName`	`material_name_for(texture_name: String)` `static`
`void`	`register_entity_types()` `static`
`void`	`set_ambient_bus(value: StringName)` `static`
`void`	`set_ambient_resolver(value: Callable)` `static`
`void`	`set_changes(value: HammeriteAudioRuntimeChanges)` `static`
`void`	`set_material_resolver(value: Callable)` `static`
`void`	`set_materials(value: HammeriteAudioMaterials)` `static`
`void`	`set_mix_settings(value: HammeriteAudioMixSettings)` `static`
`void`	`set_presets(value: HammeriteAudioPreset[])` `static`
`void`	`set_sound_types(value: HammeriteAudioSoundTypes)` `static`
`void`	`set_sounds(value: HammeriteAssetLibrary)` `static`
`StringName`	`sound_file()` `static`
`void`	`upgrade_map(map: HammeriteMap)` `static`

Method descriptions

add_preset()

static func add_preset(preset: HammeriteAudioPreset) -> void

Undocumented.

ambience()

static func ambience() -> StringName

Undocumented.

ambient_stream()

static func ambient_stream(id: String) -> AudioStream

Undocumented.

bake()

static func bake(map: HammeriteMap) -> HammeriteAudioBakeReport

Undocumented.

get_ambient_bus()

static func get_ambient_bus() -> StringName

Undocumented.

get_ambient_resolver()

static func get_ambient_resolver() -> Callable

Undocumented.

get_changes()

static func get_changes() -> HammeriteAudioRuntimeChanges

Undocumented.

get_manager()

static func get_manager(context: Node = null) -> HammeriteAudioManager

Undocumented.

get_material_resolver()

static func get_material_resolver() -> Callable

Undocumented.

get_materials()

static func get_materials() -> HammeriteAudioMaterials

Undocumented.

get_mix_settings()

static func get_mix_settings() -> HammeriteAudioMixSettings

Undocumented.

get_presets()

static func get_presets() -> HammeriteAudioPreset[]

Undocumented.

get_sound_types()

static func get_sound_types() -> HammeriteAudioSoundTypes

Undocumented.

get_sounds()

static func get_sounds() -> HammeriteAssetLibrary

Undocumented.

graph_key()

static func graph_key() -> StringName

Undocumented.

material_for_texture()

static func material_for_texture(texture_name: String) -> HammeriteAudioMaterial

Undocumented.

material_name_for()

static func material_name_for(texture_name: String) -> StringName

Undocumented.

register_entity_types()

static func register_entity_types() -> void

Undocumented.

set_ambient_bus()

static func set_ambient_bus(value: StringName) -> void

Undocumented.

set_ambient_resolver()

static func set_ambient_resolver(value: Callable) -> void

Undocumented.

set_changes()

static func set_changes(value: HammeriteAudioRuntimeChanges) -> void

Undocumented.

set_material_resolver()

static func set_material_resolver(value: Callable) -> void

Undocumented.

set_materials()

static func set_materials(value: HammeriteAudioMaterials) -> void

Undocumented.

set_mix_settings()

static func set_mix_settings(value: HammeriteAudioMixSettings) -> void

Undocumented.

set_presets()

static func set_presets(value: HammeriteAudioPreset[]) -> void

Undocumented.

set_sound_types()

static func set_sound_types(value: HammeriteAudioSoundTypes) -> void

Undocumented.

set_sounds()

static func set_sounds(value: HammeriteAssetLibrary) -> void

Undocumented.

sound_file()

static func sound_file() -> StringName

Undocumented.

upgrade_map()

static func upgrade_map(map: HammeriteMap) -> void

Undocumented.