terrain_builder::rule_image Struct Reference

Each terrain_graphics rule is associated a set of images, which are applied on the terrain if the rule matches. More...

#include <builder.hpp>

Public Member Functions
bool	is_background () const

Public Attributes
int	layer
	The layer of the image for horizontal layering. More...
int	basex
	The position of the image base (that is, the point where the image reaches the floor) for vertical layering. More...
int	basey
bool	global_image = false
	Set to true if the image was defined as a child of the [terrain_graphics] tag, set to false if it was defined as a child of a [tile] tag. More...
int	center_x = -1
	The position where the center of the image base should be. More...
int	center_y = -1
bool	is_water = false
std::vector< rule_image_variant >	variants {}
	A list of variants for this image. More...

Detailed Description

Each terrain_graphics rule is associated a set of images, which are applied on the terrain if the rule matches.

An image is more than graphics: it is graphics (with several possible tod-alternatives,) and a position for these graphics. The rule_image structure represents one such image.

Definition at line 226 of file builder.hpp.

Member Function Documentation

is_background()

bool terrain_builder::rule_image::is_background ( ) const

inline

Definition at line 228 of file builder.hpp.

References basey, layer, and terrain_builder::UNITPOS.

Referenced by gui2::dialogs::terrain_layers::pre_show().

Member Data Documentation

basex

int terrain_builder::rule_image::basex

The position of the image base (that is, the point where the image reaches the floor) for vertical layering.

Definition at line 238 of file builder.hpp.

Referenced by gui2::dialogs::terrain_layers::pre_show().

basey

int terrain_builder::rule_image::basey

Definition at line 238 of file builder.hpp.

Referenced by is_background(), terrain_builder::tile::rule_image_rand::operator<(), and gui2::dialogs::terrain_layers::pre_show().

center_x

int terrain_builder::rule_image::center_x = -1

The position where the center of the image base should be.

Definition at line 247 of file builder.hpp.

Referenced by terrain_builder::load_images(), and gui2::dialogs::terrain_layers::pre_show().

center_y

int terrain_builder::rule_image::center_y = -1

Definition at line 247 of file builder.hpp.

Referenced by terrain_builder::load_images(), and gui2::dialogs::terrain_layers::pre_show().

global_image

bool terrain_builder::rule_image::global_image = false

Set to true if the image was defined as a child of the [terrain_graphics] tag, set to false if it was defined as a child of a [tile] tag.

Definition at line 243 of file builder.hpp.

Referenced by terrain_builder::load_images().

is_water

bool terrain_builder::rule_image::is_water = false

Definition at line 249 of file builder.hpp.

layer

int terrain_builder::rule_image::layer

The layer of the image for horizontal layering.

Definition at line 234 of file builder.hpp.

Referenced by is_background(), terrain_builder::tile::rule_image_rand::operator<(), and gui2::dialogs::terrain_layers::pre_show().

variants

std::vector<rule_image_variant> terrain_builder::rule_image::variants {}

A list of variants for this image.

Definition at line 252 of file builder.hpp.

Referenced by terrain_builder::building_rule::get_hash(), and terrain_builder::load_images().

---

The documentation for this struct was generated from the following file:

• terrain/builder.hpp