Statics

The Statics class provides access to informations about the Map, down to the individual tile. When using this function it's important to remember the distinction between Land and Tile: Land ---- For a given (X,Y,map) there can be only 1 (0 zero) Land item, and has 1 specific Z coordinate. Tile ---- For a given (X,Y,map) there can be any number of Tile items.

Table of Contents

Methods

CheckDeedHouse

Syntax: Statics.CheckDeedHouse(x, y, exemptSerial)

Check if the given Tile is occupied by a private house. Need to be in-sight, on most servers the maximum distance is 18 tiles.

Parameters:
  • x (Int32)
  • y (Int32)
  • exemptSerial (Int32)
Returns: Boolean

FindClearGroundLocations

Syntax: Statics.FindClearGroundLocations(radius)

Find all clear ground squares within a radius of the player's location. A clear square means: no tile items and not impassable.

Parameters:
  • radius (Int32): Search radius (1-3 tiles). Defaults to 1.
Returns: List[ValueTuple[Int32, Int32, Int32]]

FindNextMiningSpot

Syntax: Statics.FindNextMiningSpot(mineRadius)

Find the next mining spot (8x8 square with resources) adjacent to the player or to already mined squares.

Parameters:
  • mineRadius (Int32): Search radius around player in tiles
Returns: List[ValueTuple[Int32, Int32]]

GetItemData

Syntax: Statics.GetItemData(StaticID)
Parameters:
  • StaticID (Int32)
Returns: ItemData

GetLandFlag

Syntax: Statics.GetLandFlag(staticID, flagname)

Land: Check Flag value of a given Land item.

Parameters:
  • staticID (Int32): StaticID of a Land item.
  • flagname (String): None Translucent Wall Damaging Impassable Surface Bridge Window NoShoot Foliage HoverOver Roof Door Wet
Returns: Boolean

GetLandID

Syntax: Statics.GetLandID(x, y, map)

Land: Return the StaticID of the Land item, give the coordinates and map.

Parameters:
  • x (Int32): X coordinate.
  • y (Int32): Y coordinate.
  • map (Int32): 0 = Felucca 1 = Trammel 2 = Ilshenar 3 = Malas 4 = Tokuno 5 = TerMur
Returns: Int32

GetLandName

Syntax: Statics.GetLandName(StaticID)

Land: Get the name of a Land item given the StaticID.

Parameters:
  • StaticID (Int32): Land item StaticID.
Returns: String

GetLandZ

Syntax: Statics.GetLandZ(x, y, map)

Land: Return the Z coordinate (height) of the Land item, give the coordinates and map.

Parameters:
  • x (Int32): X coordinate.
  • y (Int32): Y coordinate.
  • map (Int32): 0 = Felucca 1 = Trammel 2 = Ilshenar 3 = Malas 4 = Tokuno 5 = TerMur
Returns: Int32

GetStaticsLandInfo

Syntax: Statics.GetStaticsLandInfo(x, y, map)

Land: Return a TileInfo representing the Land item for a given X,Y, map.

Parameters:
  • x (Int32): X coordinate.
  • y (Int32): Y coordinate.
  • map (Int32): 0 = Felucca 1 = Trammel 2 = Ilshenar 3 = Malas 4 = Tokuno 5 = TerMur
Returns: Statics.TileInfo

GetStaticsTileInfo

Syntax: Statics.GetStaticsTileInfo(x, y, map)

Tile: Return a list of TileInfo representing the Tile items for a given X,Y, map.

Parameters:
  • x (Int32): X coordinate.
  • y (Int32): Y coordinate.
  • map (Int32): 0 = Felucca 1 = Trammel 2 = Ilshenar 3 = Malas 4 = Tokuno 5 = TerMur
Returns: List[Statics.TileInfo]

GetTileFlag

Syntax: Statics.GetTileFlag(StaticID, flagname)

Tile: Check Flag value of a given Tile item.

Parameters:
  • StaticID (Int32): StaticID of a Tile item.
  • flagname (String): None Translucent Wall Damaging Impassable Surface Bridge Window NoShoot Foliage HoverOver Roof Door Wet
Returns: Boolean

GetTileHeight

Syntax: Statics.GetTileHeight(StaticID)

Tile: Get hight of a Tile item, in Z coordinate reference.

Parameters:
  • StaticID (Int32): Tile item StaticID.
Returns: Int32

GetTileName

Syntax: Statics.GetTileName(StaticID)

Tile: Get the name of a Tile item given the StaticID.

Parameters:
  • StaticID (Int32): Tile item StaticID.
Returns: String