HammeriteAudioBrushProperties

Audio. Inherits RefCounted

The acoustic character of a room, authored on the air brush that carves it.

In the subtractive world an air brush IS a room and the compiler already derives which rooms exist and which openings join them. What it cannot derive is intent: whether a courtyard should be treated as open sky, how much weather gets into a covered alley, whether a chamber should ring like stone or be deadened like a carpeted study. Those are authoring decisions, and before this schema existed there was nowhere on a brush to put them - which is why acoustics needed a parallel world of hand-placed zone entities to hold them.

So: hammerite-audio declares them, core stores them sparsely on the brush, and the audio graph reads them off the cells. Core never learns what a reverb preset is.

Every property AUTO-derives by default, so an author who places nothing and touches nothing still gets a working graph - the overrides exist for the cases derivation gets wrong.

Schema id, and therefore the namespace of every key below.

Native since 2.0 (#269): SCHEMA_ID and the KEY_ constants are static methods of the same names in lower case; PRESET_AUTO, an integer, stays.

Methods

Returns	Method
`int`	`get_preset(brush: HammeriteBrush)` `static`
`bool`	`is_excluded(map: HammeriteMap, cell: HammeriteCell)` `static`
`StringName`	`key_ambient()` `static`
`StringName`	`key_ambient_volume()` `static`
`StringName`	`key_exclude()` `static`
`StringName`	`key_preset()` `static`
`StringName`	`key_weather_exposure()` `static`
`StringName`	`key_zone_type()` `static`
`int`	`preset_id_for_cell(map: HammeriteMap, cell: HammeriteCell)` `static`
`void`	`register()` `static`
`StringName`	`schema_id()` `static`
`bool`	`set_preset(brush: HammeriteBrush, preset_id: int)` `static`
`float`	`weather_exposure_for_cell(map: HammeriteMap, cell: HammeriteCell)` `static`
`int`	`zone_type_for_cell(map: HammeriteMap, cell: HammeriteCell)` `static`

Enumerations

enum ZoneTypeChoice

Value	Name	Description
`0`	`AUTO`
`1`	`INTERIOR`
`2`	`EXTERIOR`
`3`	`SEMI_EXTERIOR`

Constants

PRESET_AUTO

const PRESET_AUTO = -1

Undocumented.

Method descriptions

get_preset()

static func get_preset(brush: HammeriteBrush) -> int

Undocumented.

is_excluded()

static func is_excluded(map: HammeriteMap, cell: HammeriteCell) -> bool

Undocumented.

key_ambient()

static func key_ambient() -> StringName

Undocumented.

key_ambient_volume()

static func key_ambient_volume() -> StringName

Undocumented.

key_exclude()

static func key_exclude() -> StringName

Undocumented.

key_preset()

static func key_preset() -> StringName

Undocumented.

key_weather_exposure()

static func key_weather_exposure() -> StringName

Undocumented.

key_zone_type()

static func key_zone_type() -> StringName

Undocumented.

preset_id_for_cell()

static func preset_id_for_cell(map: HammeriteMap, cell: HammeriteCell) -> int

Undocumented.

register()

static func register() -> void

Undocumented.

schema_id()

static func schema_id() -> StringName

Undocumented.

set_preset()

static func set_preset(brush: HammeriteBrush, preset_id: int) -> bool

Undocumented.

weather_exposure_for_cell()

static func weather_exposure_for_cell(map: HammeriteMap, cell: HammeriteCell) -> float

Undocumented.

zone_type_for_cell()

static func zone_type_for_cell(map: HammeriteMap, cell: HammeriteCell) -> int

Undocumented.