Gridmap
This page will give a comprehensive overview of the Gridmaps feature in Events.
You can find examples from the base game in Json/Events/Labyrinth/ and check each floor file in their respective folder.
Warning
Gridmaps is a new and developing feature which could be prone to issues that could be in need of further revisions and clarifications in the future.
Functionality may be considered limited till future updates.
See also
For Gridmap functions meant to be defined outside the Gridmap in an event, see Gridmap Functions
Creating a Gridmap
A Gridmap doesn’t require a specific CardType from an event, it only needs a scene to be placed in.
Everything that defines a Gridmap starts with the function "GoToMap", and ends upon calling "StartMap",
where the player is then placed in the defined Gridmap.
What you place between these two functions permantently defines how the scenes Gridmap will work, you cannot alter it thereafter without making an entire new Gridmap.
Assume all functions are required, unless stated otherwise.
This page will break down the following example:
"GoToMap",
"Tileset",
"0", "GridMap/floor.png", "Floor", "", "", "",
"1", "GridMap/Wall.png", "Wall", "", "", "",
"E", "GridMap/LockedGate.png", "Interactable", "Labyrinth Floor 4", "Exit", "You stand before a large metal gate with multiple large locks...",
"A", "GridMap/floorPoisoned.png", "Auto", "Labyrinth", "Poison", "The ground is laden in aphrodisiac.",
"EndLoop",
"YAdjust", "75",
"PlayerCoord", "2", "4",
"Sight", "4",
"NPC",
"Name", "Key",
"Img", "GridMap/Key.png",
"Event", "Auto", "Labyrinth", "Key",
"Obstacle",
"EndLoop",
"NPC",
"Name", "Ceris",
"Img", "GridMap/CerisIcon.png",
"Event", "Auto", "CerisGridAI", "Caught",
"Movement", "Chase", "Player",
"TurnEvent", "CerisGridAI", "Timer",
"EndLoop",
"NPC",
"Name", "RecallPoint",
"Img", "Invisible",
"EndLoop",
"NPC",
"Name", "ShadowsTile",
"Img", "GridMap/ShadowsTile.png",
"Event", "Auto", "ShadowsTile", "ShadowsTile",
"Obstacle",
"EndLoop",
"NPC",
"Name", "CharmShooterRight",
"Img", "Invisible",
"Timer", "4", "CharmShooter", "SpawnHeartRight",
"Obstacle",
"EndLoop",
"NPC",
"Name", "CharmShooterDownOverlay",
"Img", "GridMap/CharmShooterDown.png",
"Timer", "3", "CharmShooter", "PrimeCharmDown",
"TimerMax", "4",
"Obstacle",
"EndLoop",
"SpawnNPC", "Key", "5", "10",
"SpawnNPC", "CharmShooterDownOverlay", "Timer", "6", "TimerMax", "7", "8", "0",
"Row", "1","1","1","1","1","1","1","1","1","1","1","1","1","1","1", "EndLoop",
"Row", "1","0","0","0","T","0","0","0","1","0","0","0","1","E","1", "EndLoop",
"Row", "1","0","1","0","1","1","1","0","1","0","1","0","1","0","1", "EndLoop",
"Row", "1","3","1","0","0","1","1","0","0","0","1","0","0","0","1", "EndLoop",
"Row", "1","0","1","1","0","0","0","1","1","0","1","1","1","1","1", "EndLoop",
"Row", "1","1","1","0","0","1","0","0","1","0","0","0","0","0","1", "EndLoop",
"Row", "1","0","0","0","1","0","1","1","1","1","1","1","0","1","1", "EndLoop",
"Row", "1","1","1","0","1","0","0","1","1","1","0","0","0","1","1", "EndLoop",
"Row", "1","0","0","0","1","0","1","1","0","0","0","1","0","0","1", "EndLoop",
"Row", "1","0","1","1","1","0","0","0","0","1","1","1","1","0","1", "EndLoop",
"Row", "1","0","1","0","0","0","1","1","1","1","0","0","0","0","1", "EndLoop",
"Row", "1","0","0","0","1","0","0","0","0","0","0","1","1","0","1", "EndLoop",
"Row", "1","1","1","1","1","1","1","1","1","1","1","1","1","1","1", "EndLoop",
"StartMap"
Gridmap Example Breakdown
GoToMap
"GoToMap' starts the creation of your Gridmap.
StartMap
"StartMap" finalizes the setup and sends the player into the defined Gridmap.
It must be called after everything else, nor should any of the other functions in this breakdown be used after it.
Tileset
"Tileset",
"0", "GridMap/floor.png", "Floor", "", "", "",
"3", "GridMap/darkfloor.png", "Floor", "", "", "",
"1", "GridMap/Wall.png", "Wall", "", "", "",
"E", "GridMap/LockedGate.png", "Interactable", "Labyrinth Floor 4", "Exit", "You stand before a large metal gate with multiple large locks...",
"T", "GridMap/floorPoisoned.png", "Auto", "Labyrinth", "Poison", "The ground is laden in aphrodisiac.",
"EndLoop",
The "Tileset" function loop defines the tiles that will visually make up your Gridmap.
Each tile is defined on a 6-string interval. Even if a value goes unused, an empty string will still count towards the tile.
The disambiguation will use the following tile example:
``"T", "GridMap/floorPoisoned.png", "Auto", "Labyrinth", "Poison", "The ground is laden in aphrodisiac.",``
First Value:
The tile ID used to tell the game which tile to place, in this case "T" to denote a poisoned tile.
It’s encouraged to make this a single character, as the similar width will make the later placement of these tiles easier to visually follow.
Tip
Also see setting a monospace font in your respective text editors settings to make all characters the same width.
Second Value:
The image path used for your tile.
The pixel width and length used by MGD is 50x50 tiles. Any other size, such as 64x64 tilesets, will not work as expected.
Third-Sixth Values:
The third value defines the type of tile, defining how it behaves.
|
A simple tile the player and an NPC could traverse. |
|
Blocks players and NPCs from moving into it, such as for walls, pits, etc. |
|
Calls an Event when the player is standing on it and hits the interact button. Players and NPCs traverse them like a Floor. |
|
Calls an Event after the player steps on it no matter what. NPCs traverse them like a Floor. |
The fourth and fifth value is for Interactables and Auto tiles to define the name of the Event and then Scene to call. Floors and Walls leave it blank.
In this case, the tile type is "Auto", and calls the event "Labyrinth", and goes to the scene "Poison".
The sixth value is for optionally displaying flavor text when the tile is stepped by the player. Walls can’t make use of it, given players cannot step in Walls.
In this case, "The ground is laden in aphrodisiac.", will play after the Auto tile event is done being called.
YAdjust
"YAdjust" alters the position of the Gridmap on the screen via the following string value.
The value necessary will vary depending on the amount of Rows your Gridmap has.
You’ll likely need to adjust this manually from reviewing the Gridmap in-game till the positioning is considered correct.
Tip
Ensuring your event can be readily accessed in-game by temporarily defining it as a town CardType is useful during early iterations.
PlayerCoord
"PlayerCoord" sets the players starting coordinates on the Gridmap in the following two string values.
The first given value represents the X position, increasing in numerical value from left to right. The second value represents the Y position, increasing in numerical value from top to bottom.
Note how in the above example Gridmap, the player spawns on the Floor tile of ID "3", with the given player coordinates of "2", "4".
Avoid placing the player inside a wall, it’s currently unknown what this will cause.
Sight
Declaring "Sight" enables the fog of war, only letting player see as far as the following string value.
Each numerical value increases the players sight radius in a 50px interval. Vision is blocked by Wall tiles.
It’s optional and can thus be excluded if you want to disable fog of war and let the player see the entire Gridmap, including through walls.
Tip
If you just want to limit player vision through walls, you can set the sight to the maximum possible length of a column or row on the map.
DenyGridInventory
Declaring "DenyGridInventory" disables the player inventory while traversing the Gridmap. Ignores state set by the Inventory functions.
Tip
Events by default disable the inventory, and have to be manually enabled with AllowInventory every time a scene from the gridmap is entered.
NPC
"NPC",
"Name", "Key",
"Img", "GridMap/Key.png",
"Event", "Auto", "Labyrinth", "Key",
"Obstacle",
"EndLoop",
"NPC",
"Name", "Ceris",
"Img", "GridMap/CerisIcon.png",
"Event", "Auto", "CerisGridAI", "Caught",
"Movement", "Chase", "Player",
"TurnEvent", "CerisGridAI", "Timer",
"EndLoop",
"NPC",
"Name", "RecallPoint",
"Img", "Invisible",
"EndLoop",
"NPC",
"Name", "ShadowsTile",
"Img", "GridMap/ShadowsTile.png",
"Event", "Auto", "ShadowsTile", "ShadowsTile",
"Obstacle",
"EndLoop",
Each use of the "NPC" function will define a NPC.
Not only for monsters, can also be an object, like a key, or to define a RecallPoint.
The following table breaks down all following sub-functions you can provide it before closing the loop:
|
Name of your NPC, for what other Gridmap functions will call the NPC by. |
|
Image to display on map in the following string value, which is either the file path, or |
|
Upon player collision with the NPC, calls an event, featuring the same possible paramaters as Tileset. |
|
Movement type the NPC will use to navigate the Gridmap. See ChangeGridNPCMovement for possible parameters. |
|
Calls the given event then given scene every Gridmap turn, aka every step. See base game examples and Gridmap Functions. |
|
Skips the NPC in movement calls, and sets it to be displayed under all other NPCs. |
|
Sets an internal timer for the npc to count down then call an event and reset at 0. |
|
Changes the max timer count that the timer is reset to. Must be called after “Timer”. |
SpawnNPC
"SpawnNPC", "Key", "5", "10",
"SpawnNPC", "CharmShooterDownOverlay", "Timer", "6", "TimerMax", "7", "8", "0",
"SpawnNPC" spawns the given NPC at the coordinates provided in the following two string values.
The NPC must be defined in the Gridmap when it’s created to avoid issues.
The first given value represents the X position, increasing in numerical value from left to right. The second value represents the Y position, increasing in numerical value from top to bottom.
Timer and Timer max can also be called before the coordinates to alter the timer of the NPC if it already has a timer given to it.
Rows
"Row", "1","1","1","1","1","1","1","1","1","1","1","1","1","1","1", "EndLoop",
"Row", "1","0","0","0","T","0","0","0","1","0","0","0","1","E","1", "EndLoop",
"Row", "1","0","1","0","1","1","1","0","1","0","1","0","1","0","1", "EndLoop",
"Row", "1","3","1","0","0","1","1","0","0","0","1","0","0","0","1", "EndLoop",
"Row", "1","0","1","1","0","0","0","1","1","0","1","1","1","1","1", "EndLoop",
"Row", "1","1","1","0","0","1","0","0","1","0","0","0","0","0","1", "EndLoop",
"Row", "1","0","0","0","1","0","1","1","1","1","1","1","0","1","1", "EndLoop",
"Row", "1","1","1","0","1","0","0","1","1","1","0","0","0","1","1", "EndLoop",
"Row", "1","0","0","0","1","0","1","1","0","0","0","1","0","0","1", "EndLoop",
"Row", "1","0","1","1","1","0","0","0","0","1","1","1","1","0","1", "EndLoop",
"Row", "1","0","1","0","0","0","1","1","1","1","0","0","0","0","1", "EndLoop",
"Row", "1","0","0","0","1","0","0","0","0","0","0","1","1","0","1", "EndLoop",
"Row", "1","1","1","1","1","1","1","1","1","1","1","1","1","1","1", "EndLoop",
Each "Row" function loops through the defined the Gridmap layout, and is repeated till done.
Values will use the defined Tileset tiles.
Each Row must have the same legth, or errors may occur. In other words, make sure no row is too longer or shorter than another.
It’s recommended to take screenshots of your map as you make it for references and positioning of NPCs/tiles.
Tip
You can select each row by click and dragging your mouse across it to get a selected character count in the bottom right as a way to test this.
Also see using a monospace font in your text editors settings to make all text characters the same width.