World & Game State

Functions for getting world information, tile data, and game state.

Functions

getTile()

getTile(x:number, y:number) -> Tile

• Description: Get tile at coordinates
• Parameters:
  • x (number) - X coordinate
  • y (number) - Y coordinate
• Returns:
  • Tile - Tile data
• Example:

  log(getTile(10,5).fg)

getTiles()

getTiles() -> Tile[]

• Description: Get all tiles
• Returns:
  • Tile[] - Array of tiles
• Example:

  for _,i in pairs(getTiles())
      do log(i.fg)
  end

FindPath()

FindPath(x:number, y:number, check_only?:boolean) -> boolean

• Description: Pathfinding check

• Parameters:

  • x (number) - X coordinate
  • y (number) - Y coordinate
  • check_only (boolean, optional) - Check only mode

• Returns: isBlocked: boolean

• boolean - Path exists

• Example:

  local isBlocked = FindPath(10,5,true)

isInside()

isInside(cx:number, cy:number, rad:number, x:number, y:number) -> boolean

• Description: Check if point is inside circle.
• Parameters:
  • cx (number) - Circle center X
  • cy (number) - Circle center Y
  • rad (number) - Circle radius
  • x (number) - Point X
  • y (number) - Point Y
• Returns: boolean - Inside circle
• Example:

  log(isInside(0,0,10,5,5))

getNPCList()

getNPCList() -> ClientNPC[]

• Description: Get list of client-side NPCs.
• Returns:
  • ClientNPC[] - NPC list
• Example:

  for _,n in pairs(getNPCList()) do
      log(n.id) 
  end

getPlayerList()

getPlayerList() -> NetAvatar[]

• Description: Get list of players.
• Returns:
  • NetAvatar[] - Player list
• Example:

  for _, player in pairs(getPlayerList()) do
      log(player.name)
  end

getObjectList()

getObjectList() -> WorldObject[]

• Description: Get list of world objects.
• Returns:
  • WorldObject[] - Object list
• Example:

  for _, object in pairs(getObjectList()) do
      log(object.itemid)
  end

getWorldTileMap()

getWorldTileMap() -> WorldTileMap

• Description: Get world tile map.
• Returns:
  • WorldTileMap - World tile map
• Example:

  log(getWorldTileMap().x)

getPlayerByNetID()

getPlayerByNetID(netid:number) -> NetAvatar

• Description: Get player by NetID.
• Parameters:
  • netid (number) - Network ID
• Returns:
  • NetAvatar - Player
• Example:

  log(getPlayerByNetID(-1).name)

GetWorldName() / getCurrentWorldName()

GetWorldName() -> string / getCurrentWorldName() -> string

• Description: Get current world name.
• Returns:
  • string - World name
• Example:

  log(GetWorldName())