world

The world library provides information about the player's current area.

local world = require('world')

❗ Dependency Required

To use this library, you must include world in the manifest.xml file for your package:

<dependency>world</dependency>

Tables

The world table has the following entries:

• world.music : music (table)
  
  
• world.weather_id : id of the weather
• world.weather : weather (table)
• world.weather_change : weather_change (event)
  
  
• world.zone_id : id of the zone
• world.zone : zone (table)
• world.zone_change : (event)

music

The music table has the following entries:

• day : id of music played in the day
• night : id of music played in the night
• party_combat : id of music played in party combat
• solo_combat : id of music played in solo combat

weather

The weather table has the following entries:

• element : id of the element associated with the weather
• en : English name of the weather
• id : id of the weather
• intensity : level of intensity
• ja : Japanese name of the weather
• name : name of the weather in client language

zone

The zone table has the following entries:

• en : English name of the zone
• id : id of the zone
• ja : Japanese name of the zone
• name : name of the zone in client language
• search : search term for the zone