View source for 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. {{FuncUsage|nmspace=GAME|nm=EnterGroundMap|args=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. {{FuncUsage|nmspace=GAME|nm=EnterGroundMap|args=id, entryPoint, preserveMusic}}

=== Arguments ===
Enter
{| class="wikitable"
{{ArgHeader}}
{{ArgRow
|name=zone
|type=String
|techt=System.String
|purp=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.
}}
{{ArgRow
|name=id
|type=Integer
|techt=System.Int32
|purp=
}}
{{ArgRow
|name=entryPoint
|type=Integer OR String
|techt=System.Int32 or System.String
|purp=The name of the entry point in the ground map. May either use the entry point IDs or their names.
}}
{{ArgRow
|name=preserveMusic
|type=Boolean
|techt=System.Boolean
|purp=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. {{FuncUsage|nmspace=GAME|nm=EnterDungeon|args=dunID, structID, mapID, entry, stakes, recorded, silentRestrict}}

=== Arguments ===
{| class="wikitable"
{{ArgHeader}}
{{ArgRow
|name=dunID
|type=Integer
|techt=System.Integer
|purp=The id of the dungeon to travel to.
}}
{{ArgRow
|name=structID
|type=Integer
|techt=System.Integer
|purp= The segment (or structure ID) within the zone to start in. -1 represents ground maps.
}}
{{ArgRow
|name=mapID
|type=Integer
|techt=System.Integer
|purp=The id of the ground map or dungeon map within the dungeon segment.
}}
{{ArgRow
|name=entry
|type=String
|techt=System.String
|purp=The entry point on the resulting map. 
}}
{{ArgRow
|name=stakes
|type=Stake
|techt=?
|purp=Declares the [[stake|stakes]] of the exploration.
}}
{{ArgRow
|name=recorded
|type=Boolean
|techt=System.Boolean
|purp=True if the dungeon should be recorded in a replay, false if not.
}}
{{ArgRow
|name=silentRestrict
|type=Boolean
|techt=System.Boolean
|purp=True if the dungeon restrictions should be silent, false if not.
}}
|}

=== 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. Used in rescue team like midpoint contexts (where PP and belly is not restored). {{FuncUsage|nmspace=GAME|nm=ContinueDungeon|args=dunID, structID, mapID, entry}}

{| class="wikitable"
{{ArgHeader}}
{{ArgRow
|name=dunID
|type=Integer
|techt=System.Integer
|purp=The id of the dungeon to travel to.
}}
{{ArgRow
|name=structID
|type=Integer
|techt=System.Integer
|purp= The segment (or structure ID) within the zone to start in. -1 represents ground maps.
}}
{{ArgRow
|name=mapID
|type=Integer
|techt=System.Integer
|purp=The id of the ground map or dungeon map within the dungeon segment.
}}
{{ArgRow
|name=entry
|type=String
|techt=System.String
|purp=The entry point on the resulting map. 
}}
|}

=== Example ===

<pre>

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

</pre>

== EndDungeonRun ==

Ends the current adventure, sending the player to a specified destination. {{FuncUsage|nmspace=GAME|nm=EndDungeonRun|args=result, zoneID, structID, mapID, entryID, display, fanfare, completedZone}}

=== Arguments ===
{| class="wikitable"
{{ArgHeader}}
{{ArgRow
|name=result
|type=(undocumented)
|techt=(undocumented)
|purp=The result of the adventure.
}}
{{ArgRow
|name=zoneID
|type=String
|techt=System.String
|purp=The id of the dungeon to travel to.
}}
{{ArgRow
|name=structID
|type=String
|techt=System.String
|purp=The segment within the dungeon to start in.  -1 represents ground maps.
}}
{{ArgRow
|name=mapID
|type=String
|techt=System.String
|purp=The id of the ground map or dungeon map within the dungeon segment.
}}
{{ArgRow
|name=entryID
|type=String
|techt=System.String
|purp=The entry point on the resulting map
}}
{{ArgRow
|name=display
|type=(undocumented)
|techt=(undocumented)
|purp=Display an epitaph marking the end of the adventure.
}}
{{ArgRow
|name=fanfare
|type=Boolean
|techt=System.Boolean
|purp=Play a fanfare.
}}
{{ArgRow
|name=completedZone
|type=Boolean
|techt=System.Boolean
|purp=Zone to mark as completed. Defaults to current zone.
}}
|}

=== Example ===

<pre>

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

</pre>

== EnterZone ==

Enters a zone and begins a new adventure.

=== Arguments ===
{| class="wikitable"
{{ArgHeader}}
{{ArgRow
|name=dunID
|type=Integer
|techt=System.Integer
|purp=The id of the dungeon to travel to.
}}
{{ArgRow
|name=structID
|type=Integer
|techt=System.Integer
|purp= The segment (or structure ID) within the zone to start in. -1 represents ground maps.
}}
{{ArgRow
|name=mapID
|type=Integer
|techt=System.Integer
|purp=The id of the ground map or dungeon map within the dungeon segment.
}}
{{ArgRow
|name=entry
|type=String
|techt=System.String
|purp=The entry point on the resulting map. 
}}
|}