Leahnaya/porymap
1
0
Fork 0
mirror of https://github.com/huderlem/porymap.git synced 2026-08-20 07:36:31 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Apply the "map opened" API callback to layouts, add utility functions

Browse Source
This commit is contained in:
GriffinR
2025-02-07 16:25:58 -05:00
parent df861b59ad
commit 01126a888a
5 changed files with 59 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
docsrc/manual/scripting-capabilities.rst
View File

@@ -153,9 +153,9 @@ Callbacks
.. js:function:: onMapOpened(mapName)
Called when a map is opened.
Called when a map or layout is opened.
:param mapName: the name of the opened map
:param mapName: the name of the opened map or layout
:type mapName: string
.. js:function:: onBlockChanged(x, y, prevBlock, newBlock)
@@ -1995,7 +1995,28 @@ All utility functions are callable via the global ``utility`` object.
Gets the list of map names.
:returns: the list of map names
:returns: the list of map names (e.g. `PetalburgCity`)
:rtype: array
.. js:function:: utility.getMapConstants()
Gets the list of map IDs (e.g. `MAP_PETALBURG_CITY`)
:returns: the list of map IDs
:rtype: array
.. js:function:: utility.getLayoutNames()
Gets the list of layout names.
:returns: the list of layout names (e.g. `PetalburgCity_Layout`)
:rtype: array
.. js:function:: utility.getLayoutConstants()
Gets the list of layout IDs (e.g. `LAYOUT_PETALBURG_CITY`)
:returns: the list of layout IDs
:rtype: array
.. js:function:: utility.getTilesetNames()