Module necro.client.GameSession

Classes

GameSessionTransition

Functions

cancelPendingTransitions (force)
getCurrentMode ()
getCurrentModeID ()
getLevelCount ()
goToLevel (levelNumber, delay)
hasPendingTransition ()
isLevelAvailable (levelNumber)
isRestartAllowed ()
nextLevel (delay)
registerMode (modeData)
restart (delay)
start (parameters, delay)

Tables

Mode
SeedMode


Classes

GameSessionTransition
  • parameters any Arbitrary user storage associated with the transition
  • steps function[] List of callbacks to execute before generating the level
  • finishFunc function Final callback to execute the state change
  • levelNumber integer The level number to generate
  • levelIndex integer The level number to store the generated level in and change to
  • uniqueID integer Unique numeric identifier for this level transition
  • delay number|nil The target delay for performing the transition, which includes level generation time
  • minimumDelay number|nil The minimum delay to wait after completing the resource upload before transitioning
  • targetTime number|nil The target timestamp for performing the level transition
  • sequenceSync boolean If true, initializes and awaits a sequence sync before generating the level
  • resourceSync boolean If true, waits for the resources to be uploaded before changing the game state
  • skipCutscenes boolean If true, prevents run-start cutscenes from being played
  • generated boolean Set to true when level data has been produced by the level generator
  • canceled boolean Set to true when the transition was cancelled

Functions

cancelPendingTransitions (force)

Parameters:

  • force
getCurrentMode ()
getCurrentModeID ()
getLevelCount ()
goToLevel (levelNumber, delay)

Parameters:

  • levelNumber
  • delay
hasPendingTransition ()
isLevelAvailable (levelNumber)

Parameters:

  • levelNumber
isRestartAllowed ()
nextLevel (delay)

Parameters:

  • delay
registerMode (modeData)

Parameters:

  • modeData
restart (delay)

Parameters:

  • delay
start (parameters, delay)

Parameters:

  • parameters
  • delay

Tables

Mode

Fields:

  • AllZones "AllZones"
  • AllZonesSeeded "AllZonesSeeded"
  • CustomDungeon "CustomDungeon"
  • DailyChallenge "DailyChallenge"
  • DailyChallengeAmplified "DailyChallengeAmplified"
  • Lobby "Lobby"
  • Training "Training"
SeedMode

Fields:

  • NONE 0
  • RANDOM 1
  • MANUAL 2
generated by LDoc 1.4.6