Introduction

Events are the backbone of the interactivity in your game.

Events can be created directly on maps, but global events can also be made with the common events editor. Each event acts as a container for what you are wanting to do in your game so multiple events may be running or accessible globally or on a specific map at any given time.

Below are a handful of interactions that you can accomplish with events:

• Give quests
• Open shops
• Environmental puzzles
• Chests
• Doors animations
• Cutscenes
• Conversations and dialog prompts
• And just about anything you would want to do outside of combat.

In this section, we will do our best to explain anything you need to get started. If you’re new and need to start from the beginning, continue reading. Or you can see an exhaustive list of the Event Commands, or if you just need to see how things work in practice, you can check out our Examples page.

Overview

To begin, we’ll start with the basic events you can place down on your maps.

To place an event, you’ll need to open the event tab in your map editor on the Map Layers

Now you can double click on your map to place the event.

Map Event Editor

This is the editor you will see when placing Map Events. If you want to know about common events and how they differ, see the Common Events section.

We will go through this section by section.

General

Basic info and behavior for the event.

• Name: This is the name of the event as it will appear to the world.
• Global Event: If checked, the event will play for anyone when triggered.

Page Options

These allow you to add and remove pages to your events. There is no upper limit to the number of pages, but you should limit it to as many pages as you need for your event to function.

• New Page: Adds a new page.
• Copy Page: Copies the currently selected page.
• Paste Page: Paste a page you previously copy onto the currently selected page.
• Delete Page: Removes the currently selected page.
• Clear Page: Erases the data of the page as if you had just created a new page.

Conditions

Here you can set the conditions it will spawn under. You will use this to create list(s) and if any of the conditions are true, the event can run/spawn

For a detailed breakdown on these conditions and how to use them, you can refer to the Conditions List. These are similar to the Event Commands but the way they are selected/applied varies a bit.

Entity Options

These options allow you to control the event and set a visual for it.

• Preview Window: This is what the event entity will look like. You can double click this window to select a sprite or tileset image for the entity. Sprites must be in the resources/entities folder and tilesets must be in the resources/tilesets folder.
• Animation Dropdown: You can also add an animation to your event or select an animation as the only thing that will be visible. Animations must first be made in the Animations Editor to be able to select anything here.
• Movement: If you wish your entity/event to move, these options allow you to set it’s behavior.
  • Type: Select the type of movement. None is the default and the event will not move. Random will have it move in a random direction at the intervals decided below, or Move Route will have it follow a move route that you must set using the “Set Route” button.
  • Speed: Sets the speed setting for the event.
  • Freq: Sets the frequency, or how often, the event will execute a move.
  • Layer: Sets if the event is on the same layer as the player, or if they are above or below the player.

Entity Inspector Options

The Entity Inspector is what allows a player to click the event/entity and get a target box, allowing them to see some information on the event.

• Disable Inspector Checkbox: If checked, these options are disabled and the player can not click the entity.
• Face: This dropdown allows you to select a face for the entity. These are located in resources/faces.
• Inspector Description: This is the text that is displayed to the player.

Example

Extras

These are some options you can have that change different aspects of the event.

• Passable: If checked, collision is removed from the event.
• Hide Name: If checked, will hide the name of the event.
• Dir Fix: If checked, fixes the direction of the entity so that it does not turn to face the player.
• Walking Anim: If checked will pull the walking animation for the sprite.
• Interaction Freeze: If checked, interacting with the event will cause the event/entity to freeze and not do anything else like walking off.
• Ignore NPC Avoids: If checked, will ignore blocks labeled with NPC Avoids in the Attributes section of the Map Editor

Trigger

This decides what actually triggers the event and makes it run it’s command list.

In the dropdown you can select:

• Action Button: The player must interact directly with the event.
• Player Collide: The player must walk INTO the same square as the event.
• Autorun: This event is constantly running. BE AWARE THIS SHOULD BE USED SPARINGLY!
• Player Bump: The player only needs to come into contact with the entity.

Commands

This is where all the magic for events happens and where you will tell your event what it actually does using Event Commands.

• To add a command, DOUBLE CLICK anywhere you see a @ symbol.
• If you double click a command that you already have placed, it will ask you to add a command and insert it in place, pushing the previous command down.

You will be presented with the Add Command window.

These commands are detailed in the Event Commands section. Some if not most commands will create additional input sections (the @) allowing you to enter more commands.

Command Flow

It is worth noting how the commands flow through. When a command is triggered via it’s Trigger from above and assuming it meets all it’s Conditions above, it will start it’s commands FROM THE TOP and work DOWN. Commands that have multiple choices like the Show Options or the Conditional Branch will have an indented @ and will execute when the option or condition is chosen, skipping any of the non-relevant ones before leaving the case and continuing down. An Event only ends when you reach the end of the command window or use an Exit Event Process command.