bn::bg_palette_rotate_by_action class

Modifies the number of colors to rotate to the right in a bg_palette_ptr by delta_count when the action is updated a given number of times. When the property is over the given maximum, it goes back to the given minimum and vice versa.

Base classes

template<typename Value, typename Property, class PropertyManager>
class cyclic_duration_by_value_template_action<bg_palette_ptr, int, bg_palette_rotate_manager>
Modifies the property of a value by delta when the action is updated a given number of times. When the property is over the given maximum, it goes back to the given minimum and vice versa.

Constructors, destructors, conversion operators

bg_palette_rotate_by_action(const bg_palette_ptr& palette, int duration_updates, int delta_count)
Constructor.
bg_palette_rotate_by_action(bg_palette_ptr&& palette, int duration_updates, int delta_count)
Constructor.

Public functions

auto palette() const -> const bg_palette_ptr&
Returns the bg_palette_ptr to modify.
auto delta_count() const -> int
Returns how many colors to add to the number of colors to rotate to the right when the action is updated the given number of times.

Function documentation

bn::bg_palette_rotate_by_action::bg_palette_rotate_by_action(const bg_palette_ptr& palette, int duration_updates, int delta_count)

Constructor.

Parameters
palette bg_palette_ptr to copy.
duration_updates How many times the action has to be updated before updating the number of colors to rotate.
delta_count How many colors to add to the number of colors to rotate to the right when the action is updated duration_updates times.

bn::bg_palette_rotate_by_action::bg_palette_rotate_by_action(bg_palette_ptr&& palette, int duration_updates, int delta_count)

Constructor.

Parameters
palette bg_palette_ptr to move.
duration_updates How many times the action has to be updated before updating the number of colors to rotate.
delta_count How many colors to add to the number of colors to rotate to the right when the action is updated duration_updates times.