bn::regular_bg_visible_toggle_action class
#include <bn_regular_bg_actions.h>

Toggles if a regular_bg_ptr must be committed to the GBA or not when the action is updated a given number of times.

Base classes

template<typename Value, class PropertyManager>
class bool_toggle_value_template_action<regular_bg_ptr, regular_bg_visible_manager>
Toggles a boolean property of a value when the action is updated a given number of times.

Constructors, destructors, conversion operators

regular_bg_visible_toggle_action(const regular_bg_ptr& bg, int duration_updates)
Constructor.
regular_bg_visible_toggle_action(regular_bg_ptr&& bg, int duration_updates)
Constructor.

Public functions

auto bg() const -> const regular_bg_ptr&
Returns the regular_bg_ptr to modify.

Function documentation

bn::regular_bg_visible_toggle_action::regular_bg_visible_toggle_action(const regular_bg_ptr& bg, int duration_updates)

Constructor.

Parameters
bg regular_bg_ptr to copy.
duration_updates How many times the action has to be updated to toggle if the given regular_bg_ptr must be committed to the GBA or not.

bn::regular_bg_visible_toggle_action::regular_bg_visible_toggle_action(regular_bg_ptr&& bg, int duration_updates)

Constructor.

Parameters
bg regular_bg_ptr to move.
duration_updates How many times the action has to be updated to toggle if the given regular_bg_ptr must be committed to the GBA or not.