Module necro.game.level.CurrentLevel

Functions

getBossType () Returns the ID of the level's current boss.
getDepth () The depth number of the current level.
getDungeonLength () The number of levels in the current dungeon.
getFloor () The floor number of the current level within its zone.
getName () Returns a string representation of this level's zone and floor number.
getNumber () The 1-indexed logical number of the current level within the dungeon.
getSequentialNumber () Returns a sequential 1-indexed number representing the order in which this current level was visited within the run.
getUniqueID () Returns a fully unique number identifying a level across runs.
getZone () The zone number of the current level.
isBoss () Returns true if the current level represents a boss arena.
isLobby ()
isRegularFloor () Returns true if the current level represents a normal floor.


Functions

getBossType ()
Returns the ID of the level's current boss.
getDepth ()
The depth number of the current level. Starts at 1 for all chracters and typically increments every 4 levels.
getDungeonLength ()
The number of levels in the current dungeon.
getFloor ()
The floor number of the current level within its zone. Starts at 1, increases by 1 every level, typically up to 4. Upon entering a new zone, resets back to 1.
getName ()
Returns a string representation of this level's zone and floor number.
getNumber ()
The 1-indexed logical number of the current level within the dungeon. Mirrors non-linear skips between levels (e.g. via the 'level' command).
getSequentialNumber ()
Returns a sequential 1-indexed number representing the order in which this current level was visited within the run. Increases by 1 on each level change, even if the 'level' command or other arbitrary level changes are used.
getUniqueID ()
Returns a fully unique number identifying a level across runs. Initialized to a random integer at startup, increases by 1 for every level loaded or generated.
getZone ()
The zone number of the current level. Starts at 1 and typically increments every 4 levels. Reversed for certain characters, starting at 4 or 5 and counting down every 4 levels.
isBoss ()
Returns true if the current level represents a boss arena. Returns false for normal floors or special levels.
isLobby ()
isRegularFloor ()
Returns true if the current level represents a normal floor. Returns false for boss or special levels.
generated by LDoc 1.4.6