PMDOWiki - User contributions [en]

Rest

2025-10-15T21:02:22Z

WalterTheRalts: Created page with "{{:Rest/Data|MoveInfobox}} '''Rest''' is a move in PMDO. == Effects == Rest fully restores the user's HP, removes status conditions, and puts the user to sleep. == Strategy == Rest is useful for times when you can't sit and wait for your health to get better, or if you want to save a few berries in your bag."

{{:Rest/Data|MoveInfobox}}

'''Rest''' is a [[move]] in [[PMDO]].

== Effects ==
Rest fully restores the user's HP, removes status conditions, and puts the user to [[sleep]].

== Strategy ==

Rest is useful for times when you can't sit and wait for your health to get better, or if you want to save a few berries in your bag.

List of PMDO Mods

2025-09-10T23:32:50Z

WalterTheRalts: Spelling fix for and link to Minior,

A listing of mods that have been developed for PMDO.

== Mod Categories ==
The mods here are categorized in the following way.
; Quest : A self-contained adventure with its own save file.
; Mechanics : A mod that alters the game mechanics of the base PMDO game.
; Expansion : A mod that adds extra content to the base PMDO game.
; Aesthetics : A mod that only makes changes to the game's visuals or sounds
; QoL : A mod that does not meaningfully change PMDO's gameplay but improves the user experience
; Library : A mod that makes no changes to the game on its own, but provides content for other mods to include within them.

== List of Mods ==
{| class="wikitable sortable"
|-
! Category !! Mod !! Description !! Author !! 0.8.11 Compatibility
|-
| Mechanics || [https://gamebanana.com/mods/615680 On-Screen Keyboard] || Adds a keyboard on the screen. || Wintermourn || Compatable
|-
| Mechanics || [https://github.com/DSE76190/Party_Plus_12/releases/download/Party_Plus_12_2.1/Party_Plus_12.2.1.zip Party Plus 12] || Increases the party size. || DSE76 || Compatible
|-
| Mechanics || [https://drive.google.com/drive/folders/1_MeXe1XD_wTxxBCYx1GluDYeV9uvLV7U?usp=drive_link Friend Areas] || Adds friend areas. || someoneelse || Compatible
|-
| Framework || [https://github.com/435THz/NebulaMissionBoard/releases Nebula Mission Board] || Adds a mission board that can also be implemented into other mods. || Mistress Nebula|| Compatible
|-
| Quest || [https://www.insertnamejam.net/forum/insert-name-jam-2025/pokemon-mystery-dungeon-minior-the-fallen-star Minior the Fallen Star] || A [[Minior]] that fell from the sky goes on a journey to get home. || CregALeg|| Compatible
|-
| Quest || [https://github.com/Palikadude/Halcyon Halcyon] || A quest that aims to recapture the vibes and energy of Explorers in an all-new original adventure.|| Palika || Downgrade to 0.8.1
|-
| Quest || [https://github.com/RaoKurai/ZMDO Zoura Mystery Dungeon Origins] || Demo of a very unique pmd adventure..! || RaoKurai || Downgrade to 0.8.2
|}

[[Category:Modding]]

Guildmaster Island

2025-09-10T23:28:38Z

WalterTheRalts: Link to Dungeons

'''Guildmaster Island''' is the setting of PMDO.

== Description ==
It is an isolated island in the mystery dungeon world. During the time period the game takes place in, it is one of the few places remaining in the world that still has [[Dungeons|mystery dungeons]].

[[Category:Locations]]

Stick

2025-08-28T00:46:00Z

WalterTheRalts:

{{:Stick/Data|ItemInfobox}}

The '''Stick''' is an item in [[PMDO]].

== Uses ==
The stick is thrown in a straight line, causing the hit opponent to [[flinch]]. The damage dealt accounts for stat boosts, has no associated type, and has 50 attack power.

== Strategy ==
The stick, like other throwables, is an extra ranged move. If you have a Pokémon that was built for melee, you can use the stick to deal with opponents that give you trouble from afar.

Apple

2025-08-27T02:53:49Z

WalterTheRalts: Strats

{{:Apple/Data|ItemInfobox}}

The '''Apple''' is an item in [[PMDO]].

== Uses ==
When eaten, the Apple restores 50 [[Belly]]. If the consumer's belly is full, it will also add 3 to their belly's max.
[[Category:Food]]

== Strategy ==
Apples can be considered the most common food item in the base game, making it very easy to have a reliable pile of food in your bag. Using an apple can ensure that you won't get hungry for a good chunk of floors, so having a reasonable amount on you can get you through a large dungeon.

Stick

2025-08-18T01:45:02Z

WalterTheRalts: Created page with "{{:Stick/Data|ItemInfobox}} The '''Stick''' is an item in PMDO. == Uses == The stick is thrown in a straight line, causing the hit opponent to flinch. The damage dealt accounts for stat boosts, has no associated type, and has 50 attack power."

Warp Seed

2025-08-18T01:34:03Z

WalterTheRalts:

{{:Warp Seed/Data|ItemInfobox}}

The '''Warp Seed''' is a [[Seed]] and an item in [[PMDO]].

== Uses ==
When eaten, the user will teleport to a random tile that they can walk on.

== Strategy ==
{{sectstub}}

Warp Seed

2025-08-18T01:32:11Z

WalterTheRalts: Created page with "{{:Warp Seed/Data|ItemInfobox}} The '''Warp Seed''' is a Seed and an item in PMDO. == Uses == When eaten, the user will teleport to a random tile that they can walk on."

{{:Warp Seed/Data|ItemInfobox}}

The '''Warp Seed''' is a [[Seed]] and an item in [[PMDO]].

== Uses ==
When eaten, the user will teleport to a random tile that they can walk on.

Beedrill family

2025-08-18T00:03:20Z

WalterTheRalts: Created page with "{{stub}} __NOTOC__ <tabs> <tab name="Weedle">{{:Weedle/Data|PokemonInfobox}}</tab> <tab name="Kakuna">{{:Kakuna/Data|PokemonInfobox}}</tab> <tab name="Beedrill">{{:Beedrill/Data|PokemonInfobox}}</tab> </tabs>"

{{stub}}

__NOTOC__

<tabs>
<tab name="Weedle">{{:Weedle/Data|PokemonInfobox}}</tab>
<tab name="Kakuna">{{:Kakuna/Data|PokemonInfobox}}</tab>
<tab name="Beedrill">{{:Beedrill/Data|PokemonInfobox}}</tab>
</tabs>

Beedrill

2025-08-18T00:01:15Z

WalterTheRalts: Redirected page to Beedrill family

#REDIRECT [[Beedrill family]]

Shroomish/Learnset

2025-08-17T23:59:17Z

WalterTheRalts: Created page with "<h6>By level up</h6> {|- class="wikitable" {{LearnsetHeader}} | 1 {{:Absorb/Data|LearnsetRow}} | 1 {{:Tackle/Data|LearnsetRow}} | 5 {{:Stun Spore/Data|LearnsetRow}} | 8 {{:Leech Seed/Data|LearnsetRow}} | 12 {{:Mega Drain/Data|LearnsetRow}} | 15 {{:Headbutt/Data|LearnsetRow}} | 19 {{:Poison Powder/Data|LearnsetRow}} | 22 {{:Worry Seed/Data|LearnsetRow}} | 26 {{:Giga Drain/Data|LearnsetRow}} | 29 {{:Growth/Data|LearnsetRow}} |..."

<h6>By level up</h6>
{|- class="wikitable"
{{LearnsetHeader}}
| 1 {{:Absorb/Data|LearnsetRow}}
| 1 {{:Tackle/Data|LearnsetRow}}
| 5 {{:Stun Spore/Data|LearnsetRow}}
| 8 {{:Leech Seed/Data|LearnsetRow}}
| 12 {{:Mega Drain/Data|LearnsetRow}}
| 15 {{:Headbutt/Data|LearnsetRow}}
| 19 {{:Poison Powder/Data|LearnsetRow}}
| 22 {{:Worry Seed/Data|LearnsetRow}}
| 26 {{:Giga Drain/Data|LearnsetRow}}
| 29 {{:Growth/Data|LearnsetRow}}
| 33 {{:Toxic/Data|LearnsetRow}}
| 36 {{:Seed Bomb/Data|LearnsetRow}}
| 40 {{:Spore/Data|LearnsetRow}}
|}

<h6>By TM</h6>
{{sectstub}}

<h6>By move tutor</h6>
{{sectstub}}

<noinclude>[[Category: Learnsets]]</noinclude>

Shroomish

2025-08-17T23:51:25Z

WalterTheRalts: Redirected page to Breloom family

#REDIRECT [[Breloom family]]

Shroomish/Data

2025-08-17T23:51:03Z

WalterTheRalts: Created page with "{{{{{1|PokemonData}}} |pokemon_name=Shroomish |pokemon_id=shroomish |type1=Grass |ability1=Effect Spore |ability2=Poison Heal |ability3=Quick Feet |recruit=80 |portrait=Portrait_Shroomish.png }}"

{{{{{1|PokemonData}}}
|pokemon_name=Shroomish
|pokemon_id=shroomish
|type1=Grass
|ability1=Effect Spore
|ability2=Poison Heal
|ability3=Quick Feet
|recruit=80
|portrait=Portrait_Shroomish.png
}}

Breloom family

2025-08-17T23:46:54Z

WalterTheRalts: Created page with "{{stub}} __NOTOC__ <tabs> <tab name="Shroomish">{{:Shroomish/Data|PokemonInfobox}}</tab> <tab name="Breloom">{{:Breloom/Data|PokemonInfobox}}</tab> </tabs>"

{{stub}}

__NOTOC__

<tabs>
<tab name="Shroomish">{{:Shroomish/Data|PokemonInfobox}}</tab>
<tab name="Breloom">{{:Breloom/Data|PokemonInfobox}}</tab>
</tabs>

Huge Power

2025-08-15T03:31:41Z

WalterTheRalts: Strats

{{:Huge Power/Data|AbilityInfobox}}

'''Huge Power''' is an [[ability]] in [[PMDO]].

== Effects ==
The Pokémon's Attack stat is multiplied by 1.5x.
== Strategy ==
This ability is essentially just a free stat boost. It has no active utility, but it can make a Pokémon good with physical moves much more powerful.

Dev Mode

2025-08-13T18:59:41Z

WalterTheRalts: Added links to prevent Dead Ends

PMDO has a secret developer mode that can be used to cheat, examine, and mod the game.
Start PMDO in this mode using the following command:

Windows:
<pre>
PMDO.exe -dev
</pre>

Unix:
<pre>
./PMDO -dev
</pre>

You can also run the <code>dev.bat</code> file to start without the command line.

== Hotkeys ==

* F1 shows diagnostic information. This will show FPS, version number, current position, animation, and hitboxes. This is also usable outside of dev mode but will only show FPS and version number.
* Shift+Up/Down warps to the next and previous floors of the dungeon, respectively.
* Shift+Left/Right warps to the next and previous segments of the dungeon. A dungeon may be split up into segments such as Magma Cavern and Deep Magma Cavern.
* Shift+Right Click will warp the player to the location clicked.
* F2 pauses the game.
* F3 advances the frame when the game is paused.
* F4 is a test button used by programmers to quickly test a feature. Don’t worry about this.
* F5 slows down the game.
* F6 speeds up the game.
* F8 mutes the music, and unmutes it when muted.
* F9 turns on FreeCam mode, where the camera can be moved. In dungeons, it turns on SeeAll mode.
* F11 takes a screenshot of the ENTIRE map, useful for showcasing maps. All characters, objects, and currently active VFX are included. The screenshot is saved to the SCREENSHOT/ subfolder.
* F12 warps the player to the debug ground map using their current save file. If no save file exists, a debug file is created (but not saved)
* F1+F12 warps the player to the debug room. Unlike F12, it send the player to the debug dungeon map.
* CTRL+F12 soft resets to the title screen.
* CTRL+Cancel clears textboxes and menus to skip text. Cancel is the Z key by default.

== Dev Panel ==

This contains the main controls to modify the game. They are separated into tabs.

=== Game ===
Often used to cheat and test in dungeons.

[[File:DevPanel_Game.png|frameless]]

* Hide Objects: Hides items and traps. In ground maps, objects are hidden.
* Hide Sprites: Hides Pokemon. Often used for screenshots.
* Create Clone: Creates a (Hostile) clone of your current character in your current location.
* Clear All Foes: Removes all enemies from the map.
* Skill List: Allows you to learn a [[move]] or give it to foes.
* Ability list: Allows you to gain an [[ability]] or give it to foes.
* Status List: Allows you to take on a status effect.
* Item List: Allows you to spawn [[items]] in dungeons.

=== Player ===
Often used to cheat in dungeons, or test animations.

[[File:DevPanel_Player.png|frameless]]

* Lv.: Sets the current player’s level. Updates in real time.
* Reroll: Updates the current player’s moveset to the latest naturally learned moves at the current level.
* Species/Form/Skin/[[Gender]]: Change the player’s current species/form/shininess/gender.
* Animation: Change the player’s current animation.

=== Travel ===
Used to instantly warp to needed locations.

[[File:DevPanel_Travel.png|frameless]]

* Areas are organized into Zones.
* Each zone has a list of Structures, plus a list of Ground Maps.
* Ground Maps are the hub maps with free movement.
* Each Structure contains a list of floors.
* You can choose to enter either a Ground map using Enter Ground, or a dungeon floor using Enter Map.

=== Data ===
Used to edit maps, items, Pokemon, etc.

[[File:DevPanel_Data.png|frameless]]

=== Sprites ===
Used to the graphics of the game.

[[File:DevPanel_Sprites.png|frameless]]

* Char Sprites: Pokemon sprites in dungeons/overworld.
* Portraits: Character portraits in dialogue.
* Particles: Most attack graphics.
* Beams: Used in attacks that shoot continuous beams, plus columns of light used for sending home.
* Backgrounds: Used in the title screen, and maps with parallax backgrounds.
* Emotes: Emote animations. Includes status effect icons.
* Tiles: All tilesets. Does not include autotiles (which are in the Data tab).
* Items: Item Sprites
* Objects: Tree stumps, signs, traps, etc.

=== Script ===
A lua command prompt to enter custom commands.

[[File:DevPanel_Script.png|frameless]]

* Reload Scripts: Reloads all lua scripts with your edits without needing to restart the game.
* Text Test: Allows you to test a dialogue box with sample text. For translators.

Command box controls:
* Type in a lua script command to run it directly on the game.
* Use TASK:BranchCoroutine(<your function here>) to call coroutines.
* SHIFT+Up/Down to scroll past commands.
* SHIFT+Enter to enter a multiline command.

=== Mods ===
Controls which mod the game currently has loaded. Can create, delete, and switch between mods. Only one may be loaded at a time. If you want to work on a mod, make sure the game is set to that mod before doing work.

[[File:DevPanel_Mod.png|frameless]]

=== Constants ===
Starter data, special game events, and VFX that are used in hardcoded portions of the game.

[[File:DevPanel_Constants.png|frameless]]

=== The Debug Room ===
This room contains a crowd of Pokemon at the top left corner for east move/ability/item testing.

[[File:DebugRoom.png|frameless]]

[[Category:Modding]]
[[Category:Quick Reference]]

Fire Spin

2025-08-13T18:43:48Z

WalterTheRalts: Created page with "{{:Fire Spin/Data|MoveInfobox}} '''Fire Spin''' is a move in PMDO. == Effects == Fire Spin deals damage and applies the Fire Spin effect to the target. == Strategy == {{sectstub}}"

{{:Fire Spin/Data|MoveInfobox}}

'''Fire Spin''' is a [[move]] in [[PMDO]].

== Effects ==
Fire Spin deals damage and applies the Fire Spin effect to the target.

== Strategy ==
{{sectstub}}

Flower Veil

2025-08-13T18:38:40Z

WalterTheRalts:

{{:Flower Veil/Data|AbilityInfobox}}

'''Flower Veil''' is an [[ability]] in [[PMDO]].

== Effects ==
Flower Veil protects all allies within a 1-tile area from being afflicted with major status effects.

The Flower Veil user themself is not protected by the ability.
== Strategy ==
This support ability is valuable since it protects the user's allies from almost all forms of gaining a status ability. Aside from the usual moves, it can also make items like [[Grimy Food]] more viable in a dungeon run.

User:WalterTheRalts

2025-08-12T18:48:32Z

WalterTheRalts:

A music-making Ralts that edits wikis for the games he mods.

Currently creating a whole game in this system, using many COMMON functions along the way. The first "release" of the game can be found here: https://github.com/WalterRalts/Explorers_of_Friending

There are a lot of things for me to share on this wiki, and I hope that I can help out.

Move

2025-07-25T02:38:16Z

WalterTheRalts: Draft of Moves

{{stub}}
Pokemon Mystery Dungeon: Origins has most of the moves from the main series games released. To create a move, see the [[Creating Moves]] page.

== Basic Information ==
Similarly to the main series games, using a move ends an entity's turn. Most moves are either damaging moves or status moves.

Pikachu/Data

2025-07-25T02:09:24Z

WalterTheRalts: Created page with "{{{{{1|PokemonData}}} |pokemon_name=Pikachu |pokemon_id=pikachu |form_id=00 |type1=Electric |ability1=Static |ability2= |ability3=Lightning Rod |recruit=40 |portrait=Portrait_Pikachu.png }}"

{{{{{1|PokemonData}}}
|pokemon_name=Pikachu
|pokemon_id=pikachu
|form_id=00
|type1=Electric
|ability1=Static
|ability2=
|ability3=Lightning Rod
|recruit=40
|portrait=Portrait_Pikachu.png
}}

Raichu family

2025-07-25T02:06:33Z

WalterTheRalts: Created page with "{{stub}} __NOTOC__ <tabs> <tab name="Pichu">{{:Pichu/Data|PokemonInfobox}}</tab> <tab name="Pikachu">{{:Pikachu/Data|PokemonInfobox}}</tab> <tab name="Raichu">{{:Raichu/Data|PokemonInfobox}}</tab> <tab name="Alolan Raichu">{{:Alolan_Raichu/Data|PokemonInfobox}}</tab> </tabs>"

{{stub}}

__NOTOC__

<tabs>
<tab name="Pichu">{{:Pichu/Data|PokemonInfobox}}</tab>
<tab name="Pikachu">{{:Pikachu/Data|PokemonInfobox}}</tab>
<tab name="Raichu">{{:Raichu/Data|PokemonInfobox}}</tab>
<tab name="Alolan Raichu">{{:Alolan_Raichu/Data|PokemonInfobox}}</tab>
</tabs>

Pikachu

2025-07-25T02:05:18Z

WalterTheRalts: Redirected page to Raichu family

#REDIRECT [[Raichu family]]

Mod:Party Plus

2025-07-19T22:17:26Z

WalterTheRalts: Created page with "'''Party Plus''' (namespace: <code>franzies_party_plus_</code>) and '''Party Plus Plus''' (namespace: <code>franzies_party_plus_plus</code>) are mods for PMDO by FranzyStar that increase the maximum number of party members. == Changes == * '''Party Plus''' increases the number to 6, while '''Party Plus Plus''' increase the number to 12. * Adds more spawners around every ground location. Category:Mods"

'''Party Plus''' (namespace: <code>franzies_party_plus_</code>) and '''Party Plus Plus''' (namespace: <code>franzies_party_plus_plus</code>) are [[mod]]s for [[PMDO]] by FranzyStar that increase the maximum number of party members.

== Changes ==

* '''Party Plus''' increases the number to 6, while '''Party Plus Plus''' increase the number to 12.
* Adds more spawners around every ground location.

[[Category:Mods]]

Jaboca Berry

2025-07-02T00:56:51Z

WalterTheRalts: /* Uses */

{{:Jaboca Berry/Data|ItemInfobox}}

The '''Jaboca Berry''' is an item in [[PMDO]].

== Uses ==
When eaten, the Jaboca Berry gives the user the [[Area Counter]] status and reflects physical damage.

Rowap Berry

2025-07-02T00:56:28Z

WalterTheRalts: Created page with "{{:Rowap Berry/Data|ItemInfobox}} The '''Rowap Berry''' is an item in PMDO. == Uses == When eaten, the Rowap Berry gives the user the Area Counter status and reflects special damage."

{{:Rowap Berry/Data|ItemInfobox}}

The '''Rowap Berry''' is an item in [[PMDO]].

== Uses ==
When eaten, the Rowap Berry gives the user the [[Area Counter]] status and reflects special damage.

Jaboca Berry

2025-07-02T00:54:50Z

WalterTheRalts: Created page with "{{:Jaboca Berry/Data|ItemInfobox}} The '''Jaboca Berry''' is an item in PMDO. == Uses == When eaten, the Jaboca Berry gives the user the Area Counter status."

{{:Jaboca Berry/Data|ItemInfobox}}

The '''Jaboca Berry''' is an item in [[PMDO]].

== Uses ==
When eaten, the Jaboca Berry gives the user the [[Area Counter]] status.

Lua Function Reference

2025-07-01T23:47:54Z

WalterTheRalts: /* GROUND:AnimateToPosition */ Added height argument

This page shows all script functions that can be called from Lua

== AI:SetCharacterAI(RogueEssence.Ground.GroundChar,System.String,System.Object[]) ==

Assign the given scripted AI class to the specified GroundChar.

=== Arguments ===

* <code>ch</code>: None
* <code>classpath</code>: None

== AI:DisableCharacterAI(RogueEssence.Ground.GroundChar) ==

Disable a given groundchar's AI processing until its enabled again.

=== Arguments ===

* <code>ch</code>: None

== AI:EnableCharacterAI(RogueEssence.Ground.GroundChar) ==

Enable a given groundchar's AI processing if its currently disabled

=== Arguments ===

* <code>ch</code>: None

== AI:SetAIState(RogueEssence.Ground.GroundChar,System.String) ==

Enable a given groundchar's AI processing if its currently disabled

=== Arguments ===

* <code>ch</code>: None

== DUNGEON:CharTurnToChar(RogueEssence.Dungeon.Character,RogueEssence.Dungeon.Character) ==

Makes a character turn to face another

=== Arguments ===

* <code>curch</code>: None
* <code>turnto</code>: None

== DUNGEON:LastDungeonResult ==

Gets the result of the last dungeon adventure.

== DUNGEON:DungeonCurrentFloor ==

Returns the floor number of the current dungeon.

== DUNGEON:DungeonAssetName ==

Returns the internal name for the current dungeon.

== DUNGEON:DungeonDisplayName ==

Returns the localized name of the current dungeon.

== DUNGEON:CharSetEmote(RogueEssence.Dungeon.Character,System.String,System.Int32) ==

Set a character's emote in a dungeon map.

=== Arguments ===

* <code>chara</code>: Character to emote
* <code>emoteid</code>: ID of the emote
* <code>cycles</code>: The number of times to play the emote.

== DUNGEON:CharStartAnim ==

Set a character's animation.

=== Arguments ===

* <code>chara</code>: Character to animate
* <code>anim</code>: Name of the animation
* <code>loop</code>: Whether to loop the animation

=== Example ===

<pre>

DUNGEON:CharStartAnim(player, anim, false)

</pre>

== DUNGEON:CharEndAnim ==

Stops a character's current animation, reverting them to default idle.

=== Arguments ===

* <code>chara</code>: Character to stop animating

=== Example ===

<pre>

DUNGEON:CharEndAnim(player)

</pre>

== DUNGEON:CharWaitAnim ==

Set a character's animation, and waits until it completed before continue.

=== Arguments ===

* <code>chara</code>: Character to animate
* <code>anim</code>: Name of the animation

=== Example ===

<pre>

DUNGEON:CharStartAnim(player, anim)

</pre>

== DUNGEON:PlayVFX(RogueEssence.Content.FiniteEmitter,System.Int32,System.Int32,RogueElements.Dir8) ==

Plays a VFX in the dungeon map

=== Arguments ===

* <code>emitter</code>: The VFX emitter
* <code>x</code>: X position in pixels
* <code>y</code>: Y Position in pixels
* <code>dir</code>: Direction to orient the VFX, defaults to Down

== DUNGEON:PlayVFX(RogueEssence.Content.FiniteEmitter,System.Int32,System.Int32,RogueElements.Dir8,System.Int32,System.Int32) ==

Plays a VFX that has a start position and an end position. It uses a finite emitter that generates BaseAnims.

=== Arguments ===

* <code>emitter</code>: The VFX emitter
* <code>x</code>: Start X position in pixels
* <code>y</code>: Start Y Position in pixels
* <code>dir</code>: Direction to orient the VFX, defaults to Down.
* <code>xTo</code>: End X position in pixels
* <code>yTo</code>: End Y position in pixels

== DUNGEON:PlayVFXAnim(RogueEssence.Content.BaseAnim,RogueEssence.Content.DrawLayer) ==

Plays a VFX using just a BaseAnim

=== Arguments ===

* <code>anim</code>: The animation to play
* <code>layer</code>: The layer to put it on

== DUNGEON:MoveScreen(RogueEssence.Content.ScreenMover) ==

Plays a screen-moving effect.

=== Arguments ===

* <code>mover</code>: The screen mover.

== GAME:GroundSave ==

Saves the game while in ground mode.

=== Example ===

<pre>

GAME:GroundSave()

</pre>

== GAME:GetModDiff(System.String) ==

TODO

=== Arguments ===

* <code>uuidStr</code>: None

== GAME:GetCurrentGround ==

Gets the current ground map.

== GAME:GetCurrentFloor ==

Gets the current dungeon map.

== GAME:GetCurrentDungeon ==

Gets the current zone, also known as dungeon.

== GAME:EnterGroundMap(System.Int32,System.Int32,System.Boolean) ==

Leave current map, and enter specified ground map within the current zone

=== Arguments ===

* <code>id</code>: The index of the ground map in the zone
* <code>idxentrypoint</code>: The index of the entry point in the ground map
* <code>preserveMusic</code>: If set to true, does not change the music when moving to the new ground map.

== GAME:EnterGroundMap(System.String,System.String,System.Boolean) ==

Leave current map, and enter specified ground map within the current zone

=== Arguments ===

* <code>name</code>: The name of the ground map. It must exist within in the zone.
* <code>entrypoint</code>: The name of the entry point in the ground map
* <code>preserveMusic</code>: If set to true, does not change the music when moving to the new ground map.

== GAME:EnterGroundMap(System.String,System.String,System.String,System.Boolean) ==

Leave current map, and enter specified ground map within a new zone.

=== Arguments ===

* <code>zone</code>: The name of the destination zone.
* <code>name</code>: The name of the ground map. It must exist within in the zone.
* <code>entrypoint</code>: The name of the entry point in the ground map
* <code>preserveMusic</code>: If set to true, does not change the music when moving to the new ground map.

== GAME:EnterDungeon ==

Enters a zone and begins a new adventure.

=== Arguments ===

* <code>dungeonid</code>: The id of the dungeon to travel to.
* <code>structureid</code>: The segment within the dungeon to start in. -1 represents ground maps.
* <code>mapid</code>: The id of the ground map or dungeon map within the dungeon segment.
* <code>entry</code>: The entry point on the resulting map
* <code>stakes</code>: Decides what happens when the adventure fails/succeeds.
* <code>recorded</code>: Record the adventure in a replay
* <code>silentRestrict</code>: Make the dungeon restrictions silently

=== Example ===

<pre>

GAME:EnterDungeon(1, 0, 0, 0, RogueEssence.Data.GameProgress.DungeonStakes.Risk, true, false)

</pre>

== GAME:ContinueDungeon ==

Enters a zone and continues the current adventure.

=== Arguments ===

* <code>dungeonid</code>: The id of the dungeon to travel to.
* <code>structureid</code>: The segment within the dungeon to start in. -1 represents ground maps.
* <code>mapid</code>: The id of the ground map or dungeon map within the dungeon segment.
* <code>entry</code>: The entry point on the resulting map

=== Example ===

<pre>

GAME:ContinueDungeon(1, 1, 0, 0)

</pre>

== GAME:EndDungeonRun ==

Ends the current adventure, sending the player to a specified destination.

=== Arguments ===

* <code>result</code>: The result of the adventure.
* <code>destzoneid</code>: The id of the dungeon to travel to.
* <code>structureid</code>: The segment within the dungeon to start in. -1 represents ground maps.
* <code>mapid</code>: The id of the ground map or dungeon map within the dungeon segment.
* <code>entryid</code>: The entry point on the resulting map
* <code>display</code>: Display an epitaph marking the end of the adventure.
* <code>fanfare</code>: Play a fanfare.
* <code>completedZone</code>: Zone to mark as completed. Defaults to current zone.

=== Example ===

<pre>

GAME:EndDungeonRun(GameProgress.ResultType.Cleared, 0, -1, 1, 0, true, true)

</pre>

== GAME:EnterRescue ==

Enters a zone and begins a rescue adventure.

=== Arguments ===

* <code>sosPath</code>: The path of the sos mail.

=== Example ===

<pre>

GAME:EnterRescue("RESCUE/INBOX/SOS/example.sosmail")

</pre>

== GAME:AddAOKRemark(System.Int32) ==

TODO: WIP

=== Arguments ===

* <code>remarkIndex</code>: None

== GAME:RestartToTitle ==

Leave current map and load up the title screen.

== GAME:RestartRogue(RogueEssence.Data.RogueConfig) ==

Restarts a Roguelocke run based on the configuration

=== Arguments ===

* <code>config</code>: The configuration of the roguelocke run

== GAME:EnterZone(System.String,System.Int32,System.Int32,System.Int32) ==

Enters a zone and begins a new adventure.

=== Arguments ===

* <code>dungeonid</code>: The id of the dungeon to travel to.
* <code>structureid</code>: The segment within the dungeon to start in. -1 represents ground maps.
* <code>mapid</code>: The id of the ground map or dungeon map within the dungeon segment.
* <code>entry</code>: The entry point on the resulting map

== GAME:FadeOut ==

Fade out the screen. Waits to complete before continuing.

=== Arguments ===

* <code>white</code>: Fade to white if set to true. Fades to black otherwise.
* <code>duration</code>: The amount of time to fade in frames.

=== Example ===

<pre>

GAME:FadeOut(false, 60)

</pre>

== GAME:FadeIn ==

Fade into the screen. Waits to complete before continuing.

=== Arguments ===

* <code>duration</code>: The amount of time to fade in frames.

=== Example ===

<pre>

GAME:FadeIn(60)

</pre>

== GAME:MoveCamera ==

Centers the camera on a position.

=== Arguments ===

* <code>x</code>: X coordinate of the camera center
* <code>y</code>: Y coordinate of the camera center
* <code>duration</code>: The amount of time it takes ot move to the destination
* <code>toPlayer</code>: Destination is in absolute coordinates if false, and relative to the player character if set to true.

=== Example ===

<pre>

GAME:MoveCamera(200, 240, 60, false)

</pre>

== GAME:MoveCameraToChara ==

Centers the camera on a character.

As we are simply moving the camera to a character, this will simply set ViewCenter and not ViewOffset.

=== Arguments ===

* <code>x</code>: X coordinate of the camera center, as an offset for the chara
* <code>y</code>: Y coordinate of the camera center, as an offset for the chara
* <code>duration</code>: The amount of time it takes ot move to the destination
* <code>chara</code>: The character to center on.

=== Example ===

<pre>

GAME:MoveCameraToChara(200, 240, 60, false)

</pre>

== GAME:GetCameraCenter ==

Gets the current center of the camera.

=== Returns ===

A Loc object representing the center of the camera.

== GAME:IsCameraOnChar ==

Determines whether the camera is centered relative to the player.

=== Returns ===

Returns true if the camera is relative to the player, false otherwise.

== GAME:HasSOSMail ==

TODO

== GAME:HasAOKMail ==

TODO

== GAME:GetTeamLeaderIndex ==

Returns the index of the currently player controlled entity in the party.

=== Returns ===

Index of the currently player controlled entity in the party.

== GAME:SetTeamLeaderIndex(System.Int32) ==

Sets the leader to the chosen index within the party.

=== Arguments ===

* <code>idx</code>: The index of the team member within the team.

== GAME:SetCanSwitch(System.Boolean) ==

Prevents or allows the switching of leaders for the save file.

=== Arguments ===

* <code>canSwitch</code>: Set to true to allow switching, set to false to prevent it.

== GAME:SetCanRecruit(System.Boolean) ==

Prevents or allows the joining of recruits for the save file.

=== Arguments ===

* <code>canRecruit</code>: Set to true to allow recruit joins, set to false to prevent it.

== GAME:GetPlayerPartyCount ==

Returns the player party count. Does not include guests.

=== Returns ===

The count of players

== GAME:GetPlayerPartyTable ==

Return the party as a LuaTable. Does not include guests.

=== Returns ===

A Lua Table of Characters

== GAME:GetPlayerPartyMember(System.Int32) ==

Gets the character at the specified index within the player's team.

=== Arguments ===

* <code>index</code>: The specified index

=== Returns ===

The team member retrieved.

== GAME:GetPlayerGuestCount ==

Gets the number of guests currently in the player's party.

=== Returns ===

The number of guests

== GAME:GetPlayerGuestTable ==

Return the guests as a LuaTable

=== Returns ===

A Lua Table of Characters

== GAME:GetPlayerGuestMember(System.Int32) ==

Gets the character at the specified index within the player's guests.

=== Arguments ===

* <code>index</code>: The specified index

=== Returns ===

The team member retrieved.

== GAME:GetPlayerAssemblyCount ==

Gets the number of characters currently in the player's assembly.

=== Returns ===

The number of characters

== GAME:GetPlayerAssemblyTable ==

Return the assembly as a LuaTable

=== Returns ===

A Lua Table of Characters

== GAME:GetPlayerAssemblyMember(System.Int32) ==

Gets the character at the specified index within the player's assembly.

=== Arguments ===

* <code>index</code>: The specified index

=== Returns ===

The assembly member retrieved.

== GAME:AddPlayerTeam(RogueEssence.Dungeon.Character) ==

Adds a character to the player's team.

=== Arguments ===

* <code>character</code>: The character to add.

== GAME:RemovePlayerTeam(System.Int32) ==

Removes the character from the team, placing its item back in the inventory.

=== Arguments ===

* <code>slot</code>: The slot of the player to remove.

== GAME:AddPlayerGuest(RogueEssence.Dungeon.Character) ==

Adds a character to the player's guests.

=== Arguments ===

* <code>character</code>: The character to add.

== GAME:RemovePlayerGuest(System.Int32) ==

Removes the character from the team's guests, placing its item back in the inventory.

=== Arguments ===

* <code>slot</code>: The slot of the player to remove.

== GAME:AddPlayerAssembly(RogueEssence.Dungeon.Character) ==

Adds a character to the player's assembly.

=== Arguments ===

* <code>character</code>: The character to add.

== GAME:RemovePlayerAssembly(System.Int32) ==

Removes the character from the assembly, placing its item back in the inventory.

=== Arguments ===

* <code>slot</code>: The slot of the player to remove.

== GAME:SetCharacterNickname(RogueEssence.Dungeon.Character,System.String) ==

Sets a character's nickname

=== Arguments ===

* <code>character</code>: The character to rename
* <code>nickname</code>: The new name

== GAME:GetCharacterNickname(RogueEssence.Dungeon.Character) ==

Gets the character nickname

=== Arguments ===

* <code>character</code>: The character to get the nickname from

=== Returns ===

The character's nickname

== GAME:SetTeamName(System.String) ==

Sets the name of the player's team

=== Arguments ===

* <code>teamname</code>: The new team name

== GAME:GetTeamName ==

Gets the name of the player's team

=== Returns ===

The team's name

== GAME:CanRelearn(RogueEssence.Dungeon.Character) ==

Checks if the character can relearn any skills.

=== Arguments ===

* <code>character</code>: The character to check

== GAME:CanForget(RogueEssence.Dungeon.Character) ==

Checks if the character can forget any skills.

=== Arguments ===

* <code>character</code>: The character to check

== GAME:CanLearn(RogueEssence.Dungeon.Character) ==

Checks if the character can learn any skills.

=== Arguments ===

* <code>character</code>: The character to check

== GAME:CheckLevelSkills ==

Checks the levels gained by a character and prompts to learn all skills along the levels.
Waits until all skills have been accepted or declined before continuing.

=== Arguments ===

* <code>chara</code>: The character to prompt for learning.
* <code>oldLevel</code>: The level that the character leveled up from.

=== Example ===

<pre>

GAME:CheckLevelSkills(player, 5)

</pre>

== GAME:TryLearnSkill ==

Attempts to give a new skill to the specified character, prompting to replace an old one if they are full.
Waits until all the skill has been accepted or declined before continuing.

=== Arguments ===

* <code>chara</code>: The character to learn the skill
* <code>skill</code>: The skill to learn

=== Example ===

<pre>

GAME:TryLearnSkill(player, "thunder")

</pre>

== GAME:LearnSkill(RogueEssence.Dungeon.Character,System.String) ==

Gives a new skill to a specified character.
Fails if the character's skills are full.

=== Arguments ===

* <code>chara</code>: The character to learn the skill
* <code>skill</code>: The skill to learn

== GAME:ForgetSkill(RogueEssence.Dungeon.Character,System.Int32) ==

Removed a skill from the specified character.

=== Arguments ===

* <code>chara</code>: The character to forget the skill
* <code>slot</code>: The slot of the skill to forget

== GAME:LockSkill(RogueEssence.Dungeon.Character,System.Int32) ==

Makes a skill impossible to forget or replace for the specified character.
Note that this only affects normal gameplay. Scripts can still freely get rid of the skill.

=== Arguments ===

* <code>chara</code>: The character to lock the skill
* <code>slot</code>: The slot of the skill to lock

== GAME:UnlockSkill(RogueEssence.Dungeon.Character,System.Int32) ==

Unlocks a previously locked skill for the specified character, making it possible to be forgotten or replaced during normal gameplay.

=== Arguments ===

* <code>chara</code>: The character to unlock the skill
* <code>slot</code>: The slot of the skill to unlock

== GAME:SetCharacterSkill(RogueEssence.Dungeon.Character,System.String,System.Int32,System.Boolean) ==

Gives a new skill to a specified character, replacing a specifically chosen slot.

=== Arguments ===

* <code>character</code>: The character to learn the skill
* <code>skillId</code>: The skill to learn
* <code>slot</code>: The slot to replace

== GAME:GetCharacterSkill(RogueEssence.Dungeon.Character,System.Int32) ==

Gets the skill from a specified character and specified slot.

=== Arguments ===

* <code>chara</code>: The character to get the skill from.
* <code>slot</code>: The slot to get the skill from.

=== Returns ===

The ID of the skill in the slot

== GAME:CanPromote(RogueEssence.Dungeon.Character) ==

Checks if the character can be promoted to a new class.

=== Arguments ===

* <code>character</code>: The character to check

=== Returns ===

True if the character can be promoted, false otherwise.

== GAME:GetAvailablePromotions(RogueEssence.Dungeon.Character,System.String) ==

Gets a list of possible classes that the character can prmote to.

=== Arguments ===

* <code>character</code>: The character to check
* <code>bypassItem</code>: An exception item that can bypass checks for promotion

=== Returns ===

A lua table of PromoteBranch objects

== GAME:PromoteCharacter(RogueEssence.Dungeon.Character,RogueEssence.Data.PromoteBranch,System.String) ==

Promotes a character ot a new class.

=== Arguments ===

* <code>character</code>: The character to promote
* <code>branch</code>: The PromoteBranch to promote with
* <code>bypassItem</code>: An exception item that can bypass checks for promotion

== GAME:FindPlayerItem(System.String,System.Boolean,System.Boolean) ==

Finds an item in the player's team and returns its slot within the inventory or among its team's equips.

=== Arguments ===

* <code>id</code>: The item ID to search for.
* <code>held</code>: Check equipped items.
* <code>inv</code>: Check inventory items.

=== Returns ===

The InvSlot of the item. Invalid if the item could not be found.

== GAME:GetPlayerEquippedCount ==

Get the number of items equipped by players. Does not include guests.

=== Returns ===

The number of items.

== GAME:GetPlayerBagCount ==

Get the number of items in the bag.

=== Returns ===

The number of items.

== GAME:GetPlayerBagLimit ==

Gets the maximum amount of item the player's team can carry.

=== Returns ===

The number of items.

== GAME:GetPlayerEquippedItem(System.Int32) ==

Gets the equipped item for the character in the specified slot.

=== Arguments ===

* <code>slot</code>: The team slot of the character to check

=== Returns ===

The character's equipped item

== GAME:GetGuestEquippedItem(System.Int32) ==

Gets the equipped item for the character in the specified guest slot.

=== Arguments ===

* <code>slot</code>: The guest slot of the character to check

=== Returns ===

The character's equipped item

== GAME:GivePlayerItem(RogueEssence.Dungeon.InvItem) ==

Gives an item and adds it to the player team's bag.

=== Arguments ===

* <code>item</code>: The item to give

== GAME:GivePlayerItem(System.String,System.Int32,System.Boolean,System.String) ==

Gives an item and adds it to the player team's bag.

=== Arguments ===

* <code>id</code>: The ID of the item
* <code>count</code>: The amount to give. Default 1
* <code>cursed</code>: Whether the item is cursed. Default false.
* <code>hiddenval</code>: The hidden value of the item. Default empty string.

== GAME:GetPlayerBagItem(System.Int32) ==

Gets the item found at the specified slot of the player's bag.

=== Arguments ===

* <code>slot</code>: The slot to check

=== Returns ===

The item found in the slot

== GAME:TakePlayerBagItem(System.Int32,System.Boolean) ==

Remove an item from player inventory

=== Arguments ===

* <code>slot</code>: The slot from which to remove the item
* <code>takeAll</code>: None

== GAME:TakePlayerEquippedItem(System.Int32,System.Boolean) ==

Remove the equipped item from a chosen member of the team

=== Arguments ===

* <code>slot</code>: The slot of the character on the team from which to remove the item
* <code>takeAll</code>: None

== GAME:TakeGuestEquippedItem(System.Int32,System.Boolean) ==

Remove the equipped item from a chosen guest of the team

=== Arguments ===

* <code>slot</code>: The slot of the character on the team's guest list from which to remove the item
* <code>takeAll</code>: None

== GAME:GetPlayerStorageCount ==

Get the amount of items in the player's storage

== GAME:GetPlayerStorageItemCount(System.String) ==

Get the amount of a specific item in the player's storage

=== Arguments ===

* <code>id</code>: ID of the item ot check

=== Returns ===

The amount of copies currently in storage

== GAME:GivePlayerStorageItem(RogueEssence.Dungeon.InvItem) ==

Gives an item and adds it to the player team's storage.

=== Arguments ===

* <code>item</code>: The item to give

== GAME:GivePlayerStorageItem(System.String,System.Int32,System.Boolean,System.String) ==

Gives an item and adds it to the player team's storage.

=== Arguments ===

* <code>id</code>: The ID of the item
* <code>count</code>: The amount to give. Default 1
* <code>cursed</code>: Whether the item is cursed. Default false.
* <code>hiddenval</code>: The hidden value of the item. Default empty string.

== GAME:TakePlayerStorageItem(System.String) ==

Takes an item from the storage

=== Arguments ===

* <code>id</code>: The ID of the item to take

== GAME:DepositAll ==

Takes all items in the player team's bag and equipped items, and deposits them in storage.

== GAME:GetPlayerMoney ==

Gets the amount of money the player currently has on hand.

=== Returns ===

The amount of money.

== GAME:AddToPlayerMoney(System.Int32) ==

Adds money to the player's wallet.

=== Arguments ===

* <code>toadd</code>: The amount of money to add.

== GAME:RemoveFromPlayerMoney(System.Int32) ==

Removes money from the player's wallet.

=== Arguments ===

* <code>toremove</code>: The amount of money to remove.

== GAME:GetPlayerMoneyBank ==

Gets the amount of money in the player's bank

=== Returns ===

The amount of money.

== GAME:AddToPlayerMoneyBank(System.Int32) ==

Adds money to the player's bank.

=== Arguments ===

* <code>toadd</code>: The amount of money to add.

== GAME:RemoveFromPlayerMoneyBank(System.Int32) ==

Removes money from the player's bank.

=== Arguments ===

* <code>toremove</code>: The amount of money to remove.

== GAME:IsKeyDown(System.Int32) ==

Checks if a player is making a certain physical keyboard input.

=== Arguments ===

* <code>keyid</code>: The ID of the input

=== Returns ===

True if the button is currently pressed. False otherwise.

== GAME:IsInputDown(System.Int32) ==

Checks if a player is making a certain game input.

=== Arguments ===

* <code>inputid</code>: None

=== Returns ===

True if the input is currently pressed. False otherwise.

== GAME:CutsceneMode(System.Boolean) ==

Sets the game in cutscene mode. This prevents characters from taking idle action and hides certain UI.

=== Arguments ===

* <code>bon</code>: If set to true, turns cutscene mode on. If set to false, turns it off.

== GAME:GetDailySeed ==

Gets the random seed for the current adventure.

=== Returns ===

The current adventure's seed.

== GAME:UnlockDungeon(System.String) ==

Unlocks a specified dungeon.

=== Arguments ===

* <code>dungeonid</code>: ID of the dungeon to unlock.

== GAME:DungeonUnlocked(System.String) ==

Checks if a dungeon is unlocked.

=== Arguments ===

* <code>dungeonid</code>: ID of the dungeon to check

=== Returns ===

True if unlocked, false otherwise.

== GAME:InRogueMode ==

Checks if the current game is in rogue mode.

=== Returns ===

True if in rogue mode, false otherwise.

== GAME:HasServerSet ==

TODO: WIP

== GAME:GetRescueAllowed ==

Checks to see if rescue is allowed.

=== Returns ===

True if rescues are allowed, false otherwise.

== GAME:SetRescueAllowed(System.Boolean) ==

Sets the value in the player's save file to determine if they can be rescued or not.
If rescue is possible on the Save File level, it can still be prevented by the map.

=== Arguments ===

* <code>allowed</code>: Set to true to allow the player to be rescued. False otherwise.

== GAME:QueueLeaderEvent(System.Object) ==

Prepares an event to execute on the next frame.

=== Arguments ===

* <code>obj</code>: None

== GAME:WaitFrames ==

Waits for a specified number of frames before continuing.

=== Arguments ===

* <code>frames</code>: The number of frames ot wait. Each frame is 1/60th of a second.

=== Example ===

<pre>

GAME:WaitFrames(60)

</pre>

== GAME:VectorToDirection(RogueElements.Loc) ==

Turns a vector (preferably a unit vector) into a cardinal or diagonal direction.

=== Arguments ===

* <code>v</code>: The vector.

=== Returns ===

The direction as one of 8 values.

== GAME:VectorToDirection(System.Double,System.Double) ==

Convenience function to get a vector's components from lua numbers(doubles)

=== Arguments ===

* <code>X</code>: The X value of the vector
* <code>Y</code>: The Y value of the vector

=== Returns ===

The direction the vector points to as one of 8 values.

== GAME:RandomDirection ==

Generates a random direction.

=== Returns ===

An 8-directional direction.

== GAME:SetupLuaFunctions(RogueEssence.Script.LuaEngine) ==

Setups any extra functionalities for this object written on the lua side.

== GROUND:Hide(System.String) ==

Hides an entity.

=== Arguments ===

* <code>entityname</code>: The name of the entity to hide.

== GROUND:Unhide(System.String) ==

Unhides an entity.

=== Arguments ===

* <code>entityname</code>: The name of the entity to unhide.

== GROUND:CreateObject(System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32) ==

TODO: WIP

=== Arguments ===

* <code>objtype</code>: None
* <code>instancename</code>: None
* <code>x</code>: None
* <code>y</code>: None
* <code>w</code>: None
* <code>h</code>: None

== GROUND:CreateCharacter(System.String,System.String,System.Int32,System.Int32,System.String,System.String) ==

TODO: WIP

=== Arguments ===

* <code>chartype</code>: None
* <code>instancename</code>: None
* <code>x</code>: None
* <code>y</code>: None
* <code>actionfun</code>: None
* <code>thinkfun</code>: None

== GROUND:RemoveObject(System.String) ==

Deletes an object from the ground map, identified by its instance name.

=== Arguments ===

* <code>instancename</code>: The instance name of the object.

=== Returns ===

Returns true if succeeded, false otherwise.

== GROUND:RemoveCharacter(System.String) ==

Deletes a character from the ground map, identified by its instance name.

=== Arguments ===

* <code>instancename</code>: The instance name of the object.

=== Returns ===

Returns true if succeeded, false otherwise.

== GROUND:CreateCharacterFromCharData(System.String,RogueEssence.Dungeon.Character,System.Int32,System.Int32,RogueElements.Dir8) ==

Creates a ground character, given a dungeon character.

=== Arguments ===

* <code>instancename</code>: The instance name to give the character
* <code>data</code>: Character data to create from
* <code>x</code>: X coordinate of the character
* <code>y</code>: Y coordinate of the character
* <code>direction</code>: Direction the character will face, defaults to Dir8.Down

== GROUND:RefreshPlayer ==

Reloads the controllable player's character data to be the current team's leader.

== GROUND:SetPlayer(RogueEssence.Dungeon.CharData) ==

Sets the controllable player to use new character data

=== Arguments ===

* <code>charData</code>: The new character data

== GROUND:SpawnerDoSpawn(System.String) ==

Make the specified spawner run its spawn method.

=== Arguments ===

* <code>spawnername</code>: None

=== Returns ===

The ground character spawned.

== GROUND:SpawnerSetSpawn(System.String,RogueEssence.Dungeon.CharData) ==

Sets the character to the specified spawner

=== Arguments ===

* <code>spawnername</code>: The spawner to set the character to, by name
* <code>spawnChar</code>: The character to spawn.

== GROUND:CharTurnToChar(RogueEssence.Ground.GroundChar,RogueEssence.Ground.GroundChar) ==

Makes a character turn to face another character instantly.

=== Arguments ===

* <code>turnchar</code>: The character that is turning.
* <code>turnto</code>: The character to turn to.

== GROUND:CharTurnToCharAnimated ==

Makes a character do an animated turn to face another character over the specified time.
Clockwise or counter-clockwise are chosen based on the closest direction.
Waits until the operation is completed.

=== Arguments ===

* <code>curch</code>: Character that is turning
* <code>turnto</code>: Character to turn to
* <code>framedur</code>: Time spent on each direction, in frames

=== Example ===

<pre>

CharTurnToCharAnimated(charFrom, charTo, 3)

</pre>

== GROUND:EntTurn(RogueEssence.Ground.GroundEntity,RogueElements.Dir8) ==

Makes a ground entity turn to face a direction.

=== Arguments ===

* <code>ent</code>: The ground entity. Can be a character or object.
* <code>direction</code>: The direction to face.

== GROUND:CharAnimateTurn ==

Makes a character do an animated turn to face a chosen direction over the specified time.
Must specify clockwise or counter-clockwise.
Waits until the operation is completed.

=== Arguments ===

* <code>ch</code>: The character to turn
* <code>direction</code>: The direction to turn to
* <code>framedur</code>: The time spent in each intermediate direction, in frames
* <code>ccw</code>: false if clockwise, true if counter-clockwise

=== Example ===

<pre>

GROUND:CharTurnToCharAnimated(charFrom, Dir8.Left, 3, true)

</pre>

== GROUND:CharAnimateTurnTo ==

Makes a character do an animated turn to face a chosen direction over the specified time.
Waits until the operation is completed.

=== Arguments ===

* <code>ch</code>: The character to turn
* <code>direction</code>: The direction to turn to
* <code>framedur</code>: The time spent in each intermediate direction, in frames

=== Example ===

<pre>

CharAnimateTurnTo(charFrom, Dir8.Left, 3)

</pre>

== GROUND:TeleportTo(RogueEssence.Ground.GroundEntity,System.Int32,System.Int32,RogueElements.Dir8,System.Int32) ==

Repositions the ground entity in a specified location.

=== Arguments ===

* <code>ent</code>: The ground entity to reposition
* <code>x</code>: The X coordinate of the destination
* <code>y</code>: The Y coordinate of the destination
* <code>direction</code>: The direction to point the entity. Defaults to Dir8.None, which leaves it untouched.
* <code>height</code>: None

== GROUND:MoveInDirection ==

Make ground character move in a direction.

=== Arguments ===

* <code>chara</code>: Character to move
* <code>direction</code>: Direction to move in
* <code>duration</code>: Duration of movement, in frames
* <code>run</code>: True if using a running animation, false otherwise
* <code>speed</code>: Speed in pixels per frame

=== Example ===

<pre>

GROUND:MoveInDirection(player, Dir8.Down, 24, false, 2)

</pre>

== GROUND:MoveToPosition ==

Make ground character move to a position.

=== Arguments ===

* <code>chara</code>: Character to move
* <code>x</code>: X coordinate of destination
* <code>y</code>: Y coordinate of destination
* <code>run</code>: True if using a running animation, false otherwise
* <code>speed</code>: Speed in pixels per frame

=== Example ===

<pre>

GROUND:MoveInDirection(player, 200, 240, false, 2)

</pre>

== GROUND:MoveToMarker ==

Make ground character move to a ground marker.

=== Arguments ===

* <code>chara</code>: Character to move
* <code>mark</code>: GroundMarker object ot move to
* <code>run</code>: True if using a running animation, false otherwise
* <code>speed</code>: Speed in pixels per frame

=== Example ===

<pre>

GROUND:MoveInDirection(player, marker, false, 2)

</pre>

== GROUND:MoveObjectToPosition ==

Make ground object move to a position.

=== Arguments ===

* <code>ent</code>: Ground Entity to move
* <code>x</code>: X coordinate of destination
* <code>y</code>: Y coordinate of destination
* <code>speed</code>: Speed in pixels per frame

=== Example ===

<pre>

GROUND:MoveInDirection(player, 200, 240, 2)

</pre>

== GROUND:AnimateInDirection ==

Make a ground character move in a direction with custom animation

=== Arguments ===

* <code>chara</code>: Character to move
* <code>anim</code>: Name of the animation
* <code>animDir</code>: Direction of animation
* <code>direction</code>: Direction to move in
* <code>duration</code>: Duration of movement, in frames
* <code>animSpeed</code>: Speed of animation, where 1.0 represents normal speed
* <code>speed</code>: Speed movement, in pixels per frame

=== Example ===

<pre>

GROUND:AnimateInDirection(player, "Hurt", Dir8.Down, 24, 0.5, 2)

</pre>

== GROUND:AnimateToPosition ==

Make a ground entity move to a position with custom animation

=== Arguments ===

* <code>ent</code>: Entity to move
* <code>anim</code>: Name of the animation
* <code>animDir</code>: Direction of animation
* <code>x</code>: X coordinate of the destination
* <code>y</code>: Y coordinate of the destination
* <code>animSpeed</code>: Speed of animation, where 1.0 represents normal speed
* <code>speed</code>: Speed movement, in pixels per frame
* <code>height</code>: Height of the destination

=== Example ===

<pre>

GROUND:AnimateToPosition(player, "Hurt", Dir8.Down, 200, 240, 0.5, 2, 0)

</pre>

== GROUND:CharSetEmote(RogueEssence.Ground.GroundChar,System.String,System.Int32) ==

Make a character emote on the ground map.

=== Arguments ===

* <code>chara</code>: Character to emote
* <code>emoteid</code>: ID of the emote
* <code>cycles</code>: The number of times to play the emote.

== GROUND:CharSetDrawEffect(RogueEssence.Ground.GroundChar,RogueEssence.Dungeon.DrawEffect) ==

Sets the ground character's draw effect to become invisible, shaking, still, etc.

=== Arguments ===

* <code>chara</code>: Target ground character.
* <code>effect</code>: The draw effect.

== GROUND:CharEndDrawEffect(RogueEssence.Ground.GroundChar,RogueEssence.Dungeon.DrawEffect) ==

Sets the ground character's draw effect to become invisible, shaking, still, etc.

=== Arguments ===

* <code>chara</code>: Target ground character.
* <code>effect</code>: The draw effect.

== GROUND:CharGetAnimFallback(RogueEssence.Ground.GroundChar,System.String) ==

Gets the fallback animation for the character.

=== Arguments ===

* <code>chara</code>: None
* <code>anim</code>: The anim to get the fallback anim of.

=== Returns ===

The fallback animation, as a string. Blank if there is none. Will return anim if anim already exists.

== GROUND:CharGetAnim(RogueEssence.Ground.GroundChar) ==

Gets a character's current animation as a string.

=== Arguments ===

* <code>chara</code>: None

== GROUND:CharGetAnimPoint(RogueEssence.Ground.GroundChar,RogueEssence.Content.ActionPointType) ==

Gets the chosen action point of the character at this specific frame.

=== Arguments ===

* <code>chara</code>: None
* <code>actionPoint</code>: The ype of action point to retrieve the coordinates for.

=== Returns ===

The location of the action point in absolute coordinates on the map.

== GROUND:CharSetAnim(RogueEssence.Ground.GroundChar,System.String,System.Boolean) ==

Set a character's animation.

=== Arguments ===

* <code>chara</code>: Character to animate
* <code>anim</code>: Name of the animation
* <code>loop</code>: Whether to loop the animation

== GROUND:CharEndAnim(RogueEssence.Ground.GroundChar) ==

Stops a character's current animation, reverting them to default idle.

=== Arguments ===

* <code>chara</code>: Character to stop animating

== GROUND:CharWaitAnim ==

Makes the character perform an animation and waits until it's over.

=== Arguments ===

* <code>ent</code>: Character to animate
* <code>anim</code>: Animation to play

=== Example ===

<pre>

GROUND:CharWaitAnim(player, "Hurt")

</pre>

== GROUND:CharSetAction(RogueEssence.Ground.GroundChar,RogueEssence.Ground.GroundAction) ==

Set a character's action.

=== Arguments ===

* <code>chara</code>: Character to perfom the action
* <code>action</code>: The action to perform

== GROUND:CharWaitAction ==

Makes the character perform an action and waits until it's over.

=== Arguments ===

* <code>ent</code>: Character to animate
* <code>action</code>: Action to perform

=== Example ===

<pre>

GROUND:CharWaitAction(player, action)

</pre>

== GROUND:ObjectSetAnim(RogueEssence.Ground.GroundObject,System.Int32,System.Int32,System.Int32,RogueElements.Dir8,System.Int32) ==

Sets a ground object's animation. After it finishes, it will return to the default animation.

=== Arguments ===

* <code>obj</code>: The object to animate
* <code>frameTime</code>: The duration of each frame of animation
* <code>startFrame</code>: The start frame of animation
* <code>endFrame</code>: The end frame of animation
* <code>dir</code>: The direction of the animation
* <code>cycles</code>: The number of times to repeat the animation

== GROUND:ObjectSetDefaultAnim(RogueEssence.Ground.GroundObject,System.String,System.Int32,System.Int32,System.Int32,RogueElements.Dir8) ==

Sets a ground object's default animation.

=== Arguments ===

* <code>obj</code>: The object to animate
* <code>animName</code>: The name of the animation
* <code>frameTime</code>: The duration of each frame of animation
* <code>startFrame</code>: The start frame of animation
* <code>endFrame</code>: The end frame of animation
* <code>dir</code>: The direction of the animation

== GROUND:ObjectWaitAnimFrame ==

Waits for the object to reach a specific frame before continuing.

=== Arguments ===

* <code>obj</code>: The object ot wait on
* <code>frame</code>: The frame of animation to wait on.

=== Example ===

<pre>

GROUND:WaitObjectAnim(fountain, 3)

</pre>

== GROUND:PlayVFX(RogueEssence.Content.FiniteEmitter,System.Int32,System.Int32,RogueElements.Dir8) ==

Plays a VFX using a finite emitter that generates BaseAnims.

=== Arguments ===

* <code>emitter</code>: The VFX emitter
* <code>x</code>: X position
* <code>y</code>: Y Position
* <code>dir</code>: Direction to orient the VFX, defaults to Down

== GROUND:PlayVFX(RogueEssence.Content.FiniteEmitter,System.Int32,System.Int32,RogueElements.Dir8,System.Int32,System.Int32) ==

Plays a VFX that has a start position and an end position. It uses a finite emitter that generates BaseAnims.

=== Arguments ===

* <code>emitter</code>: The VFX emitter
* <code>x</code>: Start X position
* <code>y</code>: Start Y Position
* <code>dir</code>: Direction to orient the VFX, defaults to Down.
* <code>xTo</code>: End X position
* <code>yTo</code>: End Y position

== GROUND:PlayVFXAnim(RogueEssence.Content.BaseAnim,RogueEssence.Content.DrawLayer) ==

Plays a VFX using just a BaseAnim

=== Arguments ===

* <code>anim</code>: The animation to play
* <code>layer</code>: The layer to put it on

== GROUND:MoveScreen(RogueEssence.Content.ScreenMover) ==

Plays a screen-moving effect.

=== Arguments ===

* <code>mover</code>: The screen mover.

== GROUND:HandoutEXP ==

Gives a character a set amount of EXP.
Also handles leveling up and learning new moves.

=== Arguments ===

* <code>character</code>: The characters to level up.
* <code>experience</code>: The amount of EXP to gain.

== GROUND:LevelUpChar ==

Levels up a character a certain amount of times all at once.
Also handles learning new moves.

=== Arguments ===

* <code>character</code>: The characters to level up.
* <code>numLevelUps</code>: The number of level ups.

== GROUND:AddMapStatus(System.String) ==

Adds a mapstatus to the ground map. Map statuses only have an aesthetic effect in ground maps.

=== Arguments ===

* <code>statusIdx</code>: The ID of the Map Status

== GROUND:RemoveMapStatus(System.String) ==

Removes a map status from the ground map.

=== Arguments ===

* <code>statusIdx</code>: The ID of the Map Status to remove.

== SOUND:PlaySE(System.String) ==

Plays a sound effect

=== Arguments ===

* <code>name</code>: Sound file name, relative to the Content/SE folder

== SOUND:PlayBattleSE(System.String) ==

Plays a sound effect specifically from the Battle/ subdirectory

=== Arguments ===

* <code>name</code>: Sound file name, relative to the Content/SE/Battle folder

== SOUND:WaitSE ==

Plays a sound effect, and waits for it to complete before continuing.

=== Example ===

<pre>

SOUND:WaitSE("Battle/Hit")

</pre>

== SOUND:LoopSE(System.String) ==

Plays a continuous sound effect

=== Arguments ===

* <code>name</code>: Sound file name, relative to the Content/SE folder

== SOUND:LoopBattleSE(System.String) ==

Plays a continuous sound effect

=== Arguments ===

* <code>name</code>: Sound file name, relative to the Content/SE/Battle folder

== SOUND:StopSE(System.String) ==

Stops a continuous sound effect

=== Arguments ===

* <code>name</code>: Sound file name, relative to the Content/SE folder

== SOUND:StopBattleSE(System.String) ==

Stops a continuous sound effect

=== Arguments ===

* <code>name</code>: Sound file name, relative to the Content/SE/Battle folder

== SOUND:FadeInSE(System.String,System.Int32) ==

Plays a continuous sound effect, fading in over a specified amount of time

=== Arguments ===

* <code>name</code>: Sound file name, relative to the Content/SE folder
* <code>fadeTime</code>: Time in frames for the sound to fade in

== SOUND:FadeInBattleSE(System.String,System.Int32) ==

Plays a continuous sound effect, fading in over a specified amount of time

=== Arguments ===

* <code>name</code>: Sound file name, relative to the Content/SE/Battle folder
* <code>fadeTime</code>: Time in frames for the sound to fade in

== SOUND:FadeOutSE(System.String,System.Int32) ==

Stops a continuous sound effect, fading out over a specified amount of time

=== Arguments ===

* <code>name</code>: Sound file name, relative to the Content/SE folder
* <code>fadeTime</code>: Time in frames for the sound to fade out

== SOUND:FadeOutBattleSE(System.String,System.Int32) ==

Stops a continuous sound effect, fading out over a specified amount of time

=== Arguments ===

* <code>name</code>: Sound file name, relative to the Content/SE/Battle folder
* <code>fadeTime</code>: Time in frames for the sound to fade out

== SOUND:PlayFanfare(System.String) ==

Plays a sound effect that temporarily mutes the music for its duration

=== Arguments ===

* <code>name</code>: Sound file name, relative to the Content/SE folder

== SOUND:WaitFanfare ==

Plays a sound effect that temporarily mutes the music for its duration.
This function waits for the sound to complete before continuing.

=== Example ===

<pre>

SOUND:WaitFanfare("Battle/LevelUp")

</pre>

== SOUND:PlayBGM(System.String,System.Boolean,System.Int32) ==

Plays a song, replacing the current one.

=== Arguments ===

* <code>name</code>: The file name of the song, relative to the Content/Music folder.
* <code>fade</code>: Whether to fade the old song out, or start a new one.
* <code>fadeTime</code>: The amount of time, in frames, to fade out the old song.

== SOUND:StopBGM ==

Stops playing the current song.

== SOUND:FadeOutBGM(System.Int32) ==

Fades out the current song.

=== Arguments ===

* <code>fadeTime</code>: The amount of time, in frames, to fade out the song.

== SOUND:SetBGMVolume(System.Single) ==

Sets the current volume of the song.

=== Arguments ===

* <code>val</code>: A float value between 0 and 1

== SOUND:GetCurrentSong ==

Gets the currently playing song. If the current song is fading out, gets the next song to be played.

=== Returns ===

The filename of the song, relative to the Content/Music folder

== STRINGS:LocaleCode ==

Gets the current language setting of the game.

=== Returns ===

The current language, represented by a locale code.

== STRINGS:Format(System.String,System.Object[]) ==

Formats a string. Will unescape escaped characters and process grammar tags.

=== Arguments ===

* <code>fmt</code>: String to format.
* <code>para</code>: Arguments

=== Returns ===

The formatted string.

== STRINGS:FormatKey(System.String,System.Object[]) ==

Formats a string given a string key. Will unescape escaped characters.

=== Arguments ===

* <code>fmt</code>: The string key to format
* <code>para</code>: string arguments

== STRINGS:LocalKeyString(System.Int32) ==

Gets the string representing a button or key.

=== Arguments ===

* <code>index</code>: The input type of the input.

=== Returns ===

The string representing the button o key the input maps to.

== STRINGS:CreateList(NLua.LuaTable) ==

Builds a single string of comma separated elements.

=== Arguments ===

* <code>listStrings</code>: LuaTable of strings containing the elements to build the list from.

=== Returns ===

The combined string containing all elements.

== TASK:StartEntityTask(RogueEssence.Ground.GroundEntity,NLua.LuaFunction) ==

Helper function to make an entity run the specified task.
Will not replace a running task!
Tasks are run interlocked with the script processing and game processing, and characters cannot run multiple tasks at the same time.

=== Arguments ===

* <code>ent</code>: Entity which will run the task.
* <code>fn</code>: Task coroutine.

== TASK:StopEntityTask(RogueEssence.Ground.GroundEntity) ==

Helper function to force stop an entity's current task.

=== Arguments ===

* <code>ent</code>: Entity running the task to stop.

== TASK:WaitStartEntityTask ==

Makes an entity run a specified task, and waits for it to complete.

=== Arguments ===

* <code>ent</code>: Entity which will run the task.
* <code>fn</code>: Task coroutine.

=== Example ===

<pre>

TODO

</pre>

== TASK:WaitEntityTask ==

Waits for the specified entity to finish its task.

=== Arguments ===

* <code>ent</code>: Entity which task we'll wait on.

=== Example ===

<pre>

TASK:WaitEntityTask(player)

</pre>

== TASK:WaitTask ==

Runs a task and waits for it to complete.
Most methods that do not expose themselves to script need to be wrapped with this.

=== Arguments ===

* <code>obj</code>: The task to wait on.

=== Example ===

<pre>

TASK:WaitTask(_DUNGEON:DropMoney(100, RogueElements.Loc(10, 10), RogueElements.Loc(10, 10)))

</pre>

== TASK:StartScriptLocalCoroutine(NLua.LuaFunction,System.Object[]) ==

A wrapper around the StartCoroutine method of the GameManager, so lua coroutines can be executed locally to the script context.
AKA, it will block the script execution while its executed.

=== Arguments ===

* <code>fn</code>: None
* <code>args</code>: None

== TASK:BranchCoroutine(System.Object) ==

Starts a new coroutine to run parallel to the current execution.
Useful for performing multiple actions at once.

=== Arguments ===

* <code>obj</code>: The task to run in parallel

=== Example ===

<pre>

local coro1 = TASK:BranchCoroutine(GAME:_FadeIn(60))

</pre>

== TASK:JoinCoroutines ==

Waits for all specified coroutines to finish before continuing execution.
Often used for coroutines created using TASK:BranchCoroutine()

=== Arguments ===

* <code>coroTable</code>: A table of coroutines to wait on.

=== Example ===

<pre>

TASK:JoinCoroutines({coro1})

</pre>

== UI:WaitInput ==

Waits for the player to press a button before continuing.

== UI:WaitShowDialogue ==

Displays a dialogue box with text, waiting until the player completes it.
Takes a string as an argument.

=== Arguments ===

* <code>text</code>: The text to display.
* <code>callbacks</code>: The Lua table of callbacks for the textbox to call.

=== Example ===

<pre>

UI:WaitShowDialogue("Hello World!")

</pre>

== UI:WaitShowTimedDialogue ==

Displays a dialogue box with text, waiting until the specified time has expired.

=== Arguments ===

* <code>text</code>: The text to display.
* <code>waitTime</code>: The time for the textbox to remain on screen. Pass -1 to wait for layer input.
* <code>callbacks</code>: The Lua table of callbacks for the textbox to call.

=== Example ===

<pre>

UI:WaitShowTimedDialogue("Hello World!", 120)

</pre>

== UI:TextDialogue(System.String,System.Int32,NLua.LuaTable) ==

Sets the current dialogue text to be shown. Requires WaitDialog to actually display.

=== Arguments ===

* <code>text</code>: The text to display.
* <code>waitTime</code>: The time for the textbox to remain on screen. Pass -1 to wait for layer input.
* <code>callbacks</code>: The Lua table of callbacks for the textbox to call.

== UI:WaitShowVoiceOver ==

Displays a voice over, waiting until the player completes it.

=== Arguments ===

* <code>text</code>: The text to display.
* <code>expireTime</code>: The time for the textbox to remain on screen. Pass -1 to wait for layer input.
* <code>x</code>: The X position of the box
* <code>y</code>: The Y position of the box
* <code>width</code>: Width of the box
* <code>height</code>: Height of the box
* <code>callbacks</code>: The Lua table of callbacks for the textbox to call.

=== Example ===

<pre>

UI:WaitShowVoiceOver("Hello World!", 120)

</pre>

== UI:TextVoiceOver(System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,NLua.LuaTable) ==

Sets the current voice-over text to be shown. Requires WaitDialog to actually display.

=== Arguments ===

* <code>text</code>: The text to display.
* <code>expireTime</code>: The time for the textbox to remain on screen. Pass -1 to wait for layer input.
* <code>x</code>: The X position of the box
* <code>y</code>: The Y position of the box
* <code>width</code>: Width of the box
* <code>height</code>: Height of the box
* <code>callbacks</code>: The Lua table of callbacks for the textbox to call.

== UI:TextPopUp(System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean) ==

Makes text pop up in the bottom-left corner by default. Displays concurrently with any other process.

=== Arguments ===

* <code>text</code>: The text to display.
* <code>expireTime</code>: The time for the textbox to remain on screen.
* <code>x</code>: The X position of the box
* <code>y</code>: The Y position of the box
* <code>width</code>: Width of the box
* <code>height</code>: Height of the box
* <code>centerH</code>: Horizontal centering
* <code>centerV</code>: Vertical centering

== UI:WaitShowTitle ==

Fades in a title text, waiting until the fade-in is complete.

=== Arguments ===

* <code>text</code>: The text to display.
* <code>time</code>: The time for the text to fade in.

=== Example ===

<pre>

UI:WaitShowTitle("Hello World!", 60)

</pre>

== UI:TextShowTitle(System.String,System.Int32) ==

Shows text in the format of a title drop. Requires WaitDialog to actually display.

=== Arguments ===

* <code>text</code>: The text to display.
* <code>time</code>: The time for the text to fade in.

== UI:WaitHideTitle ==

Fades out the currently displayed title, waiting until the fade-out is complete.

=== Arguments ===

* <code>time</code>: The time for the text to fade in.

=== Example ===

<pre>

UI:WaitHideTitle(60)

</pre>

== UI:TextFadeTitle(System.Int32) ==

Fades out the text set in a title drop. Requires WaitDialog to actually fade.

=== Arguments ===

* <code>time</code>: The time for the text to fade in.

== UI:WaitShowBG ==

Fades in a chosen background image, with a chosen framerate, at a certain fade time, waiting until the fade-in is complete.

=== Arguments ===

* <code>bg</code>: The background to show, from the list of BG textures.
* <code>frameTime</code>: Framerate of the image animation.
* <code>fadeInTime</code>: Time taken to fade in the image.

=== Example ===

<pre>

UI:WaitShowBG("TestBG", 3, 60)

</pre>

== UI:ShowBG(System.String,System.Int32,System.Int32) ==

Sets an image to display. Requires WaitDialog to actually display.

=== Arguments ===

* <code>bg</code>: The background to show, from the list of BG textures.
* <code>frameTime</code>: Framerate of the image animation.
* <code>fadeInTime</code>: Time taken to fade in the image.

== UI:WaitHideBG ==

Fades out the current background image, waiting until the fade-out is complete.

=== Arguments ===

* <code>time</code>: Time taken to fade out the image.

=== Example ===

<pre>

UI:WaitHideBG(60)

</pre>

== UI:FadeBG(System.Int32) ==

Prepares a fade-out of the current image. Requires WaitDialog to actually display.

=== Arguments ===

* <code>time</code>: Time taken to fade out the image.

== UI:ResetSpeaker(System.Boolean) ==

Clears the current speaker, so none is displayed the next time TextDialogue is called.
This also resets any custom dialogue box positions, portrait positions, and choice positions.

=== Arguments ===

* <code>keysound</code>: If turned on, the text from the dialogue boxes make sounds. Default is on.

== UI:SetSpeaker(System.String,System.Boolean,System.String,System.Int32,System.String,RogueEssence.Data.Gender) ==

Sets the speaker to be displayed during the following calls to the TextDialogue functions. It resets speaker emotion.

=== Arguments ===

* <code>name</code>: Speaker name.
* <code>keysound</code>: Plays sounds when text appears.
* <code>specie</code>: Species of the speaker
* <code>form</code>: Form of the speaker
* <code>skin</code>: Skin of the speaker
* <code>gender</code>: Gender of the speaker

== UI:SetSpeaker(RogueEssence.Ground.GroundChar,System.Boolean) ==

Sets the speaker to be displayed during the following calls to the TextDialogue functions. It resets speaker emotion.

=== Arguments ===

* <code>chara</code>: Character to set as speaker. This is a character in a ground map.
* <code>keysound</code>: Plays sounds when text appears.

== UI:SetSpeaker(RogueEssence.Dungeon.Character,System.Boolean) ==

Sets the speaker to be displayed during the following calls to the TextDialogue functions. It resets speaker emotion.

=== Arguments ===

* <code>chara</code>: Character to set as speaker. This is a character in a dungeon map.
* <code>keysound</code>: Plays sounds when text appears.

== UI:SetSpeakerReverse(System.Boolean) ==

Reverses the speaker orientation to face left instead of right. This depends on the boolean passed in.

=== Arguments ===

* <code>reverse</code>: Faces right if false, left if true.

== UI:SetChoiceLoc(System.Int32,System.Int32) ==

Sets the position of the choices for a question dialog.

=== Arguments ===

* <code>x</code>: The X position
* <code>y</code>: The Y position

== UI:ResetChoiceLoc ==

Sets the position of the choices for a question dialog back to default.

== UI:SetBounds(System.Int32,System.Int32,System.Int32,System.Int32) ==

Sets the position and size of the dialogue box.

=== Arguments ===

* <code>x</code>: The X position of the box
* <code>y</code>: The Y position of the box
* <code>width</code>: Width of the box
* <code>height</code>: Height of the box

== UI:SetSe(System.String,System.Int32) ==

Sets the speaker sound effect and speak frames played in the TextDialogue functions.

=== Arguments ===

* <code>newSe</code>: The sound effect of the box
* <code>speakTime</code>: The amount of frames to wait between each sound effect

=== Example ===

<pre>

UI:SetSe("Battle/_UNK_DUN_Water_Drop", 3)

</pre>

== UI:SetSe(System.String) ==

Sets the speaker sound effect played in the TextDialogue functions.

=== Arguments ===

* <code>newSe</code>: The sound effect of the box

=== Example ===

<pre>

UI:SetSe("Menu/Unknown-3")

</pre>

== UI:SetSpeakTime(System.Int32) ==

Sets the speak frames played in the TextDialogue functions.

=== Arguments ===

* <code>speakTime</code>: The amount of frames to wait between each sound effect

=== Example ===

<pre>

UI:SetSpeakTime(10)

</pre>

== UI:ResetSe ==

Resets to the default speaker sound effect and speaker frames.

== UI:ResetBounds ==

Resets the position and size of the dialogue box.

== UI:SetSpeakerLoc(System.Int32,System.Int32) ==

Sets the position of the speaker in a dialogue box.

=== Arguments ===

* <code>x</code>: The X position
* <code>y</code>: The Y position

== UI:ResetSpeakerLoc ==

Resets the position of the speaker in a dialogue box.

== UI:SetSpeakerEmotion(System.String,System.Boolean) ==

Sets the emotion of the speaker in the dialogue box.

=== Arguments ===

* <code>emo</code>: Emotion to display
* <code>reverse</code>: Faces right if false, left if true.

== UI:SetCenter(System.Boolean,System.Boolean) ==

Sets the centering of the text in the textbox.

=== Arguments ===

* <code>centerH</code>: Horizontal centering
* <code>centerV</code>: Vertical centering

== UI:SetAutoFinish(System.Boolean) ==

Makes the text automatically finish when it shows up.

=== Arguments ===

* <code>autoFinish</code>: Auto-finishes text if true.

== UI:WaitDialog ==

Displays the currently set dialogue box and waits for the player to complete it.

=== Example ===

<pre>

UI:WaitDialog()

</pre>

== UI:_DummyWait ==

Instantly break. Used as default/invalid value when returning a yieldable value.

== UI:ChoiceMenuYesNo(System.String,System.Boolean,NLua.LuaTable) ==

Ask a question answered by yes or no via character dialogue to the player.
UI:WaitForChoice() must be called afterwards for the menu to be actually displayed,
and for execution to suspend until the choice is returned.
Then to recover the integer value indicating the result of the menu, UI:ChoiceResult() must be called.

The Yes/No menu returns 1 for yes, and 0 for no.

=== Arguments ===

* <code>message</code>: Question to be asked to the user.
* <code>bdefaultstono</code>: Whether the cursor starts on no by default
* <code>callbacks</code>: The Lua table of callbacks for the textbox to call.

== UI:NameMenu(System.String,System.String,System.Int32,System.String) ==

Displays the name input box.

UI:WaitForChoice() must be called afterwards for the menu to be actually displayed,
and for execution to suspend until the choice is returned.
Then to recover the string value indicating the result of the menu, UI:ChoiceResult() must be called.

=== Arguments ===

* <code>title</code>: The text to show above the input line.
* <code>desc</code>: The text to show below the input line.
* <code>maxLength</code>: The length of the text in pixels.
* <code>defaultName</code>: Name to start the textbox with.

== UI:AssemblyMenu ==

Displays a menu for replacing party members with the assembly.

UI:WaitForChoice() must be called afterwards for the menu to be actually displayed,
and for execution to suspend until the choice is returned.
Then to recover the boolean value indicating whether the team composition was changed or not, UI:ChoiceResult() must be called.

== UI:ShopMenu(NLua.LuaTable) ==

Displays the Shop menu.

UI:WaitForChoice() must be called afterwards for the menu to be actually displayed,
and for execution to suspend until the choice is returned.
Then to recover the table indicating the indices of items chosen, UI:ChoiceResult() must be called.

=== Arguments ===

* <code>goods</code>: A table of items to be sold. The format is { Item=InvItem, Price=int } for each item.

== UI:SellMenu ==

Displays the Sell menu.

UI:WaitForChoice() must be called afterwards for the menu to be actually displayed,
and for execution to suspend until the choice is returned.
Then to recover the table indicating the indices of items to sell, UI:ChoiceResult() must be called.

== UI:StorageMenu ==

Displays the Storage menu for which to exchange items in the inventory with.

UI:WaitForChoice() must be called afterwards for the menu to be actually displayed,
and for execution to suspend until the menu is exited.

== UI:WithdrawMenu ==

Displays the Storage menu for which to withdraw from.

UI:WaitForChoice() must be called afterwards for the menu to be actually displayed,
and for execution to suspend until the menu is exited.

== UI:BankMenu ==

Displays the Bank menu.

UI:WaitForChoice() must be called afterwards for the menu to be actually displayed,
and for execution to suspend until the menu is exited.

== UI:SpoilsMenu(NLua.LuaTable) ==

Displays the Spoils menu.

UI:WaitForChoice() must be called afterwards for the menu to be actually displayed,
and for execution to suspend until the menu is exited.

=== Arguments ===

* <code>appraisalMap</code>: A table of mappings from containers to items, in the format of { Box=InvItem , Item=InvItem }

== UI:AppraiseMenu ==

Displays the Appraisal menu.

UI:WaitForChoice() must be called afterwards for the menu to be actually displayed,
and for execution to suspend until the choice is returned.
Then to recover the table indicating the indices of items chosen, UI:ChoiceResult() must be called.

== UI:TutorTeamMenu(NLua.LuaFunction) ==

Displays the Tutor Team menu.

UI:WaitForChoice() must be called afterwards for the menu to be actually displayed,
and for execution to suspend until the choice is returned.
Then to recover the integer representing the chosen team member, UI:ChoiceResult() must be called.

== UI:RelearnMenu(RogueEssence.Dungeon.Character) ==

Displays the Relearn menu for a character.

UI:WaitForChoice() must be called afterwards for the menu to be actually displayed,
and for execution to suspend until the choice is returned.
Then to recover the integer representing the chosen skill, UI:ChoiceResult() must be called.

=== Arguments ===

* <code>chara</code>: The character to relearn skills

== UI:LearnMenu(RogueEssence.Dungeon.Character,System.String) ==

Displays the Learn menu for a character to replace an existing skill with a new one.

UI:WaitForChoice() must be called afterwards for the menu to be actually displayed,
and for execution to suspend until the choice is returned.
Then to recover the integer representing the chosen skill, UI:ChoiceResult() must be called.

=== Arguments ===

* <code>chara</code>: The character to relearn skills
* <code>skillNum</code>: The new skill

== UI:ForgetMenu(RogueEssence.Dungeon.Character) ==

Displays the Forget menu for a character to forget a skill.

UI:WaitForChoice() must be called afterwards for the menu to be actually displayed,
and for execution to suspend until the choice is returned.
Then to recover the integer representing the chosen skill, UI:ChoiceResult() must be called.

=== Arguments ===

* <code>chara</code>: The character to relearn skills

== UI:ShowPromoteMenu ==

Displays the Promote menu to choose a team member to promote.

UI:WaitForChoice() must be called afterwards for the menu to be actually displayed,
and for execution to suspend until the choice is returned.
Then to recover the integer representing the chosen team slot, UI:ChoiceResult() must be called.

== UI:CanSwapMenu(NLua.LuaTable) ==

TODO

== UI:SwapMenu(NLua.LuaTable,NLua.LuaTable) ==

TODO

== UI:TributeMenu(System.Int32) ==

TODO

== UI:ShowMusicMenu(NLua.LuaTable) ==

Displays the Music menu to browse music for the game.

UI:WaitForChoice() must be called afterwards for the menu to be actually displayed,
and for execution to suspend until the choice is returned.
Then to recover the string representing the chosen song, UI:ChoiceResult() must be called.

=== Arguments ===

* <code>spoilerUnlocks</code>: A lua table of strings representing progression flags that have been completed.
Any ogg file that uses this tag as a spoiler tag will display in the menu only if the flag has been passed.

== UI:DungeonChoice(System.String,RogueEssence.Dungeon.ZoneLoc) ==

Ask to enter a destintion via character dialogue to the player.
UI:WaitForChoice() must be called afterwards for the menu to be actually displayed,
and for execution to suspend until the choice is returned.
Then to recover the integer value indicating the result of the menu, UI:ChoiceResult() must be called.

The Yes/No menu returns 1 for yes, and 0 for no.

=== Arguments ===

* <code>name</code>: Name of the destination
* <code>dest</code>: The ZoneLoc location of the destination.

== UI:DestinationMenu(NLua.LuaTable,System.Object) ==

Marks the start of a choice menu for choosing destinations, showing a preview of restrictions and requirements for dungeons.
UI:WaitForChoice() must be called afterwards for the menu to be actually displayed,
and for execution to suspend until the choice is returned.
Then to recover the ZoneLoc indicating the chosen destination, UI:ChoiceResult() must be called.

=== Arguments ===

* <code>destinations</code>: A lua table representing the list of destinations with each element in the format of { Name=string, Dest=ZoneLoc }

== UI:ServersMenu ==

TODO

== UI:ContactsMenu ==

TODO

== UI:SOSMenu ==

TODO

== UI:AOKMenu ==

TODO

== UI:PeersMenu ==

TODO

== UI:ShowConnectMenu ==

TODO

== UI:CurrentActivityMenu ==

TODO

== UI:ChooseMonsterMenu(System.String,NLua.LuaTable,System.Boolean,System.Boolean,System.Int32) ==

Marks the start of a choice menu for choosing monsters, showing a preview of their appearances via portrait.
UI:WaitForChoice() must be called afterwards for the menu to be actually displayed,
and for execution to suspend until the choice is returned.
Then to recover the string indicating the chosen species, UI:ChoiceResult() must be called.

=== Arguments ===

* <code>title</code>: The title of the menu
* <code>choices</code>: A lua table of choices with each element being a MonsterID.
* <code>canMenu</code>: If set to true, the Menu Button exits the menu if pressed.
* <code>canCancel</code>: If set to true, the Cancel Button exits the menu if pressed.
* <code>slotsPerPage</code>: Slots to display per page

== UI:SetCustomMenu(RogueEssence.Menu.InteractableMenu) ==

Displays a custom menu of the caller's choice.

UI:WaitForChoice() must be called afterwards for the menu to be actually displayed,
and for execution to suspend until the menu is exited.

== UI:BeginChoiceMenu(System.String,NLua.LuaTable,System.Object,System.Object,NLua.LuaTable) ==

Marks the start of a multi-choice menu.
UI:WaitForChoice() must be called afterwards for the menu to be actually displayed,
and for execution to suspend until the choice is returned.
Then to recover the integer value indicating the result of the menu, UI:ChoiceResult() must be called.

=== Arguments ===

* <code>message</code>: The question to ask the user.
* <code>choicesPairs</code>: A table of choices. Each choice can be either a string, or { string, bool } representing the text and enabled status.
* <code>defaultChoice</code>: The cursor starts on this choice.
* <code>cancelChoice</code>: This choice is chosen if the player presses the cancel button.
* <code>callbacks</code>: The Lua table of callbacks for the textbox to call.

== UI:BeginMultiPageMenu(System.Int32,System.Int32,System.Int32,System.String,NLua.LuaTable,System.Int32,System.Object,System.Object) ==

Marks the start of a multi-paged choice menu.
UI:WaitForChoice() must be called afterwards for the menu to be actually displayed,
and for execution to suspend until the choice is returned.
Then to recover the integer value indicating the result of the menu, UI:ChoiceResult() must be called.

=== Arguments ===

* <code>x</code>: X position of the menu
* <code>y</code>: Y position of the menu
* <code>width</code>: Width of the menu
* <code>title</code>: Height of the menu
* <code>choicesPairs</code>: A table of choices. Each choice can be either a string, or { string, bool } representing the text and enabled status.
* <code>linesPerPage</code>: Number of choices per page
* <code>defaultChoice</code>: The cursor starts on this choice.
* <code>cancelChoice</code>: This choice is chosen if the player presses the cancel button.

== UI:ChoiceResult ==

Get the result of the last choice menu

=== Returns ===

The result of the choice

== UI:GetChoiceAction(System.Object) ==

It's complicated.

=== Arguments ===

* <code>obj</code>: None

== UI:WaitForChoice ==

Displays the currently set choice menu and waits for the player's selection to complete.

=== Example ===

<pre>

UI:WaitForChoice()

</pre>

== UI:__WaitForChoice ==

Wait for choice and then CLEAN UP m_curchoice

[[Category:Scripting]]
[[Category:Quick Reference]]

__NOTOC__

Fire Fang

2025-07-01T20:48:58Z

WalterTheRalts: Created page with "{{:Fire_Fang/Data|MoveInfobox}} '''Fire Fang''' is a move in PMDO. == Effects == Fire Fang has a chance to flinch and a chance to cause burn. == Strategy == {{sectstub}}"

{{:Fire_Fang/Data|MoveInfobox}}

'''Fire Fang''' is a [[move]] in [[PMDO]].

== Effects ==
Fire Fang has a chance to [[flinch]] and a chance to cause [[burn]].

== Strategy ==
{{sectstub}}

Effect Tile

2025-06-26T23:32:52Z

WalterTheRalts: All current base game traps

'''Effect tiles''' are tiles that activate upon certain conditions being met that affect the player and the foe in dungeons. In most cases, tiles replace floor [[terrain]] during dungeon generation.

== List of effect tiles ==
=== Traps ===
{{sectstub}}
{| class="wikitable"
! Image
! Tile
! Range
! Effects
! Destroyed after trigger
|-
|
| Apple Trap
| User
| Changes a held item into an [[Apple]].
| Yes
|-
|
| Chestnut Trap
| 1-tile area
| Deals 1/6 of the Pokémon's Max HP as damage and causes them to [[flinch]].
| No
|-
|
| Explosion Trap
| 2-tile area
| Deals 1/2 of the Pokémon's Current HP as damage.<br>Destroys dropped items.
| Yes
|-
|
| Grimy Trap
| {{sectstub}}
| Turns a [[food]] item in the Pokémon's inventory into [[Grimy Food]].<br>Removes the Pokémon's [[Ability]].
| No
|-
|
| Grudge Trap
| 2-tile area
| Gives all opposing Pokémon the [[Grudge]] status.
| Yes
|-
|
| Gust Trap
| 1-tile area
| Launches Pokémon up to 8 walkable tiles in a random direction.
| No
|-
|
| Hunger Trap
| User
| Reduces the Pokémon's [[belly]] by 20.
| No
|-
|
| Mud Trap
| 1-tile area
| Reduces the Pokémon's highest stat by 2 stages.
| No
|-
|
| Poison Trap
| 1-tile area
| Inflicts the Pokémon with [[poison]].
| No
|-
|
| PP-Leech Trap
| User
| Removes all PP of the Pokémon's last used move. Fails if the Pokémon hasn't used a move yet.
| Yes
|-
|
| Seal Trap
| 1-tile area
| Disables Pokémon's last used move. Fails if the Pokémon hasn't used a move yet.
| Yes
|-
|
| Self-Destruct Trap
| 1-tile area
| Deals 1/2 of the Pokémon's Current HP as damage.<br>Destroys dropped items.
| Yes
|-
|
| Slow Trap
| 1-tile area
| Reduces the Pokémon's movement speed by 1 stage.
| Yes
|-
|
| Slumber Trap
| 1-tile area
| Inflicts the Pokémon with [[sleep]].
| Yes
|-
|
| Spikes
| User
| Does 1/8 of the Pokémon's Max HP as damage.
| Yes
|-
|
| Spin Trap
| 1-tile area
| Inflicts the Pokémon with [[confusion]].
| Yes
|-
|
| Stealth Rock
| User
| Does 1/8 of the Pokémon's Max HP as rock-type damage.
| Yes
|-
|
| Sticky Trap
| User
| Inflicts the Pokemon with [[Immobilized]].<br>Makes the highest priced item sticky.
| Yes
|-
|
| Summon Trap
| User
| Brings up to 4 enemies from 80 tiles away onto the nearest tile relative to the player.
| Yes
|-
|
| Toxic Spikes
| User
| Inflicts the Pokemon with [[badly poisoned]].
| Yes
|-
|
| Trigger Trap
| User
| Triggers traps up to 5 tiles away.
| Yes
|-
|
| Trip Trap
| 4-tile area
| Makes a Pokémon drop its held item.
| No
|-
|
| Warp Trap
| User
| Teleports a Pokemon onto a random walkable tile
| No
|}
=== Tiles ===
{{sectstub}}
{| class="wikitable"
! Image
! Tile
! Range
! Effects
! Destroyed after trigger
|-
|
| Wonder Tile
| 1-tile area
| Removes all [[stat changes]].
| No

Effect Tile

2025-06-25T15:09:57Z

WalterTheRalts: More Traps and Tile section

TM

2025-06-25T14:44:59Z

WalterTheRalts: Created page with "'''TMs''' are items in PMDO that can be rarely found in some dungeons in the base game. When they are used, Pokémon that are eligible can learn the move labelled on the TM. See the full list here. {{stub}}"

'''TMs''' are items in PMDO that can be rarely found in some dungeons in the base game. When they are used, Pokémon that are eligible can learn the move labelled on the TM.

See the [[Draft:List_of_TM_moves|full list here.]]

{{stub}}

Agility

2025-06-25T00:26:59Z

WalterTheRalts: Created page with "{{:Agility/Data|MoveInfobox}} '''Agility''' is a move in PMDO. == Effects == Agility increases the movement speed of the user and any allies within a three-tile radius by one stage."

{{:Agility/Data|MoveInfobox}}

'''Agility''' is a [[move]] in [[PMDO]].

== Effects ==
Agility increases the movement speed of the user and any allies within a three-tile radius by one stage.

Dragon Rage

2025-06-25T00:09:38Z

WalterTheRalts: Created page with "{{:Dragon_Rage/Data|MoveInfobox}} '''Dragon Rage''' is a move in PMDO. == Effects == Dragon Rage deals damage to the first entity within two tiles equal to the amount of HP the user is missing."

{{:Dragon_Rage/Data|MoveInfobox}}

'''Dragon Rage''' is a [[move]] in [[PMDO]].

== Effects ==
Dragon Rage deals damage to the first entity within two tiles equal to the amount of HP the user is missing.

Oran Berry

2025-06-24T23:51:35Z

WalterTheRalts: Linking to berries

{{:Oran Berry/Data|ItemInfobox}}

The '''Oran Berry''' is a [[Berry]] and an item in [[PMDO]].

== Uses ==
When eaten, the Oran Berry restores all HP.

Tangrowth family

2025-06-23T21:18:55Z

WalterTheRalts: Created page with "{{stub}} __NOTOC__ <tabs> <tab name="Tangela">{{:Tangela/Data|PokemonInfobox}}</tab> <tab name="Tangrowth">{{:Tangrowth/Data|PokemonInfobox}}</tab> </tabs>"

{{stub}}

__NOTOC__

<tabs>
<tab name="Tangela">{{:Tangela/Data|PokemonInfobox}}</tab>
<tab name="Tangrowth">{{:Tangrowth/Data|PokemonInfobox}}</tab>
</tabs>

Tangela

2025-06-23T21:17:51Z

WalterTheRalts: Redirected page to Tangrowth family#Tangela

#REDIRECT [[Tangrowth family#Tangela]]

Forest Camp

2025-06-23T21:06:46Z

WalterTheRalts: Created page with "'''Forest Camp''' is the second camp on Guildmaster Island. It is first accessed by completing Tropical Path, and you can return to it through Base Camp. == Dungeons Accessible == * Faded Trail * Bramble Woods {{sectstub}} == Story == {{sectstub}} Category: Locations"

'''Forest Camp''' is the second camp on [[Guildmaster Island]]. It is first accessed by completing [[Tropical Path]], and you can return to it through [[Base Camp]].

== Dungeons Accessible ==
* [[Faded Trail]]
* [[Bramble Woods]]

{{sectstub}}

== Story ==
{{sectstub}}

[[Category: Locations]]

Traps

2025-06-11T15:05:43Z

WalterTheRalts: Redirected page to Effect Tiles

#REDIRECT [[Effect Tiles]]

Effect tiles

2025-06-11T15:05:22Z

WalterTheRalts: WalterTheRalts moved page Effect tiles to Effect Tiles: Misspelled title

#REDIRECT [[Effect Tiles]]

Effect Tile

2025-06-11T15:05:21Z

WalterTheRalts: WalterTheRalts moved page Effect tiles to Effect Tiles: Misspelled title

{{stub}}
Effect Tiles are tiles that activate upon certain conditions being met that affect the player and the foe in dungeons. In most cases, tiles replace floor [[terrain]].

== Traps ==

{| class="wikitable"
! Terrain
! Affects
! Effects
! Is destroyed
|-
| Apple Trap
| Activator
| Changes a random held item into an [[Apple]]
| Yes
|-
| Chestnut Trap
| A 3 by 3 square with the tile in the center.
| Does 1/6 of the Pokémon's Max HP as damage to Pokémon within one tile of the trap and causes them to [[flinch]].
| No
|-
| Explosion Trap
| A 5 by 5 square with the tile in the center.
| Does 1/2 of the Pokémon's Current HP as damage to Pokémon within two tiles.
| Yes
|-
| Grimy Trap
| Player Inventory
| Turns all food items in the player's bag into [[Grimy Food]] and removes the Pokémon's [[ability]].
| No
|-
| Grudge Trap
| All foes within a 5 by 5 square with the tile in the center.
| Gives all opposing Pokémon the Grudge effect
| Yes
|-

{{stub}}

Effect Tile

2025-06-11T15:02:27Z

WalterTheRalts: Effect Tiles Draft

Floor Generation Overview

2025-06-11T14:20:38Z

WalterTheRalts:

Floor generation is performed as a list of steps, which allows a developer to customize their floor layout at every part of the pipeline. This page covers the basics of what each step is responsible for and why it is needed.

== Overview ==

A dungeon map can be generated without items, enemies, or traps. But at a bare minimum, a dungeon map must generate [[terrain]] (plus entrance/exit) in order to complete without errors. There are 4 main options on how to do this:

* Generate a Grid of Rooms, which is then converted into a connected List of Rooms, which are then used to generate tiles.
* Generate a connected List of Rooms, and then use those rooms to generate tiles.
* Generate Tiles directly.
* Load a Pre-made Map.

The type of floor gen you choose in the editor will dictate which options you have:

[[File:FloorGen_Type.png|frameless]]

=== Generating Tiles Directly ===

Direct tile generation will randomly generate wall and floor tiles, and then add a start and end point somewhere in the result. To use this approach, make the floor a <code>StairsFloorGen</code>.

* The first step needed is <code>InitTilesStep</code>, which specifies the dimensions of the floor in tiles and initializes a grid of wall tiles.

[[File:FloorGen_Tiles_Empty.png|frameless]]

* Then an algorithm is used to carve out floor tiles out of the dungeon, such as <code>SpecificTilesStep</code> or <code>PerlinWaterStep</code>.

[[File:FloorGen_Tiles_Tiles.png|frameless]]

* Finally, <code>StairsStep</code> is used to choose a start and end tile on a walkable tile(purple).

[[File:FloorGen_Tiles_Start_End.png|frameless]]

While this approach theoretically works has been used in some debug room tests, it has never shown up in practice due to its inflexibility compared to the Grid or List of Rooms methods that follow.

=== List of Rooms ===

List of Rooms is an approach that splits generation into rooms and hallways, planning out their dimensions before filling in the tile details. To use this approach, make the floor a <code>RoomFloorGen</code>.

* The first step needed is <code>InitFloorPlanStep</code>, which initializes a space for which to plan out rooms and halls:

[[File:FloorGen_Tiles_Empty.png|frameless]]

* Then, a path generator such as <code>FloorPathBranch</code> is run to place the rooms with connecting halls between them (yellow):

[[File:FloorGen_Floor_Rooms_Halls.png|frameless]]

* Then, the list of rooms and halls is then translated into tiles, using <code>DrawFloorToTileStep</code>.

It accomplishes this by first asking each room to generate its tiles:

[[File:FloorGen_Floor_Rooms_To_Tiles.png|frameless]]

Then, the hall algorithms are asked to generate:

[[File:FloorGen_Floor_Rooms_Halls_To_Tiles.png|frameless]]

This leaves us with all floor tiles:

[[File:FloorGen_Floor_Tiles.png|frameless]]

* Lastly, the start and end tile are marked, by first selecting 2 separate rooms (pink) and then choosing a tile (purple) in each room to put the marker. The step responsible for this is <code>FloorStairsStep</code>

[[File:FloorGen_Floor_Start_End.png|frameless]]

Room Floors are somewhat uncommon and has few templates to choose from for floor shape. However it's possible to vary the floor shape a lot simply by choosing different room types to generate with.

=== Grid of Rooms ===

Grid of Rooms is an approach that starts generation off with a grid of rooms, before planning out their dimensions and then filling in the tile details. It is basically the List of Rooms approach with extra steps. To use this approach, make the floor a <code>GridFloorGen</code>.

* The first step needed is <code>InitGridPlanStep</code>, which initializes a grid of cells:

[[File:FloorGen_Grid_Cells.png|frameless]]

* Then, a path generator such as <code>GridPathBranch</code> is run to place rooms in the grid (blue) with connecting halls between them (yellow):

[[File:FloorGen_Grid_Cells_Chosen.png|frameless]]

Each room and hall filled in here are also assigned an algorithm at this step.

* The grid rooms and grid connectors are then translated into a list of rooms and halls, using <code>DrawGridToFloorStep</code>.

It accomplishes this by first having each room algorithm then choose its size and location:

[[File:FloorGen_Grid_Cells_To_Rooms.png|frameless]]

The rooms then signal their connection requirements to the halls, which then have their sizes chosen:

[[File:FloorGen_Grid_Cells_To_Rooms_Halls.png|frameless]]

Then finally by writing it out to an actual list of rooms and halls:

[[File:FloorGen_Grid_Rooms_Halls.png|frameless]]

* Then, the list of room and halls are then translated into tiles, using <code>DrawFloorToTileStep</code>.

It accomplishes this by first asking each room to generate its tiles:

[[File:FloorGen_Grid_Rooms_To_Tiles.png|frameless]]

Then, the hall algorithms are asked to generate:

[[File:FloorGen_Grid_Rooms_Halls_To_Tiles.png|frameless]]

This leaves us with all floor tiles:

[[File:FloorGen_Grid_Tiles.png|frameless]]

* Lastly, the start and end tile are marked, by first selecting 2 separate rooms (pink) and then choosing a tile (purple) in each room to put the marker. The step responsible for this is <code>FloorStairsStep</code>

[[File:FloorGen_Grid_Start_End.png|frameless]]

Grid Floors are the most common approach to dungeon generation, with a large number of unique templates for floor shape.

=== Pre-Made Map ===

Pre-made maps directly load a file from the Data/Maps/ directory to be used as a dungeon map. To use this approach, make the floor a <code>LoadGen</code>.

Only one step is needed, which is the file-loading step: <code>MappedRoomStep</code>

Pre-made maps are often used for fixed dungeon floors such as the reward rooms at the end of a dungeon, or secret rooms.

== Priority System ==

Floor generation is broken down into an ordered list of steps, each assigned a priority. The priority determines at what point in the generation process the step should be performed, with a lower number means a step will execute earlier. While these priority numbers do not need to be obeyed for modding, they are the numbers that base PMDO uses. Priority becomes especially handy when using [[Zone Step Overview|Zone Steps]] to plan out dungeon features across multiple floors instead of a single one.

== Steps Summary ==

While the Overview section covers the bare minimum steps to generate without error, you may notice that generating a map only with those steps will have no name, no music, no time limit, and even no textures, forcing you to rely on the minimap to understand the terrain. Below is a table of commonly used steps, what priorities PMDO places them in, and what they are used for.

{| class="wikitable" style="margin:auto"
|-
! Priority !! Step !! Description
|-
| -7 || MappedRoomStep || Loads a dungeon map to use as this floor's layout, including its entities and properties.
|-
| -6 || MapDataStep || Sets the music, time limit, and [[darkness]] of the floor.
|-
| -6 || MapNameIDStep || Gives the map a name.
|-
| -6 || MapTitleDropStep || Makes the map name show up before fading in.
|-
| -6 || MapEffectStep || Sets event data for the floor.
|-
| -5 || InitGridPlanStep || Initializes a grid for GridFloorGen.
|-
| -4 || GridPathBranch, GridPathCircle, GridPathTwoSides, etc. || Generates a path of rooms and halls for GridFloorGen.
|-
| -4 || SetGridDefaultsStep || Turns some rooms into halls (1 tile size), for GridFloorGen.
|-
| -4 || ConnectGridBranchStep || Connects some adjacent rooms, for GridFloorGen.
|-
| -4 || CombineGridRoomStep || Combines some rooms into larger rooms, for GridFloorGen.
|-
| -3 || InitFloorPlanStep || Initializes a list of rooms and halls for RoomFloorGen.
|-
| -3 || DrawGridToFloorStep || Initializes a list of rooms and halls and populates it with the grid from GridFloorGen.
|-
| -2 || FloorPathBranch|| Generates a path of rooms and halls for RoomFloorGen.
|-
| -1 || InitTilesStep || Sets the floor dimensions and initializes a grid of tiles, for StairsFloorGen.
|-
| -1 || DrawFloorToTileStep || Creates a grid of tiles and draws onto it based on the list of rooms and halls from a RoomFloorGen or GridFloorGen.
|-
| 0 || SpecificTilesStep || Sets the floor to specific tiles. Only used for debug.
|-
| 0.1 || UnbreakableBorderStep || Adds a border of unbreakable tiles at the edge of the map.
|-
| 0.3 || AddTunnelStep || Digs tunnels into the walls starting from a room.
|-
| 1 || MoneySpawnStep || Sets the spawn table for money on this floor.
|-
| 1.1 || ItemSpawnStep || Sets the spawn table for items on this floor.
|-
| 1.2 || MobSpawnStep || Sets the spawn table for mobs on this floor.
|-
| 1.2 || MobSpawnSettingsStep || Sets the rules for enemies respawning on the floor.
|-
| 1.3 || TileSpawnStep || Sets the spawn table for traps on this floor.
|-
| 2 || FloorStairsStep || Places the start point and the end stairs on different rooms of the floor, for RoomFloorGen or GridFloorGen.
|-
| 2 || StairsStep || Places the start point and the end stairs on different tiles of the floor, for StairsFloorGen.
|-
| 3 || PerlinWaterStep || Adds water/lava/etc. using Perlin Noise.
|-
| 3 || [[Blob Water Step|BlobWaterStep]] || Adds water/lava/etc. by placing several blobs made from cellular automata.
|-
| 4 || MapTextureStep || Defines the textures for floors, walls, and water.
|-
| 4 || MapDictTextureStep || Defines the textures in a more advanced way, needed if the layout uses grass.
|-
| 5 || RandomRoomSpawnStep<?, EffectTile> || Spawns traps in random rooms.
|-
| 5 || SpacedRoomSpawnStep<?, EffectTile> || Spawns traps in random rooms, taking care not to place in the same room or adjacent rooms.
|-
| 6 || TerminalSpawnStep<?, MoneySpawn> || Spawns money in dead-end rooms.
|-
| 6.1 || DueSpawnStep<?, InvItem, MapEntrance> || Spawns items based on how far they are from the starting room.
|-
| 6.2 || PlaceRandomMobsStep || Randomly places enemies on the map.
|-
| 7 || DetectIsolatedStairsStep || Testing step: Looks for a path from start to end and throws an error if none can be found.
|-
| 7 || DetectTileStep || Testing step: Checks to see if a certain tile can be found on the map and throws an error if none can be found.
|}

The sections below go into more detail of what each priority is typically used for, as well as less commonly used steps used in those priority brackets.

== Floor Data ==

Priority -6

Examples:

* MapDataStep
* MapEffectStep
* MapNameIDStep
* DefaultMapStatusStep
* MapTimeLimitStep

== Grid Creation ==

Priority -5

Examples:

* InitGridPlanStep

== Grid Path Generation ==

Priority -4

Examples:

* GridPathBranch
* GridPathCircle
* GridPathTwoSides
* GridPathGrid
* GridPathBeetle
* GridPathTiered

* SetGridDefaultsStep
* ConnectGridBranchStep
* CombineGridRoomStep

== Room List Creation ==

Priority -3

Examples:

* InitFloorPlanStep
* DrawGridToFloorStep

== Room List Generation ==

Priority -2

Examples:

* FloorPathBranch

== Tiles Creation ==

Priority -1

Examples:

* InitTilesStep
* DrawFloorToTileStep

== Tiles Generation ==

Priority 0

Examples:

* SpecificTilesStep

== Spawn Tables ==

Priority 1

Examples:

* MoneySpawnStep
* ItemSpawnStep (Priority 1.1)
* MobSpawnStep (Priority 1.2)
* TileSpawnStep (Priority 1.3)

== Exits ==

Priority 2

Examples:

* FloorStairsStep
* StairsStep

== Water ==

Priority 3

Examples:

* PerlinWaterStep
* BlobWaterStep

== Textures ==

Priority 4

Used to be here because textures were actually placed here, but now only assigns textures to the map itself and lets the map compute them after ALL steps are done. Thus, this step is the least dependent on its current position in the steps.

Examples:

* MapTextureStep
* MapDictTextureStep

== Tile Spawns ==

Priority 5

Examples:

* RandomSpawnStep
* DueSpawnStep
* TerminalSpawnStep

== Spawns ==

Priority 6

Examples:

* All steps in Tile Spawns
* PlaceRandomMobsStep
* PlaceDisconnectedMobsStep
* PlaceNoLocMobsStep

== Debug Checks ==

Priority 7

These gen steps are used to check the dungeon for issues, and throw an error if they're found. Useful for [[Stress Testing Dungeons|stress testing]].

Examples:

* DetectIsolatedStairsStep
* DetectTileStep

[[Category:Modding Data]]

Slash

2025-06-09T22:10:02Z

WalterTheRalts: Created page with "{{:Slash/Data|MoveInfobox}} '''Slash''' is a move in PMDO. == Effects == Slash deals damage with a higher chance of a critical hit. == Strategy == Slash is essentially a stronger Scratch. With a better chance to critically hit and the higher power, it is usually better to replace Scratch with this move instead."

{{:Slash/Data|MoveInfobox}}

'''Slash''' is a [[move]] in [[PMDO]].

== Effects ==
Slash deals damage with a higher chance of a critical hit.

== Strategy ==
Slash is essentially a stronger [[Scratch]]. With a better chance to critically hit and the higher power, it is usually better to replace Scratch with this move instead.

Flamethrower

2025-05-31T16:00:34Z

WalterTheRalts: Created page with "{{:Flamethrower/Data|MoveInfobox}} '''Flamethrower''' is a move in PMDO. == Effects == Flamethrower has a 25% chance to inflict burn. This move will also burn grass on tiles."

{{:Flamethrower/Data|MoveInfobox}}

'''Flamethrower''' is a [[move]] in [[PMDO]].

== Effects ==
Flamethrower has a 25% chance to inflict burn. This move will also burn grass on tiles.

Scary Face

2025-05-18T23:41:20Z

WalterTheRalts: Created page with "{{:Scary Face/Data|MoveInfobox}} '''Scary Face''' is a move in PMDO. == Effects == Scary Face has a 70% chance of reducing the opponent's movement speed by two stages. == Strategy =="

{{:Scary Face/Data|MoveInfobox}}

'''Scary Face''' is a [[move]] in [[PMDO]].

== Effects ==
Scary Face has a 70% chance of reducing the opponent's [[Speed|movement speed]] by two stages.

== Strategy ==

Petrify Orb

2025-05-18T23:32:43Z

WalterTheRalts: Item Category

{{:Petrify_Orb/Data|ItemInfobox}}

The '''Petrify Orb''' is an item in [[PMDO]].

== Uses ==
When used, all foes within 5 tiles of the user will be affected with [[Paralysis]] for 10 turns.

[[Category: Items]]

Escape Orb

2025-05-18T23:31:15Z

WalterTheRalts: Item Category

{{:Escape Orb/Data|ItemInfobox}}

The '''Escape Orb''' is an item in [[PMDO]].

== Uses ==
When used, it allows the user to leave a dungeon. This will always work unless certain conditions are met.

== Strategy ==

[[Category: Items]]

Absorb

2025-05-16T14:54:02Z

WalterTheRalts: Created page with "{{:Absorb/Data|MoveInfobox}} '''Absorb''' is a move in PMDO. == Effects == Absorb deals damage and heals the user for half of the damage done. == Strategy == Absorb's best use is dealing with close crowds. Because of its ability to affect anything in the user's surrounding tiles, it is efficient in stealing multiple opponents' health to keep your HP in a good spot."

{{:Absorb/Data|MoveInfobox}}

'''Absorb''' is a [[move]] in [[PMDO]].

== Effects ==
Absorb deals damage and heals the user for half of the damage done.

== Strategy ==
Absorb's best use is dealing with close crowds. Because of its ability to affect anything in the user's surrounding tiles, it is efficient in stealing multiple opponents' health to keep your HP in a good spot.

Ancient Power

2025-05-09T23:42:58Z

WalterTheRalts: Created page with "{{:Ancient Power/Data|MoveInfobox}} '''Ancient Power''' is a move in PMDO. == Effects == Ancient Power has a 25% chance to increase all stats (excluding accuracy) by one stage after the move hits."

{{:Ancient Power/Data|MoveInfobox}}

'''Ancient Power''' is a [[move]] in [[PMDO]].

== Effects ==
Ancient Power has a 25% chance to increase all stats (excluding accuracy) by one stage after the move hits.