terrain_builder::building_rule Struct Reference

The in-memory representation of a [terrain_graphics] WML rule. More...

Public Member Functions
	building_rule ()
bool	operator< (building_rule const &that) const
unsigned int	get_hash () const

Public Attributes
constraint_set	constraints
	The set of [tile] constraints of this rule. More...
map_location	location_constraints
	The location on which this map may match. More...
map_location	modulo_constraints
	Used to constrain locations to ones with coordinates that are multiples of the "mod_x" and "mod_y" parameters. More...
int	probability
	The probability of this rule to match, when all conditions are met. More...
int	precedence
	Ordering relation between the rules. More...
bool	local
	Indicate if the rule is only for this scenario. More...

Private Attributes
unsigned int	hash_

Detailed Description

The in-memory representation of a [terrain_graphics] WML rule.

Definition at line 368 of file builder.hpp.

Constructor & Destructor Documentation

terrain_builder::building_rule::building_rule ( )

inline

Definition at line 370 of file builder.hpp.

Member Function Documentation

unsigned int terrain_builder::building_rule::get_hash

(

)

const

Definition at line 1109 of file builder.cpp.

References terrain_builder::DUMMY_HASH, hash_, hash_str(), terrain_builder::rule_image_variant::image_string, and terrain_builder::rule_image::variants.

Referenced by terrain_builder::apply_rule(), and terrain_builder::rule_matches().

bool terrain_builder::building_rule::operator< ( building_rule const &  that ) const

inline

Definition at line 416 of file builder.hpp.

References precedence.

Member Data Documentation

constraint_set terrain_builder::building_rule::constraints

The set of [tile] constraints of this rule.

Definition at line 383 of file builder.hpp.

Referenced by terrain_builder::apply_rule(), terrain_builder::load_images(), terrain_builder::parse_config(), terrain_builder::parse_mapstring(), terrain_builder::replace_rotate_tokens(), terrain_builder::rotate_rule(), and terrain_builder::rule_matches().

unsigned int terrain_builder::building_rule::hash_

mutableprivate

Definition at line 421 of file builder.hpp.

bool terrain_builder::building_rule::local

Indicate if the rule is only for this scenario.

Definition at line 414 of file builder.hpp.

Referenced by terrain_builder::parse_config().

map_location terrain_builder::building_rule::location_constraints

The location on which this map may match.

Set to a valid map_location if the "x" and "y" parameters of the [terrain_graphics] rule are set.

Definition at line 390 of file builder.hpp.

Referenced by terrain_builder::parse_config(), and terrain_builder::rule_matches().

map_location terrain_builder::building_rule::modulo_constraints

Used to constrain locations to ones with coordinates that are multiples of the "mod_x" and "mod_y" parameters.

Doesn't actually refer to a real map location.

Definition at line 397 of file builder.hpp.

Referenced by terrain_builder::parse_config(), and terrain_builder::rule_matches().

int terrain_builder::building_rule::precedence

Ordering relation between the rules.

Definition at line 409 of file builder.hpp.

Referenced by operator<(), and terrain_builder::parse_config().

int terrain_builder::building_rule::probability

The probability of this rule to match, when all conditions are met.

Defined if the "probability" parameter of the [terrain_graphics] element is set.

Definition at line 404 of file builder.hpp.

Referenced by terrain_builder::parse_config(), and terrain_builder::rule_matches().

---

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

• terrain/builder.hpp
• terrain/builder.cpp