Class TileInstance
A tile instance is a non-single-instance version of a Tile that is placed on a Map at a specific position and floor. Tile instances are serializable and can store additional data on a map to disk using the DataMemberAttribute.
[DataContract]
public class TileInstance : JsonTypeSafeGenericDataHolder, IGenericDataHolder
- Inheritance
-
JsonTypeSafeGenericDataHolderTileInstance
- Implements
-
IGenericDataHolder
- Inherited Members
-
JsonTypeSafeGenericDataHolder.GetDataKeys()
- Extension Methods
Constructors
TileInstance(Tile, Map, Point, int)
Creates a new tile instance with the given settings.
public TileInstance(Tile tile, Map map, Point position, int floor)
Parameters
tileTileThe underlying tile.
mapMapThe map that this tile instance is on.
positionPointThe position of this tile instance on the map, in tile coordinates.
floorintThe floor that this tile instance is on.
Fields
Tile
The underlying tile.
[DataMember]
public readonly Tile Tile
Field Value
Properties
Floor
The floor that this tile instance is on.
public int Floor { get; }
Property Value
Map
The map that this tile instance is on.
public Map Map { get; }
Property Value
Position
The position of this tile instance on the map, in tile coordinates.
public Point Position { get; }
Property Value
- Point
Methods
GetVariationTexture(Direction2)
Returns a random variation texture (based on this tile instance's Position and Floor) based on the variation textures that this tile instance's Tile supplies through Regions.
public virtual Point GetVariationTexture(Direction2 direction)
Parameters
directionDirection2The camera rotation.
Returns
- Point
The variation texture location.
Validate(Map, Point, int)
Validates this tile instance when loading the game. By default, this method always returns true after setting the Map, Position, and Floor properties.
public virtual bool Validate(Map map, Point position, int floor)
Parameters
mapMapThe map that this tile instance is on.
positionPointThe position of this tile instance on the map, in tile coordinates.
floorintThe floor that this tile instance is on.