The Battle for Wesnoth  1.15.1+dev
Public Member Functions | Public Attributes | List of all members
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

 rule_image (int layer, int x, int y, bool global_image=false, int center_x=-1, int center_y=-1, bool is_water=false)
 
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
 
std::vector< rule_image_variantvariants
 A list of variants for this image. More...
 
bool global_image
 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
 The position where the center of the image base should be. More...
 
int center_y
 
bool is_water
 

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 230 of file builder.hpp.

Constructor & Destructor Documentation

◆ rule_image()

terrain_builder::rule_image::rule_image ( int  layer,
int  x,
int  y,
bool  global_image = false,
int  center_x = -1,
int  center_y = -1,
bool  is_water = false 
)

Definition at line 90 of file builder.cpp.

Member Function Documentation

◆ is_background()

bool terrain_builder::rule_image::is_background ( ) const
inline

Definition at line 240 of file builder.hpp.

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 250 of file builder.hpp.

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

◆ basey

int terrain_builder::rule_image::basey

◆ center_x

int terrain_builder::rule_image::center_x

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

Definition at line 262 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

◆ global_image

bool terrain_builder::rule_image::global_image

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 258 of file builder.hpp.

Referenced by terrain_builder::load_images().

◆ is_water

bool terrain_builder::rule_image::is_water

Definition at line 264 of file builder.hpp.

◆ layer

int terrain_builder::rule_image::layer

The layer of the image for horizontal layering.

Definition at line 246 of file builder.hpp.

Referenced by 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 253 of file builder.hpp.

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


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