bn::regular_bg_map_cell_info class

Manages the properties of a regular background map cell.

Constructors, destructors, conversion operators

regular_bg_map_cell_info() defaulted constexpr
Default constructor.
regular_bg_map_cell_info(regular_bg_map_cell cell) explicit constexpr
Constructor.

Public functions

auto cell() const -> regular_bg_map_cell constexpr
Returns the managed regular_bg_map_cell.
void set_cell(regular_bg_map_cell cell) constexpr
Sets the managed regular_bg_map_cell.
auto tile_index() const -> int constexpr
Returns the referenced tile index.
void set_tile_index(int tile_index) constexpr
Sets the referenced tile index.
auto palette_id() const -> int constexpr
Returns the referenced palette id.
void set_palette_id(int palette_id) constexpr
Sets the referenced palette id.
auto horizontal_flip() const -> bool
Indicates if the managed cell is flipped in the horizontal axis or not.
void set_horizontal_flip(bool horizontal_flip)
Sets if the managed cell is flipped in the horizontal axis or not.
auto vertical_flip() const -> bool
Indicates if the managed cell is flipped in the vertical axis or not.
void set_vertical_flip(bool vertical_flip)
Sets if the managed cell is flipped in the vertical axis or not.

Friends

auto operator==(regular_bg_map_cell_info a, regular_bg_map_cell_info b) -> bool
Equal operator.
auto operator!=(regular_bg_map_cell_info a, regular_bg_map_cell_info b) -> bool
Not equal operator.

Function documentation

bn::regular_bg_map_cell_info::regular_bg_map_cell_info(regular_bg_map_cell cell) explicit constexpr

Constructor.

Parameters
cell Managed regular_bg_map_cell.

bool operator==(regular_bg_map_cell_info a, regular_bg_map_cell_info b)

Equal operator.

Parameters
a First regular_bg_map_cell_info to compare.
b Second regular_bg_map_cell_info to compare.
Returns true if the first managed cell is equal to the second one, otherwise false.

bool operator!=(regular_bg_map_cell_info a, regular_bg_map_cell_info b)

Not equal operator.

Parameters
a First regular_bg_map_cell_info to compare.
b Second regular_bg_map_cell_info to compare.
Returns true if the first managed cell is not equal to the second one, otherwise false.