XSGridEditor  1.0.0
XSGridEditor is a lightweight square grid map system for 2D/3D SRPG games, and comes with a simple and easy-to-use grid editing function. It can be used as a beginning for you to create SRPG games.
Public Member Functions | Protected Member Functions | Static Protected Attributes | Properties | List of all members
XSSLG.XSGridMgr Class Reference

tile management class, responsible for tile coordinate transformation, data and other functions More...

Inheritance diagram for XSSLG.XSGridMgr:
XSSLG.XSIGridMgr

Public Member Functions

virtual List< XSTileGetAllTiles ()
 
virtual void ClearAllTiles ()
 
 XSGridMgr (XSITileRoot tileRoot, Vector3 cellSize)
 
virtual void Init (XSGridHelper helper)
 
virtual Vector3Int WorldToTile (Vector3 worldPos)
 change world position to tile position More...
 
virtual Vector3 WorldToTileCenterWorld (Vector3 worldPos)
 get the center position of the tile from a world position More...
 
virtual Vector3 TileToTileCenterWorld (Vector3Int tilePos)
 
virtual XSTile AddXSTile (XSITileNode tileNode)
 add tile to dict More...
 
virtual bool RemoveXSTileByWorldPos (Vector3 worldPos)
 remove tile from dict More...
 
virtual bool HasXSTile (Vector3Int tilePos)
 
virtual bool HasXSTileByWorldPos (Vector3 worldPos)
 get tile from a world position More...
 
virtual XSTile GetXSTile (Vector3Int tilePos)
 
virtual XSTile GetXSTileByWorldPos (Vector3 worldPos)
 
virtual bool TryGetXSTile (Vector3Int tilePos, out XSTile tile)
 
virtual bool TryGetXSTileByWorldPos (Vector3 worldPos, out XSTile tile)
 
virtual void UpdateTileSize (Vector3 tileSize)
 
virtual Dictionary< Vector3Int, List< Vector3 > > FindAllPath (XSTile srcTile, int moveRange)
 get all paths More...
 
virtual List< Vector3FindPath (XSTile srcTile, XSTile destTile)
 

Protected Member Functions

virtual void CreateXSTileDict (XSGridHelper helper)
 

Static Protected Attributes

static readonly Vector3Int[] NearPosArray = { Vector3Int.left, Vector3Int.back, Vector3Int.right, Vector3Int.forward, }
 4 near tile to each tile for squre map More...
 

Properties

TileDict TileDict = new TileDict() [get, set]
 key is tilepos, value is tile More...
 
XSITileRoot TileRoot [get]
 tiles parent,we can change this gameobject position to move all tiles position More...
 
Vector3 TileSize = Vector3.zero [get, set]
 used to calculate tilePos More...
 

Detailed Description

tile management class, responsible for tile coordinate transformation, data and other functions

Constructor & Destructor Documentation

◆ XSGridMgr()

XSSLG.XSGridMgr.XSGridMgr ( XSITileRoot  tileRoot,
Vector3  cellSize 
)
inline

Member Function Documentation

◆ AddXSTile()

virtual XSTile XSSLG.XSGridMgr.AddXSTile ( XSITileNode  tileNode)
inlinevirtual

add tile to dict

Parameters
tileNode
Returns

Implements XSSLG.XSIGridMgr.

◆ ClearAllTiles()

virtual void XSSLG.XSGridMgr.ClearAllTiles ( )
inlinevirtual

Implements XSSLG.XSIGridMgr.

◆ CreateXSTileDict()

virtual void XSSLG.XSGridMgr.CreateXSTileDict ( XSGridHelper  helper)
inlineprotectedvirtual

◆ FindAllPath()

virtual Dictionary<Vector3Int, List<Vector3> > XSSLG.XSGridMgr.FindAllPath ( XSTile  srcTile,
int  moveRange 
)
virtual

get all paths

Parameters
srcTilebeginning tile
moveRange-1 or less than 0 means no limit to move range
Returns

Implements XSSLG.XSIGridMgr.

◆ FindPath()

virtual List<Vector3> XSSLG.XSGridMgr.FindPath ( XSTile  srcTile,
XSTile  destTile 
)
virtual

Implements XSSLG.XSIGridMgr.

◆ GetAllTiles()

virtual List<XSTile> XSSLG.XSGridMgr.GetAllTiles ( )
virtual

Implements XSSLG.XSIGridMgr.

◆ GetXSTile()

virtual XSTile XSSLG.XSGridMgr.GetXSTile ( Vector3Int  tilePos)
inlinevirtual

Implements XSSLG.XSIGridMgr.

◆ GetXSTileByWorldPos()

virtual XSTile XSSLG.XSGridMgr.GetXSTileByWorldPos ( Vector3  worldPos)
inlinevirtual

Implements XSSLG.XSIGridMgr.

◆ HasXSTile()

virtual bool XSSLG.XSGridMgr.HasXSTile ( Vector3Int  tilePos)
virtual

Implements XSSLG.XSIGridMgr.

◆ HasXSTileByWorldPos()

virtual bool XSSLG.XSGridMgr.HasXSTileByWorldPos ( Vector3  worldPos)
virtual

get tile from a world position

Parameters
worldPosunity`s world position

Implements XSSLG.XSIGridMgr.

◆ Init()

virtual void XSSLG.XSGridMgr.Init ( XSGridHelper  helper)
inlinevirtual

Implements XSSLG.XSIGridMgr.

◆ RemoveXSTileByWorldPos()

virtual bool XSSLG.XSGridMgr.RemoveXSTileByWorldPos ( Vector3  worldPos)
inlinevirtual

remove tile from dict

Parameters
worldPostila's world position
Returns

Implements XSSLG.XSIGridMgr.

◆ TileToTileCenterWorld()

virtual Vector3 XSSLG.XSGridMgr.TileToTileCenterWorld ( Vector3Int  tilePos)
inlinevirtual

Implements XSSLG.XSIGridMgr.

◆ TryGetXSTile()

virtual bool XSSLG.XSGridMgr.TryGetXSTile ( Vector3Int  tilePos,
out XSTile  tile 
)
inlinevirtual

Implements XSSLG.XSIGridMgr.

◆ TryGetXSTileByWorldPos()

virtual bool XSSLG.XSGridMgr.TryGetXSTileByWorldPos ( Vector3  worldPos,
out XSTile  tile 
)
inlinevirtual

Implements XSSLG.XSIGridMgr.

◆ UpdateTileSize()

virtual void XSSLG.XSGridMgr.UpdateTileSize ( Vector3  tileSize)
inlinevirtual

Implements XSSLG.XSIGridMgr.

◆ WorldToTile()

virtual Vector3Int XSSLG.XSGridMgr.WorldToTile ( Vector3  worldPos)
inlinevirtual

change world position to tile position

Parameters
worldPosunity`s world position

Implements XSSLG.XSIGridMgr.

◆ WorldToTileCenterWorld()

virtual Vector3 XSSLG.XSGridMgr.WorldToTileCenterWorld ( Vector3  worldPos)
inlinevirtual

get the center position of the tile from a world position

Parameters
worldPosunity`s world position

Implements XSSLG.XSIGridMgr.

Member Data Documentation

◆ NearPosArray

readonly Vector3Int [] XSSLG.XSGridMgr.NearPosArray = { Vector3Int.left, Vector3Int.back, Vector3Int.right, Vector3Int.forward, }
staticprotected

4 near tile to each tile for squre map

Property Documentation

◆ TileDict

TileDict XSSLG.XSGridMgr.TileDict = new TileDict()
getsetprotected

key is tilepos, value is tile

◆ TileRoot

XSITileRoot XSSLG.XSGridMgr.TileRoot
getprotected

tiles parent,we can change this gameobject position to move all tiles position

◆ TileSize

Vector3 XSSLG.XSGridMgr.TileSize = Vector3.zero
getsetprotected

used to calculate tilePos


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