LuaMapData classmod

Contains parameters for the current map.

Fields

LuaMapData.atlas_number	[RW] The map tile atlas to use for this map.
LuaMapData.next_regenerate_date	[RW] The date in hours when this map is next regenerated.
LuaMapData.turn_cost	[RW] The relative time it takes to pass a single turn in this map.
LuaMapData.max_crowd_density	[RW] The maximum crowd density of this map.
LuaMapData.current_dungeon_level	[R] The current dungeon level of this map.
LuaMapData.tileset	[RW] The tileset type to use for this map.
LuaMapData.next_restock_date	[RW] The date in hours when the map is next restocked.
LuaMapData.max_item_count	[RW] The maximum number of items this map can hold.
LuaMapData.regenerate_count	[R] The number of times this map has been regenerated.
LuaMapData.is_genreated_every_time	[RW] If true, reset characters to their initial position on map refresh.
LuaMapData.is_indoors	[RW] Indicates if this map is indoors.
LuaMapData.is_user_map	[RW] Indicates if this map is a user map.
LuaMapData.play_campfire_sound	[RW] If true, play the campfire ambience.
LuaMapData.should_regenerate	[RW] If true, regenerate this map when it is refreshed.
LuaMapData.is_temporary	[RW] If true, delete this map when it is exited.
LuaMapData.type	[RW] The type of the map.
LuaMapData.stair_up_pos	[R] The position of the map's up stairs.
LuaMapData.stair_down_pos	[R] The position of the map's down stairs.
LuaMapData.bgm	[RW] The music which will play on entering the map.

Fields

# LuaMapData.atlas_number

[RW] The map tile atlas to use for this map.

• atlas_number : (num)

# LuaMapData.next_regenerate_date

[RW] The date in hours when this map is next regenerated.

• next_regenerate_date : (num)

# LuaMapData.turn_cost

[RW] The relative time it takes to pass a single turn in this map.

• turn_cost : (num)

# LuaMapData.max_crowd_density

[RW] The maximum crowd density of this map.

• max_crowd_density : (num)

# LuaMapData.current_dungeon_level

[R] The current dungeon level of this map.

• current_dungeon_level : (num)

# LuaMapData.tileset

[RW] The tileset type to use for this map.

• tileset : (num)

# LuaMapData.next_restock_date

[RW] The date in hours when the map is next restocked.

• next_restock_date : (num)

# LuaMapData.max_item_count

[RW] The maximum number of items this map can hold.

• max_item_count : (num)

# LuaMapData.regenerate_count

[R] The number of times this map has been regenerated.

• regenerate_count : (num)

# LuaMapData.is_genreated_every_time

[RW] If true, reset characters to their initial position on map refresh.

• is_genreated_every_time : (bool)

# LuaMapData.is_indoors

[RW] Indicates if this map is indoors.

• is_indoors : (bool)

# LuaMapData.is_user_map

[RW] Indicates if this map is a user map.

• is_user_map : (bool)

# LuaMapData.play_campfire_sound

[RW] If true, play the campfire ambience.

• play_campfire_sound : (bool)

# LuaMapData.should_regenerate

[RW] If true, regenerate this map when it is refreshed.

This will restock shop inventories.

• should_regenerate : (bool)

# LuaMapData.is_temporary

[RW] If true, delete this map when it is exited.

• is_temporary : (bool)

# LuaMapData.type

[RW] The type of the map.

• type : (MapType)

# LuaMapData.stair_up_pos

[R] The position of the map's up stairs.

• stair_up_pos : (LuaPosition)

# LuaMapData.stair_down_pos

[R] The position of the map's down stairs.

• stair_down_pos : (LuaPosition)

# LuaMapData.bgm

[RW] The music which will play on entering the map.

• bgm : (core.music)