bn::sound_master_volume_to_action class

Modifies the master volume of all sound effects until it has a given state.

Base classes

template<typename Property, class PropertyManager>
class to_template_action<fixed, sound_master_volume_manager>
Modifies the property until it has a given state.

Constructors, destructors, conversion operators

sound_master_volume_to_action(int duration_updates, fixed final_volume)
Constructor.

Public functions

auto final_volume() const -> fixed
Returns the volume when the action is updated the given number of times.

Function documentation

bn::sound_master_volume_to_action::sound_master_volume_to_action(int duration_updates, fixed final_volume)

Constructor.

Parameters
duration_updates Number of times that the action must be updated until the volume is equal to final_volume.
final_volume Volume when the action is updated duration_updates times.

This volume must be in the range [0..1].