MainSound

Type

struct

Properties

sound

• Type: Sound
• Optional: true

Cannot be empty.

probability

• Type: double
• Optional: true

Modifies how often the sound is played.

Silently clamped to the [0.0, 1.0] range.

Unused when WorkingSound::persistent is true.

Examples

probability = 1 / (3 * 60) -- average pause between the sound is 3 seconds

fade_in_ticks

• Type: uint32
• Optional: true

Can't be used when match_progress_to_activity is true.

fade_out_ticks

• Type: uint32
• Optional: true

Can't be used when match_progress_to_activity is true.

activity_to_volume_modifiers

• Type: ActivityMatchingModifiers
• Optional: true

activity_to_speed_modifiers

• Type: ActivityMatchingModifiers
• Optional: true

match_progress_to_activity

• Type: boolean
• Optional: true

Unused when WorkingSound::persistent is true.

match_volume_to_activity

• Type: boolean
• Optional: true

match_speed_to_activity

• Type: boolean
• Optional: true

play_for_working_visualisations

• Type: Array<string>
• Optional: true

Array of WorkingVisualisation::names, individual names cannot be empty.

The sound is played when at least one of the specified working visualisations is drawn.

Unused when WorkingSound::persistent is true.

volume_smoothing_window_size

• Type: uint32
• Optional: true

Only used if WorkingSound::persistent is true.