mirror of
https://github.com/huderlem/porymap.git
synced 2026-03-22 01:54:46 -05:00
6a982402d9
Some checks failed
Build Porymap / build-linux (5.14.2) (push) Has been cancelled
Build Porymap / build-linux (6.8.*) (push) Has been cancelled
Build Porymap / build-macos (macos-15-intel) (push) Has been cancelled
Build Porymap / build-macos (macos-latest) (push) Has been cancelled
Build Porymap / build-static-windows (push) Has been cancelled
767 lines
65 KiB
HTML
767 lines
65 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" data-content_root="../">
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>Editing Map Events — porymap documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=eb07c574" />
|
||
|
||
|
||
<link rel="shortcut icon" href="../_static/porymap-icon-2.ico"/>
|
||
<script src="../_static/jquery.js?v=5d32c60e"></script>
|
||
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||
<script src="../_static/documentation_options.js?v=5929fcd5"></script>
|
||
<script src="../_static/doctools.js?v=9bcbadda"></script>
|
||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||
<script src="../_static/js/theme.js"></script>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="Editing Map Headers" href="editing-map-header.html" />
|
||
<link rel="prev" title="Editing Map Collisions" href="editing-map-collisions.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" style="background: linear-gradient(180deg, #08ACD5 50%, #FF6262 0%);" >
|
||
|
||
|
||
|
||
<a href="../index.html" class="icon icon-home">
|
||
porymap
|
||
</a>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||
<p class="caption" role="heading"><span class="caption-text">User Manual</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="introduction.html#about-porymap">About Porymap</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="introduction.html#getting-started">Getting Started</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="navigation.html">Navigation</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="navigation.html#map-list">Map List</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="navigation.html#tabs">Tabs</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="navigation.html#buttons">Buttons</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="navigation.html#status-icons">Status Icons</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="navigation.html#main-window">Main Window</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="editing-map-tiles.html">Editing Map Tiles</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#visual-options">Visual Options</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#selecting-metatiles">Selecting Metatiles</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#pencil-tool">Pencil Tool</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#pointer-tool">Pointer Tool</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#bucket-fill-tool">Bucket Fill Tool</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#move-tool">Move Tool</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#map-shift-tool">Map Shift Tool</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#smart-paths">Smart Paths</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#straight-paths">Straight Paths</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#change-dimensions">Change Dimensions</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="editing-map-tiles.html#border-dimensions">Border Dimensions</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#change-layout">Change Layout</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#change-map-tilesets">Change Map Tilesets</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#change-map-border">Change Map Border</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#undo-redo">Undo & Redo</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-tiles.html#prefabs">Prefabs</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="editing-map-collisions.html">Editing Map Collisions</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-collisions.html#selecting-collision-types">Selecting Collision Types</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-collisions.html#painting-collisions">Painting Collisions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-collisions.html#collision-types">Collision Types</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Editing Map Events</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="#adding-deleting-events">Adding & Deleting Events</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#event-positions">Event Positions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#object-events">Object Events</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#clone-object-events">Clone Object Events</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#warp-events">Warp Events</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#trigger-events">Trigger Events</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#weather-trigger-events">Weather Trigger Events</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#sign-event">Sign Event</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#hidden-item-event">Hidden Item Event</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#secret-base-event">Secret Base Event</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#heal-locations">Heal Locations</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#custom-attributes">Custom Attributes</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#open-map-scripts">Open Map Scripts</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#tool-buttons">Tool Buttons</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#ruler-tool">Ruler Tool</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="editing-map-header.html">Editing Map Headers</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="editing-map-connections.html">Editing Map Connections</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-connections.html#dive-emerge-warps">Dive & Emerge Warps</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-map-connections.html#mirror-connections">Mirror Connections</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="editing-wild-encounters.html">Editing Wild Encounters</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-wild-encounters.html#adding-new-encounter-groups">Adding New Encounter Groups</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-wild-encounters.html#configuring-the-wild-encounter-fields">Configuring the Wild Encounter Fields</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-wild-encounters.html#summary-chart">Summary Chart</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="editing-wild-encounters.html#species-search">Species Search</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="creating-new-maps.html">Creating New Maps</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="region-map-editor.html">The Region Map Editor</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#background-image-tab">Background Image Tab</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#map-layout-tab">Map Layout Tab</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="region-map-editor.html#map-entries-tab">Map Entries Tab</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tileset-editor.html">The Tileset Editor</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#metatile-properties">Metatile Properties</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#layer-type">Layer Type</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#metatile-behavior">Metatile Behavior</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#encounter-type">Encounter Type</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#terrain-type">Terrain Type</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#metatile-label">Metatile Label</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#tools-menu">Tools Menu</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#import-tiles-image">Import Tiles Image…</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#import-metatiles-from-advance-map-1-92">Import Metatiles from Advance Map 1.92…</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#change-number-of-metatiles">Change Number of Metatiles</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="tileset-editor.html#other-tools">Other Tools</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="tileset-editor.html#palette-editor">Palette Editor</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#custom-scripts-editor">Custom Scripts Editor</a></li>
|
||
<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><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#onProjectOpened"><code class="docutils literal notranslate"><span class="pre">onProjectOpened</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#onProjectClosed"><code class="docutils literal notranslate"><span class="pre">onProjectClosed</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#onMapOpened"><code class="docutils literal notranslate"><span class="pre">onMapOpened</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#onLayoutOpened"><code class="docutils literal notranslate"><span class="pre">onLayoutOpened</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#onBlockChanged"><code class="docutils literal notranslate"><span class="pre">onBlockChanged</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#onBorderMetatileChanged"><code class="docutils literal notranslate"><span class="pre">onBorderMetatileChanged</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#onBlockHoverChanged"><code class="docutils literal notranslate"><span class="pre">onBlockHoverChanged</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#onBlockHoverCleared"><code class="docutils literal notranslate"><span class="pre">onBlockHoverCleared</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#onMapResized"><code class="docutils literal notranslate"><span class="pre">onMapResized</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#onBorderResized"><code class="docutils literal notranslate"><span class="pre">onBorderResized</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#onMapShifted"><code class="docutils literal notranslate"><span class="pre">onMapShifted</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#onTilesetUpdated"><code class="docutils literal notranslate"><span class="pre">onTilesetUpdated</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#onMainTabChanged"><code class="docutils literal notranslate"><span class="pre">onMainTabChanged</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#onMapViewTabChanged"><code class="docutils literal notranslate"><span class="pre">onMapViewTabChanged</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#onBorderVisibilityToggled"><code class="docutils literal notranslate"><span class="pre">onBorderVisibilityToggled</span></code></a></li>
|
||
</ul>
|
||
</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-header-editing-functions">Map Header Editing 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#overlay-functions">Overlay 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>
|
||
<li class="toctree-l3"><a class="reference internal" href="scripting-capabilities.html#constants">Constants</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#constants.max_primary_tiles"><code class="docutils literal notranslate"><span class="pre">constants.max_primary_tiles</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#constants.max_secondary_tiles"><code class="docutils literal notranslate"><span class="pre">constants.max_secondary_tiles</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#constants.max_primary_metatiles"><code class="docutils literal notranslate"><span class="pre">constants.max_primary_metatiles</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#constants.max_secondary_metatiles"><code class="docutils literal notranslate"><span class="pre">constants.max_secondary_metatiles</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#constants.num_primary_palettes"><code class="docutils literal notranslate"><span class="pre">constants.num_primary_palettes</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#constants.num_secondary_palettes"><code class="docutils literal notranslate"><span class="pre">constants.num_secondary_palettes</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#constants.layers_per_metatile"><code class="docutils literal notranslate"><span class="pre">constants.layers_per_metatile</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#constants.tiles_per_metatile"><code class="docutils literal notranslate"><span class="pre">constants.tiles_per_metatile</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#constants.metatile_behaviors"><code class="docutils literal notranslate"><span class="pre">constants.metatile_behaviors</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#constants.base_game_version"><code class="docutils literal notranslate"><span class="pre">constants.base_game_version</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#constants.version.major"><code class="docutils literal notranslate"><span class="pre">constants.version.major</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#constants.version.minor"><code class="docutils literal notranslate"><span class="pre">constants.version.minor</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="scripting-capabilities.html#constants.version.patch"><code class="docutils literal notranslate"><span class="pre">constants.version.patch</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="project-files.html">Project Files</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="project-files.html#identifiers">Identifiers</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="project-files.html#global-constants">Global Constants</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="breaking-changes.html">Breaking Changes</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="breaking-changes.html#versioning">Versioning</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="breaking-changes.html#what-s-a-breaking-change">What’s a breaking change?</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="breaking-changes.html#updating-your-project">Updating your project</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="breaking-changes.html#from-5-x-x-to-6-x-x">From <code class="docutils literal notranslate"><span class="pre">5.x.x</span></code> to <code class="docutils literal notranslate"><span class="pre">6.x.x</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="breaking-changes.html#map-num-map-group">1. <code class="docutils literal notranslate"><span class="pre">MAP_NUM</span></code>/<code class="docutils literal notranslate"><span class="pre">MAP_GROUP</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="breaking-changes.html#heal-locations">2. Heal Locations</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="breaking-changes.html#region-map-sections">3. Region Map Sections</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="breaking-changes.html#local-ids">4. Local IDs</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="breaking-changes.html#from-4-x-x-to-5-x-x">From <code class="docutils literal notranslate"><span class="pre">4.x.x</span></code> to <code class="docutils literal notranslate"><span class="pre">5.x.x</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="breaking-changes.html#map-none-renamed">1. <code class="docutils literal notranslate"><span class="pre">MAP_NONE</span></code> renamed</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="breaking-changes.html#dest-warp-id">2. <code class="docutils literal notranslate"><span class="pre">dest_warp_id</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="breaking-changes.html#clone-object-events">3. Clone Object events</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="breaking-changes.html#region-map-editor">4. Region Map Editor</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="breaking-changes.html#additional-api-changes">5. Additional API changes</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="breaking-changes.html#prior-to-4-x-x">Prior to <code class="docutils literal notranslate"><span class="pre">4.x.x</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="shortcuts.html">Shortcuts</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="shortcuts.html#main-window">Main Window</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="shortcuts.html#tileset-editor">Tileset Editor</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="shortcuts.html#region-map-editor">Region Map Editor</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="shortcuts.html#custom-scripts-editor">Custom Scripts Editor</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="settings-and-options.html">Porymap Settings</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="settings-and-options.html#global-settings">Global settings</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="settings-and-options.html#project-settings">Project settings</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#general">General</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#maps">Maps</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#tilesets">Tilesets</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#events">Events</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="settings-and-options.html#files-identifiers">Files & Identifiers</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<p class="caption" role="heading"><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">6.3.0 - 2025-12-26</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#changed">Changed</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">6.2.0 - 2025-08-08</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Changed</a></li>
|
||
<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#id6">6.1.0 - 2025-06-09</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id10">6.0.0 - 2025-05-27</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#id11">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id13">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id14">5.4.1 - 2024-03-21</a><ul>
|
||
<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">5.4.0 - 2024-02-13</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#id20">5.3.0 - 2024-01-15</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">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id24">5.2.0 - 2024-01-02</a><ul>
|
||
<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">5.1.1 - 2023-02-20</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id29">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id30">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id31">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id32">5.1.0 - 2023-01-22</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id33">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id34">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id35">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id36">5.0.0 - 2022-10-30</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id37">Breaking Changes</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id38">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id39">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id40">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id41">4.5.0 - 2021-12-26</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id42">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id43">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id44">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id45">4.4.0 - 2020-12-20</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id46">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id47">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id48">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id49">4.3.1 - 2020-07-17</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id50">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id51">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id52">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id53">4.3.0 - 2020-06-27</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id54">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id55">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id56">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id57">4.2.0 - 2020-06-06</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id58">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id59">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id60">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id61">4.1.0 - 2020-05-18</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id62">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id63">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id64">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id65">4.0.0 - 2020-04-28</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id66">Breaking Changes</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id67">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id68">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id69">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id70">3.0.1 - 2020-03-04</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id71">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id72">3.0.0 - 2020-03-04</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id73">Breaking Changes</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id74">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id75">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id76">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id77">2.0.0 - 2019-10-16</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id78">Breaking Changes</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id79">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id80">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id81">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id82">1.2.2 - 2019-05-16</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id83">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id84">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id85">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id86">1.2.1 - 2019-02-16</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id87">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id88">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id89">1.2.0 - 2019-02-04</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id90">Breaking Changes</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id91">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id92">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id93">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id94">1.1.0 - 2018-12-27</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id95">Breaking Changes</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id96">Added</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id97">Changed</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id98">Fixed</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id99">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>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: linear-gradient(180deg, #08ACD5 50%, #FF6262 0%);" >
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="../index.html">porymap</a>
|
||
</nav>
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
<div role="navigation" aria-label="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||
<li class="breadcrumb-item active">Editing Map Events</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="https://github.com/huderlem/porymap/blob/master/docsrc/manual/editing-map-events.rst" class="fa fa-github"> Edit on GitHub</a>
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<section id="editing-map-events">
|
||
<span id="id1"></span><h1>Editing Map Events<a class="headerlink" href="#editing-map-events" title="Link to this heading"></a></h1>
|
||
<p>Events are what bring your maps to life. They include NPCs, signposts, warps, scripts, and more. Open the <em>Events</em> tab above the map area, and let’s dissect what’s going on.</p>
|
||
<figure class="align-center" id="id4">
|
||
<img alt="Map Events View" src="../_images/map-events.png" />
|
||
<figcaption>
|
||
<p><span class="caption-text">Map Events View</span><a class="headerlink" href="#id4" title="Link to this image"></a></p>
|
||
</figcaption>
|
||
</figure>
|
||
<p>All of the events are visible on the map. The Event Details window on the right displays the properties of the currently-selected event. If you look closely, you’ll see that the woman NPC near the Pokémon Center has a pink border around it because it’s selected. To select a different event, simply click on an event in the map area. Multiple events can be selected at the same time by holding <code class="docutils literal notranslate"><span class="pre">Ctrl</span></code> (<code class="docutils literal notranslate"><span class="pre">Cmd</span></code> on macOS) and clicking another event. Alternatively, you can use the spinner at the top of the event properties window to cycle through events.</p>
|
||
<figure class="align-center" id="id5">
|
||
<a class="reference internal image-reference" href="../_images/event-id-spinner.png"><img alt="Event Id Spinner" src="../_images/event-id-spinner.png" style="width: 75%;" />
|
||
</a>
|
||
<figcaption>
|
||
<p><span class="caption-text">Event Id Spinner</span><a class="headerlink" href="#id5" title="Link to this image"></a></p>
|
||
</figcaption>
|
||
</figure>
|
||
<div class="admonition warning">
|
||
<p class="admonition-title">Warning</p>
|
||
<p>There is currently no undo/redo functionality when editing information in the Event Details window! Use Git version control!</p>
|
||
</div>
|
||
<section id="adding-deleting-events">
|
||
<h2>Adding & Deleting Events<a class="headerlink" href="#adding-deleting-events" title="Link to this heading"></a></h2>
|
||
<p>To add a new event, press the green plus button. You can choose between the different types of events by clicking the small arrow on the right side of the button. You can also duplicate any currently selected events with <code class="docutils literal notranslate"><span class="pre">Ctrl+D</span></code>.</p>
|
||
<figure class="align-center" id="id6">
|
||
<a class="reference internal image-reference" href="../_images/add-event.png"><img alt="Add Event Button" src="../_images/add-event.png" style="width: 75%;" />
|
||
</a>
|
||
<figcaption>
|
||
<p><span class="caption-text">Add Event Button</span><a class="headerlink" href="#id6" title="Link to this image"></a></p>
|
||
</figcaption>
|
||
</figure>
|
||
<p>To delete the selected event, press the <img alt="delete-event-button" src="../_images/delete-event-button.png" /> button.</p>
|
||
</section>
|
||
<section id="event-positions">
|
||
<h2>Event Positions<a class="headerlink" href="#event-positions" title="Link to this heading"></a></h2>
|
||
<p>All events have X/Y coordinates. To move an Event, click and drag it to a new position on the map. Alternatively, you can use the X and Y spinners in the event properties.</p>
|
||
<figure class="align-center" id="id7">
|
||
<a class="reference internal image-reference" href="../_images/event-coords-spinners.png"><img alt="Event Coordinates Spinners" src="../_images/event-coords-spinners.png" style="width: 75%;" />
|
||
</a>
|
||
<figcaption>
|
||
<p><span class="caption-text">Event Coordinates Spinners</span><a class="headerlink" href="#id7" title="Link to this image"></a></p>
|
||
</figcaption>
|
||
</figure>
|
||
<p>Events also have an elevation, also known as Z coordinates (see image above). Elevations are explained in detail in the <a class="reference internal" href="editing-map-collisions.html#collision-types"><span class="std std-ref">Collision Types</span></a> section.</p>
|
||
<p>Next, we’ll cover each type of event in detail.</p>
|
||
</section>
|
||
<section id="object-events">
|
||
<h2>Object Events<a class="headerlink" href="#object-events" title="Link to this heading"></a></h2>
|
||
<p>Object events are typically used for NPCs (non-player-characters). More technically, it’s any event that has a sprite and the ability to move around. Object events are displayed using their assigned sprite, except for special cases. Any object event that uses a dynamic sprite (like berry trees) or that Porymap doesn’t recognize will be displayed as a blue square with an <cite>N</cite> <img alt="dynamic-sprite" src="../_images/dynamic-sprite.png" />.</p>
|
||
<figure class="align-center" id="id8">
|
||
<a class="reference internal image-reference" href="../_images/event-object.png"><img alt="Object Event Properties" src="../_images/event-object.png" style="width: 75%;" />
|
||
</a>
|
||
<figcaption>
|
||
<p><span class="caption-text">Object Event Properties</span><a class="headerlink" href="#id8" title="Link to this image"></a></p>
|
||
</figcaption>
|
||
</figure>
|
||
<dl>
|
||
<dt>Local ID</dt><dd><p>This is an optional field. Here you can give a <em>unique</em> name to your event so that you can refer to it elsewhere. If the event has no ID name, you can still refer to it using its number ID instead (the number next to the spinner at the top of the window).</p>
|
||
<p>For example, if you give this object event a Local ID name of <code class="docutils literal notranslate"><span class="pre">LOCALID_MY_NPC</span></code>, you could write in a script <code class="docutils literal notranslate"><span class="pre">applymovement</span> <span class="pre">LOCALID_MY_NPC,</span> <span class="pre">MovementScript</span></code>, or <code class="docutils literal notranslate"><span class="pre">applymovement</span> <span class="pre">1,</span> <span class="pre">MovementScript</span></code>, and either one would apply to this event. The benefit of using <code class="docutils literal notranslate"><span class="pre">LOCALID_MY_NPC</span></code> over <code class="docutils literal notranslate"><span class="pre">1</span></code> is that if the number changes you won’t have to update your scripts at all!</p>
|
||
</dd>
|
||
<dt>Sprite</dt><dd><p>The sprite that is used by the object.</p>
|
||
</dd>
|
||
<dt>Movement</dt><dd><p>The movement type used by the object during normal gameplay.</p>
|
||
</dd>
|
||
<dt>Movement Radius X/Y</dt><dd><p>Movement types that involves walking or moving around the map can be bounded by a radius. The ensures that the object is always within the specified range from its original position.</p>
|
||
</dd>
|
||
<dt>Script</dt><dd><p>The script that executes when the player interacts with the event. The dropdown for this field contains all the scripts from the current map and any scripts already in-use by the map’s events. You can enter the name of any script even if it doesn’t appear in the dropdown.</p>
|
||
</dd>
|
||
<dt>Event Flag</dt><dd><p>The flag value that controls if the object is visible. If the flag is set (equal to 1), then the object will be invisible. If the flag is not set, or <code class="docutils literal notranslate"><span class="pre">Event</span> <span class="pre">Flag</span></code> is set to <code class="docutils literal notranslate"><span class="pre">0</span></code> (i.e., no flag), then the object will be visible.</p>
|
||
</dd>
|
||
<dt>Trainer Type</dt><dd><p>The trainer type used by the object. If the object is a trainer, <code class="docutils literal notranslate"><span class="pre">TRAINER_TYPE_NORMAL</span></code> means that the trainer will spot the player in the object’s line-of-sight.</p>
|
||
</dd>
|
||
<dt>Sight Radius or Berry Tree ID</dt><dd><p>If the object is a trainer, this property control how many spaces away the trainer can see to spot the player for battle. If the object is a berry tree, this specifies the global id of the berry tree. Each berry tree in the game has a unique berry tree id.</p>
|
||
</dd>
|
||
</dl>
|
||
</section>
|
||
<section id="clone-object-events">
|
||
<h2>Clone Object Events<a class="headerlink" href="#clone-object-events" title="Link to this heading"></a></h2>
|
||
<p>Clone Object events are a special type of object that inherits its properties from another Object event. They are used in-game to load objects that are visible in the connecting area of adjacent maps. The targeted object to clone is specified by id and map name. If the targeted object does not exist, or it’s also a clone, the sprite for graphics id 0 will be displayed instead. Double-clicking on a Clone Object will open the targeted map with the targeted object selected.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This event type is exclusive to pokefirered projects. If you have modified your pokeemerald/pokeruby project to support this event type, you can enable them under the <code class="docutils literal notranslate"><span class="pre">Events</span></code> tab of <code class="docutils literal notranslate"><span class="pre">Options</span> <span class="pre">></span> <span class="pre">Project</span> <span class="pre">Settings...</span></code>.</p>
|
||
</div>
|
||
<figure class="align-center" id="id9">
|
||
<a class="reference internal image-reference" href="../_images/event-clone-object.png"><img alt="Clone Object Event Properties" src="../_images/event-clone-object.png" style="width: 75%;" />
|
||
</a>
|
||
<figcaption>
|
||
<p><span class="caption-text">Clone Object Event Properties</span><a class="headerlink" href="#id9" title="Link to this image"></a></p>
|
||
</figcaption>
|
||
</figure>
|
||
<dl class="simple">
|
||
<dt>Local ID</dt><dd><p>This is an optional field. Here you can give a <em>unique</em> name to your event so that you can refer to it elsewhere. If the event has no ID name, you can still refer to it using its number ID instead (the number next to the spinner at the top of the window).</p>
|
||
</dd>
|
||
<dt>Sprite</dt><dd><p>The sprite that is used by the object. Clone Objects inherit their sprite from the targeted object, so this cannot be edited. This field is not actually read by the game.</p>
|
||
</dd>
|
||
<dt>Target Local ID</dt><dd><p>The local id of the object to be cloned.</p>
|
||
</dd>
|
||
<dt>Target Map</dt><dd><p>The name of the map the object to be cloned is on.</p>
|
||
</dd>
|
||
</dl>
|
||
</section>
|
||
<section id="warp-events">
|
||
<span id="event-warps"></span><h2>Warp Events<a class="headerlink" href="#warp-events" title="Link to this heading"></a></h2>
|
||
<p>Warp events are how the player is able to warp to other maps, such as entering a building. Double-clicking on a warp will automatically open the destination map and select the destination warp. This makes it very easy to navigate around in Porymap. Warps need to be on specific metatiles to function as an exit; a warning will appear if the warp event is not on one of these metatiles.</p>
|
||
<figure class="align-center" id="id10">
|
||
<a class="reference internal image-reference" href="../_images/event-warp.png"><img alt="Warp Event Properties" src="../_images/event-warp.png" style="width: 75%;" />
|
||
</a>
|
||
<figcaption>
|
||
<p><span class="caption-text">Warp Event Properties</span><a class="headerlink" href="#id10" title="Link to this image"></a></p>
|
||
</figcaption>
|
||
</figure>
|
||
<dl>
|
||
<dt>ID</dt><dd><p>This is an optional field. Here you can give a <em>unique</em> name to your event so that you can refer to it elsewhere. If the event has no ID name, you can still refer to it using its number ID instead (the number next to the spinner at the top of the window).</p>
|
||
<p>This is used when setting the Destination Warp property for another warp.</p>
|
||
</dd>
|
||
<dt>Destination Map</dt><dd><p>The name of the map to travel to.</p>
|
||
</dd>
|
||
<dt>Destination Warp</dt><dd><p>The ID of the warp to travel to.</p>
|
||
</dd>
|
||
</dl>
|
||
</section>
|
||
<section id="trigger-events">
|
||
<h2>Trigger Events<a class="headerlink" href="#trigger-events" title="Link to this heading"></a></h2>
|
||
<p>Trigger events are scripts that execute when the player walks over them. However, they only execute when a variable is equal to some value. Typically, they execute once, set the variable’s value to something else, and then never execute again because the variable’s value no longer matches.</p>
|
||
<figure class="align-center" id="id11">
|
||
<a class="reference internal image-reference" href="../_images/event-trigger.png"><img alt="Trigger Event Properties" src="../_images/event-trigger.png" style="width: 75%;" />
|
||
</a>
|
||
<figcaption>
|
||
<p><span class="caption-text">Trigger Event Properties</span><a class="headerlink" href="#id11" title="Link to this image"></a></p>
|
||
</figcaption>
|
||
</figure>
|
||
<dl class="simple">
|
||
<dt>Script</dt><dd><p>The script that executes when the player walks over the trigger AND when the value of <code class="docutils literal notranslate"><span class="pre">Var</span></code> equals <code class="docutils literal notranslate"><span class="pre">Var</span> <span class="pre">Value</span></code>.</p>
|
||
</dd>
|
||
<dt>Var</dt><dd><p>The variable used to determine if the trigger’s Script should execute.</p>
|
||
</dd>
|
||
<dt>Var Value</dt><dd><p>The value that the Var must equal for the trigger’s Script to execute.</p>
|
||
</dd>
|
||
</dl>
|
||
</section>
|
||
<section id="weather-trigger-events">
|
||
<h2>Weather Trigger Events<a class="headerlink" href="#weather-trigger-events" title="Link to this heading"></a></h2>
|
||
<p>Weather trigger events are a very specific type of trigger. When the player walks over a weather trigger, the overworld’s weather will transition to the specified weather type.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This event type is exclusive to pokeemerald/pokeruby projects. If you have modified your pokefirered project to support this event type, you can enable them under the <code class="docutils literal notranslate"><span class="pre">Events</span></code> tab of <code class="docutils literal notranslate"><span class="pre">Options</span> <span class="pre">></span> <span class="pre">Project</span> <span class="pre">Settings...</span></code>.</p>
|
||
</div>
|
||
<figure class="align-center" id="id12">
|
||
<a class="reference internal image-reference" href="../_images/event-weather-trigger.png"><img alt="Weather Trigger Event Properties" src="../_images/event-weather-trigger.png" style="width: 75%;" />
|
||
</a>
|
||
<figcaption>
|
||
<p><span class="caption-text">Weather Trigger Event Properties</span><a class="headerlink" href="#id12" title="Link to this image"></a></p>
|
||
</figcaption>
|
||
</figure>
|
||
<dl class="simple">
|
||
<dt>Weather</dt><dd><p>The type of weather to transition to.</p>
|
||
</dd>
|
||
</dl>
|
||
</section>
|
||
<section id="sign-event">
|
||
<h2>Sign Event<a class="headerlink" href="#sign-event" title="Link to this heading"></a></h2>
|
||
<p>Sign events, or signposts, are simple interactable scripts. They are typically used for things like signs in front of buildings. The player’s facing direction can be required to be a certain direction in order to interact with the sign. Signs are the first of three “BG” event types.</p>
|
||
<figure class="align-center" id="id13">
|
||
<a class="reference internal image-reference" href="../_images/event-sign.png"><img alt="Sign Event Properties" src="../_images/event-sign.png" style="width: 75%;" />
|
||
</a>
|
||
<figcaption>
|
||
<p><span class="caption-text">Sign Event Properties</span><a class="headerlink" href="#id13" title="Link to this image"></a></p>
|
||
</figcaption>
|
||
</figure>
|
||
<dl class="simple">
|
||
<dt>Player Facing Direction</dt><dd><p>The direction the player must be facing in order to execute the sign’s script.</p>
|
||
</dd>
|
||
<dt>Script</dt><dd><p>The script that executes when the player interacts with the event. The dropdown for this field contains all the scripts from the current map and any scripts already in-use by the map’s events. You can enter the name of any script even if it doesn’t appear in the dropdown.</p>
|
||
</dd>
|
||
</dl>
|
||
</section>
|
||
<section id="hidden-item-event">
|
||
<h2>Hidden Item Event<a class="headerlink" href="#hidden-item-event" title="Link to this heading"></a></h2>
|
||
<p>Hidden items are invisible items that can be picked up by the player. They each use a flag to ensure the item can only be picked up once.</p>
|
||
<figure class="align-center" id="id14">
|
||
<a class="reference internal image-reference" href="../_images/event-hidden-item.png"><img alt="Hidden Item Event Properties" src="../_images/event-hidden-item.png" style="width: 75%;" />
|
||
</a>
|
||
<figcaption>
|
||
<p><span class="caption-text">Hidden Item Event Properties</span><a class="headerlink" href="#id14" title="Link to this image"></a></p>
|
||
</figcaption>
|
||
</figure>
|
||
<dl>
|
||
<dt>Item</dt><dd><p>The item the player will receive when interacting with this hidden item.</p>
|
||
</dd>
|
||
<dt>Flag</dt><dd><p>This flag is set when the player receives the hidden item.</p>
|
||
</dd>
|
||
<dt>Quantity</dt><dd><p>The number of items received when the item is picked up.</p>
|
||
<p>Exclusive to pokefirered projects. Can be enabled under the <code class="docutils literal notranslate"><span class="pre">Events</span></code> tab of <code class="docutils literal notranslate"><span class="pre">Options</span> <span class="pre">></span> <span class="pre">Project</span> <span class="pre">Settings...</span></code>.</p>
|
||
</dd>
|
||
<dt>Requires Itemfinder</dt><dd><p>When checked, the hidden item can only be received by standing on it and using the Itemfinder.</p>
|
||
<p>Exclusive to pokefirered projects. Can be enabled under the <code class="docutils literal notranslate"><span class="pre">Events</span></code> tab of <code class="docutils literal notranslate"><span class="pre">Options</span> <span class="pre">></span> <span class="pre">Project</span> <span class="pre">Settings...</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</section>
|
||
<section id="secret-base-event">
|
||
<h2>Secret Base Event<a class="headerlink" href="#secret-base-event" title="Link to this heading"></a></h2>
|
||
<p>This is the event used to mark entrances to secret bases. This event will only be functional on certain metatiles. Unfortunately, they are hardcoded into the game’s engine (see <code class="docutils literal notranslate"><span class="pre">sSecretBaseEntranceMetatiles</span></code> in <code class="docutils literal notranslate"><span class="pre">src/secret_base.c</span></code>). Double-clicking on a secret base will open the secret base’s map (assuming Porymap is able to infer which map that is by looking at the <code class="docutils literal notranslate"><span class="pre">Secret</span> <span class="pre">Base</span></code> field).</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This event type is exclusive to pokeemerald/pokeruby projects. If you have modified your pokefirered project to support this event type, you can enable them under the <code class="docutils literal notranslate"><span class="pre">Events</span></code> tab of <code class="docutils literal notranslate"><span class="pre">Options</span> <span class="pre">></span> <span class="pre">Project</span> <span class="pre">Settings...</span></code>.</p>
|
||
</div>
|
||
<figure class="align-center" id="id15">
|
||
<a class="reference internal image-reference" href="../_images/event-secret-base.png"><img alt="Secret Base Event Properties" src="../_images/event-secret-base.png" style="width: 75%;" />
|
||
</a>
|
||
<figcaption>
|
||
<p><span class="caption-text">Secret Base Event Properties</span><a class="headerlink" href="#id15" title="Link to this image"></a></p>
|
||
</figcaption>
|
||
</figure>
|
||
<dl class="simple">
|
||
<dt>Secret Base</dt><dd><p>The id of the destination secret base.</p>
|
||
</dd>
|
||
</dl>
|
||
</section>
|
||
<section id="heal-locations">
|
||
<h2>Heal Locations<a class="headerlink" href="#heal-locations" title="Link to this heading"></a></h2>
|
||
<p>This event is used to control where a player will arrive when they white out or fly to the map. The white out functions a little differently between game versions. For pokeemerald and pokeruby players will arrive at the event’s coordinates after a white out, while in pokefirered they will arrive on the map set in <code class="docutils literal notranslate"><span class="pre">Respawn</span> <span class="pre">Map</span></code> and at hardcoded coordinates (see <code class="docutils literal notranslate"><span class="pre">SetWhiteoutRespawnWarpAndHealerNpc</span></code> in <code class="docutils literal notranslate"><span class="pre">src/heal_location.c</span></code>).</p>
|
||
<figure class="align-center" id="id16">
|
||
<a class="reference internal image-reference" href="../_images/event-heal-location.png"><img alt="Heal Location Properties" src="../_images/event-heal-location.png" style="width: 75%;" />
|
||
</a>
|
||
<figcaption>
|
||
<p><span class="caption-text">Heal Location Properties</span><a class="headerlink" href="#id16" title="Link to this image"></a></p>
|
||
</figcaption>
|
||
</figure>
|
||
<dl>
|
||
<dt>ID</dt><dd><p>The unique ID name of this Heal Location Event. This is the name you’ll use to refer to this heal location in scripts (e.g. <code class="docutils literal notranslate"><span class="pre">setrespawn</span> <span class="pre">HEAL_LOCATION_VIRIDIAN_CITY</span></code>) or elsewhere in your project. Unlike other ID name fields, this name is required and cannot be substituted with the ID number at the top of the window.</p>
|
||
</dd>
|
||
<dt>Respawn Map</dt><dd><p>The map where the player will arrive when they white out (e.g. inside the PokéCenter that the heal location is in front of).</p>
|
||
<p>Exclusive to pokefirered projects. Can be enabled under the <code class="docutils literal notranslate"><span class="pre">Events</span></code> tab of <code class="docutils literal notranslate"><span class="pre">Options</span> <span class="pre">></span> <span class="pre">Project</span> <span class="pre">Settings...</span></code>.</p>
|
||
</dd>
|
||
<dt>Respawn NPC</dt><dd><p>The local id of the NPC the player will interact with when they white out.</p>
|
||
<p>Exclusive to pokefirered projects. Can be enabled under the <code class="docutils literal notranslate"><span class="pre">Events</span></code> tab of <code class="docutils literal notranslate"><span class="pre">Options</span> <span class="pre">></span> <span class="pre">Project</span> <span class="pre">Settings...</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</section>
|
||
<section id="custom-attributes">
|
||
<span id="id2"></span><h2>Custom Attributes<a class="headerlink" href="#custom-attributes" title="Link to this heading"></a></h2>
|
||
<p>Under each event you’ll also find the <code class="docutils literal notranslate"><span class="pre">Custom</span> <span class="pre">Attributes</span></code> table. This lets you add new data to any event. By default it is empty, and only the <code class="docutils literal notranslate"><span class="pre">Add</span></code> button is enabled.</p>
|
||
<figure class="align-center">
|
||
<a class="reference internal image-reference" href="../_images/custom-attributes.png"><img alt="Custom Attributes" src="../_images/custom-attributes.png" style="width: 35%;" />
|
||
</a>
|
||
</figure>
|
||
<p>When you click <code class="docutils literal notranslate"><span class="pre">Add</span></code> you will be prompted to enter the name of your new data field, what type of data it is, and the value. Once added you can edit their values in the table, or select an entry and click <code class="docutils literal notranslate"><span class="pre">Delete</span></code> to remove it.</p>
|
||
<figure class="align-center">
|
||
<a class="reference internal image-reference" href="../_images/custom-attributes-table.png"><img alt="Custom Attributes Table" src="../_images/custom-attributes-table.png" style="width: 75%;" />
|
||
</a>
|
||
</figure>
|
||
<p>At the moment our new data has no impact on the game, but we can write code in our project to do whatever we want with it! The new data can be found in the <code class="docutils literal notranslate"><span class="pre">map.json</span></code> file of whatever map it was added to. Normally these <code class="docutils literal notranslate"><span class="pre">map.json</span></code> files are handled by a tool in your project called <code class="docutils literal notranslate"><span class="pre">mapjson</span></code>, so to use your new data you may need to modify this tool.</p>
|
||
</section>
|
||
<section id="open-map-scripts">
|
||
<h2>Open Map Scripts<a class="headerlink" href="#open-map-scripts" title="Link to this heading"></a></h2>
|
||
<p>Clicking the <img alt="open-map-scripts-button" src="../_images/open-map-scripts-button.png" /> button will open the map’s scripts file in your default text editor. If nothing happens when this button is clicked, you may need to associate a text editor with the <code class="docutils literal notranslate"><span class="pre">.inc</span></code> file extension (or <code class="docutils literal notranslate"><span class="pre">.pory</span></code> if you’re using Porycript).</p>
|
||
<p>Additionally, if you specify a <code class="docutils literal notranslate"><span class="pre">Goto</span> <span class="pre">Line</span> <span class="pre">Command</span></code> in <code class="docutils literal notranslate"><span class="pre">Preferences...</span></code> then a tool-button will appear next to the <code class="docutils literal notranslate"><span class="pre">Script</span></code> combo-box in the <code class="docutils literal notranslate"><span class="pre">Events</span></code> tab. Clicking this button will open the file that contains the script directly to the line number of that script. If the script cannot be found in the project then the current map’s scripts file is opened.
|
||
<img alt="go-to-script-button" src="../_images/go-to-script-button.png" /></p>
|
||
</section>
|
||
<section id="tool-buttons">
|
||
<h2>Tool Buttons<a class="headerlink" href="#tool-buttons" title="Link to this heading"></a></h2>
|
||
<p>The event editing tab also extends functionality to a few of the tool buttons described in <a class="reference internal" href="editing-map-tiles.html#editing-map-tiles"><span class="std std-ref">Editing Map Tiles</span></a>.</p>
|
||
<dl class="simple">
|
||
<dt>Pencil</dt><dd><p>Clicking on an empty space will create a new event of the same type as your currently-selected event. This is the same as clicking the New Event button except that the new event will be positioned under your cursor. Right-clicking with the Pencil Tool will return to the Pointer tool.</p>
|
||
</dd>
|
||
</dl>
|
||
<figure class="align-center" id="id17">
|
||
<img alt="Drawing Object Events with the Pencil Tool" src="../_images/event-tool-pencil.gif" />
|
||
<figcaption>
|
||
<p><span class="caption-text">Drawing Object Events with the Pencil Tool</span><a class="headerlink" href="#id17" title="Link to this image"></a></p>
|
||
</figcaption>
|
||
</figure>
|
||
<dl class="simple">
|
||
<dt>Pointer</dt><dd><p>The Pointer Tool is the default tool for the event editing tab and allows you to select and move events on the map. The Pointer Tool also gives you access to the <a class="reference internal" href="#ruler-tool"><span class="std std-ref">Ruler Tool</span></a>.</p>
|
||
</dd>
|
||
<dt>Shift</dt><dd><p>You can use the Shift Tool to move any number of events together. When a selected event is dragged, all other selected events will move with it. When a tile with no event is clicked, all events on the map can be dragged.</p>
|
||
</dd>
|
||
</dl>
|
||
<figure class="align-center" id="id18">
|
||
<img alt="Moving Events with the Shift Tool" src="../_images/event-tool-shift.gif" />
|
||
<figcaption>
|
||
<p><span class="caption-text">Moving Events with the Shift Tool</span><a class="headerlink" href="#id18" title="Link to this image"></a></p>
|
||
</figcaption>
|
||
</figure>
|
||
</section>
|
||
<section id="ruler-tool">
|
||
<span id="id3"></span><h2>Ruler Tool<a class="headerlink" href="#ruler-tool" title="Link to this heading"></a></h2>
|
||
<p>The Ruler Tool provides a convenient way to measure distance on the map. This is particularly useful for scripting object movement. With the Pointer Tool selected you can activate the ruler with a Right-click. With the ruler active you can move the mouse around to extend the ruler. The ruler can be deactivated with another Right-click, or locked in place with a Left-click (Left-click again to unlock the ruler).</p>
|
||
<figure class="align-center" id="id19">
|
||
<img alt="Measuring metatile distance with the Ruler Tool" src="../_images/event-tool-ruler.gif" />
|
||
<figcaption>
|
||
<p><span class="caption-text">Measuring metatile distance with the Ruler Tool</span><a class="headerlink" href="#id19" title="Link to this image"></a></p>
|
||
</figcaption>
|
||
</figure>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>If you’d like to see your events while editing the map, select <code class="docutils literal notranslate"><span class="pre">View</span> <span class="pre">></span> <span class="pre">Show</span> <span class="pre">Events</span> <span class="pre">in</span> <span class="pre">Map</span> <span class="pre">View</span></code>.</p>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="editing-map-collisions.html" class="btn btn-neutral float-left" title="Editing Map Collisions" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="editing-map-header.html" class="btn btn-neutral float-right" title="Editing Map Headers" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2023, huderlem.</p>
|
||
</div>
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |