bn::music_volume_loop_action class

Modifies the volume of the active music from a minimum to a maximum. When the volume is equal to the given final state, it goes back to its initial state and vice versa.

Base classes

template<typename Property, class PropertyManager>
class loop_template_action<fixed, music_volume_manager>
Modifies the property by delta from a minimum to a maximum. When the property is equal to the given final state, it goes back to its initial state and vice versa.

Constructors, destructors, conversion operators

music_volume_loop_action(int duration_updates, fixed final_volume)
Constructor.

Public functions

auto final_volume() const -> fixed
When the volume is equal to the returned parameter, it goes back to its initial state and vice versa.

Function documentation

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

Constructor.

Parameters
duration_updates How much times the action has to be updated before changing the direction of the volume delta.
final_volume When the volume is equal to this parameter, it goes back to its initial state and vice versa.

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