FloppaClient/floppaclient.floppamap.dungeon/Dungeon

Dungeon

In this class everything Dungeon map related is dispatched. It is also used to post various dungeon related events to be used within the Modules.

Based on FunnyMap by Harry282.

Author

Aton

Functions

getCurrentRoom

@JvmName(name = "getCurrentRoomFromCoordinates")

fun getCurrentRoom(): Room?

Returns the room the player is currently in. Includes boss room.

getDungeonTabList

fun getDungeonTabList(): List<Pair<NetworkPlayerInfo, String>>?

getDungeonTile

@JvmName(name = "getDungeonTileDefault")

fun getDungeonTile(column: Int, row: Int): Tile?

Gets the corresponding Tile from dungeonList but first performs a check whether the indices are in range.

inline fun <T : Tile> getDungeonTile(column: Int, row: Int): T?

Gets the corresponding Tile from dungeonList but first performs a check whether the indices are in range. It is attempted to cast the Tile to T, if not possible returns null.

getDungeonTileList

@JvmName(name = "getDungeonTileListDefault")

fun getDungeonTileList(): List<Tile?>

Returns the dungeonList as an immutable List.

inline fun <T : Tile> getDungeonTileList(): List<T>

Returns the dungeonList filtered for the supplied Tile Type.

onChat

fun onChat(event: ClientChatReceivedEvent)

onRoomChange

fun onRoomChange(event: RoomChangeEvent)

Update visited rooms when room is changed. This event is posted whenever you, the Player, change the Tile you are in.

onTick

fun onTick(event: TickEvent.ClientTickEvent)

onWorldLoad

fun onWorldLoad(event: WorldEvent.Unload)

reset

fun reset()

Rests most of the dungeon properties. Other properties which are not reset here are reset in onWorlLoad.

setDungeonTile

fun setDungeonTile(column: Int, row: Int, tile: Tile?): Boolean

Sets the corresponding value from dungeonList but first performs a check whether the indices are in range.

Properties

cryptCount

var cryptCount: Int = 0

currentRoom

val currentRoom: Room?

currentRoomPair

var currentRoomPair: Pair<Room, Int>? = null

Contains the current room and its rotation. Updated every tick. The rotation is based on the clipConfig. For extras Block rotations refer to Extras.currentExtrasRoom.

dungeonTeammates

val dungeonTeammates: MutableList<DungeonPlayer>

Contains all the teammates in the current dungeon. Also contains the Player.

fullyScanned

var fullyScanned: Boolean = false

fullyScannedRotation

var fullyScannedRotation: Boolean = false

hasRunStarted

var hasRunStarted: Boolean = false

inBoss

var inBoss: Boolean = false

mimicFound