Factorio.com|Forums|Wiki|Mod Portal|API Docs

# Factorio Prototype Docs Version 2.0.77

# AggregationSpecification - Prototype Docs

## AggregationSpecification :: struct

## Properties

- default
- sorted

max_count | :: uint32 |
progress_threshold optional | :: float | If `count_already_playing` is `true`, this will determine maximum progress when instance is counted toward playing sounds.
If `count_already_playing` is `true`, this will determine maximum progress when instance is counted toward playing sounds.
volume_reduction_rate optional | :: float | Has to be greater than or equal to 0.0.
Has to be greater than or equal to 0.0.
remove | :: boolean | If `false`, the volume of sound instances above `max_count` is calculated according to the formula `volume = (x + 1) ^ (-volume_reduction_rate)`, where `x` is the order number of an instance above the threshold. [...]
If `false`, the volume of sound instances above `max_count` is calculated according to the formula `volume = (x + 1) ^ (-volume_reduction_rate)`, where `x` is the order number of an instance above the threshold. [...]
count_already_playing optional | :: boolean | If `true`, already playing sounds are taken into account when checking `max_count`.
If `true`, already playing sounds are taken into account when checking `max_count`.
priority optional | :: `"closest"` or `"farthest"` or `"newest"` or `"oldest"` |

max_count | :: uint32 |
remove | :: boolean | If `false`, the volume of sound instances above `max_count` is calculated according to the formula `volume = (x + 1) ^ (-volume_reduction_rate)`, where `x` is the order number of an instance above the threshold. [...]
If `false`, the volume of sound instances above `max_count` is calculated according to the formula `volume = (x + 1) ^ (-volume_reduction_rate)`, where `x` is the order number of an instance above the threshold. [...]
count_already_playing optional | :: boolean | If `true`, already playing sounds are taken into account when checking `max_count`.
If `true`, already playing sounds are taken into account when checking `max_count`.
priority optional | :: `"closest"` or `"farthest"` or `"newest"` or `"oldest"` |
progress_threshold optional | :: float | If `count_already_playing` is `true`, this will determine maximum progress when instance is counted toward playing sounds.
If `count_already_playing` is `true`, this will determine maximum progress when instance is counted toward playing sounds.
volume_reduction_rate optional | :: float | Has to be greater than or equal to 0.0.
Has to be greater than or equal to 0.0.

## Properties

### max_count :: uint32

### progress_threshold :: float optional

Default: `1.0`

If `count_already_playing` is `true`, this will determine maximum progress when instance is counted toward playing sounds.

### volume_reduction_rate :: float optional

Default: `2.0`

Has to be greater than or equal to 0.0.

### remove :: boolean

If `false`, the volume of sound instances above `max_count` is calculated according to the formula `volume = (x + 1) ^ (-volume_reduction_rate)`, where `x` is the order number of an instance above the threshold.

If `true`, sound instances above `max_count` are removed.

### count_already_playing :: boolean optional

Default: `false`

If `true`, already playing sounds are taken into account when checking `max_count`.

### priority :: `"closest"` or `"farthest"` or `"newest"` or `"oldest"` optional

Default: `"closest"`

Type used in

- Sound::aggregation
- SoundPrototype::aggregation