The Battle for Wesnoth  1.13.10+dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Public Types | Public Member Functions | Public Attributes | List of all members
terrain_builder::tile Struct Reference

Represents a tile of the game map, with all associated builder-specific parameters: flags, images attached to this tile, etc. More...

#include <builder.hpp>

Classes

struct  rule_image_rand
 Represent a rule_image applied with a random seed. More...
 

Public Types

typedef std::pair< const
rule_image_rand *, const
rule_image_variant * > 
log_details
 
typedef std::vector< log_detailslogs
 

Public Member Functions

 tile ()
 Constructor for the tile() structure. More...
 
void rebuild_cache (const std::string &tod, logs *log=nullptr)
 Rebuilds the whole image cache, for a given time-of-day. More...
 
void clear ()
 Clears all data in this tile, and resets the cache. More...
 

Public Attributes

std::set< std::string > flags
 The list of flags present in this tile. More...
 
std::vector< rule_image_randimages
 The list of rule_images and random seeds associated to this tile. More...
 
imagelist images_foreground
 The list of images which are in front of the unit sprites, attached to this tile. More...
 
imagelist images_background
 The list of images which are behind the unit sprites, attached to this tile. More...
 
std::string last_tod
 The time-of-day to which the image caches correspond. More...
 
bool sorted_images
 Indicates if 'images' is sorted. More...
 

Detailed Description

Represents a tile of the game map, with all associated builder-specific parameters: flags, images attached to this tile, etc.

An array of those tiles is built when terrains are built either during construction, or upon calling the rebuild_all() method.

Definition at line 311 of file builder.hpp.

Member Typedef Documentation

Definition at line 316 of file builder.hpp.

Definition at line 318 of file builder.hpp.

Constructor & Destructor Documentation

terrain_builder::tile::tile ( )

Constructor for the tile() structure.

Definition at line 102 of file builder.cpp.

Member Function Documentation

void terrain_builder::tile::clear ( )

Clears all data in this tile, and resets the cache.

Definition at line 187 of file builder.cpp.

References about::images.

void terrain_builder::tile::rebuild_cache ( const std::string &  tod,
logs log = nullptr 
)

Member Data Documentation

std::set<std::string> terrain_builder::tile::flags

The list of flags present in this tile.

Definition at line 331 of file builder.hpp.

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

std::vector<rule_image_rand> terrain_builder::tile::images

The list of rule_images and random seeds associated to this tile.

Definition at line 358 of file builder.hpp.

Referenced by terrain_builder::apply_rule().

imagelist terrain_builder::tile::images_background

The list of images which are behind the unit sprites, attached to this tile.

This member is considered a cache: it is built once, and on-demand.

Definition at line 369 of file builder.hpp.

Referenced by terrain_builder::get_terrain_at(), terrain_builder::rebuild_terrain(), and terrain_builder::update_animation().

imagelist terrain_builder::tile::images_foreground

The list of images which are in front of the unit sprites, attached to this tile.

This member is considered a cache: it is built once, and on-demand.

Definition at line 364 of file builder.hpp.

Referenced by terrain_builder::get_terrain_at(), terrain_builder::rebuild_terrain(), and terrain_builder::update_animation().

std::string terrain_builder::tile::last_tod

The time-of-day to which the image caches correspond.

Definition at line 373 of file builder.hpp.

Referenced by terrain_builder::get_terrain_at().

bool terrain_builder::tile::sorted_images

Indicates if 'images' is sorted.

Definition at line 376 of file builder.hpp.


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