Struct TileSetAutoTileContext 

pub struct TileSetAutoTileContext(/* private fields */);

This is a specialization of AutoTileContext for use with a TileSet. The pattern of each tile is taken from the values of a nine-slice property, and TileDefinitionHandle is used to represent individual tiles.

See TileSetAutoTileContext::fill_pattern_map for details on how to fill a TileSetAutoTileContext with data from a tile set in preparation for auto-tiling.

Implementations

impl TileSetAutoTileContext

pub fn fill_pattern_map( &mut self, tile_set: &TileSet, pattern_property: TileSetPropertyNine, frequency_property: Option<TileSetPropertyF32>, ) -> Result<(), FillPatternMapError>

Prepare for auto-tiling by extracting tile patterns from the given tile set. Each tile has an associated pattern through the value of the property with the UUID given by pattern_property. Each pattern contains nine i8 values arranged in a 3x3 grid. The outer eight values are used to determine which tiles are permitted to be adjacent to which other tiles, while the central i8 controls which cells may have this tile. The central value of 0 is reserved for cells that should be empty, and any tiles which have a central value of 0 are ignored by the auto-tiler.

When more than one tile has the same pattern, the auto-tiler must choose between the tiles randomly. The frequency_property is used to weigh the probabilities of choosing each tile, so tiles with higher values are more likely to be chosen. If no frequency property is given, then all tiles are equally likely.

Methods from Deref<Target = AutoTileContext<TileTerrainId, PatternBits, TileDefinitionHandle>>

pub fn is_empty(&self) -> bool

True if this context contains no patterns.

pub fn clear(&mut self)

Make the context empty in preparation for building a new context.

pub fn add(&mut self, key: Ter, pattern: Pat, frequency: f32, value: Tile)

Add a particular tile to the context and specify that tile’s terrain, pattern, and frequency. The higher the frequency, the more likely this tile will be chosen if it shares the same pattern as another tile.

pub fn sort(&mut self)

where Pat: Ord,

Sort the pattern values according to their natural order.

pub fn get_random_value<R>(&self, rng: &mut R, pattern: &Pat) -> Option<&Tile>

where R: Rng + ?Sized,

Get a random tile that has the given pattern, if possible.

Trait Implementations

impl Clone for TileSetAutoTileContext

fn clone(&self) -> TileSetAutoTileContext

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TileSetAutoTileContext

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TileSetAutoTileContext

fn default() -> TileSetAutoTileContext

Returns the “default value” for a type.

impl Deref for TileSetAutoTileContext

type Target = AutoTileContext<i8, PatternBits, TileDefinitionHandle>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for TileSetAutoTileContext

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.