Game (functions)/Map and Adventure Control
GetCurrentGround
Gets the current ground map.
GetCurrentFloor
Gets the current dungeon map.
GetCurrentDungeon
Gets the current zone, also known as dungeon.
EnterGroundMap
Leave current map, and enter specified ground map within the current zone.
Context 1
If the ground map is not within the current zone, the zone must be specified in order to travel to it. Argument order is GAME:EnterGroundMap(zone,id, entryPoint, preserveMusic).
Context 2
If the ground map is within the current zone, there is no need to specify the zone to travel to it. Argument order is GAME:EnterGroundMap(id, entryPoint, preserveMusic).
Arguments
Enter
| Name | Type | Technical Type | Purpose |
|---|---|---|---|
| zone | String | System.String
|
The name of the zone the ground map is located in. Not required if traveling from a ground map to another ground map in the same zone. |
| id | Integer | System.Int32
|
|
| entryPoint | Integer OR String | System.Int32 or System.String
|
The name of the entry point in the ground map. May either use the entry point IDs or their names. |
| preserveMusic | Boolean | System.Boolean
|
If set to true, does not change the music when moving to the new ground map. |
EnterDungeon
Enters a zone and begins a new adventure. Argument order is GAME:EnterDungeon(dunID, structID, mapID, entry, stakes, recorded, silentRestrict).
Arguments
| Name | Type | Technical Type | Purpose |
|---|---|---|---|
| dunID | Integer | System.Integer
|
The id of the dungeon to travel to. |
| structID | Integer | System.Integer
|
The segment (or structure ID) within the zone to start in. -1 represents ground maps. |
| mapID | Integer | System.Integer
|
The id of the ground map or dungeon map within the dungeon segment. |
| entry | String | System.String
|
The entry point on the resulting map. |
| stakes | Stake | ?
|
Declares the stakes of the exploration. |
| recorded | Boolean | System.Boolean
|
True if the dungeon should be recorded in a replay, false if not. |
| silentRestrict | Boolean | System.Boolean
|
True if the dungeon restrictions should be silent, false if not. |
Example
GAME:EnterDungeon(1, 0, 0, 0, RogueEssence.Data.GameProgress.DungeonStakes.Risk, true, false)
GAME:ContinueDungeon
Enters a zone and continues the current adventure. Used in rescue team like midpoint contexts (where PP and belly is not restored). Argument order is GAME:ContinueDungeon(dunID, structID, mapID, entry).
| Name | Type | Technical Type | Purpose |
|---|---|---|---|
| dunID | Integer | System.Integer
|
The id of the dungeon to travel to. |
| structID | Integer | System.Integer
|
The segment (or structure ID) within the zone to start in. -1 represents ground maps. |
| mapID | Integer | System.Integer
|
The id of the ground map or dungeon map within the dungeon segment. |
| entry | String | System.String
|
The entry point on the resulting map. |
Example
GAME:ContinueDungeon(1, 1, 0, 0)
EndDungeonRun
Ends the current adventure, sending the player to a specified destination. Argument order is GAME:EndDungeonRun(result, zoneID, structID, mapID, entryID, display, fanfare, completedZone).
Arguments
| Name | Type | Technical Type | Purpose |
|---|---|---|---|
| result | (undocumented) | (undocumented)
|
The result of the adventure. |
| zoneID | String | System.String
|
The id of the dungeon to travel to. |
| structID | String | System.String
|
The segment within the dungeon to start in. -1 represents ground maps. |
| mapID | String | System.String
|
The id of the ground map or dungeon map within the dungeon segment. |
| entryID | String | System.String
|
The entry point on the resulting map |
| display | (undocumented) | (undocumented)
|
Display an epitaph marking the end of the adventure. |
| fanfare | Boolean | System.Boolean
|
Play a fanfare. |
| completedZone | Boolean | System.Boolean
|
Zone to mark as completed. Defaults to current zone. |
Example
GAME:EndDungeonRun(GameProgress.ResultType.Cleared, 0, -1, 1, 0, true, true)
EnterZone
Enters a zone and begins a new adventure.
Arguments
| Name | Type | Technical Type | Purpose |
|---|---|---|---|
| dunID | Integer | System.Integer
|
The id of the dungeon to travel to. |
| structID | Integer | System.Integer
|
The segment (or structure ID) within the zone to start in. -1 represents ground maps. |
| mapID | Integer | System.Integer
|
The id of the ground map or dungeon map within the dungeon segment. |
| entry | String | System.String
|
The entry point on the resulting map. |
