Map util - pival13/FehWikiBot GitHub Wiki

A module holding several useful functions for generation of map and event pages.

Globals

WEAPONS

Type: Dict (String, Skill object)

REFINED

Type: List (String)

Functions

MapImage()

 MapImage(field, simpleMap, useDebris, units)

Parameter Type Default
field SRPGMap.Field object +
2 Lists ({"x": Integer, "y": Integer})
simpleMap Boolean False
useDebris Boolean False
units SRPGMap.Units object None

Return: String

MapInfobox()

 MapInfobox(obj, restricted)

Parameter Type Default
obj Object (See below)
restricted Boolean False

Return: String

Availability()

 Availability(avail, notification, type)

Parameter Type Default
avail Availability object
notification String ""
type String "event"

Return: String

MapAvailability()

 MapAvailability(avail, notification, type)

Parameter Type Default
avail Availability object
notification String None
type String "map"

Return: String

UnitData()

 UnitData(SRPGMap)

Parameter Type
SRPGMap SRPGMap object

Return: String

InOtherLanguage()

 InOtherLanguage(ids, mapName, reorder)

Parameter Type Default
ids String / List (String)
mapName String None
reorder Boolean True

Return: String

__main__

python3 mapUtil.py tag1 [tag2]

Internal globals

REFINED_TYPE

Type: Dict (Integer, String)

USE_ALLY_STATS

Type: List (String)

USE_ENEMY_STATS

Type: List (String)

allLanguages

Type: Dict (String, Language object)

Language object

{
    "USEN": String,
    "JPJA": String,
    "EUDE": String,
    "EUES": String,
    "USES": String,
    "EUFR": String,
    "EUIT": String,
    "TWZH": String,
    "USPT": String,
}

Internal functions

needBackdrop()

 needBackdrop(mapId)

Parameter Type
mapId String

Return: Boolean

containDebris()

 containDebris(terrain)

Parameter Type
terrain List (List (Integer))

Return: Boolean

mapTerrain()

 mapTerrain(terrain, wallStyle, x, y, useDebris)

Parameter Type
terrain List (List (Integer))
wallStyle String
x Integer
y Integer
useDebris Boolean

Return: String

⚠️ **GitHub.com Fallback** ⚠️