Add scripting documentation
This commit is contained in:
Marcus Huderle
parent
23a20dd736
commit
92223711e7
27 changed files with 3419 additions and 485 deletions
|
|
@ -1,4 +1,4 @@
|
|||
# Sphinx build info version 1
|
||||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||
config: 0c9901306ee335472548e17d7ddc5dfb
|
||||
config: e41613e939dfe6ab7008de864b4e64a8
|
||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||
|
|
|
|||
BIN
docs/_images/porymap-scripting-grass.gif
Normal file
BIN
docs/_images/porymap-scripting-grass.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 243 KiB |
|
|
@ -17,6 +17,7 @@ Porymap Documentation
|
|||
manual/editing-map-connections
|
||||
manual/editing-wild-encounters
|
||||
manual/region-map-editor
|
||||
manual/scripting-capabilities
|
||||
manual/project-files
|
||||
|
||||
.. toctree::
|
||||
|
|
|
|||
523
docs/_sources/manual/scripting-capabilities.rst.txt
Normal file
523
docs/_sources/manual/scripting-capabilities.rst.txt
Normal file
|
|
@ -0,0 +1,523 @@
|
|||
**********************
|
||||
Scripting Capabilities
|
||||
**********************
|
||||
|
||||
Porymap is extensible via scripting capabilities. This allows the user to write custom JavaScript (technically, ECMAScript) files to support enhanced workflows, without having to fork Porymap itself. While the possibilities are endless, some useful examples of scripting might be:
|
||||
|
||||
- Toggle Day/Night Palettes
|
||||
- Custom Map Painting Brushes
|
||||
- Detect Tile Errors
|
||||
- Show Diagonistic Information
|
||||
- Procedurally Generated Maps
|
||||
- Randomize Grass Patterns
|
||||
|
||||
Writing a Custom Script
|
||||
-----------------------
|
||||
|
||||
Let's write a custom script that will randomize grass patterns when the user is editing the map. This is useful, since it's cumbersome to manually add randomness to grass patches. With the custom script, it will happen automatically. Whenever the user paints a grass tile onto the map, the script will overwrite the tile with a random grass tile instead.
|
||||
|
||||
First, create a new script file called ``my_script.js``--place it in the project directory (e.g. ``pokefirered/``).
|
||||
|
||||
Next, open the Porymap project config file, ``porymap.project.cfg``, in the project directory. Add the script file to the ``custom_scripts`` configuration value. Multiple script files can be loaded by separating the filepaths with a comma.
|
||||
|
||||
.. code-block::
|
||||
|
||||
custom_scripts=my_script.js
|
||||
|
||||
Now that Porymap is configured to load the script file, let's write the actual code that will power the grass-randomizer. Scripts have access to several "callbacks" for events that occur while Porymap is running. This means our script can define functions for each of these callbacks. We're interested in the ``onBlockChanged()`` callback, since we want our script to take action whenever a user paints a block on the map.
|
||||
|
||||
.. code-block:: js
|
||||
|
||||
// Porymap callback when a block is painted.
|
||||
export function onBlockChanged(x, y, prevBlock, newBlock) {
|
||||
// Grass-randomizing logic goes here.
|
||||
}
|
||||
|
||||
It's very **important** to remember to ``export`` the callback functions in the script. Otherwise, Porymap will not be able to execute them.
|
||||
|
||||
In addition to the callbacks, Porymap also supports a scripting API so that the script can interact with Porymap in interesting ways. For example, a script can change a block or add overlay text on the map. Since we want to paint random grass tiles, we'll be using the ``map.setMetatileId()`` function. Let's fill in the rest of the grass-randomizing code.
|
||||
|
||||
.. code-block:: js
|
||||
|
||||
function randInt(min, max) {
|
||||
min = Math.ceil(min);
|
||||
max = Math.floor(max);
|
||||
return Math.floor(Math.random() * (max - min)) + min;
|
||||
}
|
||||
|
||||
// These are the grass metatiles in pokefirered.
|
||||
const grassTiles = [0x8, 0x9, 0x10, 0x11];
|
||||
|
||||
// Porymap callback when a block is painted.
|
||||
export function onBlockChanged(x, y, prevBlock, newBlock) {
|
||||
// Check if the user is painting a grass tile.
|
||||
if (grassTiles.indexOf(newBlock.metatileId) != -1) {
|
||||
// Choose a random grass tile and paint it on the map.
|
||||
const i = randInt(0, grassTiles.length);
|
||||
map.setMetatileId(x, y, grassTiles[i]);
|
||||
}
|
||||
}
|
||||
|
||||
Let's test the script out by re-launching Porymap. If we try to paint grass on the map, we should see our script inserting a nice randomized grass pattern.
|
||||
|
||||
.. figure:: images/scripting-capabilities/porymap-scripting-grass.gif
|
||||
:alt: Grass-Randomizing Script
|
||||
|
||||
Grass-Randomizing Script
|
||||
|
||||
Registering Script Actions
|
||||
--------------------------
|
||||
|
||||
The grass-randomizer script above happens implicitly when the user paints on the map. However, other times we probably want to call the custom script on demand. One of the API function Porymap provides is the ability to trigger scripting functions from the ``Tools`` menu, or a keyboard shortcut. To do this, we will usually want to register the action when the project loads. Here is an example script where a couple custom actions are registered.
|
||||
|
||||
.. code-block:: js
|
||||
|
||||
function applyNightTint() {
|
||||
// Apply night palette tinting...
|
||||
}
|
||||
|
||||
// Porymap callback when project is opened.
|
||||
export function onProjectOpened(projectPath) {
|
||||
map.registerAction("applyNightTint", "View Night Tint", "T")
|
||||
}
|
||||
|
||||
Then, to trigger the ``applyNightTint()`` function, we could either click ``Tools -> View Night Tint`` or use the ``T`` keyboard shortcut.
|
||||
|
||||
Now that we have an overview of how to utilize Porymap's scripting capabilities, the entire scripting API is documented below.
|
||||
|
||||
Scripting API
|
||||
-------------
|
||||
|
||||
Callbacks
|
||||
~~~~~~~~~
|
||||
|
||||
.. js:function:: onProjectOpened(projectPath)
|
||||
|
||||
Called when Porymap successfully opens a project.
|
||||
|
||||
:param string projectPath: the directory path of the opened project
|
||||
|
||||
.. js:function:: onProjectClosed(projectPath)
|
||||
|
||||
Called when Porymap closes a project. For example, this is called when opening a different project.
|
||||
|
||||
:param string projectPath: the directory path of the closed project
|
||||
|
||||
.. js:function:: onMapOpened(mapName)
|
||||
|
||||
Called when a map is opened.
|
||||
|
||||
:param string mapName: the name of the opened map
|
||||
|
||||
.. js:function:: onBlockChanged(x, y, prevBlock, newBlock)
|
||||
|
||||
Called when a block is changed on the map. For example, this is called when a user paints a new tile or changes the collision property of a block.
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:param object prevBlock: the block's state before it was modified. The object's shape is ``{metatileId, collision, elevation, rawValue}``
|
||||
:param object newBlock: the block's new state after it was modified. The object's shape is ``{metatileId, collision, elevation, rawValue}``
|
||||
|
||||
Functions
|
||||
~~~~~~~~~
|
||||
|
||||
All scripting functions are callable via the global ``map`` object.
|
||||
|
||||
Map Editing Functions
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The following functions are related to editing the map's blocks or retrieving information about them.
|
||||
|
||||
.. js:function:: map.getBlock(x, y)
|
||||
|
||||
Gets a block in the currently-opened map.
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:returns {metatileId, collision, elevation, rawValue}: the block object
|
||||
|
||||
.. js:function:: map.setBlock(x, y, metatileId, collision, elevation)
|
||||
|
||||
Sets a block in the currently-opened map.
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:param number metatileId: the metatile id of the block
|
||||
:param number collision: the collision of the block (``0`` = passable, ``1`` = impassable)
|
||||
:param number elevation: the elevation of the block
|
||||
|
||||
.. js:function:: map.getMetatileId(x, y)
|
||||
|
||||
Gets the metatile id of a block in the currently-opened map.
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:returns number: the metatile id of the block
|
||||
|
||||
.. js:function:: map.setMetatileId(x, y, metatileId)
|
||||
|
||||
Sets the metatile id of a block in the currently-opened map.
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:param number metatileId: the metatile id of the block
|
||||
|
||||
.. js:function:: map.getCollision(x, y)
|
||||
|
||||
Gets the collision of a block in the currently-opened map. (``0`` = passable, ``1`` = impassable)
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:returns number: the collision of the block
|
||||
|
||||
.. js:function:: map.setCollision(x, y, collision)
|
||||
|
||||
Sets the collision of a block in the currently-opened map. (``0`` = passable, ``1`` = impassable)
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:param number collision: the collision of the block
|
||||
|
||||
.. js:function:: map.getElevation(x, y)
|
||||
|
||||
Gets the elevation of a block in the currently-opened map.
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:returns number: the elevation of the block
|
||||
|
||||
.. js:function:: map.setElevation(x, y, elevation)
|
||||
|
||||
Sets the elevation of a block in the currently-opened map.
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:param number elevation: the elevation of the block
|
||||
|
||||
.. js:function:: map.setBlocksFromSelection(x, y)
|
||||
|
||||
Sets blocks on the map using the user's current metatile selection.
|
||||
|
||||
:param number x: initial x coordinate
|
||||
:param number y: initial y coordinate
|
||||
|
||||
.. js:function:: map.bucketFill(x, y, metatileId)
|
||||
|
||||
Performs a bucket fill of a metatile id, starting at the given coordinates.
|
||||
|
||||
:param number x: initial x coordinate
|
||||
:param number y: initial y coordinate
|
||||
:param number metatileId: metatile id to fill
|
||||
|
||||
.. js:function:: map.bucketFillFromSelection(x, y)
|
||||
|
||||
Performs a bucket fill using the user's current metatile selection, starting at the given coordinates.
|
||||
|
||||
:param number x: initial x coordinate
|
||||
:param number y: initial y coordinate
|
||||
|
||||
.. js:function:: map.magicFill(x, y, metatileId)
|
||||
|
||||
Performs a magic fill of a metatile id, starting at the given coordinates.
|
||||
|
||||
:param number x: initial x coordinate
|
||||
:param number y: initial y coordinate
|
||||
:param number metatileId: metatile id to magic fill
|
||||
|
||||
.. js:function:: map.magicFillFromSelection(x, y)
|
||||
|
||||
Performs a magic fill using the user's current metatile selection, starting at the given coordinates.
|
||||
|
||||
:param number x: initial x coordinate
|
||||
:param number y: initial y coordinate
|
||||
|
||||
.. js:function:: map.shift(xDelta, yDelta)
|
||||
|
||||
Performs a shift on the map's blocks.
|
||||
|
||||
:param number xDelta: number of blocks to shift horizontally
|
||||
:param number yDelta: number of blocks to shift vertically
|
||||
|
||||
.. js:function:: map.getDimensions()
|
||||
|
||||
Gets the dimensions of the currently-opened map.
|
||||
|
||||
:returns {width, height}: the dimensions of the map
|
||||
|
||||
.. js:function:: map.getWidth()
|
||||
|
||||
Gets the width of the currently-opened map.
|
||||
|
||||
:returns number: the width of the map
|
||||
|
||||
.. js:function:: map.getHeight()
|
||||
|
||||
Gets the height of the currently-opened map.
|
||||
|
||||
:returns number: the height of the map
|
||||
|
||||
.. js:function:: map.setDimensions(width, height)
|
||||
|
||||
Sets the dimensions of the currently-opened map.
|
||||
|
||||
:param number width: width in blocks
|
||||
:param number height: height in blocks
|
||||
|
||||
.. js:function:: map.setWidth(width)
|
||||
|
||||
Sets the width of the currently-opened map.
|
||||
|
||||
:param number width: width in blocks
|
||||
|
||||
.. js:function:: map.setHeight()
|
||||
|
||||
Sets the height of the currently-opened map.
|
||||
|
||||
:param number height: height in blocks
|
||||
|
||||
Map Overlay Functions
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The following functions are related to an overlay that is drawn on top of the map area. Text, images, and shapes can be drawn using these functions.
|
||||
|
||||
.. js:function:: map.clearOverlay()
|
||||
|
||||
Clears and erases all overlay items that were previously-added to the map.
|
||||
|
||||
.. js:function:: map.addText(text, x, y, color = "#000000", size = 12)
|
||||
|
||||
Adds a text item to the overlay.
|
||||
|
||||
:param string text: the text to display
|
||||
:param number x: the x pixel coordinate of the text
|
||||
:param number y: the y pixel coordinate of the text
|
||||
:param string color: the color of the text. Can be specified as "#RRGGBB" or "#AARRGGBB". Defaults to black.
|
||||
:param number size: the font size of the text. Defaults to 12.
|
||||
|
||||
.. js:function:: map.addRect(x, y, width, height, color = "#000000")
|
||||
|
||||
Adds a rectangle outline item to the overlay.
|
||||
|
||||
:param number x: the x pixel coordinate of the rectangle's top-left corner
|
||||
:param number y: the y pixel coordinate of the rectangle's top-left corner
|
||||
:param number width: the pixel width of the rectangle
|
||||
:param number height: the pixel height of the rectangle
|
||||
:param string color: the color of the rectangle. Can be specified as "#RRGGBB" or "#AARRGGBB". Defaults to black.
|
||||
|
||||
.. js:function:: map.addFilledRect(x, y, width, height, color = "#000000")
|
||||
|
||||
Adds a filled rectangle item to the overlay.
|
||||
|
||||
:param number x: the x pixel coordinate of the rectangle's top-left corner
|
||||
:param number y: the y pixel coordinate of the rectangle's top-left corner
|
||||
:param number width: the pixel width of the rectangle
|
||||
:param number height: the pixel height of the rectangle
|
||||
:param string color: the color of the rectangle. Can be specified as "#RRGGBB" or "#AARRGGBB". Defaults to black.
|
||||
|
||||
.. js:function:: map.addImage(x, y, filepath)
|
||||
|
||||
Adds an image item to the overlay.
|
||||
|
||||
:param number x: the x pixel coordinate of the image's top-left corner
|
||||
:param number y: the y pixel coordinate of the image's top-left corner
|
||||
:param string filepath: the image's filepath
|
||||
|
||||
Tileset Functions
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
The following functions are related to tilesets and their palettes. The functions with "preview" in their name operate on a "fake" version of the palette colors. This means that changing these "preview" colors won't affect the actual tileset colors in the project. A good use of the "preview" palettes would be Day/Night tints, for example.
|
||||
|
||||
.. js:function:: map.getPrimaryTilesetPalettePreview(paletteIndex)
|
||||
|
||||
Gets a palette from the primary tileset of the currently-opened map.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:returns array: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setPrimaryTilesetPalettePreview(paletteIndex, colors)
|
||||
|
||||
Sets a palette in the primary tileset of the currently-opened map. This will NOT affect the true underlying colors--it only displays these colors in the map-editing area of Porymap.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:param array colors: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getPrimaryTilesetPalettesPreview()
|
||||
|
||||
Gets all of the palettes from the primary tileset of the currently-opened map.
|
||||
|
||||
:returns array: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setPrimaryTilesetPalettesPreview(palettes)
|
||||
|
||||
Sets all of the palettes in the primary tileset of the currently-opened map. This will NOT affect the true underlying colors--it only displays these colors in the map-editing area of Porymap.
|
||||
|
||||
:param array palettes: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getSecondaryTilesetPalettePreview(paletteIndex)
|
||||
|
||||
Gets a palette from the secondary tileset of the currently-opened map.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:returns array: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setSecondaryTilesetPalettePreview(paletteIndex, colors)
|
||||
|
||||
Sets a palette in the secondary tileset of the currently-opened map. This will NOT affect the true underlying colors--it only displays these colors in the map-editing area of Porymap.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:param array colors: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getSecondaryTilesetPalettesPreview()
|
||||
|
||||
Gets all of the palettes from the secondary tileset of the currently-opened map.
|
||||
|
||||
:returns array: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setSecondaryTilesetPalettesPreview(palettes)
|
||||
|
||||
Sets all of the palettes in the secondary tileset of the currently-opened map. This will NOT affect the true underlying colors--it only displays these colors in the map-editing area of Porymap.
|
||||
|
||||
:param array palettes: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getPrimaryTilesetPalette(paletteIndex)
|
||||
|
||||
Gets a palette from the primary tileset of the currently-opened map.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:returns array: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setPrimaryTilesetPalette(paletteIndex, colors)
|
||||
|
||||
Sets a palette in the primary tileset of the currently-opened map. This will permanently affect the palette and save the palette to disk.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:param array colors: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getPrimaryTilesetPalettes()
|
||||
|
||||
Gets all of the palettes from the primary tileset of the currently-opened map.
|
||||
|
||||
:returns array: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setPrimaryTilesetPalettes(palettes)
|
||||
|
||||
Sets all of the palettes in the primary tileset of the currently-opened map. This will permanently affect the palettes and save the palettes to disk.
|
||||
|
||||
:param array palettes: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getSecondaryTilesetPalette(paletteIndex)
|
||||
|
||||
Gets a palette from the secondary tileset of the currently-opened map.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:returns array: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setSecondaryTilesetPalette(paletteIndex, colors)
|
||||
|
||||
Sets a palette in the secondary tileset of the currently-opened map. This will permanently affect the palette and save the palette to disk.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:param array colors: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getSecondaryTilesetPalettes()
|
||||
|
||||
Gets all of the palettes from the secondary tileset of the currently-opened map.
|
||||
|
||||
:returns array: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setSecondaryTilesetPalettes(palettes)
|
||||
|
||||
Sets all of the palettes in the secondary tileset of the currently-opened map. This will permanently affect the palettes and save the palettes to disk.
|
||||
|
||||
:param array palettes: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getPrimaryTileset()
|
||||
|
||||
Gets the name of the primary tileset for the currently-opened map.
|
||||
|
||||
:returns string: primary tileset name
|
||||
|
||||
.. js:function:: map.setPrimaryTileset(tileset)
|
||||
|
||||
Sets the primary tileset for the currently-opened map.
|
||||
|
||||
:param string tileset: the tileset name
|
||||
|
||||
.. js:function:: map.getSecondaryTileset()
|
||||
|
||||
Gets the name of the secondary tileset for the currently-opened map.
|
||||
|
||||
:returns string: secondary tileset name
|
||||
|
||||
.. js:function:: map.setSecondaryTileset(tileset)
|
||||
|
||||
Sets the secondary tileset for the currently-opened map.
|
||||
|
||||
:param string tileset: the tileset name
|
||||
|
||||
Settings Functions
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The following functions are related to settings.
|
||||
|
||||
.. js:function:: map.getGridVisibility()
|
||||
|
||||
Gets the visibility of the map grid overlay.
|
||||
|
||||
:returns boolean: grid visibility
|
||||
|
||||
.. js:function:: map.setGridVisibility(visible)
|
||||
|
||||
Sets the visibility of the map grid overlay.
|
||||
|
||||
:param boolean visible: grid visibility
|
||||
|
||||
.. js:function:: map.getBorderVisibility()
|
||||
|
||||
Gets the visibility of the map's border.
|
||||
|
||||
:returns boolean: border visibility
|
||||
|
||||
.. js:function:: map.setBorderVisibility(visible)
|
||||
|
||||
Sets the visibility of the map's border.
|
||||
|
||||
:param boolean visible: border visibility
|
||||
|
||||
.. js:function:: map.getSmartPathsEnabled()
|
||||
|
||||
Gets the toggle state of smart paths.
|
||||
|
||||
:returns boolean: smart paths enabled
|
||||
|
||||
.. js:function:: map.setSmartPathsEnabled(enabled)
|
||||
|
||||
Sets the toggle state of smart paths.
|
||||
|
||||
:param boolean enabled: smart paths enabled
|
||||
|
||||
Utility Functions
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
These are some miscellaneous functions that can be very useful when building custom scripts.
|
||||
|
||||
.. js:function:: map.registerAction(functionName, actionName, shortcut = "")
|
||||
|
||||
Registers a JavaScript function to an action that can be manually triggered in Porymap's ``Tools`` menu. Optionally, a keyboard shortcut (e.g. ``"Ctrl+P"``) can also be specified, assuming it doesn't collide with any existing shortcuts used by Porymap.
|
||||
|
||||
:param string functionName: name of the JavaScript function
|
||||
:param string actionName: name of the action that will be displayed in the ``Tools`` menu
|
||||
:param string shortcut: optional keyboard shortcut
|
||||
|
||||
.. js:function:: map.setTimeout(func, delayMs)
|
||||
|
||||
This behaves essentially the same as JavaScript's ``setTimeout()`` that is used in web browsers or NodeJS. The ``func`` argument is a JavaScript function (NOT the name of a function) which will be executed after a delay. This is useful for creating animations or refreshing the overlay at constant intervals.
|
||||
|
||||
:param function func: a JavaScript function that will be executed later
|
||||
:param number delayMs: the number of milliseconds to wait before executing ``func``
|
||||
|
||||
.. js:function:: map.log(message)
|
||||
|
||||
Logs a message to the Porymap log file. This is useful for debugging custom scripts.
|
||||
|
||||
:param string message: the message to log
|
||||
|
|
@ -2,12 +2,43 @@
|
|||
All notable changes to this project will be documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||
and this project somewhat adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). The MINOR version number is bumped when there are breaking changes in the pret projects.
|
||||
and this project somewhat adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). The MAJOR version number is bumped when there are breaking changes in the pret projects.
|
||||
|
||||
The **"Breaking Changes"** listed below are changes that have been made in the decompilation projects (e.g. pokeemerald), which porymap requires in order to work properly. If porymap is used on a project that is not up-to-date with the breaking changes, then porymap will likely break or behave improperly.
|
||||
|
||||
## Unreleased
|
||||
Nothing, yet.
|
||||
## [Unreleased]
|
||||
### Added
|
||||
- Add scripting capabilities, which allows the user to add custom behavior to Porymap using JavaScript scripts.
|
||||
- Add ability to import FRLG tileset .bvd files from Advance Map 1.92.
|
||||
|
||||
### Fixed
|
||||
- Disallow drawing new heal locations in the events tab.
|
||||
- Fix issue where the metatile selection window was not resizable.
|
||||
|
||||
## [4.0.0] - 2020-04-28
|
||||
### Breaking Changes
|
||||
- If you are using pokeemerald or pokeruby, there were changes made in [pokeemerald/#1010](https://github.com/pret/pokeemerald/pull/1010) and [pokeruby/#776](https://github.com/pret/pokeruby/pull/776) that you will need to integrate in order to use this version of porymap.
|
||||
|
||||
### Added
|
||||
- Support for [pokefirered](https://github.com/pret/pokefirered). Kanto fans rejoice! At long last porymap supports the FRLG decompilation project.
|
||||
- Add ability to export map stitches with `File -> Export Map Stitch Image...`.
|
||||
- Add new project config option `use_custom_border_size`.
|
||||
- Add ability to toggle project settings in `Options` menu.
|
||||
- Add file monitoring, so Porymap will prompt the user to reload the project if certain project files are modified outside of Porymap.
|
||||
- Add ability to reload project.
|
||||
- Add `Pencil`, `Move`, and `Map Shift` tools to the Events tab.
|
||||
|
||||
### Changed
|
||||
- Porymap now saves map and encounter json data in an order consistent with the upstream repos. This will provide more comprehensible diffs when files are saved.
|
||||
- Update Porymap icon.
|
||||
- The "Map" and "Events" tabs now render using the same view, so jumping between them is smooth.
|
||||
- Extend connection min and max offsets to player's view boundary, rather than the map's boundary.
|
||||
|
||||
### Fixed
|
||||
- Fix bug where pressing TAB key did not navigate through widgets in the wild encounter tables.
|
||||
- Fix bug that allowed selecting an invalid metatile in the metatile selector.
|
||||
- Don't allow `.` or `-` characters in new tileset names.
|
||||
- Fix regression that prevented selecting empty region map squares
|
||||
|
||||
## [3.0.1] - 2020-03-04
|
||||
### Fixed
|
||||
|
|
@ -150,7 +181,8 @@ Nothing, yet.
|
|||
## [1.0.0] - 2018-10-26
|
||||
This was the initial release.
|
||||
|
||||
[Unreleased]: https://github.com/huderlem/porymap/compare/3.0.1...HEAD
|
||||
[Unreleased]: https://github.com/huderlem/porymap/compare/4.0.0...HEAD
|
||||
[4.0.0]: https://github.com/huderlem/porymap/compare/3.0.1...4.0.0
|
||||
[3.0.1]: https://github.com/huderlem/porymap/compare/3.0.0...3.0.1
|
||||
[3.0.0]: https://github.com/huderlem/porymap/compare/2.0.0...3.0.0
|
||||
[2.0.0]: https://github.com/huderlem/porymap/compare/1.2.2...2.0.0
|
||||
|
|
|
|||
|
|
@ -145,56 +145,84 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#city-maps">City Maps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="manual/scripting-capabilities.html">Scripting Capabilities</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#writing-a-custom-script">Writing a Custom Script</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#registering-script-actions">Registering Script Actions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#scripting-api">Scripting API</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="manual/scripting-capabilities.html#callbacks">Callbacks</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="manual/scripting-capabilities.html#functions">Functions</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#map-overlay-functions">Map Overlay Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#tileset-functions">Tileset Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#settings-functions">Settings Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#utility-functions">Utility Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="manual/project-files.html">Project Files</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">4.0.0 - 2020-04-28</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id8">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id4">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id5">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id12">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id6">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id7">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id8">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id9">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id10">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id11">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id12">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id13">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id14">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id20">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id16">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id17">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id18">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id19">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id25">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id20">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id21">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id22">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id23">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id24">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id25">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id26">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id27">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id28">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id29">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id30">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id31">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id32">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id33">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reference/related-projects.html">Related Projects</a></li>
|
||||
|
|
@ -268,8 +296,142 @@
|
|||
<h1 id="index">Index</h1>
|
||||
|
||||
<div class="genindex-jumpbox">
|
||||
<a href="#M"><strong>M</strong></a>
|
||||
| <a href="#O"><strong>O</strong></a>
|
||||
|
||||
</div>
|
||||
<h2 id="M">M</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="manual/scripting-capabilities.html#map.addFilledRect">map.addFilledRect() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.addImage">map.addImage() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.addRect">map.addRect() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.addText">map.addText() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.bucketFill">map.bucketFill() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.bucketFillFromSelection">map.bucketFillFromSelection() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.clearOverlay">map.clearOverlay() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getBlock">map.getBlock() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getBorderVisibility">map.getBorderVisibility() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getCollision">map.getCollision() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getDimensions">map.getDimensions() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getElevation">map.getElevation() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getGridVisibility">map.getGridVisibility() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getHeight">map.getHeight() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getMetatileId">map.getMetatileId() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getPrimaryTileset">map.getPrimaryTileset() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getPrimaryTilesetPalette">map.getPrimaryTilesetPalette() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getPrimaryTilesetPalettePreview">map.getPrimaryTilesetPalettePreview() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getPrimaryTilesetPalettes">map.getPrimaryTilesetPalettes() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getPrimaryTilesetPalettesPreview">map.getPrimaryTilesetPalettesPreview() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getSecondaryTileset">map.getSecondaryTileset() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getSecondaryTilesetPalette">map.getSecondaryTilesetPalette() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getSecondaryTilesetPalettePreview">map.getSecondaryTilesetPalettePreview() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getSecondaryTilesetPalettes">map.getSecondaryTilesetPalettes() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getSecondaryTilesetPalettesPreview">map.getSecondaryTilesetPalettesPreview() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getSmartPathsEnabled">map.getSmartPathsEnabled() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.getWidth">map.getWidth() (map method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="manual/scripting-capabilities.html#map.log">map.log() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.magicFill">map.magicFill() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.magicFillFromSelection">map.magicFillFromSelection() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.registerAction">map.registerAction() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setBlock">map.setBlock() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setBlocksFromSelection">map.setBlocksFromSelection() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setBorderVisibility">map.setBorderVisibility() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setCollision">map.setCollision() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setDimensions">map.setDimensions() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setElevation">map.setElevation() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setGridVisibility">map.setGridVisibility() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setHeight">map.setHeight() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setMetatileId">map.setMetatileId() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setPrimaryTileset">map.setPrimaryTileset() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setPrimaryTilesetPalette">map.setPrimaryTilesetPalette() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setPrimaryTilesetPalettePreview">map.setPrimaryTilesetPalettePreview() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setPrimaryTilesetPalettes">map.setPrimaryTilesetPalettes() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setPrimaryTilesetPalettesPreview">map.setPrimaryTilesetPalettesPreview() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setSecondaryTileset">map.setSecondaryTileset() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setSecondaryTilesetPalette">map.setSecondaryTilesetPalette() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setSecondaryTilesetPalettePreview">map.setSecondaryTilesetPalettePreview() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setSecondaryTilesetPalettes">map.setSecondaryTilesetPalettes() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setSecondaryTilesetPalettesPreview">map.setSecondaryTilesetPalettesPreview() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setSmartPathsEnabled">map.setSmartPathsEnabled() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setTimeout">map.setTimeout() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.setWidth">map.setWidth() (map method)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#map.shift">map.shift() (map method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="O">O</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="manual/scripting-capabilities.html#onBlockChanged">onBlockChanged() (built-in function)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#onMapOpened">onMapOpened() (built-in function)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="manual/scripting-capabilities.html#onProjectClosed">onProjectClosed() (built-in function)</a>
|
||||
</li>
|
||||
<li><a href="manual/scripting-capabilities.html#onProjectOpened">onProjectOpened() (built-in function)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
|
@ -282,7 +444,7 @@
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
|
|
|||
105
docs/index.html
105
docs/index.html
|
|
@ -145,56 +145,84 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#city-maps">City Maps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="manual/scripting-capabilities.html">Scripting Capabilities</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#writing-a-custom-script">Writing a Custom Script</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#registering-script-actions">Registering Script Actions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#scripting-api">Scripting API</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="manual/scripting-capabilities.html#callbacks">Callbacks</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="manual/scripting-capabilities.html#functions">Functions</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#map-overlay-functions">Map Overlay Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#tileset-functions">Tileset Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#settings-functions">Settings Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#utility-functions">Utility Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="manual/project-files.html">Project Files</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">4.0.0 - 2020-04-28</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id8">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id4">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id5">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id12">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id6">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id7">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id8">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id9">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id10">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id11">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id12">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id13">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id14">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id20">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id16">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id17">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id18">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id19">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id25">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id20">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id21">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id22">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id23">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id24">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id25">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id26">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id27">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id28">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id29">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id30">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id31">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id32">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id33">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reference/related-projects.html">Related Projects</a></li>
|
||||
|
|
@ -336,6 +364,12 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#city-maps">City Maps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="manual/scripting-capabilities.html">Scripting Capabilities</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#writing-a-custom-script">Writing a Custom Script</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#registering-script-actions">Registering Script Actions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#scripting-api">Scripting API</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="manual/project-files.html">Project Files</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
@ -344,14 +378,15 @@
|
|||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">3.0.1 - 2020-03-04</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id2">3.0.0 - 2020-03-04</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id4">2.0.0 - 2019-10-16</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id9">1.2.2 - 2019-05-16</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id13">1.2.1 - 2019-02-16</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id16">1.2.0 - 2019-02-04</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id21">1.1.0 - 2018-12-27</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">4.0.0 - 2020-04-28</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id4">3.0.1 - 2020-03-04</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id6">3.0.0 - 2020-03-04</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id11">2.0.0 - 2019-10-16</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id16">1.2.2 - 2019-05-16</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id20">1.2.1 - 2019-02-16</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id23">1.2.0 - 2019-02-04</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id28">1.1.0 - 2018-12-27</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id33">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reference/related-projects.html">Related Projects</a></li>
|
||||
|
|
@ -377,7 +412,7 @@
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -146,56 +146,84 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#city-maps">City Maps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="scripting-capabilities.html">Scripting Capabilities</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#writing-a-custom-script">Writing a Custom Script</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#registering-script-actions">Registering Script Actions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#scripting-api">Scripting API</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#callbacks">Callbacks</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#functions">Functions</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-overlay-functions">Map Overlay Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#tileset-functions">Tileset Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#settings-functions">Settings Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#utility-functions">Utility Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">4.0.0 - 2020-04-28</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id6">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id11">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id13">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id20">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id21">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id23">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id26">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id28">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id29">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id30">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id31">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id32">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id33">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
|
||||
|
|
@ -334,7 +362,7 @@
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -146,56 +146,84 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#city-maps">City Maps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="scripting-capabilities.html">Scripting Capabilities</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#writing-a-custom-script">Writing a Custom Script</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#registering-script-actions">Registering Script Actions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#scripting-api">Scripting API</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#callbacks">Callbacks</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#functions">Functions</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-overlay-functions">Map Overlay Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#tileset-functions">Tileset Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#settings-functions">Settings Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#utility-functions">Utility Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">4.0.0 - 2020-04-28</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id6">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id11">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id13">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id20">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id21">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id23">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id26">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id28">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id29">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id30">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id31">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id32">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id33">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
|
||||
|
|
@ -308,7 +336,7 @@
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -146,56 +146,84 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#city-maps">City Maps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="scripting-capabilities.html">Scripting Capabilities</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#writing-a-custom-script">Writing a Custom Script</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#registering-script-actions">Registering Script Actions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#scripting-api">Scripting API</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#callbacks">Callbacks</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#functions">Functions</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-overlay-functions">Map Overlay Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#tileset-functions">Tileset Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#settings-functions">Settings Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#utility-functions">Utility Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">4.0.0 - 2020-04-28</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id6">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id11">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id13">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id20">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id21">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id23">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id26">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id28">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id29">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id30">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id31">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id32">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id33">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
|
||||
|
|
@ -442,7 +470,7 @@
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -146,56 +146,84 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#city-maps">City Maps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="scripting-capabilities.html">Scripting Capabilities</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#writing-a-custom-script">Writing a Custom Script</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#registering-script-actions">Registering Script Actions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#scripting-api">Scripting API</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#callbacks">Callbacks</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#functions">Functions</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-overlay-functions">Map Overlay Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#tileset-functions">Tileset Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#settings-functions">Settings Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#utility-functions">Utility Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">4.0.0 - 2020-04-28</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id6">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id11">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id13">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id20">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id21">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id23">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id26">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id28">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id29">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id30">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id31">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id32">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id33">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
|
||||
|
|
@ -318,7 +346,7 @@
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -146,56 +146,84 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#city-maps">City Maps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="scripting-capabilities.html">Scripting Capabilities</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#writing-a-custom-script">Writing a Custom Script</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#registering-script-actions">Registering Script Actions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#scripting-api">Scripting API</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#callbacks">Callbacks</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#functions">Functions</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-overlay-functions">Map Overlay Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#tileset-functions">Tileset Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#settings-functions">Settings Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#utility-functions">Utility Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">4.0.0 - 2020-04-28</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id6">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id11">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id13">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id20">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id21">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id23">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id26">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id28">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id29">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id30">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id31">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id32">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id33">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
|
||||
|
|
@ -396,7 +424,7 @@
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -146,56 +146,84 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#city-maps">City Maps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="scripting-capabilities.html">Scripting Capabilities</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#writing-a-custom-script">Writing a Custom Script</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#registering-script-actions">Registering Script Actions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#scripting-api">Scripting API</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#callbacks">Callbacks</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#functions">Functions</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-overlay-functions">Map Overlay Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#tileset-functions">Tileset Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#settings-functions">Settings Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#utility-functions">Utility Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">4.0.0 - 2020-04-28</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id6">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id11">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id13">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id20">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id21">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id23">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id26">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id28">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id29">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id30">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id31">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id32">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id33">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
|
||||
|
|
@ -369,7 +397,7 @@ the levels.</p>
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -146,56 +146,84 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#city-maps">City Maps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="scripting-capabilities.html">Scripting Capabilities</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#writing-a-custom-script">Writing a Custom Script</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#registering-script-actions">Registering Script Actions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#scripting-api">Scripting API</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#callbacks">Callbacks</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#functions">Functions</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-overlay-functions">Map Overlay Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#tileset-functions">Tileset Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#settings-functions">Settings Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#utility-functions">Utility Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">4.0.0 - 2020-04-28</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id6">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id11">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id13">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id20">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id21">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id23">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id26">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id28">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id29">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id30">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id31">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id32">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id33">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
|
||||
|
|
@ -339,7 +367,7 @@
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -146,56 +146,84 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#city-maps">City Maps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="scripting-capabilities.html">Scripting Capabilities</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#writing-a-custom-script">Writing a Custom Script</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#registering-script-actions">Registering Script Actions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#scripting-api">Scripting API</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#callbacks">Callbacks</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#functions">Functions</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-overlay-functions">Map Overlay Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#tileset-functions">Tileset Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#settings-functions">Settings Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#utility-functions">Utility Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">4.0.0 - 2020-04-28</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id6">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id11">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id13">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id20">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id21">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id23">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id26">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id28">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id29">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id30">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id31">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id32">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id33">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
|
||||
|
|
@ -350,7 +378,7 @@
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@
|
|||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="next" title="Changelog" href="../reference/changelog.html" />
|
||||
<link rel="prev" title="The Region Map Editor" href="region-map-editor.html" />
|
||||
<link rel="prev" title="Scripting Capabilities" href="scripting-capabilities.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
|
@ -146,56 +146,84 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#city-maps">City Maps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="scripting-capabilities.html">Scripting Capabilities</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#writing-a-custom-script">Writing a Custom Script</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#registering-script-actions">Registering Script Actions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#scripting-api">Scripting API</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#callbacks">Callbacks</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#functions">Functions</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-overlay-functions">Map Overlay Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#tileset-functions">Tileset Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#settings-functions">Settings Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#utility-functions">Utility Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Project Files</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">4.0.0 - 2020-04-28</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id6">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id11">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id13">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id20">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id21">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id23">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id26">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id28">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id29">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id30">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id31">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id32">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id33">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
|
||||
|
|
@ -455,7 +483,7 @@ to a file, it probably is not a good idea to edit yourself unless otherwise note
|
|||
<a href="../reference/changelog.html" class="btn btn-neutral float-right" title="Changelog" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="region-map-editor.html" class="btn btn-neutral float-left" title="The Region Map Editor" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="scripting-capabilities.html" class="btn btn-neutral float-left" title="Scripting Capabilities" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
@ -464,7 +492,7 @@ to a file, it probably is not a good idea to edit yourself unless otherwise note
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@
|
|||
<link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="next" title="Project Files" href="project-files.html" />
|
||||
<link rel="next" title="Scripting Capabilities" href="scripting-capabilities.html" />
|
||||
<link rel="prev" title="Editing Wild Encounters" href="editing-wild-encounters.html" />
|
||||
</head>
|
||||
|
||||
|
|
@ -146,56 +146,84 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="#city-maps">City Maps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="scripting-capabilities.html">Scripting Capabilities</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#writing-a-custom-script">Writing a Custom Script</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#registering-script-actions">Registering Script Actions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="scripting-capabilities.html#scripting-api">Scripting API</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#callbacks">Callbacks</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#functions">Functions</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#map-overlay-functions">Map Overlay Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#tileset-functions">Tileset Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#settings-functions">Settings Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#utility-functions">Utility Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">4.0.0 - 2020-04-28</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id6">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id11">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id13">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id20">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id21">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id23">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id26">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id27">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id28">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id29">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id30">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id31">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id32">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id33">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
|
||||
|
|
@ -376,7 +404,7 @@ but that functionality will be added in a future update.</p>
|
|||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="project-files.html" class="btn btn-neutral float-right" title="Project Files" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
<a href="scripting-capabilities.html" class="btn btn-neutral float-right" title="Scripting Capabilities" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="editing-wild-encounters.html" class="btn btn-neutral float-left" title="Editing Wild Encounters" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
|
@ -388,7 +416,7 @@ but that functionality will be added in a future update.</p>
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
|
|
|||
1241
docs/manual/scripting-capabilities.html
Normal file
1241
docs/manual/scripting-capabilities.html
Normal file
File diff suppressed because it is too large
Load diff
BIN
docs/objects.inv
BIN
docs/objects.inv
Binary file not shown.
|
|
@ -146,56 +146,84 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="../manual/region-map-editor.html#city-maps">City Maps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../manual/scripting-capabilities.html">Scripting Capabilities</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/scripting-capabilities.html#writing-a-custom-script">Writing a Custom Script</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/scripting-capabilities.html#registering-script-actions">Registering Script Actions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/scripting-capabilities.html#scripting-api">Scripting API</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../manual/scripting-capabilities.html#callbacks">Callbacks</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../manual/scripting-capabilities.html#functions">Functions</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#map-overlay-functions">Map Overlay Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#tileset-functions">Tileset Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#settings-functions">Settings Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#utility-functions">Utility Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../manual/project-files.html">Project Files</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id1">4.0.0 - 2020-04-28</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id8">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id4">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id5">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id12">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id6">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id7">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id8">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id9">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id10">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id14">Added</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id11">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id12">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id13">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id14">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id20">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id16">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id17">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id18">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id19">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id25">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id20">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id21">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id22">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id26">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id23">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id24">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id25">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id26">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id27">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id28">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id29">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id30">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id31">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id32">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id33">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="related-projects.html">Related Projects</a></li>
|
||||
|
|
@ -269,25 +297,77 @@
|
|||
<h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this headline">¶</a></h1>
|
||||
<p>All notable changes to this project will be documented in this file.</p>
|
||||
<p>The format is based on <a class="reference external" href="https://keepachangelog.com/en/1.0.0/">Keep a Changelog</a>,
|
||||
and this project somewhat adheres to <a class="reference external" href="https://semver.org/spec/v2.0.0.html">Semantic Versioning</a>. The MINOR version number is bumped when there are breaking changes in the pret projects.</p>
|
||||
and this project somewhat adheres to <a class="reference external" href="https://semver.org/spec/v2.0.0.html">Semantic Versioning</a>. The MAJOR version number is bumped when there are breaking changes in the pret projects.</p>
|
||||
<p>The <strong>“Breaking Changes”</strong> listed below are changes that have been made in the decompilation projects (e.g. pokeemerald), which porymap requires in order to work properly. If porymap is used on a project that is not up-to-date with the breaking changes, then porymap will likely break or behave improperly.</p>
|
||||
<div class="section" id="unreleased">
|
||||
<h2>Unreleased<a class="headerlink" href="#unreleased" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Nothing, yet.</p>
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/4.0.0...HEAD">Unreleased</a><a class="headerlink" href="#unreleased" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="added">
|
||||
<h3>Added<a class="headerlink" href="#added" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Add scripting capabilities, which allows the user to add custom behavior to Porymap using JavaScript scripts.</p></li>
|
||||
<li><p>Add ability to import FRLG tileset .bvd files from Advance Map 1.92.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id1">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/3.0.0...3.0.1">3.0.1</a> - 2020-03-04<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="fixed">
|
||||
<h3>Fixed<a class="headerlink" href="#fixed" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Disallow drawing new heal locations in the events tab.</p></li>
|
||||
<li><p>Fix issue where the metatile selection window was not resizable.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id1">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/3.0.1...4.0.0">4.0.0</a> - 2020-04-28<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="breaking-changes">
|
||||
<h3>Breaking Changes<a class="headerlink" href="#breaking-changes" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>If you are using pokeemerald or pokeruby, there were changes made in <a class="reference external" href="https://github.com/pret/pokeemerald/pull/1010">pokeemerald/#1010</a> and <a class="reference external" href="https://github.com/pret/pokeruby/pull/776">pokeruby/#776</a> that you will need to integrate in order to use this version of porymap.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id2">
|
||||
<h3>Added<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Support for <a class="reference external" href="https://github.com/pret/pokefirered">pokefirered</a>. Kanto fans rejoice! At long last porymap supports the FRLG decompilation project.</p></li>
|
||||
<li><p>Add ability to export map stitches with <code class="docutils literal notranslate"><span class="pre">File</span> <span class="pre">-></span> <span class="pre">Export</span> <span class="pre">Map</span> <span class="pre">Stitch</span> <span class="pre">Image...</span></code>.</p></li>
|
||||
<li><p>Add new project config option <code class="docutils literal notranslate"><span class="pre">use_custom_border_size</span></code>.</p></li>
|
||||
<li><p>Add ability to toggle project settings in <code class="docutils literal notranslate"><span class="pre">Options</span></code> menu.</p></li>
|
||||
<li><p>Add file monitoring, so Porymap will prompt the user to reload the project if certain project files are modified outside of Porymap.</p></li>
|
||||
<li><p>Add ability to reload project.</p></li>
|
||||
<li><p>Add <code class="docutils literal notranslate"><span class="pre">Pencil</span></code>, <code class="docutils literal notranslate"><span class="pre">Move</span></code>, and <code class="docutils literal notranslate"><span class="pre">Map</span> <span class="pre">Shift</span></code> tools to the Events tab.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="changed">
|
||||
<h3>Changed<a class="headerlink" href="#changed" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Porymap now saves map and encounter json data in an order consistent with the upstream repos. This will provide more comprehensible diffs when files are saved.</p></li>
|
||||
<li><p>Update Porymap icon.</p></li>
|
||||
<li><p>The “Map” and “Events” tabs now render using the same view, so jumping between them is smooth.</p></li>
|
||||
<li><p>Extend connection min and max offsets to player’s view boundary, rather than the map’s boundary.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id3">
|
||||
<h3>Fixed<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Fix bug where pressing TAB key did not navigate through widgets in the wild encounter tables.</p></li>
|
||||
<li><p>Fix bug that allowed selecting an invalid metatile in the metatile selector.</p></li>
|
||||
<li><p>Don’t allow <code class="docutils literal notranslate"><span class="pre">.</span></code> or <code class="docutils literal notranslate"><span class="pre">-</span></code> characters in new tileset names.</p></li>
|
||||
<li><p>Fix regression that prevented selecting empty region map squares</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id4">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/3.0.0...3.0.1">3.0.1</a> - 2020-03-04<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id5">
|
||||
<h3>Fixed<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Fix bug on Mac where tileset images were corrupted when saving.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id2">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/2.0.0...3.0.0">3.0.0</a> - 2020-03-04<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="breaking-changes">
|
||||
<h3>Breaking Changes<a class="headerlink" href="#breaking-changes" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id6">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/2.0.0...3.0.0">3.0.0</a> - 2020-03-04<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id7">
|
||||
<h3>Breaking Changes<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>pokeemerald and pokeruby both underwent a naming consistency update with respect to “object events”. As such, these naming changes break old versions of Porymap.</p>
|
||||
<ul>
|
||||
|
|
@ -297,22 +377,22 @@ and this project somewhat adheres to <a class="reference external" href="https:/
|
|||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="added">
|
||||
<h3>Added<a class="headerlink" href="#added" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id8">
|
||||
<h3>Added<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Add optional support for Poryscript script files via the <code class="docutils literal notranslate"><span class="pre">use_poryscript</span></code> config option.</p></li>
|
||||
<li><p>Selecting a group of metatiles from the map area now also copies the collision properties, too.</p></li>
|
||||
<li><p>Add keyboard shortcut <code class="docutils literal notranslate"><span class="pre">Ctrl</span> <span class="pre">+</span> <span class="pre">G</span></code> for toggling the map grid.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="changed">
|
||||
<h3>Changed<a class="headerlink" href="#changed" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id9">
|
||||
<h3>Changed<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Draw map connections with the current map’s tilesets to more accurately mimic their appearance in-game.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id3">
|
||||
<h3>Fixed<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id10">
|
||||
<h3>Fixed<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Fix index-out-of-bounds crash when deleting the last event in an event type group.</p></li>
|
||||
<li><p>Fix bug where exporting tileset images could add an extra row of junk at the end.</p></li>
|
||||
|
|
@ -322,17 +402,17 @@ and this project somewhat adheres to <a class="reference external" href="https:/
|
|||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id4">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.2.2...2.0.0">2.0.0</a> - 2019-10-16<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id5">
|
||||
<h3>Breaking Changes<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id11">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.2.2...2.0.0">2.0.0</a> - 2019-10-16<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id12">
|
||||
<h3>Breaking Changes<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Accomodate event object graphics pointer table being explicitly indexed. From changes introduced in commits <a class="reference external" href="https://github.com/pret/pokeemerald/commit/cdae0c1444bed98e652c87dc3e3edcecacfef8be">cdae0c1444bed98e652c87dc3e3edcecacfef8be</a> and <a class="reference external" href="https://github.com/pret/pokeruby/commit/0e8ccfc4fd3544001f4c25fafd401f7558bdefba">0e8ccfc4fd3544001f4c25fafd401f7558bdefba</a>.</p></li>
|
||||
<li><p>New “field” key in wild encounter JSON data from pokeemerald and pokeruby commits <a class="reference external" href="https://github.com/pret/pokeemerald/commit/adb0a444577b59eb02788c782a3d04bc285be0ba">adb0a444577b59eb02788c782a3d04bc285be0ba</a> and <a class="reference external" href="c73de8bed752ca538d90cfc93c4a9e8c7965f8c9">https://github.com/pret/pokeruby/commit/c73de8bed752ca538d90cfc93c4a9e8c7965f8c9</a>.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id6">
|
||||
<h3>Added<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id13">
|
||||
<h3>Added<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Add wild encounter table editor.</p></li>
|
||||
<li><p>Add dark themes.</p></li>
|
||||
|
|
@ -340,16 +420,16 @@ and this project somewhat adheres to <a class="reference external" href="https:/
|
|||
<li><p>Add warning when closing porymap with unsaved changes.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id7">
|
||||
<h3>Changed<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id14">
|
||||
<h3>Changed<a class="headerlink" href="#id14" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Exporting map images is now more configurable. Events, connections, collision, etc. can be toggled on and off before exporting the image.</p></li>
|
||||
<li><p>The entire Tileset Editor selection is now conveniently flipped when selecting x-flip or y-flip.</p></li>
|
||||
<li><p>Autocomplete for porymap’s comboboxes no longer require typing the full string prefix.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id8">
|
||||
<h3>Fixed<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id15">
|
||||
<h3>Fixed<a class="headerlink" href="#id15" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Fix bug where map group names were hardcoded when creating a new map.</p></li>
|
||||
<li><p>Fix bug in Tileset Editor where multi-tile selections weren’t properly painted when clicking on the bottom row of the metatile layers.</p></li>
|
||||
|
|
@ -360,18 +440,18 @@ and this project somewhat adheres to <a class="reference external" href="https:/
|
|||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id9">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.2.1...1.2.2">1.2.2</a> - 2019-05-16<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id10">
|
||||
<h3>Added<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id16">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.2.1...1.2.2">1.2.2</a> - 2019-05-16<a class="headerlink" href="#id16" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id17">
|
||||
<h3>Added<a class="headerlink" href="#id17" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Add region map editor</p></li>
|
||||
<li><p>Add ability to add new tilesets</p></li>
|
||||
<li><p>Add official Porymap documentation website: https://huderlem.github.io/porymap/</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id11">
|
||||
<h3>Changed<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id18">
|
||||
<h3>Changed<a class="headerlink" href="#id18" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Event sprites now display as facing the direction of their movement type.</p></li>
|
||||
<li><p>Default values for newly-created events now use valid values from the project, rather than hardcoded values.</p></li>
|
||||
|
|
@ -381,8 +461,8 @@ and this project somewhat adheres to <a class="reference external" href="https:/
|
|||
<li><p>Default values for new events are now more sensible and guaranteed to be valid.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id12">
|
||||
<h3>Fixed<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id19">
|
||||
<h3>Fixed<a class="headerlink" href="#id19" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Fix bug in zoomed metatile selector where a large selection rectangle was being rendered.</p></li>
|
||||
<li><p>Fix bug where edited map icons were not rendered properly.</p></li>
|
||||
|
|
@ -391,32 +471,32 @@ and this project somewhat adheres to <a class="reference external" href="https:/
|
|||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id13">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.2.0...1.2.1">1.2.1</a> - 2019-02-16<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id14">
|
||||
<h3>Added<a class="headerlink" href="#id14" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id20">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.2.0...1.2.1">1.2.1</a> - 2019-02-16<a class="headerlink" href="#id20" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id21">
|
||||
<h3>Added<a class="headerlink" href="#id21" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Add ability to zoom in and out the map metatile selector via a slider at the bottom of the metatile selector window.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id15">
|
||||
<h3>Fixed<a class="headerlink" href="#id15" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id22">
|
||||
<h3>Fixed<a class="headerlink" href="#id22" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Fix crash when creating a new map from a layout that has no pre-existing maps that use it.</p></li>
|
||||
<li><p>Fix bug where <code class="docutils literal notranslate"><span class="pre">var_value</span></code>, <code class="docutils literal notranslate"><span class="pre">trainer_type</span></code> and <code class="docutils literal notranslate"><span class="pre">trainer_sight_or_berry_tree_id</span></code> JSON fields were being interpreted as integers.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id16">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.1.0...1.2.0">1.2.0</a> - 2019-02-04<a class="headerlink" href="#id16" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id17">
|
||||
<h3>Breaking Changes<a class="headerlink" href="#id17" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id23">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.1.0...1.2.0">1.2.0</a> - 2019-02-04<a class="headerlink" href="#id23" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id24">
|
||||
<h3>Breaking Changes<a class="headerlink" href="#id24" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>New JSON map data format in pokeemerald and pokeruby from commits <a class="reference external" href="https://github.com/pret/pokeemerald/commit/82abc164dc9f6a74fdf0c535cc1621b7ed05318b">82abc164dc9f6a74fdf0c535cc1621b7ed05318b</a> and <a class="reference external" href="https://github.com/pret/pokeruby/commit/a0ba1b7c6353f7e4f3066025514c05b323a0123d">a0ba1b7c6353f7e4f3066025514c05b323a0123d</a>.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id18">
|
||||
<h3>Added<a class="headerlink" href="#id18" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id25">
|
||||
<h3>Added<a class="headerlink" href="#id25" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Add “magic fill” mode to fill tool (hold down CTRL key). This fills all matching metatiles on the map, rather than only the contiguous region.</p></li>
|
||||
<li><p>Add ability to import tileset palettes (JASC, .pal, .tpl, .gpl, .act).</p></li>
|
||||
|
|
@ -429,8 +509,8 @@ and this project somewhat adheres to <a class="reference external" href="https:/
|
|||
<li><p>Add ability to define custom fields for map header and all events.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id19">
|
||||
<h3>Changed<a class="headerlink" href="#id19" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id26">
|
||||
<h3>Changed<a class="headerlink" href="#id26" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Collapse the map list by default.</p></li>
|
||||
<li><p>Collision view now has a transparency slider to help make it easier to view the underlying metatiles.</p></li>
|
||||
|
|
@ -444,8 +524,8 @@ and this project somewhat adheres to <a class="reference external" href="https:/
|
|||
<li><p>The tiles image in the tileset editor will no longer flip according to the x/y flip checkboxes. The individual tile selection still flips, though.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id20">
|
||||
<h3>Fixed<a class="headerlink" href="#id20" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id27">
|
||||
<h3>Fixed<a class="headerlink" href="#id27" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Fix bug where smart paths could be auto-enabled, despite the checkbox being disabled.</p></li>
|
||||
<li><p>Fix crash that could occur when changing the palette id in the tileset palette editor.</p></li>
|
||||
|
|
@ -454,32 +534,32 @@ and this project somewhat adheres to <a class="reference external" href="https:/
|
|||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id21">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.0.0...1.1.0">1.1.0</a> - 2018-12-27<a class="headerlink" href="#id21" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id22">
|
||||
<h3>Breaking Changes<a class="headerlink" href="#id22" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id28">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.0.0...1.1.0">1.1.0</a> - 2018-12-27<a class="headerlink" href="#id28" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id29">
|
||||
<h3>Breaking Changes<a class="headerlink" href="#id29" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>New map header format in pokeemerald from commit <a class="reference external" href="https://github.com/pret/pokeemerald/commit/a1ea3b5e394bc115ba9b86348c161094a00dcca7">a1ea3b5e394bc115ba9b86348c161094a00dcca7</a>.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id23">
|
||||
<h3>Added<a class="headerlink" href="#id23" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id30">
|
||||
<h3>Added<a class="headerlink" href="#id30" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Add <code class="docutils literal notranslate"><span class="pre">porymap.project.cfg</span></code> config file to project repos, in order to house project-specific settings, such as <code class="docutils literal notranslate"><span class="pre">base_game_version=pokeemerald</span></code>.</p></li>
|
||||
<li><p>Write all logs to <code class="docutils literal notranslate"><span class="pre">porymap.log</span></code> file, so users can view any errors that porymap hits.</p></li>
|
||||
<li><p>Changelog</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id24">
|
||||
<h3>Changed<a class="headerlink" href="#id24" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id31">
|
||||
<h3>Changed<a class="headerlink" href="#id31" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Add <code class="docutils literal notranslate"><span class="pre">porymap.cfg</span></code> base config file, rather than using built-in system settings (e.g. registry on Windows).</p></li>
|
||||
<li><p>Properly read/write map headers for <code class="docutils literal notranslate"><span class="pre">pokeemerald</span></code>.</p></li>
|
||||
<li><p>Overhauled event editing pane, which now contains tabs for each different event. Events of the same type can be iterated through using the spinner at the top of the tab. This makes it possible to edit events that are outside the viewing window.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id25">
|
||||
<h3>Fixed<a class="headerlink" href="#id25" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="id32">
|
||||
<h3>Fixed<a class="headerlink" href="#id32" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Creating new hidden-item events now uses a valid default flag value.</p></li>
|
||||
<li><p>Fix bug where tilesets were sometimes not displaying their bottom row of metatiles.</p></li>
|
||||
|
|
@ -492,8 +572,8 @@ and this project somewhat adheres to <a class="reference external" href="https:/
|
|||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id26">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/tree/1.0.0">1.0.0</a> - 2018-10-26<a class="headerlink" href="#id26" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id33">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/tree/1.0.0">1.0.0</a> - 2018-10-26<a class="headerlink" href="#id33" title="Permalink to this headline">¶</a></h2>
|
||||
<p>This was the initial release.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -518,7 +598,7 @@ and this project somewhat adheres to <a class="reference external" href="https:/
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -145,56 +145,84 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="../manual/region-map-editor.html#city-maps">City Maps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../manual/scripting-capabilities.html">Scripting Capabilities</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/scripting-capabilities.html#writing-a-custom-script">Writing a Custom Script</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/scripting-capabilities.html#registering-script-actions">Registering Script Actions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/scripting-capabilities.html#scripting-api">Scripting API</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../manual/scripting-capabilities.html#callbacks">Callbacks</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../manual/scripting-capabilities.html#functions">Functions</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#map-overlay-functions">Map Overlay Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#tileset-functions">Tileset Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#settings-functions">Settings Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../manual/scripting-capabilities.html#utility-functions">Utility Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../manual/project-files.html">Project Files</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id1">4.0.0 - 2020-04-28</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id8">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id4">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id5">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id12">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id6">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id7">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id8">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id9">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id10">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id11">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id12">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id13">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id14">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id20">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id16">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id17">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id18">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id19">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id25">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id20">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id21">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id22">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id23">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id24">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id25">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id26">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id27">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id28">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id29">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id30">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id31">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id32">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id33">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Related Projects</a></li>
|
||||
|
|
@ -286,7 +314,7 @@
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -145,56 +145,84 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="manual/region-map-editor.html#city-maps">City Maps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="manual/scripting-capabilities.html">Scripting Capabilities</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#writing-a-custom-script">Writing a Custom Script</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#registering-script-actions">Registering Script Actions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/scripting-capabilities.html#scripting-api">Scripting API</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="manual/scripting-capabilities.html#callbacks">Callbacks</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="manual/scripting-capabilities.html#functions">Functions</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#map-editing-functions">Map Editing Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#map-overlay-functions">Map Overlay Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#tileset-functions">Tileset Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#settings-functions">Settings Functions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="manual/scripting-capabilities.html#utility-functions">Utility Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="manual/project-files.html">Project Files</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">4.0.0 - 2020-04-28</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id8">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id4">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id5">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id12">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id6">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id7">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id8">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id9">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id10">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id11">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id12">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id13">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id14">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id20">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id16">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id17">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id18">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id19">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id25">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id20">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id21">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id22">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id23">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id24">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id25">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id26">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id27">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id28">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id29">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id30">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id31">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id32">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id33">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reference/related-projects.html">Related Projects</a></li>
|
||||
|
|
@ -288,7 +316,7 @@
|
|||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
© Copyright 2020, huderlem
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -18,7 +18,7 @@
|
|||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = u'porymap'
|
||||
copyright = u'2019, huderlem'
|
||||
copyright = u'2020, huderlem'
|
||||
author = u'huderlem'
|
||||
|
||||
# The short X.Y version
|
||||
|
|
|
|||
|
|
@ -17,6 +17,7 @@ Porymap Documentation
|
|||
manual/editing-map-connections
|
||||
manual/editing-wild-encounters
|
||||
manual/region-map-editor
|
||||
manual/scripting-capabilities
|
||||
manual/project-files
|
||||
|
||||
.. toctree::
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 243 KiB |
523
docsrc/manual/scripting-capabilities.rst
Normal file
523
docsrc/manual/scripting-capabilities.rst
Normal file
|
|
@ -0,0 +1,523 @@
|
|||
**********************
|
||||
Scripting Capabilities
|
||||
**********************
|
||||
|
||||
Porymap is extensible via scripting capabilities. This allows the user to write custom JavaScript (technically, ECMAScript) files to support enhanced workflows, without having to fork Porymap itself. While the possibilities are endless, some useful examples of scripting might be:
|
||||
|
||||
- Toggle Day/Night Palettes
|
||||
- Custom Map Painting Brushes
|
||||
- Detect Tile Errors
|
||||
- Show Diagonistic Information
|
||||
- Procedurally Generated Maps
|
||||
- Randomize Grass Patterns
|
||||
|
||||
Writing a Custom Script
|
||||
-----------------------
|
||||
|
||||
Let's write a custom script that will randomize grass patterns when the user is editing the map. This is useful, since it's cumbersome to manually add randomness to grass patches. With the custom script, it will happen automatically. Whenever the user paints a grass tile onto the map, the script will overwrite the tile with a random grass tile instead.
|
||||
|
||||
First, create a new script file called ``my_script.js``--place it in the project directory (e.g. ``pokefirered/``).
|
||||
|
||||
Next, open the Porymap project config file, ``porymap.project.cfg``, in the project directory. Add the script file to the ``custom_scripts`` configuration value. Multiple script files can be loaded by separating the filepaths with a comma.
|
||||
|
||||
.. code-block::
|
||||
|
||||
custom_scripts=my_script.js
|
||||
|
||||
Now that Porymap is configured to load the script file, let's write the actual code that will power the grass-randomizer. Scripts have access to several "callbacks" for events that occur while Porymap is running. This means our script can define functions for each of these callbacks. We're interested in the ``onBlockChanged()`` callback, since we want our script to take action whenever a user paints a block on the map.
|
||||
|
||||
.. code-block:: js
|
||||
|
||||
// Porymap callback when a block is painted.
|
||||
export function onBlockChanged(x, y, prevBlock, newBlock) {
|
||||
// Grass-randomizing logic goes here.
|
||||
}
|
||||
|
||||
It's very **important** to remember to ``export`` the callback functions in the script. Otherwise, Porymap will not be able to execute them.
|
||||
|
||||
In addition to the callbacks, Porymap also supports a scripting API so that the script can interact with Porymap in interesting ways. For example, a script can change a block or add overlay text on the map. Since we want to paint random grass tiles, we'll be using the ``map.setMetatileId()`` function. Let's fill in the rest of the grass-randomizing code.
|
||||
|
||||
.. code-block:: js
|
||||
|
||||
function randInt(min, max) {
|
||||
min = Math.ceil(min);
|
||||
max = Math.floor(max);
|
||||
return Math.floor(Math.random() * (max - min)) + min;
|
||||
}
|
||||
|
||||
// These are the grass metatiles in pokefirered.
|
||||
const grassTiles = [0x8, 0x9, 0x10, 0x11];
|
||||
|
||||
// Porymap callback when a block is painted.
|
||||
export function onBlockChanged(x, y, prevBlock, newBlock) {
|
||||
// Check if the user is painting a grass tile.
|
||||
if (grassTiles.indexOf(newBlock.metatileId) != -1) {
|
||||
// Choose a random grass tile and paint it on the map.
|
||||
const i = randInt(0, grassTiles.length);
|
||||
map.setMetatileId(x, y, grassTiles[i]);
|
||||
}
|
||||
}
|
||||
|
||||
Let's test the script out by re-launching Porymap. If we try to paint grass on the map, we should see our script inserting a nice randomized grass pattern.
|
||||
|
||||
.. figure:: images/scripting-capabilities/porymap-scripting-grass.gif
|
||||
:alt: Grass-Randomizing Script
|
||||
|
||||
Grass-Randomizing Script
|
||||
|
||||
Registering Script Actions
|
||||
--------------------------
|
||||
|
||||
The grass-randomizer script above happens implicitly when the user paints on the map. However, other times we probably want to call the custom script on demand. One of the API function Porymap provides is the ability to trigger scripting functions from the ``Tools`` menu, or a keyboard shortcut. To do this, we will usually want to register the action when the project loads. Here is an example script where a couple custom actions are registered.
|
||||
|
||||
.. code-block:: js
|
||||
|
||||
function applyNightTint() {
|
||||
// Apply night palette tinting...
|
||||
}
|
||||
|
||||
// Porymap callback when project is opened.
|
||||
export function onProjectOpened(projectPath) {
|
||||
map.registerAction("applyNightTint", "View Night Tint", "T")
|
||||
}
|
||||
|
||||
Then, to trigger the ``applyNightTint()`` function, we could either click ``Tools -> View Night Tint`` or use the ``T`` keyboard shortcut.
|
||||
|
||||
Now that we have an overview of how to utilize Porymap's scripting capabilities, the entire scripting API is documented below.
|
||||
|
||||
Scripting API
|
||||
-------------
|
||||
|
||||
Callbacks
|
||||
~~~~~~~~~
|
||||
|
||||
.. js:function:: onProjectOpened(projectPath)
|
||||
|
||||
Called when Porymap successfully opens a project.
|
||||
|
||||
:param string projectPath: the directory path of the opened project
|
||||
|
||||
.. js:function:: onProjectClosed(projectPath)
|
||||
|
||||
Called when Porymap closes a project. For example, this is called when opening a different project.
|
||||
|
||||
:param string projectPath: the directory path of the closed project
|
||||
|
||||
.. js:function:: onMapOpened(mapName)
|
||||
|
||||
Called when a map is opened.
|
||||
|
||||
:param string mapName: the name of the opened map
|
||||
|
||||
.. js:function:: onBlockChanged(x, y, prevBlock, newBlock)
|
||||
|
||||
Called when a block is changed on the map. For example, this is called when a user paints a new tile or changes the collision property of a block.
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:param object prevBlock: the block's state before it was modified. The object's shape is ``{metatileId, collision, elevation, rawValue}``
|
||||
:param object newBlock: the block's new state after it was modified. The object's shape is ``{metatileId, collision, elevation, rawValue}``
|
||||
|
||||
Functions
|
||||
~~~~~~~~~
|
||||
|
||||
All scripting functions are callable via the global ``map`` object.
|
||||
|
||||
Map Editing Functions
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The following functions are related to editing the map's blocks or retrieving information about them.
|
||||
|
||||
.. js:function:: map.getBlock(x, y)
|
||||
|
||||
Gets a block in the currently-opened map.
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:returns {metatileId, collision, elevation, rawValue}: the block object
|
||||
|
||||
.. js:function:: map.setBlock(x, y, metatileId, collision, elevation)
|
||||
|
||||
Sets a block in the currently-opened map.
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:param number metatileId: the metatile id of the block
|
||||
:param number collision: the collision of the block (``0`` = passable, ``1`` = impassable)
|
||||
:param number elevation: the elevation of the block
|
||||
|
||||
.. js:function:: map.getMetatileId(x, y)
|
||||
|
||||
Gets the metatile id of a block in the currently-opened map.
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:returns number: the metatile id of the block
|
||||
|
||||
.. js:function:: map.setMetatileId(x, y, metatileId)
|
||||
|
||||
Sets the metatile id of a block in the currently-opened map.
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:param number metatileId: the metatile id of the block
|
||||
|
||||
.. js:function:: map.getCollision(x, y)
|
||||
|
||||
Gets the collision of a block in the currently-opened map. (``0`` = passable, ``1`` = impassable)
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:returns number: the collision of the block
|
||||
|
||||
.. js:function:: map.setCollision(x, y, collision)
|
||||
|
||||
Sets the collision of a block in the currently-opened map. (``0`` = passable, ``1`` = impassable)
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:param number collision: the collision of the block
|
||||
|
||||
.. js:function:: map.getElevation(x, y)
|
||||
|
||||
Gets the elevation of a block in the currently-opened map.
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:returns number: the elevation of the block
|
||||
|
||||
.. js:function:: map.setElevation(x, y, elevation)
|
||||
|
||||
Sets the elevation of a block in the currently-opened map.
|
||||
|
||||
:param number x: x coordinate of the block
|
||||
:param number y: y coordinate of the block
|
||||
:param number elevation: the elevation of the block
|
||||
|
||||
.. js:function:: map.setBlocksFromSelection(x, y)
|
||||
|
||||
Sets blocks on the map using the user's current metatile selection.
|
||||
|
||||
:param number x: initial x coordinate
|
||||
:param number y: initial y coordinate
|
||||
|
||||
.. js:function:: map.bucketFill(x, y, metatileId)
|
||||
|
||||
Performs a bucket fill of a metatile id, starting at the given coordinates.
|
||||
|
||||
:param number x: initial x coordinate
|
||||
:param number y: initial y coordinate
|
||||
:param number metatileId: metatile id to fill
|
||||
|
||||
.. js:function:: map.bucketFillFromSelection(x, y)
|
||||
|
||||
Performs a bucket fill using the user's current metatile selection, starting at the given coordinates.
|
||||
|
||||
:param number x: initial x coordinate
|
||||
:param number y: initial y coordinate
|
||||
|
||||
.. js:function:: map.magicFill(x, y, metatileId)
|
||||
|
||||
Performs a magic fill of a metatile id, starting at the given coordinates.
|
||||
|
||||
:param number x: initial x coordinate
|
||||
:param number y: initial y coordinate
|
||||
:param number metatileId: metatile id to magic fill
|
||||
|
||||
.. js:function:: map.magicFillFromSelection(x, y)
|
||||
|
||||
Performs a magic fill using the user's current metatile selection, starting at the given coordinates.
|
||||
|
||||
:param number x: initial x coordinate
|
||||
:param number y: initial y coordinate
|
||||
|
||||
.. js:function:: map.shift(xDelta, yDelta)
|
||||
|
||||
Performs a shift on the map's blocks.
|
||||
|
||||
:param number xDelta: number of blocks to shift horizontally
|
||||
:param number yDelta: number of blocks to shift vertically
|
||||
|
||||
.. js:function:: map.getDimensions()
|
||||
|
||||
Gets the dimensions of the currently-opened map.
|
||||
|
||||
:returns {width, height}: the dimensions of the map
|
||||
|
||||
.. js:function:: map.getWidth()
|
||||
|
||||
Gets the width of the currently-opened map.
|
||||
|
||||
:returns number: the width of the map
|
||||
|
||||
.. js:function:: map.getHeight()
|
||||
|
||||
Gets the height of the currently-opened map.
|
||||
|
||||
:returns number: the height of the map
|
||||
|
||||
.. js:function:: map.setDimensions(width, height)
|
||||
|
||||
Sets the dimensions of the currently-opened map.
|
||||
|
||||
:param number width: width in blocks
|
||||
:param number height: height in blocks
|
||||
|
||||
.. js:function:: map.setWidth(width)
|
||||
|
||||
Sets the width of the currently-opened map.
|
||||
|
||||
:param number width: width in blocks
|
||||
|
||||
.. js:function:: map.setHeight()
|
||||
|
||||
Sets the height of the currently-opened map.
|
||||
|
||||
:param number height: height in blocks
|
||||
|
||||
Map Overlay Functions
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The following functions are related to an overlay that is drawn on top of the map area. Text, images, and shapes can be drawn using these functions.
|
||||
|
||||
.. js:function:: map.clearOverlay()
|
||||
|
||||
Clears and erases all overlay items that were previously-added to the map.
|
||||
|
||||
.. js:function:: map.addText(text, x, y, color = "#000000", size = 12)
|
||||
|
||||
Adds a text item to the overlay.
|
||||
|
||||
:param string text: the text to display
|
||||
:param number x: the x pixel coordinate of the text
|
||||
:param number y: the y pixel coordinate of the text
|
||||
:param string color: the color of the text. Can be specified as "#RRGGBB" or "#AARRGGBB". Defaults to black.
|
||||
:param number size: the font size of the text. Defaults to 12.
|
||||
|
||||
.. js:function:: map.addRect(x, y, width, height, color = "#000000")
|
||||
|
||||
Adds a rectangle outline item to the overlay.
|
||||
|
||||
:param number x: the x pixel coordinate of the rectangle's top-left corner
|
||||
:param number y: the y pixel coordinate of the rectangle's top-left corner
|
||||
:param number width: the pixel width of the rectangle
|
||||
:param number height: the pixel height of the rectangle
|
||||
:param string color: the color of the rectangle. Can be specified as "#RRGGBB" or "#AARRGGBB". Defaults to black.
|
||||
|
||||
.. js:function:: map.addFilledRect(x, y, width, height, color = "#000000")
|
||||
|
||||
Adds a filled rectangle item to the overlay.
|
||||
|
||||
:param number x: the x pixel coordinate of the rectangle's top-left corner
|
||||
:param number y: the y pixel coordinate of the rectangle's top-left corner
|
||||
:param number width: the pixel width of the rectangle
|
||||
:param number height: the pixel height of the rectangle
|
||||
:param string color: the color of the rectangle. Can be specified as "#RRGGBB" or "#AARRGGBB". Defaults to black.
|
||||
|
||||
.. js:function:: map.addImage(x, y, filepath)
|
||||
|
||||
Adds an image item to the overlay.
|
||||
|
||||
:param number x: the x pixel coordinate of the image's top-left corner
|
||||
:param number y: the y pixel coordinate of the image's top-left corner
|
||||
:param string filepath: the image's filepath
|
||||
|
||||
Tileset Functions
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
The following functions are related to tilesets and their palettes. The functions with "preview" in their name operate on a "fake" version of the palette colors. This means that changing these "preview" colors won't affect the actual tileset colors in the project. A good use of the "preview" palettes would be Day/Night tints, for example.
|
||||
|
||||
.. js:function:: map.getPrimaryTilesetPalettePreview(paletteIndex)
|
||||
|
||||
Gets a palette from the primary tileset of the currently-opened map.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:returns array: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setPrimaryTilesetPalettePreview(paletteIndex, colors)
|
||||
|
||||
Sets a palette in the primary tileset of the currently-opened map. This will NOT affect the true underlying colors--it only displays these colors in the map-editing area of Porymap.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:param array colors: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getPrimaryTilesetPalettesPreview()
|
||||
|
||||
Gets all of the palettes from the primary tileset of the currently-opened map.
|
||||
|
||||
:returns array: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setPrimaryTilesetPalettesPreview(palettes)
|
||||
|
||||
Sets all of the palettes in the primary tileset of the currently-opened map. This will NOT affect the true underlying colors--it only displays these colors in the map-editing area of Porymap.
|
||||
|
||||
:param array palettes: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getSecondaryTilesetPalettePreview(paletteIndex)
|
||||
|
||||
Gets a palette from the secondary tileset of the currently-opened map.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:returns array: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setSecondaryTilesetPalettePreview(paletteIndex, colors)
|
||||
|
||||
Sets a palette in the secondary tileset of the currently-opened map. This will NOT affect the true underlying colors--it only displays these colors in the map-editing area of Porymap.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:param array colors: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getSecondaryTilesetPalettesPreview()
|
||||
|
||||
Gets all of the palettes from the secondary tileset of the currently-opened map.
|
||||
|
||||
:returns array: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setSecondaryTilesetPalettesPreview(palettes)
|
||||
|
||||
Sets all of the palettes in the secondary tileset of the currently-opened map. This will NOT affect the true underlying colors--it only displays these colors in the map-editing area of Porymap.
|
||||
|
||||
:param array palettes: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getPrimaryTilesetPalette(paletteIndex)
|
||||
|
||||
Gets a palette from the primary tileset of the currently-opened map.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:returns array: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setPrimaryTilesetPalette(paletteIndex, colors)
|
||||
|
||||
Sets a palette in the primary tileset of the currently-opened map. This will permanently affect the palette and save the palette to disk.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:param array colors: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getPrimaryTilesetPalettes()
|
||||
|
||||
Gets all of the palettes from the primary tileset of the currently-opened map.
|
||||
|
||||
:returns array: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setPrimaryTilesetPalettes(palettes)
|
||||
|
||||
Sets all of the palettes in the primary tileset of the currently-opened map. This will permanently affect the palettes and save the palettes to disk.
|
||||
|
||||
:param array palettes: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getSecondaryTilesetPalette(paletteIndex)
|
||||
|
||||
Gets a palette from the secondary tileset of the currently-opened map.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:returns array: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setSecondaryTilesetPalette(paletteIndex, colors)
|
||||
|
||||
Sets a palette in the secondary tileset of the currently-opened map. This will permanently affect the palette and save the palette to disk.
|
||||
|
||||
:param number paletteIndex: the palette index
|
||||
:param array colors: array of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getSecondaryTilesetPalettes()
|
||||
|
||||
Gets all of the palettes from the secondary tileset of the currently-opened map.
|
||||
|
||||
:returns array: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.setSecondaryTilesetPalettes(palettes)
|
||||
|
||||
Sets all of the palettes in the secondary tileset of the currently-opened map. This will permanently affect the palettes and save the palettes to disk.
|
||||
|
||||
:param array palettes: array of arrays of colors. Each color is a 3-element RGB array
|
||||
|
||||
.. js:function:: map.getPrimaryTileset()
|
||||
|
||||
Gets the name of the primary tileset for the currently-opened map.
|
||||
|
||||
:returns string: primary tileset name
|
||||
|
||||
.. js:function:: map.setPrimaryTileset(tileset)
|
||||
|
||||
Sets the primary tileset for the currently-opened map.
|
||||
|
||||
:param string tileset: the tileset name
|
||||
|
||||
.. js:function:: map.getSecondaryTileset()
|
||||
|
||||
Gets the name of the secondary tileset for the currently-opened map.
|
||||
|
||||
:returns string: secondary tileset name
|
||||
|
||||
.. js:function:: map.setSecondaryTileset(tileset)
|
||||
|
||||
Sets the secondary tileset for the currently-opened map.
|
||||
|
||||
:param string tileset: the tileset name
|
||||
|
||||
Settings Functions
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The following functions are related to settings.
|
||||
|
||||
.. js:function:: map.getGridVisibility()
|
||||
|
||||
Gets the visibility of the map grid overlay.
|
||||
|
||||
:returns boolean: grid visibility
|
||||
|
||||
.. js:function:: map.setGridVisibility(visible)
|
||||
|
||||
Sets the visibility of the map grid overlay.
|
||||
|
||||
:param boolean visible: grid visibility
|
||||
|
||||
.. js:function:: map.getBorderVisibility()
|
||||
|
||||
Gets the visibility of the map's border.
|
||||
|
||||
:returns boolean: border visibility
|
||||
|
||||
.. js:function:: map.setBorderVisibility(visible)
|
||||
|
||||
Sets the visibility of the map's border.
|
||||
|
||||
:param boolean visible: border visibility
|
||||
|
||||
.. js:function:: map.getSmartPathsEnabled()
|
||||
|
||||
Gets the toggle state of smart paths.
|
||||
|
||||
:returns boolean: smart paths enabled
|
||||
|
||||
.. js:function:: map.setSmartPathsEnabled(enabled)
|
||||
|
||||
Sets the toggle state of smart paths.
|
||||
|
||||
:param boolean enabled: smart paths enabled
|
||||
|
||||
Utility Functions
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
These are some miscellaneous functions that can be very useful when building custom scripts.
|
||||
|
||||
.. js:function:: map.registerAction(functionName, actionName, shortcut = "")
|
||||
|
||||
Registers a JavaScript function to an action that can be manually triggered in Porymap's ``Tools`` menu. Optionally, a keyboard shortcut (e.g. ``"Ctrl+P"``) can also be specified, assuming it doesn't collide with any existing shortcuts used by Porymap.
|
||||
|
||||
:param string functionName: name of the JavaScript function
|
||||
:param string actionName: name of the action that will be displayed in the ``Tools`` menu
|
||||
:param string shortcut: optional keyboard shortcut
|
||||
|
||||
.. js:function:: map.setTimeout(func, delayMs)
|
||||
|
||||
This behaves essentially the same as JavaScript's ``setTimeout()`` that is used in web browsers or NodeJS. The ``func`` argument is a JavaScript function (NOT the name of a function) which will be executed after a delay. This is useful for creating animations or refreshing the overlay at constant intervals.
|
||||
|
||||
:param function func: a JavaScript function that will be executed later
|
||||
:param number delayMs: the number of milliseconds to wait before executing ``func``
|
||||
|
||||
.. js:function:: map.log(message)
|
||||
|
||||
Logs a message to the Porymap log file. This is useful for debugging custom scripts.
|
||||
|
||||
:param string message: the message to log
|
||||
Loading…
Reference in a new issue