Class AutoTile
An auto-tile is a Tile that visually connects to other tiles around it, while leaving a border around tiles that it doesn't connect to. Implementors can override ConnectsToTile(Map, Point, int, int, int, Func<Point, int, Tile>) to edit this behavior.
public class AutoTile : Tile- Inheritance
-
AutoTile
- Derived
- Inherited Members
- Extension Methods
Constructors
AutoTile(string, string, int, Dictionary<Point, TextureRegion>, Dictionary<Direction2, Point[]>, ColorSettings, int[], bool, float, Category, TextureRegion, Func<Point, float>)
Creates a new tile with the given settings. To create an instance of a custom tile class, use Register(string, int, Dictionary<Point, TextureRegion>, Point, ColorScheme, float, bool, Category, TextureRegion, Func<Direction2, Point?>, int?, Func<Point, float>, Type).
protected AutoTile(string baseName, string name, int price, Dictionary<Point, TextureRegion> textures, Dictionary<Direction2, Point[]> regions, ColorSettings colorSettings, int[] colors, bool canBuy, float pathCostModifier, Tile.Category categories, TextureRegion icon, Func<Point, float> regionWeights)Parameters
baseNamestringnamestringpriceinttexturesDictionary<Point, TextureRegion>regionsDictionary<Direction2, Point[]>colorSettingsColorSettingscolorsint[]canBuyboolpathCostModifierfloatcategoriesTile.CategoryiconTextureRegionregionWeightsFunc<Point, float>
Properties
DefaultBorderTile
Returns the tile information that should be used in place of GetAutoTileBorder(Map, Point, int, Point, Tile, int) if no relevant border tiles are around. This defaults to the grass tile border with the default color.
protected virtual (Func<int, TextureRegion>, Color) DefaultBorderTile { get; }Property Value
Methods
ConnectsToTile(Map, Point, int, int, int, Func<Point, int, Tile>)
Override this method to determine what other tiles this auto-tile should connect to. By default, auto-tiles connect to other tiles of the same type.
protected virtual bool ConnectsToTile(Map map, Point pos, int floor, int x, int y, Func<Point, int, Tile> getRelatedTileFunc = null)Parameters
mapMapThe map.
posPointThe position of the tile.
floorintThe floor of the tile.
xintThe offset from
posin the x axis.yintThe offset from
posin the y axis.getRelatedTileFuncFunc<Point, int, Tile>A function that can optionally be supplied to override the GetTile(Point, int) method when checking for neighboring tiles. This is useful for when tile placement in the world is mocked, for example.
Returns
- bool
Whether this tile should connect to the tile at the offset position.
Draw(GameTime, object, Map, Point, int, Vector2, float, float, ICollection<Item>, bool, Func<Point, int, Tile>)
Draws this tile at the given position in the world using a Microsoft.Xna.Framework.Graphics.SpriteBatch or MLEM.Graphics.StaticSpriteBatch
public override bool Draw(GameTime time, object batch, Map map, Point pos, int floor, Vector2 drawPos, float scale, float depthOffset, ICollection<StaticSpriteBatch.Item> items, bool hasStaticContext, Func<Point, int, Tile> getRelatedTileFunc = null)Parameters
timeGameTimeThe game's current time.
batchobjectThe sprite batch to use for drawing, which can either be a Microsoft.Xna.Framework.Graphics.SpriteBatch or a MLEM.Graphics.StaticSpriteBatch.
mapMapThe map that the tile is on.
posPointThe position that the tile is on.
floorintThe floor that this tile is on.
drawPosVector2The position, in screen space, to draw at.
scalefloatThe scale to draw the tile with.
depthOffsetfloatA depth offset that can optionally be added to this tile's draw depth.
itemsICollection<StaticSpriteBatch.Item>The MLEM.Graphics.StaticSpriteBatch.Item collection that added items can optionally be added to.
hasStaticContextboolWhether this tile also has a static context, that is, whether it will already be drawn using a MLEM.Graphics.StaticSpriteBatch.
getRelatedTileFuncFunc<Point, int, Tile>A function that can optionally be supplied to override the GetTile(Point, int) method when checking for neighboring tiles. This is useful for when tile placement in the world is mocked, for example.
Returns
- bool
Whether this tile was fully drawn. If the
batchis a MLEM.Graphics.StaticSpriteBatch and false is returned, this tile will be marked as an animated tile, causing it to draw every frame.
DrawBorder(object, Map, Point, int, int, Vector2, float, float, ICollection<Item>, Func<Point, int, Tile>)
Draws the auto-tile border.
protected void DrawBorder(object batch, Map map, Point pos, int floor, int layer, Vector2 drawPos, float scale, float depthOffset, ICollection<StaticSpriteBatch.Item> items, Func<Point, int, Tile> getRelatedTileFunc = null)Parameters
batchobjectThe sprite batch to use for drawing, which can either be a Microsoft.Xna.Framework.Graphics.SpriteBatch or a MLEM.Graphics.StaticSpriteBatch.
mapMapThe map that the tile is on.
posPointThe position that the tile is on.
floorintThe floor to draw at.
layerintThe layer of the border to draw. By default, tiles use layer 0 for regular borders, and layer 1 for special borders, like the little "cliff" that displays on water tiles. This is passed to GetAutoTileBorder(Map, Point, int, Point, Tile, int).
drawPosVector2The position, in screen space, to draw at.
scalefloatThe scale to draw the tile with.
depthOffsetfloatA depth offset that is optionally added to the calculated draw depth.
itemsICollection<StaticSpriteBatch.Item>The MLEM.Graphics.StaticSpriteBatch.Item collection that added items can optionally be added to.
getRelatedTileFuncFunc<Point, int, Tile>A function that can optionally be supplied to override the GetTile(Point, int) method when checking for neighboring tiles. This is useful for when tile placement in the world is mocked, for example.
OnNeighborChanged(Map, Point, Point, int)
A method that is called when a neighboring Tile on the Map changes. This method does nothing by default, but is overriden by AutoTile to notify neighboring tiles of changes.
public override void OnNeighborChanged(Map map, Point pos, Point neighbor, int floor)