HamstarHelpers.Helpers.Tiles.TileHelpers Class Reference

Assorted static "helper" functions pertaining to tiles. More...

Static Public Member Functions
static bool	IsEqual (Tile tile1, Tile tile2)
	Reports if a tile is exactly identical to another tile. More...
static bool	IsAir (Tile tile, bool isWireAir=false, bool isLiquidAir=false)
	Indicates if a given tile is "air" (including no walls). More...
static bool	IsSolid (Tile tile, bool isPlatformSolid=false, bool isActuatedSolid=false)
	Indicates if a given tile is "solid". More...
static bool	IsWire (Tile tile)
	Indicates if a given tile has wires. More...
static bool	PlaceTileSynced (int tileX, int tileY, int tileType, int placeStyle=0, bool muted=false, bool forced=false, int plrWho=-1)
	Places a given tile of a given type. Synced. More...
static bool	KillTileSynced (int tileX, int tileY, bool effectOnly, bool dropsItem, bool forceSyncIfUnchanged, bool supressErrors=true)
	Kills a given tile. Results are synced. More...
static void	Swap1x1Synced (int fromTileX, int fromTileY, int toTileX, int toTileY, bool preserveWall=false, bool preserveWire=false, bool preserveLiquid=false)
	Swaps 1x1 tiles. Destructive. More...

Detailed Description

Assorted static "helper" functions pertaining to tiles.

Definition at line 9 of file TileHelpers.cs.

Member Function Documentation

IsAir()

static bool HamstarHelpers.Helpers.Tiles.TileHelpers.IsAir ( Tile  tile, bool  isWireAir = false, bool  isLiquidAir = false  )

static

Indicates if a given tile is "air" (including no walls).

Parameters

tile
isWireAir
isLiquidAir

Returns

Definition at line 36 of file TileHelpers.cs.

IsEqual()

static bool HamstarHelpers.Helpers.Tiles.TileHelpers.IsEqual ( Tile  tile1, Tile  tile2  )

static

Reports if a tile is exactly identical to another tile.

Parameters

tile1
tile2

Returns

Definition at line 16 of file TileHelpers.cs.

IsSolid()

static bool HamstarHelpers.Helpers.Tiles.TileHelpers.IsSolid ( Tile  tile, bool  isPlatformSolid = false, bool  isActuatedSolid = false  )

static

Indicates if a given tile is "solid".

Parameters

tile
isPlatformSolid
isActuatedSolid

Returns

Definition at line 61 of file TileHelpers.cs.

IsWire()

static bool HamstarHelpers.Helpers.Tiles.TileHelpers.IsWire ( Tile  tile )

static

Indicates if a given tile has wires.

Parameters

tile

Returns

Definition at line 85 of file TileHelpers.cs.

KillTileSynced()

static bool HamstarHelpers.Helpers.Tiles.TileHelpers.KillTileSynced ( int  tileX, int  tileY, bool  effectOnly, bool  dropsItem, bool  forceSyncIfUnchanged, bool  supressErrors = true  )

static

Kills a given tile. Results are synced.

Parameters

tileX
tileY
effectOnly	Only a visual effect; tile is not actually killed (nothing to sync).
dropsItem
forceSyncIfUnchanged
supressErrors

Returns

true when no complications occurred during removal. Does not force tile to be removed, if complications occurs.

Definition at line 79 of file TileHelpers_Edit.cs.

PlaceTileSynced()

static bool HamstarHelpers.Helpers.Tiles.TileHelpers.PlaceTileSynced ( int  tileX, int  tileY, int  tileType, int  placeStyle = 0, bool  muted = false, bool  forced = false, int  plrWho = -1  )

static

Places a given tile of a given type. Synced.

Parameters

tileX
tileY
tileType
placeStyle
muted
forced
plrWho

Returns

true if tile placement succeeded.

Definition at line 23 of file TileHelpers_Edit.cs.

Swap1x1Synced()

static void HamstarHelpers.Helpers.Tiles.TileHelpers.Swap1x1Synced ( int  fromTileX, int  fromTileY, int  toTileX, int  toTileY, bool  preserveWall = false, bool  preserveWire = false, bool  preserveLiquid = false  )

static

Swaps 1x1 tiles. Destructive.

Parameters

fromTileX
fromTileY
toTileX
toTileY
preserveWall
preserveWire
preserveLiquid

Definition at line 162 of file TileHelpers_Edit.cs.

---

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

• Project/HamstarHelpers/Helpers/Tiles/TileHelpers.cs
• Project/HamstarHelpers/Helpers/Tiles/TileHelpers_Edit.cs
• Project/HamstarHelpers/Helpers/Tiles/TileHelpers_Obsolete.cs