Add map events editing documentation

docs/_sources/manual/editing-map-collisions.rst.txt

@@ -23,6 +23,8 @@ Painting Collisions
 
 The painting process for collisions is nearly identical to painting metatiles. You can use the same paint tools and shortcuts, with the exception of Smart Paths.  Undo/redo history includes collision modifications, too.
 
+.. _collision-types:
+
 Collision Types
 ---------------
 

docs/_sources/manual/editing-map-events.rst.txt

@@ -1,3 +1,203 @@
 ******************
 Editing Map Events
-******************
+******************
+
+Events are what bring your maps to life.  They include NPCs, signposts, warps, scripts, and more.  Open the *Events* tab above the map area, and let's dissect what's going on.
+
+.. figure:: images/editing-map-events/map-events.png
+    :alt: Map Events View
+
+    Map Events View
+
+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, simple click on an event in the map area.  Alternatively, you can use the spinner at the top of the event properties window.  Multiple events can be selected at the same time by holding ``Ctrl`` and clicking another event.
+
+.. figure:: images/editing-map-events/event-id-spinner.png
+    :alt: Event Id Spinner
+
+    Event Id Spinner
+
+.. warning::
+    There is currently no undo/redo functionality when editing events!  Use Git version control!
+
+Events Positions
+----------------
+
+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.
+
+.. figure:: images/editing-map-events/event-coords-spinners.png
+    :alt: Event Coordinates Spinners
+
+    Event Coordinates Spinners
+
+Events also have an elevation, also known as Z coordinates (see image above).  Elevations are explained in detail in the :ref:`Collision Types <collision-types>` section.
+
+Next, we'll cover each type of event in detail.
+
+Event Objects
+-------------
+
+Event objects are typically used for NPCs (non-player-characters).  More technically, it's any event that has a sprite and the ability to move around.  Event objects are displayed using their assigned sprite, except for special cases.  Any event object that uses a dynamic sprite will be displayed as a blue square with an `N` |dynamic-sprite|.  Some examples of dynamic sprites are the player's rival and berry trees.
+
+.. |dynamic-sprite|
+   image:: images/editing-map-events/dynamic-sprite.png
+
+.. figure:: images/editing-map-events/event-object.png
+    :alt: Event Object Properties
+
+    Event Object Properties
+
+Id
+    This is the local id of the object in the map.  Some script values use this local id to specify object when using scripting commands such as `applymovement`.
+
+Sprite
+    The sprite that is used by the object.
+
+Movement
+    The movement type used by the object during normal gameplay.
+
+Movement Radius X/Y
+    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.
+
+Script
+    The script that executes when the player interacts with the object.
+
+Event Flag
+    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 Event Flag is set to `0`, then the object will always be visible because `0` means "no flag".
+
+Trainer Type
+    `NONE`, `NORMAL`, or `SEE ALL DIRECTIONS`. If the object is a trainer, `NORMAL` means that the trainer will spot the player in the object's line-of-sight.
+
+Sight Radius or Berry Tree ID
+    If the object is a trainer, this property control how many tiles 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.
+
+Event Warps
+-----------
+
+Event warps 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.
+
+.. figure:: images/editing-map-events/event-warp.png
+    :alt: Event Warp Properties
+
+    Event Warp Properties
+
+Id
+    This is the local id of the warp in the map.  This is used when setting the Destination Warp property for another warp.
+
+Destination Map
+    The destination map name.
+
+Destination Warp
+    The Id of the warp in the destination map.
+
+Event Triggers
+--------------
+
+Event triggers are scripts that execute when the player walks over them.  However, they only execute when a variable is equal 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.
+
+.. figure:: images/editing-map-events/event-trigger.png
+    :alt: Event Trigger Properties
+
+    Event Trigger Properties
+
+Id
+    The local id of the trigger in the map.  This value is not used for anything.
+
+Script
+    The script that executes when the player walks over the trigger AND when the `Var` equals the `Var Value`.
+
+Var
+    The variable used to determine if the trigger's Script should execute.
+
+Var Value
+    The value that the Var must equal for the trigger's Script to execute.
+
+Event Weather Triggers
+----------------------
+
+Event weather triggers 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.
+
+.. figure:: images/editing-map-events/event-weather-trigger.png
+    :alt: Event Weather Trigger Properties
+
+    Event Weather Trigger Properties
+
+Id
+    The local id of the trigger in the map.  This value is not used for anything.
+
+Weather
+    The type of weather to transition to.
+
+Event Signs
+-----------
+
+Event signs, 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.
+
+.. figure:: images/editing-map-events/event-sign.png
+    :alt: Event Sign Properties
+
+    Event Sign Properties
+
+Id
+    The local id of the BG event in the map.  This value is not used for anything.
+
+Player Facing Direction
+    The direction the player must be facing in order to execute the sign's script.
+
+Script
+    The script that executes when the player interacts with the sign.
+
+Event Hidden Item
+-----------------
+
+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.
+
+.. figure:: images/editing-map-events/event-hidden-item.png
+    :alt: Event Hidden Item Properties
+
+    Event Hidden Item Properties
+
+Id
+    The local id of the BG event in the map.  This value is not used for anything.
+
+Item
+    The item the player will receive when interacting with this hidden item.
+
+Flag
+    This flag is set when the player receives the hidden item.
+
+Event Secret Base
+-----------------
+
+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 ``sSecretBaseEntranceMetatiles`` in ``src/secret_base.c``).
+
+.. figure:: images/editing-map-events/event-secret-base.png
+    :alt: Event Secret Base Properties
+
+    Event Secret Base Properties
+
+Id
+    The local id of the BG event in the map.  This value is not used for anything.
+
+Secret Base Id
+    The id of the destination secret base.
+
+Adding & Deleting Events
+------------------------
+
+To add a new event, press the green plus button. |add-event-button|  You can choose between the different types of events by clicking the small arrow on the right.
+
+.. |add-event-button|
+   image:: images/editing-map-events/add-event-button.png
+
+To delete the selected event, press the delete button. |delete-event-button|
+
+.. |delete-event-button|
+   image:: images/editing-map-events/delete-event-button.png
+
+Open Map Scripts
+----------------
+
+Clicking the ``Open Map Scripts`` button |open-map-scripts-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 `.inc` file extension.
+
+.. |open-map-scripts-button|
+   image:: images/editing-map-events/open-map-scripts-button.png

docs/genindex.html

@@ -113,7 +113,19 @@
 <li class="toctree-l2"><a class="reference internal" href="manual/editing-map-collisions.html#collision-types">Collision Types</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-events.html">Editing Map Events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-events.html">Editing Map Events</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#events-positions">Events Positions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-objects">Event Objects</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-warps">Event Warps</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-triggers">Event Triggers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-signs">Event Signs</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-secret-base">Event Secret Base</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+</ul>
+</li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>

docs/index.html

@@ -113,7 +113,19 @@
 <li class="toctree-l2"><a class="reference internal" href="manual/editing-map-collisions.html#collision-types">Collision Types</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-events.html">Editing Map Events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-events.html">Editing Map Events</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#events-positions">Events Positions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-objects">Event Objects</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-warps">Event Warps</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-triggers">Event Triggers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-signs">Event Signs</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-secret-base">Event Secret Base</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+</ul>
+</li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>
@@ -253,7 +265,19 @@
 <li class="toctree-l2"><a class="reference internal" href="manual/editing-map-collisions.html#collision-types">Collision Types</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-events.html">Editing Map Events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-events.html">Editing Map Events</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#events-positions">Events Positions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-objects">Event Objects</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-warps">Event Warps</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-triggers">Event Triggers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-signs">Event Signs</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-secret-base">Event Secret Base</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+</ul>
+</li>
 </ul>
 </div>
 <div class="toctree-wrapper compound">

docs/manual/editing-map-collisions.html

@@ -114,7 +114,19 @@
 <li class="toctree-l2"><a class="reference internal" href="#collision-types">Collision Types</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="editing-map-events.html">Editing Map Events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="editing-map-events.html">Editing Map Events</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#events-positions">Events Positions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-objects">Event Objects</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-warps">Event Warps</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-triggers">Event Triggers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-signs">Event Signs</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-secret-base">Event Secret Base</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+</ul>
+</li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>
@@ -221,7 +233,7 @@
 <h2>Selecting Collision Types<a class="headerlink" href="#selecting-collision-types" title="Permalink to this headline">¶</a></h2>
 <p>The Collision Type Selector is a tab next to the Metatile Selector.  It features 32 total different collision types.  The left column is for collision types that allow the player to walk through the tiles.  These are denoted by white text.  The right column is for collision types that are impassable by the player.  These are denoted by red text.</p>
 <p>The transparency slider above the collision types controls the transparency of the collision properties on the map view.</p>
-<div class="figure" id="id1">
+<div class="figure" id="id2">
 <img alt="Map Collisions View" src="../_images/map-collisions.png" />
 <p class="caption"><span class="caption-text">Map Collisions View</span></p>
 </div>
@@ -232,10 +244,10 @@
 <p>The painting process for collisions is nearly identical to painting metatiles. You can use the same paint tools and shortcuts, with the exception of Smart Paths.  Undo/redo history includes collision modifications, too.</p>
 </div>
 <div class="section" id="collision-types">
-<h2>Collision Types<a class="headerlink" href="#collision-types" title="Permalink to this headline">¶</a></h2>
+<span id="id1"></span><h2>Collision Types<a class="headerlink" href="#collision-types" title="Permalink to this headline">¶</a></h2>
 <p>Now we’ll go over the different types of collisions, along with some important concepts.  Each row in the Collision Type Selector represents a different <em>elevation</em>, which is why most rows have hexadecimal numbers in them (2, 3, 4, …, D, E).  Rows 0, 1, and F have special purposes.</p>
 <p>Elevation is how the game determines whether or not an object is on the same level as something else.  For example, it’s commonly used to make sure the player can’t walk off the top side of a mountain.  If the player’s current elevation is 4, but the player is trying to walk onto a metatile with elevation 3, then the game won’t let the player walk in that direction.  In the example below from Route 114, the player would be unable to walk north from the mountain onto the grass.  This is because 3 and 4 are different elevations.</p>
-<div class="figure" id="id2">
+<div class="figure" id="id3">
 <img alt="Different Elevations on a Cliff" src="../_images/collision-cliff.png" />
 <p class="caption"><span class="caption-text">Different Elevations on a Cliff</span></p>
 </div>
@@ -256,7 +268,7 @@
 <dt>Multi-Level Collision Type <img alt="multi-level-collision-type-1" src="../_images/multi-level-collision-type-1.png" /> <img alt="multi-level-collision-type-2" src="../_images/multi-level-collision-type-2.png" /></dt>
 <dd>The Multi-Level collision type is used for bridges.  The red version is just the impassable version, and it doesn’t have any special use.  Multi-level collision type remembers the player’s previous elevation and maintains that elevation as long as the player continues to walk on multi-level collision.  The player will only be able to leave multi-level collision if he walks onto a new tile that has the same elevation as before the multi-level collision was entered.  Here is an example of a bridge from Route 119 that illustrates the ability to surf north/south under the bridge, while also being able to walk east/west.</dd>
 </dl>
-<div class="figure" id="id3">
+<div class="figure" id="id4">
 <img alt="Multi-Level Collision Type on a Bridge" src="../_images/multi-level-bridge.png" />
 <p class="caption"><span class="caption-text">Multi-Level Collision Type on a Bridge</span></p>
 </div>

docs/manual/editing-map-events.html

@@ -114,7 +114,19 @@
 <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></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="#events-positions">Events Positions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#event-objects">Event Objects</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#event-warps">Event Warps</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#event-triggers">Event Triggers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#event-weather-triggers">Event Weather Triggers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#event-signs">Event Signs</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#event-hidden-item">Event Hidden Item</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#event-secret-base">Event Secret Base</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#adding-deleting-events">Adding &amp; Deleting Events</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#open-map-scripts">Open Map Scripts</a></li>
+</ul>
+</li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>
@@ -216,6 +228,159 @@
             
   <div class="section" id="editing-map-events">
 <h1>Editing Map Events<a class="headerlink" href="#editing-map-events" title="Permalink to this headline">¶</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>
+<div class="figure" id="id1">
+<img alt="Map Events View" src="../_images/map-events.png" />
+<p class="caption"><span class="caption-text">Map Events View</span></p>
+</div>
+<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, simple click on an event in the map area.  Alternatively, you can use the spinner at the top of the event properties window.  Multiple events can be selected at the same time by holding <code class="docutils literal notranslate"><span class="pre">Ctrl</span></code> and clicking another event.</p>
+<div class="figure" id="id2">
+<img alt="Event Id Spinner" src="../_images/event-id-spinner.png" />
+<p class="caption"><span class="caption-text">Event Id Spinner</span></p>
+</div>
+<div class="admonition warning">
+<p class="first admonition-title">Warning</p>
+<p class="last">There is currently no undo/redo functionality when editing events!  Use Git version control!</p>
+</div>
+<div class="section" id="events-positions">
+<h2>Events Positions<a class="headerlink" href="#events-positions" title="Permalink to this headline">¶</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>
+<div class="figure" id="id3">
+<img alt="Event Coordinates Spinners" src="../_images/event-coords-spinners.png" />
+<p class="caption"><span class="caption-text">Event Coordinates Spinners</span></p>
+</div>
+<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>
+</div>
+<div class="section" id="event-objects">
+<h2>Event Objects<a class="headerlink" href="#event-objects" title="Permalink to this headline">¶</a></h2>
+<p>Event objects are typically used for NPCs (non-player-characters).  More technically, it’s any event that has a sprite and the ability to move around.  Event objects are displayed using their assigned sprite, except for special cases.  Any event object that uses a dynamic sprite will be displayed as a blue square with an <cite>N</cite> <img alt="dynamic-sprite" src="../_images/dynamic-sprite.png" />.  Some examples of dynamic sprites are the player’s rival and berry trees.</p>
+<div class="figure" id="id4">
+<img alt="Event Object Properties" src="../_images/event-object.png" />
+<p class="caption"><span class="caption-text">Event Object Properties</span></p>
+</div>
+<dl class="docutils">
+<dt>Id</dt>
+<dd>This is the local id of the object in the map.  Some script values use this local id to specify object when using scripting commands such as <cite>applymovement</cite>.</dd>
+<dt>Sprite</dt>
+<dd>The sprite that is used by the object.</dd>
+<dt>Movement</dt>
+<dd>The movement type used by the object during normal gameplay.</dd>
+<dt>Movement Radius X/Y</dt>
+<dd>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.</dd>
+<dt>Script</dt>
+<dd>The script that executes when the player interacts with the object.</dd>
+<dt>Event Flag</dt>
+<dd>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 Event Flag is set to <cite>0</cite>, then the object will always be visible because <cite>0</cite> means “no flag”.</dd>
+<dt>Trainer Type</dt>
+<dd><cite>NONE</cite>, <cite>NORMAL</cite>, or <cite>SEE ALL DIRECTIONS</cite>. If the object is a trainer, <cite>NORMAL</cite> means that the trainer will spot the player in the object’s line-of-sight.</dd>
+<dt>Sight Radius or Berry Tree ID</dt>
+<dd>If the object is a trainer, this property control how many tiles 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.</dd>
+</dl>
+</div>
+<div class="section" id="event-warps">
+<h2>Event Warps<a class="headerlink" href="#event-warps" title="Permalink to this headline">¶</a></h2>
+<p>Event warps 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.</p>
+<div class="figure" id="id5">
+<img alt="Event Warp Properties" src="../_images/event-warp.png" />
+<p class="caption"><span class="caption-text">Event Warp Properties</span></p>
+</div>
+<dl class="docutils">
+<dt>Id</dt>
+<dd>This is the local id of the warp in the map.  This is used when setting the Destination Warp property for another warp.</dd>
+<dt>Destination Map</dt>
+<dd>The destination map name.</dd>
+<dt>Destination Warp</dt>
+<dd>The Id of the warp in the destination map.</dd>
+</dl>
+</div>
+<div class="section" id="event-triggers">
+<h2>Event Triggers<a class="headerlink" href="#event-triggers" title="Permalink to this headline">¶</a></h2>
+<p>Event triggers are scripts that execute when the player walks over them.  However, they only execute when a variable is equal 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>
+<div class="figure" id="id6">
+<img alt="Event Trigger Properties" src="../_images/event-trigger.png" />
+<p class="caption"><span class="caption-text">Event Trigger Properties</span></p>
+</div>
+<dl class="docutils">
+<dt>Id</dt>
+<dd>The local id of the trigger in the map.  This value is not used for anything.</dd>
+<dt>Script</dt>
+<dd>The script that executes when the player walks over the trigger AND when the <cite>Var</cite> equals the <cite>Var Value</cite>.</dd>
+<dt>Var</dt>
+<dd>The variable used to determine if the trigger’s Script should execute.</dd>
+<dt>Var Value</dt>
+<dd>The value that the Var must equal for the trigger’s Script to execute.</dd>
+</dl>
+</div>
+<div class="section" id="event-weather-triggers">
+<h2>Event Weather Triggers<a class="headerlink" href="#event-weather-triggers" title="Permalink to this headline">¶</a></h2>
+<p>Event weather triggers 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="figure" id="id7">
+<img alt="Event Weather Trigger Properties" src="../_images/event-weather-trigger.png" />
+<p class="caption"><span class="caption-text">Event Weather Trigger Properties</span></p>
+</div>
+<dl class="docutils">
+<dt>Id</dt>
+<dd>The local id of the trigger in the map.  This value is not used for anything.</dd>
+<dt>Weather</dt>
+<dd>The type of weather to transition to.</dd>
+</dl>
+</div>
+<div class="section" id="event-signs">
+<h2>Event Signs<a class="headerlink" href="#event-signs" title="Permalink to this headline">¶</a></h2>
+<p>Event signs, 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>
+<div class="figure" id="id8">
+<img alt="Event Sign Properties" src="../_images/event-sign.png" />
+<p class="caption"><span class="caption-text">Event Sign Properties</span></p>
+</div>
+<dl class="docutils">
+<dt>Id</dt>
+<dd>The local id of the BG event in the map.  This value is not used for anything.</dd>
+<dt>Player Facing Direction</dt>
+<dd>The direction the player must be facing in order to execute the sign’s script.</dd>
+<dt>Script</dt>
+<dd>The script that executes when the player interacts with the sign.</dd>
+</dl>
+</div>
+<div class="section" id="event-hidden-item">
+<h2>Event Hidden Item<a class="headerlink" href="#event-hidden-item" title="Permalink to this headline">¶</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>
+<div class="figure" id="id9">
+<img alt="Event Hidden Item Properties" src="../_images/event-hidden-item.png" />
+<p class="caption"><span class="caption-text">Event Hidden Item Properties</span></p>
+</div>
+<dl class="docutils">
+<dt>Id</dt>
+<dd>The local id of the BG event in the map.  This value is not used for anything.</dd>
+<dt>Item</dt>
+<dd>The item the player will receive when interacting with this hidden item.</dd>
+<dt>Flag</dt>
+<dd>This flag is set when the player receives the hidden item.</dd>
+</dl>
+</div>
+<div class="section" id="event-secret-base">
+<h2>Event Secret Base<a class="headerlink" href="#event-secret-base" title="Permalink to this headline">¶</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>).</p>
+<div class="figure" id="id10">
+<img alt="Event Secret Base Properties" src="../_images/event-secret-base.png" />
+<p class="caption"><span class="caption-text">Event Secret Base Properties</span></p>
+</div>
+<dl class="docutils">
+<dt>Id</dt>
+<dd>The local id of the BG event in the map.  This value is not used for anything.</dd>
+<dt>Secret Base Id</dt>
+<dd>The id of the destination secret base.</dd>
+</dl>
+</div>
+<div class="section" id="adding-deleting-events">
+<h2>Adding &amp; Deleting Events<a class="headerlink" href="#adding-deleting-events" title="Permalink to this headline">¶</a></h2>
+<p>To add a new event, press the green plus button. <img alt="add-event-button" src="../_images/add-event-button.png" />  You can choose between the different types of events by clicking the small arrow on the right.</p>
+<p>To delete the selected event, press the delete button. <img alt="delete-event-button" src="../_images/delete-event-button.png" /></p>
+</div>
+<div class="section" id="open-map-scripts">
+<h2>Open Map Scripts<a class="headerlink" href="#open-map-scripts" title="Permalink to this headline">¶</a></h2>
+<p>Clicking the <code class="docutils literal notranslate"><span class="pre">Open</span> <span class="pre">Map</span> <span class="pre">Scripts</span></code> button <img alt="open-map-scripts-button" src="../_images/open-map-scripts-button.png" /> 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 <cite>.inc</cite> file extension.</p>
+</div>
 </div>
 
 

docs/manual/editing-map-tiles.html

@@ -114,7 +114,19 @@
 <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"><a class="reference internal" href="editing-map-events.html">Editing Map Events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="editing-map-events.html">Editing Map Events</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#events-positions">Events Positions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-objects">Event Objects</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-warps">Event Warps</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-triggers">Event Triggers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-signs">Event Signs</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-secret-base">Event Secret Base</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+</ul>
+</li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>

docs/manual/introduction.html

@@ -114,7 +114,19 @@
 <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"><a class="reference internal" href="editing-map-events.html">Editing Map Events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="editing-map-events.html">Editing Map Events</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#events-positions">Events Positions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-objects">Event Objects</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-warps">Event Warps</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-triggers">Event Triggers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-signs">Event Signs</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-secret-base">Event Secret Base</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+</ul>
+</li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>

docs/manual/navigation.html

@@ -114,7 +114,19 @@
 <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"><a class="reference internal" href="editing-map-events.html">Editing Map Events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="editing-map-events.html">Editing Map Events</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#events-positions">Events Positions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-objects">Event Objects</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-warps">Event Warps</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-triggers">Event Triggers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-signs">Event Signs</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-secret-base">Event Secret Base</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
+<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+</ul>
+</li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>

docs/reference/changelog.html

@@ -114,7 +114,19 @@
 <li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-collisions.html#collision-types">Collision Types</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="../manual/editing-map-events.html">Editing Map Events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../manual/editing-map-events.html">Editing Map Events</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#events-positions">Events Positions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-objects">Event Objects</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-warps">Event Warps</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-triggers">Event Triggers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-signs">Event Signs</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-secret-base">Event Secret Base</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+</ul>
+</li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul class="current">

docs/reference/related-projects.html

@@ -113,7 +113,19 @@
 <li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-collisions.html#collision-types">Collision Types</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="../manual/editing-map-events.html">Editing Map Events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../manual/editing-map-events.html">Editing Map Events</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#events-positions">Events Positions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-objects">Event Objects</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-warps">Event Warps</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-triggers">Event Triggers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-signs">Event Signs</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-secret-base">Event Secret Base</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+</ul>
+</li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul class="current">

docs/search.html

@@ -113,7 +113,19 @@
 <li class="toctree-l2"><a class="reference internal" href="manual/editing-map-collisions.html#collision-types">Collision Types</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-events.html">Editing Map Events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-events.html">Editing Map Events</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#events-positions">Events Positions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-objects">Event Objects</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-warps">Event Warps</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-triggers">Event Triggers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-signs">Event Signs</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-secret-base">Event Secret Base</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#adding-deleting-events">Adding &amp; Deleting Events</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
+</ul>
+</li>
 </ul>
 <p class="caption"><span class="caption-text">Reference</span></p>
 <ul>

docsrc/manual/editing-map-collisions.rst

@@ -23,6 +23,8 @@ Painting Collisions
 
 The painting process for collisions is nearly identical to painting metatiles. You can use the same paint tools and shortcuts, with the exception of Smart Paths.  Undo/redo history includes collision modifications, too.
 
+.. _collision-types:
+
 Collision Types
 ---------------
 

docsrc/manual/editing-map-events.rst

@@ -1,3 +1,203 @@
 ******************
 Editing Map Events
-******************
+******************
+
+Events are what bring your maps to life.  They include NPCs, signposts, warps, scripts, and more.  Open the *Events* tab above the map area, and let's dissect what's going on.
+
+.. figure:: images/editing-map-events/map-events.png
+    :alt: Map Events View
+
+    Map Events View
+
+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, simple click on an event in the map area.  Alternatively, you can use the spinner at the top of the event properties window.  Multiple events can be selected at the same time by holding ``Ctrl`` and clicking another event.
+
+.. figure:: images/editing-map-events/event-id-spinner.png
+    :alt: Event Id Spinner
+
+    Event Id Spinner
+
+.. warning::
+    There is currently no undo/redo functionality when editing events!  Use Git version control!
+
+Events Positions
+----------------
+
+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.
+
+.. figure:: images/editing-map-events/event-coords-spinners.png
+    :alt: Event Coordinates Spinners
+
+    Event Coordinates Spinners
+
+Events also have an elevation, also known as Z coordinates (see image above).  Elevations are explained in detail in the :ref:`Collision Types <collision-types>` section.
+
+Next, we'll cover each type of event in detail.
+
+Event Objects
+-------------
+
+Event objects are typically used for NPCs (non-player-characters).  More technically, it's any event that has a sprite and the ability to move around.  Event objects are displayed using their assigned sprite, except for special cases.  Any event object that uses a dynamic sprite will be displayed as a blue square with an `N` |dynamic-sprite|.  Some examples of dynamic sprites are the player's rival and berry trees.
+
+.. |dynamic-sprite|
+   image:: images/editing-map-events/dynamic-sprite.png
+
+.. figure:: images/editing-map-events/event-object.png
+    :alt: Event Object Properties
+
+    Event Object Properties
+
+Id
+    This is the local id of the object in the map.  Some script values use this local id to specify object when using scripting commands such as `applymovement`.
+
+Sprite
+    The sprite that is used by the object.
+
+Movement
+    The movement type used by the object during normal gameplay.
+
+Movement Radius X/Y
+    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.
+
+Script
+    The script that executes when the player interacts with the object.
+
+Event Flag
+    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 Event Flag is set to `0`, then the object will always be visible because `0` means "no flag".
+
+Trainer Type
+    `NONE`, `NORMAL`, or `SEE ALL DIRECTIONS`. If the object is a trainer, `NORMAL` means that the trainer will spot the player in the object's line-of-sight.
+
+Sight Radius or Berry Tree ID
+    If the object is a trainer, this property control how many tiles 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.
+
+Event Warps
+-----------
+
+Event warps 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.
+
+.. figure:: images/editing-map-events/event-warp.png
+    :alt: Event Warp Properties
+
+    Event Warp Properties
+
+Id
+    This is the local id of the warp in the map.  This is used when setting the Destination Warp property for another warp.
+
+Destination Map
+    The destination map name.
+
+Destination Warp
+    The Id of the warp in the destination map.
+
+Event Triggers
+--------------
+
+Event triggers are scripts that execute when the player walks over them.  However, they only execute when a variable is equal 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.
+
+.. figure:: images/editing-map-events/event-trigger.png
+    :alt: Event Trigger Properties
+
+    Event Trigger Properties
+
+Id
+    The local id of the trigger in the map.  This value is not used for anything.
+
+Script
+    The script that executes when the player walks over the trigger AND when the `Var` equals the `Var Value`.
+
+Var
+    The variable used to determine if the trigger's Script should execute.
+
+Var Value
+    The value that the Var must equal for the trigger's Script to execute.
+
+Event Weather Triggers
+----------------------
+
+Event weather triggers 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.
+
+.. figure:: images/editing-map-events/event-weather-trigger.png
+    :alt: Event Weather Trigger Properties
+
+    Event Weather Trigger Properties
+
+Id
+    The local id of the trigger in the map.  This value is not used for anything.
+
+Weather
+    The type of weather to transition to.
+
+Event Signs
+-----------
+
+Event signs, 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.
+
+.. figure:: images/editing-map-events/event-sign.png
+    :alt: Event Sign Properties
+
+    Event Sign Properties
+
+Id
+    The local id of the BG event in the map.  This value is not used for anything.
+
+Player Facing Direction
+    The direction the player must be facing in order to execute the sign's script.
+
+Script
+    The script that executes when the player interacts with the sign.
+
+Event Hidden Item
+-----------------
+
+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.
+
+.. figure:: images/editing-map-events/event-hidden-item.png
+    :alt: Event Hidden Item Properties
+
+    Event Hidden Item Properties
+
+Id
+    The local id of the BG event in the map.  This value is not used for anything.
+
+Item
+    The item the player will receive when interacting with this hidden item.
+
+Flag
+    This flag is set when the player receives the hidden item.
+
+Event Secret Base
+-----------------
+
+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 ``sSecretBaseEntranceMetatiles`` in ``src/secret_base.c``).
+
+.. figure:: images/editing-map-events/event-secret-base.png
+    :alt: Event Secret Base Properties
+
+    Event Secret Base Properties
+
+Id
+    The local id of the BG event in the map.  This value is not used for anything.
+
+Secret Base Id
+    The id of the destination secret base.
+
+Adding & Deleting Events
+------------------------
+
+To add a new event, press the green plus button. |add-event-button|  You can choose between the different types of events by clicking the small arrow on the right.
+
+.. |add-event-button|
+   image:: images/editing-map-events/add-event-button.png
+
+To delete the selected event, press the delete button. |delete-event-button|
+
+.. |delete-event-button|
+   image:: images/editing-map-events/delete-event-button.png
+
+Open Map Scripts
+----------------
+
+Clicking the ``Open Map Scripts`` button |open-map-scripts-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 `.inc` file extension.
+
+.. |open-map-scripts-button|
+   image:: images/editing-map-events/open-map-scripts-button.png