HammeriteAudioBakeReport

Audio. Inherits RefCounted

What one acoustic bake made of a map, and what it could not make of it.

The portal tool, a headless bake and a game that bakes as it loads go the same way (HammeriteAudioRuntime.bake()), so they had better say the same things about it. A report is that single voice: the tool prints it into its status panel, and a build with no editor in it prints it to the console. Most of it is counts. The part that earns its keep is what was LEFT OUT - a zone the author excluded, an opening internal to one zone, a zone nothing opens into - because from the outside each of those looks exactly like something the builder failed to find.

Properties

Methods

Property descriptions

zones

var zones: int = 0

Zones in the graph: connected groups of air, one per space sound travels through freely.

cells

var cells: int = 0

Convex pieces of air the zones were grouped from. More than zones wherever a room is not convex: a pillar alone splits a hall into four cells that are one zone.

portals

var portals: int = 0

Openings in the graph, one per aperture between two zones.

named_portals

var named_portals: int = 0

Of those, how many carry a name - which is how a door entity finds the one it stands in. An opening with no name cannot be opened or shut at runtime.

edges

var edges: int = 0

Routes between openings, along which sound travels from zone to zone.

portals_excluded

var portals_excluded: int = 0

Openings left out because a zone on one side is excluded from the graph.

portals_internal

var portals_internal: int = 0

Openings left out because both sides are one zone: sound was never going to be stopped there.

portals_unrepresentable

var portals_unrepresentable: int = 0

Openings the builder could not represent at all. Every one is an opening sound now goes straight through, so this should be zero and is worth a look when it is not.

elapsed_msec

var elapsed_msec: int = 0

How long the bake took, in milliseconds.

warnings

var warnings: String[] = []

Everything the bake could not do, in the words it said it in.

graph

var graph: HammeriteAudioNodeGraph = null

The graph this bake made, as it was stored in the map. Null when there was nothing to bake. rather than the graph where they answer the question.

Experimental: HammeriteAudioNodeGraph is not part of the supported API; read the counts above

Method descriptions

summary()

func summary() -> String

The bake in a line or two, for a status panel or a log. Leaves out warnings.