Game (functions)/Zone
This page documents the ScriptGame class for Lua scripting.
As a singleton class, it can be accessed from Lua with GAME.
GetCurrentGround
GAME:GetCurrentGround()
Gets the current ground map.
Returns
| Type | Description |
|---|---|
| RogueEssence.Ground.GroundMap |
GetCurrentFloor
GAME:GetCurrentFloor()
Gets the current dungeon map.
Returns
| Type | Description |
|---|---|
| RogueEssence.Dungeon.Map |
GetCurrentDungeon
GAME:GetCurrentDungeon()
Gets the current zone, also known as dungeon.
Returns
| Type | Description |
|---|---|
| RogueEssence.Dungeon.Zone |
UnlockDungeon
GAME:UnlockDungeon(dungeonid)
Unlocks a specified dungeon.
Parameters
| Name | Type | Description |
|---|---|---|
| System.String | System.String | ID of the dungeon to unlock. |
DungeonUnlocked
GAME:DungeonUnlocked(dungeonid)
Checks if a dungeon is unlocked.
Parameters
| Name | Type | Description |
|---|---|---|
| System.String | System.String | ID of the dungeon to check |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if unlocked, false otherwise. |
RestartToTitle
GAME:RestartToTitle()
Leave current map and load up the title screen.
RestartRogue
GAME:RestartRogue(config)
Restarts a Roguelocke run based on the configuration
Parameters
| Name | Type | Description |
|---|---|---|
| RogueEssence.Data.RogueConfig | RogueEssence.Data.RogueConfig | The configuration of the roguelocke run |
CutsceneMode
GAME:CutsceneMode(bon)
Sets the game in cutscene mode. This prevents characters from taking idle action and hides certain UI.
Parameters
| Name | Type | Description |
|---|---|---|
| System.Boolean | System.Boolean | If set to true, turns cutscene mode on. If set to false, turns it off. |
References
https://github.com/RogueCollab/RogueEssence/blob/master/RogueEssence/Lua/ScriptGameZone.cs
