Skip to content

Coromon 1.5.4 classes.spawnables

Zreezy edited this page Nov 1, 2026 · 1 revision

classes.spawnables

Coromon 1.5.4. 179 module(s). Back to index

abstractActionTileZoneArea, abstractBoat, abstractCharacter, abstractDoor, abstractEightDirectionalMovingSpawnable, abstractInteractDoor, abstractItemChest, abstractItemCollection, abstractItemSpawnable, abstractMescherRealmDarkSoul, abstractMonster, abstractMovingSpawnable, abstractNpcCharacter, abstractPotentialStatResetMachine, abstractPowerTowerElevatorPlatform, abstractPowerTowerSwitch, abstractPyramidFloorSwitch, abstractRogueCharacter, abstractSpawnable, abstractTempleDungeonPlatform, abstractWallSwitch, abstractZoneArea, allowSpawnableArea, amishTownFence, battleDomeBannerDisplay, battleDomeOpponentNpcCharacter, battleDomeOpponentPreviewDisplay, battleDomeShop, bird, blockDirectionsArea, blockSpawnableArea, bottomMaskArea, burnableBlockingObject, cactus, cakeOven, changeLayerArea, checkpointArea, clock, constrainDirectionsArea, constrainSpawnableArea, coromonLabDataScreen, coromonLabHatch, crimsoniteElectricGate, crimsoniteHeatedWaterArea, crimsoniteIceSpikes, crimsoniteMachine, crimsonitePillar, crimsonitePole, crimsoniteSandArea, crimsoniteShard, cutsceneOnInteract, cutsceneOnTile, desertRouteCooldownArea, desertRouteSandArea, dojoGroundsPaintableFence, dojoJumpMachine, door, drillShovelItem, dungeonDripArea, electricBeetleLabBatteryPack, emoji, fireTownBoulder, fishArea, fishingZoneArea, floatingCoreStone, floorIndicator, fogOfWarArea, fruitGrowingPot, ghostTownCandleFlame, ghostTownHauntedSprite, ghostTownMistSprite, ghostTownPurrgyGate, grassArea, gridOffsetArea, hedgeArea, hiddenItem, houseTransferBeamLight, houseTransferCapsule, iceArea, interactDoor, item, itemChest, ladder, ledgeArea, lockCameraArea, lockedRoomSprite, luxCannonTeleporter, luxElevator, luxEscalator, luxHealingMachine, luxHealingMachineForBattleDome, luxSolisBoat, luxStorageMachine, luxTeleporter, mainCharacter, mansionMazeTeleporterArea, mescherRealmBridge, mescherRealmDarkSoul, mescherRealmDreamSoul, mescherRealmHumanSoul, mescherRealmLightSoul, mescherRealmObstacle, mescherRealmObstacleSwitch, minecart, minecartHole, minecartTrack, minecartTrackSwitch, monster, mountablePurrgy, outpostHouse, palacePrisonGateControlPanel, portal, portalLantern, portalPillar, portalStone, potentialStatHardResetMachine, potentialStatHardResetMachineForBattleDome, potentialStatSoftResetMachine, powerTowerDoorSwitch, powerTowerElevatorPlatformDown, powerTowerElevatorPlatformUp, powerTowerMastermindButton, powerTowerMastermindDoor, powerTowerMastermindScreen, powerTowerSwitch, puddleReflectionArea, punchPlate, pushableObject, pushableRollingObject, pyramidDart, pyramidDartFloorSwitch, pyramidItemChest, pyramidSandArea, pyramidTableRiddleStatue, pyramidWall, pyramidWallFloorSwitch, pyramidWallMotor, receptionGauntletPlatform, reflectionArea, reflectionCube, researchLabFloatingCrimsoniteLumon, researchLabGauntletModuleTestMachine, researchLabTitanEssence, rogueMainCharacter, rogueMonster, roguePlayableCharacter, sandFootstepArea, sensorDoor, skiLift, soundPlayer, sprite, stairsArea, stationDoor, surfboard, surfboardInteractLedge, surfboardShortInteractLedge, swampAlarm, swampMushroom, swampPurrgyBell, swampRaft, teleporterArea, teleporterDoor, teleporterHole, templeDungeonFallPlatform, templeDungeonSpringPlatform, text, tiledSpawnable, titan, titanEssence, train, trainerHubBannerDisplay, trainerHubConsecutiveWinsText, treadmillArea, treeItem, tremorableCaveEntrance, vendingMachine, worldObjectSpawnable, wubbonianBoat, zoneArea

abstractActionTileZoneArea

classes.spawnables.abstractActionTileZoneArea

  • returns abstractActionTileZoneArea

  • requires: classes.spawnables.abstractZoneArea, classes.spawnables.plugins.triggerableSpawnablePlugin

  • abstractActionTileZoneArea:new(_options, _tiledProperties)

Instance / other functions (1)
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)

abstractBoat

classes.spawnables.abstractBoat

  • returns abstractBoat

  • requires: classes.spawnables.worldObjectSpawnable

  • abstractBoat:new(_options, _tiledProperties)

Instance / other functions (1)
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)

abstractCharacter

classes.spawnables.abstractCharacter

  • returns abstractCharacter

  • requires: classes.spawnables.abstractMovingSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.expressiveSpawnablePlugin, classes.spawnables.plugins.dialogSpeakerSpawnablePlugin, classes.spawnables.plugins.shadowSpawnablePlugin, classes.spawnables.plugins.rotatableSpawnablePlugin, classes.spawnables.plugins.bottomMaskSpawnablePlugin, classes.spawnables.plugins.interactingSpawnablePlugin, classes.spawnables.extensions.autoRotatableSpawnableExtension, classes.spawnables.plugins.reflectionSpawnablePlugin, classes.spawnables.plugins.luxTeleporterAnimationSoundSpawnablePlugin, classes.spawnables.characterSprites.modularCharacterSprite, classes.lists.characterList, classes.spawnables.plugins.armAnimationCharacterPlugin, classes.spawnables.extensions.gauntletArmAnimationCharacterExtension

  • abstractCharacter:new(_options, _tiledProperties)

Instance / other functions (44)
  • class:getExpressiveSpawnableAtTopCenterOffsetX()
  • class:getExpressiveSpawnableAtTopCenterOffsetY()
  • class:getSpeakerHead(_parent)
  • class:getSpeakerType()
  • class:getSpeakerStyle()
  • class:getSpeakerSpawnableAtTopCenterOffsetX()
  • class:getSpeakerSpawnableAtTopCenterOffsetY()
  • class:getSpriteDirection()
  • class:isMoonwalking()
  • class:startMoonwalking()
  • class:stopMoonwalking()
  • class:armFrontStartAnimation(_shouldCharge, _onComplete)
  • class:armFrontEndAnimation(_onComplete)
  • class:armUpStartAnimation(_shouldCharge, _onComplete)
  • class:armUpEndAnimation(_shouldCharge, _onComplete)
  • class:refreshCurrentSequence(_force)
  • class:setTileLocationAndDirection(_tileX, _tileY, _direction)
  • class:jumpRotateTo(_spawnable, _onComplete)
  • class:onRotate(_direction, _isInitialRotation)
  • class:onRotateStep(_onComplete)
  • class:onCull()
  • class:getGridMoveTimeBySpeed()
  • class:onStoppedMoving(_blocked)
  • class:hasReachedNewTile(_tileX, _tileY, _isSpawn)
  • class:onBeforeGridMove(_gridMoveData)
  • class:whileMovingOnGrid(_direction, _movedX, _movedY)
  • class:doInteract(_direction, _optionalOnComplete)
  • class:spawnPerkObtainedAnimation(_onComplete)
  • class:setSurprisedEyes()
  • class:unsetSurprisedEyes()
  • class:doSmallJump(...)
  • class:doMediumJump(...)
  • class:doJump(...)
  • class:doForwardFadeIn(_onComplete)
  • class:doForwardFadeOut(_onComplete)
  • class:doBodySlam(_onComplete, _triggerOnEnd, _shouldSkipFrameShake)
  • class:onBodySlamStart()
  • class:onBodySlamComplete()
  • class:createShadowSprite()
  • class:hasSprite()
  • class:getCharacterConfig()
  • class:shouldIncludeCharacterArmAnimations()
  • class:createSprite()
  • class:reloadSprite()

abstractDoor

classes.spawnables.abstractDoor

  • returns abstractDoor

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.blockingSpawnablePlugin, classes.spawnables.plugins.interactableSpawnablePlugin, classes.spawnables.extensions.cutsceneInteractableSpawnableExtension

  • abstractDoor:new(_options, _tiledProperties)

Instance / other functions (18)
  • class:shouldSaveDoorState()
  • class:getRequiredSounds()
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:isLocked()
  • class:isUnlocked()
  • class:isOpened()
  • class:isClosed()
  • class:setOpened()
  • class:setClosed()
  • class:open(_onComplete)
  • class:close(_onComplete, _alternateCloseSequence)
  • class:toggle(_onComplete)
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:removeSprite()
  • class:setVisible(_bool)
  • class:onBeforeSpawn()
  • class:onAfterSpawn()
Fields with default values (298)
  • abstractDoor.amishTown.sound = "generic"
  • abstractDoor.amishTown.tileOffsetX = -16
  • abstractDoor.amishTown.tileOffsetY = 0
  • abstractDoor.amishTown.isPushable = true
  • abstractDoor.amishTown.spriteOptions.width = 48
  • abstractDoor.amishTown.spriteOptions.height = 32
  • abstractDoor.amishTown.spriteOptions.path = "maps/all/objects/doors/"
  • abstractDoor.amishTown.spriteOptions.file = "amishTown.png"
  • abstractDoor.amishTown.spriteOptions.amount_frames = 5
  • abstractDoor.amishTown.spriteOptions.sequences = {}
  • abstractDoor.swamp.sound = "generic"
  • abstractDoor.swamp.tileOffsetX = -16
  • abstractDoor.swamp.tileOffsetY = 0
  • abstractDoor.swamp.isPushable = true
  • abstractDoor.swamp.spriteOptions.width = 48
  • abstractDoor.swamp.spriteOptions.height = 32
  • abstractDoor.swamp.spriteOptions.path = "maps/all/objects/doors/"
  • abstractDoor.swamp.spriteOptions.file = "swamp.png"
  • abstractDoor.swamp.spriteOptions.amount_frames = 5
  • abstractDoor.swamp.spriteOptions.sequences = {}
  • abstractDoor.iceTown_door.sound = "generic"
  • abstractDoor.iceTown_door.tileOffsetX = -16
  • abstractDoor.iceTown_door.tileOffsetY = 0
  • abstractDoor.iceTown_door.isPushable = true
  • abstractDoor.iceTown_door.spriteOptions.width = 48
  • abstractDoor.iceTown_door.spriteOptions.height = 32
  • abstractDoor.iceTown_door.spriteOptions.path = "maps/all/objects/doors/"
  • abstractDoor.iceTown_door.spriteOptions.file = "iceTown_door.png"
  • abstractDoor.iceTown_door.spriteOptions.amount_frames = 5
  • abstractDoor.iceTown_door.spriteOptions.sequences = {}
  • abstractDoor.iceTown_longHouse_door.sound = "generic"
  • abstractDoor.iceTown_longHouse_door.tileOffsetX = -16
  • abstractDoor.iceTown_longHouse_door.tileOffsetY = 0
  • abstractDoor.iceTown_longHouse_door.isPushable = true
  • abstractDoor.iceTown_longHouse_door.spriteOptions.width = 48
  • abstractDoor.iceTown_longHouse_door.spriteOptions.height = 32
  • abstractDoor.iceTown_longHouse_door.spriteOptions.path = "maps/all/objects/doors/"
  • abstractDoor.iceTown_longHouse_door.spriteOptions.file = "iceTown_longHouse_door.png"
  • abstractDoor.iceTown_longHouse_door.spriteOptions.amount_frames = 5
  • abstractDoor.iceTown_longHouse_door.spriteOptions.sequences = {}
  • ... 258 more in api.json

abstractEightDirectionalMovingSpawnable

classes.spawnables.abstractEightDirectionalMovingSpawnable

  • returns abstractEightDirectionalMovingSpawnable

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.collisionShapeSpawnablePlugin, classes.libraries.math2d

  • abstractEightDirectionalMovingSpawnable:new(_options, _tiledProperties)

Instance / other functions (15)
  • class:isPlayingWalkingAnimation()
  • class:isMovingProgramatically()
  • class:onEightDirectionalMovingSpawnableMoved()
  • class:refreshCurrentSequence()
  • class:tryMoveCollisionShape(_deltaX, _deltaY, _onDelta)
  • class:tryMoveCollisionShapeWithSpawnable(_deltaXToTry, _deltaYToTry)
  • class:stopWalkingAnimation()
  • class:startOrUpdateWalkingAnimation(_direction)
  • class:hasStartedWalking()
  • class:onSpriteStoppedMoving()
  • class:onBeforeSpawn()
  • class:onAllSpawnablesSpawned()
  • class:moveSpriteInDirection(_mainDirection, _secondaryDirection, _eventTime, _optionalTargetX, _optionalTargetY)
  • class:moveTo(_targetX, _targetY, _onComplete)
  • class:moveBy(_offsetX, _offsetY, _onComplete)

abstractInteractDoor

classes.spawnables.abstractInteractDoor

  • returns abstractInteractDoor

  • requires: classes.spawnables.abstractDoor

  • abstractInteractDoor:new(_options, _tiledProperties)

Instance / other functions (3)
  • class:onOpenedByInteract(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractAction(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)

abstractItemChest

classes.spawnables.abstractItemChest

  • returns abstractItemChest

  • requires: classes.spawnables.abstractItemCollection, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.bottomMaskSpawnablePlugin, classes.spawnables.plugins.triggeringWorldObjectSpawnablePlugin

  • abstractItemChest:new(_options, _tiledProperties)

Instance / other functions (6)
  • class:getRequiredSounds()
  • class:getRandomizableItemFor(_key)
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractReceiveItems(_spawnable, _onComplete)
  • class:shouldAutomaticallyRemoveItemSpawnable()
  • class:createSprite()

abstractItemCollection

classes.spawnables.abstractItemCollection

  • returns abstractItemCollection

  • requires: classes.spawnables.abstractItemSpawnable

  • abstractItemCollection:new(_options, _tiledProperties)

Instance / other functions (3)
  • class:getRandomizableItemFor(_key)
  • class:getFoundObtainableItems()
  • class:resolveObtainableItem(_index, _UID, _amount, _isSpecial, _isRandomizable)

abstractItemSpawnable

classes.spawnables.abstractItemSpawnable

  • returns abstractItemSpawnable

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.interactableSpawnablePlugin

  • abstractItemSpawnable:new(_options, _tiledProperties)

Instance / other functions (5)
  • class:shouldAutomaticallyRemoveItemSpawnable()
  • class:getFoundObtainableItems()
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractAction(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:onInteractReceiveItems(_spawnable, _onComplete)

abstractMescherRealmDarkSoul

classes.spawnables.abstractMescherRealmDarkSoul

  • returns abstractMescherRealmDarkSoul

  • requires: classes.spawnables.abstractMovingSpawnable, classes.spawnables.plugins.shadowSpawnablePlugin

  • abstractMescherRealmDarkSoul:new(_options, _tiledProperties, _spriteType)

Instance / other functions (3)
  • class:createShadowSprite()
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:setWalkingFrameOnSprite(_frame)

abstractMonster

classes.spawnables.abstractMonster

  • returns abstractMonster

  • requires: classes.spawnables.abstractMovingSpawnable, classes.spawnables.plugins.shadowSpawnablePlugin, classes.spawnables.plugins.dialogSpeakerSpawnablePlugin, classes.spawnables.plugins.expressiveSpawnablePlugin, classes.spawnables.extensions.autoRotatableSpawnableExtension

  • abstractMonster:new(_options, _tiledProperties)

Instance / other functions (18)
  • class:getMonsterUID()
  • class:getMonsterSpeakerType()
  • class:resolveSpriteSkinUID()
  • class:resolvePotential()
  • class:resolvePotentialCategory()
  • class:getSpeakerName()
  • class:getSpeakerHead(_parent)
  • class:getSpeakerType()
  • class:getSpeakerStyle()
  • class:getExpressiveSpawnableAtTopCenterOffsetX()
  • class:getExpressiveSpawnableAtTopCenterOffsetY()
  • class:getSpeakerSpawnableAtTopCenterOffsetX()
  • class:getSpeakerSpawnableAtTopCenterOffsetY()
  • class:createShadowSprite()
  • class:setWalkingFrameOnSprite(_frame)
  • class:hasSprite()
  • class:createSprite()
  • class:doInitiateBattleDash(_onComplete)
Fields with default values (3)
  • abstractMonster.createShadowFunctions.TITAN_SAND = false
  • abstractMonster.createShadowFunctions.TITAN_WATER = false
  • abstractMonster.createShadowFunctions.SAND_MOLE_1 = false

abstractMovingSpawnable

classes.spawnables.abstractMovingSpawnable

  • returns abstractMovingSpawnable

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.blockingSpawnablePlugin, classes.spawnables.plugins.changeableLayerSpawnablePlugin, classes.spawnables.plugins.triggeringWorldObjectSpawnablePlugin

  • abstractMovingSpawnable:new(_options, _tiledProperties)

Instance / other functions (110)
  • class:onChangeObjectLayer(_newObjectLayer)
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)
  • class:isMounted()
  • class:getMountedObject(_optionalClass)
  • class:mount(_mountableObject)
  • class:unmount()
  • class:onMountedObject(_spawnable)
  • class:onUnmountedObject(_spawnable)
  • class:ignorePlayerInput()
  • class:stopIgnoringPlayerInput()
  • class:isIgnoringPlayerInput()
  • class:addOnCompleteToLastStep(_onComplete)
  • lastStep.onComplete()
  • class:setStepInGridMoveStack(_index, _direction, _speed, _optionsOrOnComplete, _onComplete)
  • class:setNextStepIsEmpty()
  • class:setNextStep(_direction, _speed, _optionsOrOnComplete, _onComplete)
  • class:doStep(_direction, _speed, _optionsOrOnComplete, _onComplete)
  • class:doSteps(_direction, _speed, _amount, _optionsOrOnComplete, _onComplete)
  • class:doStepsUntilTileX(_speed, _tileX, _optionsOrOnComplete, _onComplete)
  • class:doStepsUntilTileY(_speed, _tileY, _optionsOrOnComplete, _onComplete)
  • class:doStepsUntilOutsideBoundary(_direction, _speed, _optionsOrOnComplete, _onComplete)
  • class:doStepsUntilSpawnableXY(_speed, _spawnable, _optionsOrOnComplete, _onComplete)
  • class:doStepsUntilSpawnableYX(_speed, _spawnable, _optionsOrOnComplete, _onComplete)
  • class:doStepsUntilLocationXY(_speed, _location, _optionsOrOnComplete, _onComplete)
  • class:doStepsUntilLocationYX(_speed, _location, _optionsOrOnComplete, _onComplete)
  • class:untilSpawnableXY(_spawnable, _optionsOrOnComplete, _onComplete)
  • class:untilSpawnableXYSlow(_spawnable, _optionsOrOnComplete, _onComplete)
  • class:untilSpawnableXYFast(_spawnable, _optionsOrOnComplete, _onComplete)
  • class:untilSpawnableYX(_spawnable, _optionsOrOnComplete, _onComplete)
  • class:untilSpawnableYXSlow(_spawnable, _optionsOrOnComplete, _onComplete)
  • class:untilSpawnableYXFast(_spawnable, _optionsOrOnComplete, _onComplete)
  • class:untilLocationXY(_location, _optionsOrOnComplete, _onComplete)
  • class:untilLocationXYSlow(_location, _optionsOrOnComplete, _onComplete)
  • class:untilLocationXYFast(_location, _optionsOrOnComplete, _onComplete)
  • class:untilLocationYX(_location, _optionsOrOnComplete, _onComplete)
  • class:untilLocationYXSlow(_location, _optionsOrOnComplete, _onComplete)
  • class:untilLocationYXFast(_location, _optionsOrOnComplete, _onComplete)
  • class:untilTileX(_tileX, _optionsOrOnComplete, _onComplete)
  • class:untilTileY(_tileY, _optionsOrOnComplete, _onComplete)
  • class:untilTileXSlow(_tileX, _optionsOrOnComplete, _onComplete)
  • class:untilTileYSlow(_tileY, _optionsOrOnComplete, _onComplete)
  • class:untilTileXFast(_tileX, _optionsOrOnComplete, _onComplete)
  • class:untilTileYFast(_tileY, _optionsOrOnComplete, _onComplete)
  • class:left(_amount, _optionsOrOnComplete, _onComplete)
  • class:up(_amount, _optionsOrOnComplete, _onComplete)
  • class:right(_amount, _optionsOrOnComplete, _onComplete)
  • class:down(_amount, _optionsOrOnComplete, _onComplete)
  • class:forward(_amount, _optionsOrOnComplete, _onComplete)
  • class:backward(_amount, _optionsOrOnComplete, _onComplete)
  • class:leftSlow(_amount, _optionsOrOnComplete, _onComplete)
  • class:upSlow(_amount, _optionsOrOnComplete, _onComplete)
  • class:rightSlow(_amount, _optionsOrOnComplete, _onComplete)
  • class:downSlow(_amount, _optionsOrOnComplete, _onComplete)
  • class:forwardSlow(_amount, _optionsOrOnComplete, _onComplete)
  • class:backwardSlow(_amount, _optionsOrOnComplete, _onComplete)
  • class:leftFast(_amount, _optionsOrOnComplete, _onComplete)
  • class:upFast(_amount, _optionsOrOnComplete, _onComplete)
  • class:rightFast(_amount, _optionsOrOnComplete, _onComplete)
  • class:downFast(_amount, _optionsOrOnComplete, _onComplete)
  • class:forwardFast(_amount, _optionsOrOnComplete, _onComplete)
  • class:backwardFast(_amount, _optionsOrOnComplete, _onComplete)
  • class:leftCustom(_amount, _speed, _optionsOrOnComplete, _onComplete)
  • class:upCustom(_amount, _speed, _optionsOrOnComplete, _onComplete)
  • class:rightCustom(_amount, _speed, _optionsOrOnComplete, _onComplete)
  • class:downCustom(_amount, _speed, _optionsOrOnComplete, _onComplete)
  • class:forwardCustom(_amount, _speed, _optionsOrOnComplete, _onComplete)
  • class:backwardCustom(_amount, _speed, _optionsOrOnComplete, _onComplete)
  • class:leftUntilOutsideBoundary(_optionsOrOnComplete, _onComplete)
  • class:upUntilOutsideBoundary(_optionsOrOnComplete, _onComplete)
  • class:rightUntilOutsideBoundary(_optionsOrOnComplete, _onComplete)
  • class:downUntilOutsideBoundary(_optionsOrOnComplete, _onComplete)
  • class:leftUntilOutsideBoundarySlow(_optionsOrOnComplete, _onComplete)
  • class:upUntilOutsideBoundarySlow(_optionsOrOnComplete, _onComplete)
  • class:rightUntilOutsideBoundarySlow(_optionsOrOnComplete, _onComplete)
  • class:downUntilOutsideBoundarySlow(_optionsOrOnComplete, _onComplete)
  • class:leftUntilOutsideBoundaryFast(_optionsOrOnComplete, _onComplete)
  • class:upUntilOutsideBoundaryFast(_optionsOrOnComplete, _onComplete)
  • class:rightUntilOutsideBoundaryFast(_optionsOrOnComplete, _onComplete)
  • class:downUntilOutsideBoundaryFast(_optionsOrOnComplete, _onComplete)
  • class:getGridMoveEasing(_stepSpeed)
  • class:getGridMoveTimeBySpeed()
  • class:emptyGridMoveStack()
  • class:getGridMoveStack()
  • class:executeNowOrAfterMove(_onComplete)
  • class:executeNowOrAfterMoveOrAfterCutscene(_onComplete)
  • class:onStartedMoving()
  • class:onStoppedMoving(_blocked)
  • class:isGridMoveBlocked(_stepDirection, _stepSpeed)
  • class:startGridMove(_onComplete)
  • class:parseGridMoveObject(_gridMoveObject, _executeNextStepInGridMoveStack)
  • class:onParseValidGridMoveObject(_gridMoveObject)
  • class:canBeBlockedBy(_spawnable)
  • class:isCurrentTileConstraining(_direction)
  • class:isNextTileBlocking(_nextTileX, _nextTileY, _direction, _speed)
  • class:gridMove(_gridMoveData, _onComplete)
  • class:onBeforeGridMove(_gridMoveData)
  • class:whileMovingOnGrid(_direction, _movedX, _movedY)
  • class:onGridMoveComplete(_tileX, _tileY)
  • class:getWalkingFrameForOffset(_offset)
  • class:setWalkingFrameOffset(_offset, _shouldSaveFrame)
  • class:setNextWalkingFrame()
  • class:setWalkingFrameOnSprite(_frame)
  • class:calculateCullingOptions()
  • class:setTileLocation(_tileX, _tileY)
  • class:enableStaticSequence(_footInFront)
  • class:disableStaticSequence()
  • class:onStartCutscene()
  • class:remove()
  • class:onSpawn()
  • class:onAllSpawnablesSpawned()

abstractNpcCharacter

classes.spawnables.abstractNpcCharacter

  • returns abstractNpcCharacter

  • requires: classes.spawnables.abstractCharacter, classes.spawnables.plugins.behavingCullablePlugin, classes.spawnables.plugins.spottingCharacterPlugin, classes.spawnables.plugins.interactableSpawnablePlugin, classes.spawnables.extensions.movingInteractableSpawnableExtension, classes.spawnables.extensions.cutsceneInteractableSpawnableExtension, classes.spawnables.extensions.cutsceneInteractableDialogSpeakerSpawnableExtension

  • abstractNpcCharacter:new(_options, _tiledProperties)

Instance / other functions (17)
  • class:isCullable()
  • class:turnToPlayer(_onComplete)
  • class:onSpawnableSpotted(_mainCharacter)
  • class:isSpawnableAlreadySpotted()
  • class:setSpawnableAlreadySpotted(_boolean)
  • class:getSpawnableToSpot()
  • class:shouldSpotSpawnable()
  • class:shouldSpawnExpressiveSprite()
  • class:setCharacter(_character)
  • class:getCharacterConfig()
  • class:shouldIncludeCharacterArmAnimations()
  • class:getSpeakerName()
  • class:getSpeakerStyle()
  • class:getDefaultInteractText()
  • class:onInteractAction(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:onStartCutscene()
  • class:onEndCutscene()

abstractPotentialStatResetMachine

classes.spawnables.abstractPotentialStatResetMachine

  • returns abstractPotentialStatResetMachine

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.interactableSpawnablePlugin, classes.interface.overlays.MessagePopup, classes.interface.battle.ResetPotentialStatsOverlay

  • abstractPotentialStatResetMachine:new(_options, _tiledProperties)

Instance / other functions (10)
  • class:willGiveAwayMonster()
  • class:getPotentialStatResetGoldCost()
  • class:getNewPotentialStats(_monster)
  • class:getTallMonsterButtonOverlayContextText()
  • class:onBeforeShowTallMonsterButtonOverlay(_endCutscene, _showTallMonsterButtonOverlay)
  • class:onAfterMonsterGiven(_monster, _onComplete)
  • class:getRequiredSounds()
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractAction(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:showTallMonsterButtonOverlay(_onCancel, _onComplete)

abstractPowerTowerElevatorPlatform

classes.spawnables.abstractPowerTowerElevatorPlatform

  • returns abstractPowerTowerElevatorPlatform

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.teleporterPlugin, classes.spawnables.plugins.triggerableSpawnablePlugin, classes.spawnables.plugins.soundSpawnablePlugin

  • abstractPowerTowerElevatorPlatform:new(_options, _tiledProperties)

Instance / other functions (5)
  • class:onSpawnedOnPowerTowerElevatorPlatformLocation(_playerSpawnable)
  • class:onSteppedOnCenterOfPowerTowerPlatform(_playerSpawnable)
  • class:getRequiredSounds()
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)
  • class:onAllSpawnablesSpawned()

abstractPowerTowerSwitch

classes.spawnables.abstractPowerTowerSwitch

  • returns abstractPowerTowerSwitch

  • requires: classes.spawnables.abstractWallSwitch

  • abstractPowerTowerSwitch:new(_options, _tiledProperties)

abstractPyramidFloorSwitch

classes.spawnables.abstractPyramidFloorSwitch

  • returns abstractPyramidFloorSwitch

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.triggerableSpawnablePlugin

  • abstractPyramidFloorSwitch:new(_options, _tiledProperties)

Instance / other functions (4)
  • class:createFloorSwitchIndicator(_floorSwitchContainer)
  • class:hasSprite()
  • class:createSprite()
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)

abstractRogueCharacter

classes.spawnables.abstractRogueCharacter

  • returns abstractRogueCharacter

  • requires: classes.spawnables.abstractEightDirectionalMovingSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.expressiveSpawnablePlugin, classes.spawnables.plugins.shadowSpawnablePlugin, classes.spawnables.plugins.rotatableSpawnablePlugin, classes.spawnables.plugins.luxTeleporterAnimationSoundSpawnablePlugin, classes.spawnables.plugins.rogueDialogSpeakerSpawnablePlugin

  • abstractRogueCharacter:new(_options, _tiledProperties)

Instance / other functions (23)
  • class:getExpressiveSpawnableAtTopCenterOffsetX()
  • class:getExpressiveSpawnableAtTopCenterOffsetY()
  • class:getRogueDialogSpeakerPortraitUID()
  • class:getRogueDialogSpeakerName()
  • class:getRogueSpeakerSpawnableAtTopCenterIndicatorOffsetX()
  • class:getRogueSpeakerSpawnableAtTopCenterIndicatorOffsetY()
  • class:refreshCurrentSequence()
  • class:setSurprisedEyes()
  • class:unsetSurprisedEyes()
  • class:jumpRotateTo(_spawnable, _onComplete)
  • class:onRotate(_direction, _isInitialRotation)
  • class:onRotateStep(_onComplete)
  • class:onCull()
  • class:doSmallJump(...)
  • class:doMediumJump(...)
  • class:doJump(...)
  • class:doForwardFadeIn(_onComplete)
  • class:doForwardFadeOut(_onComplete)
  • class:doBodySlam(_onComplete, _triggerOnEnd, _shouldSkipFrameShake)
  • class:onBodySlamStart()
  • class:onBodySlamComplete()
  • class:createShadowSprite()
  • class:createCollisionShapeObject(_sprite)

abstractSpawnable

classes.spawnables.abstractSpawnable

  • returns abstractSpawnable

  • abstractSpawnable:new(_options, _tiledProperties)

Instance / other functions (9)
  • class:instanceOf(_className)
  • class:getSpawnableConstructor()
  • class:onDestroySpawnableConstructor()
  • class:finalize()
  • class:onAfterUnloadTransition()
  • class:isRemoved()
  • class:remove()
  • class:destroySpawnableConstructor()
  • class:removeAndDestroySpawnableConstructor()

abstractTempleDungeonPlatform

classes.spawnables.abstractTempleDungeonPlatform

  • returns abstractTempleDungeonPlatform

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.interface.overlays.worldLostOverlayBuilder, classes.spawnables.plugins.triggerableSpawnablePlugin, classes.spawnables.plugins.constrainingSpawnablePlugin

  • abstractTempleDungeonPlatform:new(_options, _tiledProperties)

Instance / other functions (9)
  • class:onPlatformTriggerCanceled(_abstractCharacter)
  • class:onPlatformTriggered(_abstractCharacter)
  • class:alignHauntedGlowSprite(_hauntedGlowSprite)
  • class:doConstrainingAction(_spawnable, _direction, _isGridMoveOff)
  • class:getRequiredSounds()
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:removeSprite()
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)
  • class:doCharacterFallAnimation(_abstractCharacter)

abstractWallSwitch

classes.spawnables.abstractWallSwitch

  • returns abstractWallSwitch

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.interactableSpawnablePlugin

  • abstractWallSwitch:new(_options, _tiledProperties)

Instance / other functions (7)
  • class:getRequiredSounds()
  • class:onInteractActivate(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractDeactivate(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:shouldSaveActiveState()
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractAction(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:onBeforeSpawn()

abstractZoneArea

classes.spawnables.abstractZoneArea

  • returns abstractZoneArea

  • requires: classes.spawnables.worldObjectSpawnable

  • abstractZoneArea:new(_options, _tiledProperties)

Instance / other functions (2)
  • class:tryRollMonsters()
  • class:triggerBattle(_playerSpawnable, _rolledMonsters, _onComplete)

allowSpawnableArea

classes.spawnables.allowSpawnableArea

  • returns allowSpawnableArea

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.blockingSpawnablePlugin

  • allowSpawnableArea:new(_options, _tiledProperties)

Instance / other functions (1)
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)

amishTownFence

classes.spawnables.amishTownFence

  • returns amishTownFence

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.blockingSpawnablePlugin, classes.spawnables.plugins.pushableSpawnablePlugin

  • amishTownFence:new(_options, _tiledProperties)

Instance / other functions (7)
  • class:open(_onComplete)
  • class:close(_onComplete)
  • class:isOpened()
  • class:isClosed()
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)
  • class:onPush(_abstractCharacter, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:onRender()

battleDomeBannerDisplay

classes.spawnables.battleDomeBannerDisplay

  • returns trainerHubBannerDisplay

  • requires: classes.spawnables.worldObjectSpawnable

  • battleDomeBannerDisplay:new(_options, _tiledProperties)

Instance / other functions (1)
  • class:isCullable()

battleDomeOpponentNpcCharacter

classes.spawnables.battleDomeOpponentNpcCharacter

  • returns battleDomeOpponentNpcCharacter

  • requires: classes.spawnables.abstractNpcCharacter

  • battleDomeOpponentNpcCharacter:new(_options, _tiledProperties)

battleDomeOpponentPreviewDisplay

classes.spawnables.battleDomeOpponentPreviewDisplay

  • returns trainerHubBannerDisplay

  • requires: classes.spawnables.worldObjectSpawnable

  • battleDomeOpponentPreviewDisplay:new(_options, _tiledProperties)

Instance / other functions (4)
  • class:isCullable()
  • class:hasSprite()
  • class:createSprite()
  • class:reloadSpriteAnimated()

battleDomeShop

classes.spawnables.battleDomeShop

  • returns battleDomeShop

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.blockingSpawnablePlugin

  • battleDomeShop:new(_options, _tiledProperties)

Instance / other functions (4)
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)
  • class:getRequiredSounds()
  • class:unlockShopStageTwo(_onComplete)
  • class:unlockShopStageThree(_onComplete)

bird

classes.spawnables.bird

  • returns bird

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.behavingCullablePlugin, classes.sprites.Bird

  • bird:new(_options, _tiledProperties)

Instance / other functions (7)
  • class:hasSprite()
  • class:createSprite()
  • class:onBirdMoveStart()
  • class:onBirdMoveComplete(_tileX, _tileY, _onCompleteParam)
  • class:hasReachedNewTile(_tileX, _tileY, _isSpawn)
  • class:getRequiredSounds()
  • class:tryRandomAction(_onComplete)

blockDirectionsArea

classes.spawnables.blockDirectionsArea

  • returns blockDirectionsArea

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.blockingSpawnablePlugin

  • blockDirectionsArea:new(_options, _tiledProperties)

Instance / other functions (1)
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)

blockSpawnableArea

classes.spawnables.blockSpawnableArea

  • returns blockSpawnableArea

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.blockingSpawnablePlugin

  • blockSpawnableArea:new(_options, _tiledProperties)

Instance / other functions (1)
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)

bottomMaskArea

classes.spawnables.bottomMaskArea

  • returns bottomMaskArea

  • requires: classes.spawnables.abstractActionTileZoneArea

  • bottomMaskArea:new(_options, _tiledProperties)

Instance / other functions (4)
  • class:getBottomMaskType()
  • class:getBottomMaskHeight()
  • class:shouldChangeBottomMaskPerFrame()
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)

burnableBlockingObject

classes.spawnables.burnableBlockingObject

  • returns burnableBlockingObject

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.blockingSpawnablePlugin, classes.spawnables.plugins.changeableLayerSpawnablePlugin, classes.spawnables.plugins.burnableSpawnablePlugin, classes.spawnables.plugins.soundSpawnablePlugin

  • burnableBlockingObject:new(_options, _tiledProperties)

Instance / other functions (5)
  • class:getRequiredSounds()
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)
  • class:canBeBurned(_abstractCharacter, _nextTileX, _nextTileY, _direction)
  • class:onBurn(_abstractCharacter, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
Fields with default values (45)
  • burnableBlockingObject.crate.amount_frames = 14
  • burnableBlockingObject.crate.width = 16
  • burnableBlockingObject.crate.height = 32
  • burnableBlockingObject.crate.spriteTileOffsetX = 0
  • burnableBlockingObject.crate.spriteTileOffsetY = 0
  • burnableBlockingObject.crate.timePerFrame = 100
  • burnableBlockingObject.crate.loopCount = 1
  • burnableBlockingObject.crate.path = "maps/all/objects/burnables/"
  • burnableBlockingObject.crate.file = "crate.png"
  • burnableBlockingObject.barrel.amount_frames = 14
  • burnableBlockingObject.barrel.width = 16
  • burnableBlockingObject.barrel.height = 32
  • burnableBlockingObject.barrel.spriteTileOffsetX = 0
  • burnableBlockingObject.barrel.spriteTileOffsetY = 0
  • burnableBlockingObject.barrel.timePerFrame = 100
  • burnableBlockingObject.barrel.loopCount = 1
  • burnableBlockingObject.barrel.path = "maps/all/objects/burnables/"
  • burnableBlockingObject.barrel.file = "barrel.png"
  • burnableBlockingObject.desertPlant_a.amount_frames = 14
  • burnableBlockingObject.desertPlant_a.width = 48
  • burnableBlockingObject.desertPlant_a.height = 32
  • burnableBlockingObject.desertPlant_a.spriteTileOffsetX = -16
  • burnableBlockingObject.desertPlant_a.spriteTileOffsetY = 0
  • burnableBlockingObject.desertPlant_a.timePerFrame = 100
  • burnableBlockingObject.desertPlant_a.loopCount = 1
  • burnableBlockingObject.desertPlant_a.path = "maps/all/objects/burnables/"
  • burnableBlockingObject.desertPlant_a.file = "desertPlant_a.png"
  • burnableBlockingObject.desertPlant_b.amount_frames = 14
  • burnableBlockingObject.desertPlant_b.width = 48
  • burnableBlockingObject.desertPlant_b.height = 32
  • burnableBlockingObject.desertPlant_b.spriteTileOffsetX = -16
  • burnableBlockingObject.desertPlant_b.spriteTileOffsetY = 0
  • burnableBlockingObject.desertPlant_b.timePerFrame = 100
  • burnableBlockingObject.desertPlant_b.loopCount = 1
  • burnableBlockingObject.desertPlant_b.path = "maps/all/objects/burnables/"
  • burnableBlockingObject.desertPlant_b.file = "desertPlant_b.png"
  • burnableBlockingObject.desertPlant_c.amount_frames = 14
  • burnableBlockingObject.desertPlant_c.width = 48
  • burnableBlockingObject.desertPlant_c.height = 32
  • burnableBlockingObject.desertPlant_c.spriteTileOffsetX = -16
  • ... 5 more in api.json

cactus

classes.spawnables.cactus

  • returns cactus

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.blockingSpawnablePlugin

  • cactus:new(_options, _tiledProperties)

Instance / other functions (1)
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)

cakeOven

classes.spawnables.cakeOven

  • returns cakeOven

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.interactableSpawnablePlugin

  • cakeOven:new(_options, _tiledProperties)

Instance / other functions (8)
  • class:getRequiredSounds()
  • class:isCakeBatchReady()
  • class:rollCakeBatch()
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractAction(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:onRender()
  • self.updateBakingStateFunction()
  • class:onCull()

changeLayerArea

classes.spawnables.changeLayerArea

  • returns changeLayerArea

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.triggerableSpawnablePlugin

  • changeLayerArea:new(_options, _tiledProperties)

Instance / other functions (1)
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)

checkpointArea

classes.spawnables.checkpointArea

  • returns checkpointArea

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.triggerableSpawnablePlugin

  • checkpointArea:new(_options, _tiledProperties)

Instance / other functions (1)
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)

clock

classes.spawnables.clock

  • returns clock

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.interactableSpawnablePlugin

  • clock:new(_options, _tiledProperties)

Instance / other functions (6)
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractAction(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:hasSprite()
  • class:createSprite()
  • class:onRender()
  • class:onCull()

constrainDirectionsArea

classes.spawnables.constrainDirectionsArea

  • returns constrainDirectionsArea

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.constrainingSpawnablePlugin

  • constrainDirectionsArea:new(_options, _tiledProperties)

Instance / other functions (1)
  • class:doConstrainingAction(_spawnable, _direction, _isGridMoveOff)

constrainSpawnableArea

classes.spawnables.constrainSpawnableArea

  • returns constrainSpawnableArea

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.constrainingSpawnablePlugin

  • constrainSpawnableArea:new(_options, _tiledProperties)

Instance / other functions (1)
  • class:doConstrainingAction(_spawnable, _direction, _isGridMoveOff)

coromonLabDataScreen

classes.spawnables.coromonLabDataScreen

  • returns coromonLabDataScreen

  • requires: classes.spawnables.worldObjectSpawnable

  • coromonLabDataScreen:new(_options, _tiledProperties)

Instance / other functions (3)
  • class:hasSprite()
  • class:createSprite()
  • class:removeSprite()

coromonLabHatch

classes.spawnables.coromonLabHatch

  • returns coromonLabHatch

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.sprites.LuxSolisHatch

  • coromonLabHatch:new(_options, _tiledProperties)

Instance / other functions (7)
  • class:getRequiredSounds()
  • class:hasSprite()
  • class:createSprite()
  • class:open(_onComplete)
  • class:closeSilent(_onComplete)
  • class:close(_onComplete)
  • class:onAfterSpawn()

crimsoniteElectricGate

classes.spawnables.crimsoniteElectricGate

  • returns crimsoniteElectricGate

  • requires: classes.spawnables.worldObjectSpawnable, classes.interface.overlays.worldLostOverlayBuilder, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.blockingSpawnablePlugin

  • crimsoniteElectricGate:new(_options, _tiledProperties)

Instance / other functions (6)
  • class:getRequiredSounds()
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:manualStart()
  • class:manualStop()
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)
  • class:doHitAnimation(_player)

crimsoniteHeatedWaterArea

classes.spawnables.crimsoniteHeatedWaterArea

  • returns crimsoniteHeatedWaterArea

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.triggerableSpawnablePlugin

  • crimsoniteHeatedWaterArea:new(_options, _tiledProperties)

Instance / other functions (3)
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)
  • class:onRender()
  • class:onCull()

crimsoniteIceSpikes

classes.spawnables.crimsoniteIceSpikes

  • returns crimsoniteIceSpikes

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.blockingSpawnablePlugin, classes.interface.overlays.worldLostOverlayBuilder

  • crimsoniteIceSpikes:new(_options, _tiledProperties)

Instance / other functions (2)
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)
  • class:doHitAnimation(_player)

crimsoniteMachine

classes.spawnables.crimsoniteMachine

  • returns crimsoniteMachine

  • requires: classes.spawnables.worldObjectSpawnable

  • crimsoniteMachine:new(_options, _tiledProperties)

Instance / other functions (2)
  • class:hasSprite()
  • class:createSprite()

crimsonitePillar

classes.spawnables.crimsonitePillar

  • returns crimsonitePillar

  • requires: classes.spawnables.abstractMovingSpawnable, classes.interface.overlays.worldLostOverlayBuilder, classes.spawnables.plugins.rotatableSpawnablePlugin, classes.spawnables.extensions.autoRotatableSpawnableExtension

  • crimsonitePillar:new(_options, _tiledProperties)

Instance / other functions (10)
  • class:onRotate(_direction, _isInitialRotation)
  • class:isCullable()
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:update()
  • class:startRolling()
  • class:onAllSpawnablesSpawned()
  • class:finalize()
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)
  • class:canBeBlockedBy(_spawnable)
  • class:doHitAnimation(_player)
Fields with default values (28)
  • crimsonitePillar.horizontal_2.width = 18
  • crimsonitePillar.horizontal_2.height = 33
  • crimsonitePillar.horizontal_2.path = "maps/all/objects/pushables/"
  • crimsonitePillar.horizontal_2.file = "pillar_crimsoniteAura_horizontal.png"
  • crimsonitePillar.horizontal_2.amount_frames = 4
  • crimsonitePillar.horizontal_2.spriteSortLayerOffset = -3
  • crimsonitePillar.horizontal_2.sequences = {}
  • crimsonitePillar.vertical_2.width = 34
  • crimsonitePillar.vertical_2.height = 20
  • crimsonitePillar.vertical_2.path = "maps/all/objects/pushables/"
  • crimsonitePillar.vertical_2.file = "pillar_crimsoniteAura_vertical.png"
  • crimsonitePillar.vertical_2.amount_frames = 4
  • crimsonitePillar.vertical_2.spriteSortLayerOffset = -3
  • crimsonitePillar.vertical_2.sequences = {}
  • crimsonitePillar.horizontal_3.width = 18
  • crimsonitePillar.horizontal_3.height = 49
  • crimsonitePillar.horizontal_3.path = "maps/all/objects/pushables/"
  • crimsonitePillar.horizontal_3.file = "bigPillar_crimsoniteAura_horizontal.png"
  • crimsonitePillar.horizontal_3.amount_frames = 4
  • crimsonitePillar.horizontal_3.spriteSortLayerOffset = -3
  • crimsonitePillar.horizontal_3.sequences = {}
  • crimsonitePillar.vertical_3.width = 50
  • crimsonitePillar.vertical_3.height = 20
  • crimsonitePillar.vertical_3.path = "maps/all/objects/pushables/"
  • crimsonitePillar.vertical_3.file = "bigPillar_crimsoniteAura_vertical.png"
  • crimsonitePillar.vertical_3.amount_frames = 4
  • crimsonitePillar.vertical_3.spriteSortLayerOffset = -3
  • crimsonitePillar.vertical_3.sequences = {}

crimsonitePole

classes.spawnables.crimsonitePole

  • returns crimsonitePole

  • requires: classes.spawnables.worldObjectSpawnable

  • crimsonitePole:new(_options, _tiledProperties)

Instance / other functions (3)
  • class:hasSprite()
  • class:createSprite()
  • class:throwSpinner(_onComplete)

crimsoniteSandArea

classes.spawnables.crimsoniteSandArea

  • returns crimsoniteSandArea

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.triggerableSpawnablePlugin

  • crimsoniteSandArea:new(_options, _tiledProperties)

Instance / other functions (2)
  • class:getRequiredSounds()
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)

crimsoniteShard

classes.spawnables.crimsoniteShard

  • returns crimsoniteShard

  • requires: classes.spawnables.worldObjectSpawnable

  • crimsoniteShard:new(_options, _tiledProperties)

Instance / other functions (4)
  • class:hasSprite()
  • class:createSprite()
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:onAllSpawnablesSpawned()

cutsceneOnInteract

classes.spawnables.cutsceneOnInteract

  • returns cutsceneOnInteract

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.interactableSpawnablePlugin, classes.spawnables.extensions.cutsceneInteractableSpawnableExtension

  • cutsceneOnInteract:new(_options, _tiledProperties)

Instance / other functions (1)
  • class:getDefaultInteractText()

cutsceneOnTile

classes.spawnables.cutsceneOnTile

  • returns cutsceneOnTile

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.blockingSpawnablePlugin, classes.spawnables.plugins.constrainingSpawnablePlugin, classes.spawnables.plugins.triggerableSpawnablePlugin, classes.spawnables.extensions.blockingFunctionSpawnableExtension, classes.spawnables.extensions.constrainingFunctionSpawnableExtension, classes.spawnables.extensions.triggerableCutsceneSpawnableExtension

  • cutsceneOnTile:new(_options, _tiledProperties)

desertRouteCooldownArea

classes.spawnables.desertRouteCooldownArea

  • returns desertRouteCooldownArea

  • requires: classes.spawnables.checkpointArea

  • desertRouteCooldownArea:new(_options, _tiledProperties)

Instance / other functions (1)
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)

desertRouteSandArea

classes.spawnables.desertRouteSandArea

  • returns desertRouteSandArea

  • requires: classes.spawnables.sandFootstepArea

  • desertRouteSandArea:new(_options, _tiledProperties)

Instance / other functions (1)
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)

dojoGroundsPaintableFence

classes.spawnables.dojoGroundsPaintableFence

  • returns dojoGroundsPaintableFence

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.interactableSpawnablePlugin

  • dojoGroundsPaintableFence:new(_options, _tiledProperties)

Instance / other functions (3)
  • class:getRequiredSounds()
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractAction(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)

dojoJumpMachine

classes.spawnables.dojoJumpMachine

  • returns dojoJumpMachine

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.blockingSpawnablePlugin

  • dojoJumpMachine:new(_options, _tiledProperties)

Instance / other functions (7)
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)
  • class:getRequiredSounds()
  • class:hasSprite()
  • class:createSprite()
  • class:doPlayerJump()
  • class:reset(_onComplete)
  • class:start(_onEnded, _debugAutoJump)

door

classes.spawnables.door

  • returns door

  • requires: classes.spawnables.abstractDoor

  • door:new(_options, _tiledProperties)

Instance / other functions (2)
  • class:shouldSaveDoorState()
  • class:onBeforeSpawn()

drillShovelItem

classes.spawnables.drillShovelItem

  • returns drillShovelItem

  • requires: classes.spawnables.abstractItemCollection

  • drillShovelItem:new(_options, _tiledProperties)

Instance / other functions (3)
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:getRandomizableItemFor(_key)
  • class:onInteractReceiveItems(_spawnable, _onComplete)

dungeonDripArea

classes.spawnables.dungeonDripArea

  • returns dungeonDripArea

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin

  • dungeonDripArea:new(_options, _tiledProperties)

Instance / other functions (5)
  • class:isCullable()
  • class:getRequiredSounds()
  • class:onRender()
  • class:onCull()
  • class:onBeforeSpawn()

electricBeetleLabBatteryPack

classes.spawnables.electricBeetleLabBatteryPack

  • returns electricBeetleLabBatteryPack

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin

  • electricBeetleLabBatteryPack:new(_options, _tiledProperties)

Instance / other functions (2)
  • class:getRequiredSounds()
  • class:play(_onComplete)

emoji

classes.spawnables.emoji

  • returns emoji

  • requires: classes.spawnables.worldObjectSpawnable

  • emoji:new(_options, _tiledProperties)

Instance / other functions (2)
  • class:hasSprite()
  • class:createSprite()

fireTownBoulder

classes.spawnables.fireTownBoulder

  • returns fireTownBoulder

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.pushableSpawnablePlugin, classes.spawnables.plugins.tremorInteractSpawnablePlugin

  • fireTownBoulder:new(_options, _tiledProperties)

Instance / other functions (3)
  • class:onPush(_abstractCharacter, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:onTremorInteract(_onComplete)
  • class:onAfterTremorInteract(_onComplete)

fishArea

classes.spawnables.fishArea

  • returns fishArea

  • requires: classes.spawnables.fishingZoneArea

  • fishArea:new(_options, _tiledProperties)

Instance / other functions (4)
  • class:isCullable()
  • class:onRender()
  • class:onCull()
  • class:onBeforeSpawn()

fishingZoneArea

classes.spawnables.fishingZoneArea

  • returns fishingZoneArea

  • requires: classes.spawnables.abstractZoneArea

  • fishingZoneArea:new(_options, _tiledProperties)

floatingCoreStone

classes.spawnables.floatingCoreStone

  • returns floatingCoreStone

  • requires: classes.spawnables.worldObjectSpawnable

  • floatingCoreStone:new(_options, _tiledProperties)

Instance / other functions (7)
  • class:hasSprite()
  • class:createSprite()
  • class:startBreathing(_onBreathing)
  • class:getEquilibriumAnimationCameraY()
  • class:getEquilibriumAnimationBottomOffset()
  • class:triggerEquilibrium(_onComplete)
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)

floorIndicator

classes.spawnables.floorIndicator

  • returns floorIndicator

  • requires: classes.spawnables.plugins.collisionShapeSpawnablePlugin, classes.spawnables.worldObjectSpawnable

  • floorIndicator:new(_options, _tiledProperties)

Instance / other functions (7)
  • class:hasSprite()
  • class:createSprite()
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:createCollisionShapeObject(_sprite)
  • class:onStoppedColliding(_movingSpawnable)
  • class:onCollision(_movingSpawnable, _deltaXToEdge, _deltaYToEdge)
  • class:triggerCollision(_spawnable, _onComplete)

fogOfWarArea

classes.spawnables.fogOfWarArea

  • returns fogOfWarArea

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.triggerableSpawnablePlugin

  • fogOfWarArea:new(_options, _tiledProperties)

Instance / other functions (5)
  • class:show()
  • class:hide()
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)
  • class:hasSprite()
  • class:createSprite()

fruitGrowingPot

classes.spawnables.fruitGrowingPot

  • returns fruitGrowingPot

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.interactableSpawnablePlugin, classes.spawnables.plugins.burnableSpawnablePlugin, classes.interface.MilestoneAchievedPopup

  • fruitGrowingPot:new(_options, _tiledProperties)

Instance / other functions (14)
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractAction(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:canBeBurned(_abstractCharacter, _nextTileX, _nextTileY, _direction)
  • class:onBurn(_abstractCharacter, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:setAndSpawnFruitSprite(_itemUID, _stepsAlreadyComplete)
  • class:spawnFruitSprite()
  • self.updateFruitStageFunction()
  • class:destroyFruit()
  • class:destroyFruitSprite()
  • class:onRender()
  • class:onCull()
  • class:onAllSpawnablesSpawned()
  • class:onAfterUnloadTransition()
  • class:removeSprite()

ghostTownCandleFlame

classes.spawnables.ghostTownCandleFlame

  • returns ghostTownCandleFlame

  • requires: classes.spawnables.abstractActionTileZoneArea, classes.spawnables.plugins.burnableSpawnablePlugin, classes.spawnables.plugins.interactableSpawnablePlugin

  • ghostTownCandleFlame:new(_options, _tiledProperties)

Instance / other functions (9)
  • class:setLit(_boolean)
  • class:isLit()
  • class:canBeBurned(_abstractCharacter, _nextTileX, _nextTileY, _direction)
  • class:onBurn(_abstractCharacter, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractAction(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:setVisible(_bool)
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:removeSprite()

ghostTownHauntedSprite

classes.spawnables.ghostTownHauntedSprite

  • returns ghostTownHauntedSprite

  • requires: classes.spawnables.worldObjectSpawnable

  • ghostTownHauntedSprite:new(_options, _tiledProperties)

Instance / other functions (2)
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:removeSprite()

ghostTownMistSprite

classes.spawnables.ghostTownMistSprite

  • returns ghostTownMistSprite

  • requires: classes.spawnables.worldObjectSpawnable

  • ghostTownMistSprite:new(_options, _tiledProperties)

Instance / other functions (1)
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)

ghostTownPurrgyGate

classes.spawnables.ghostTownPurrgyGate

  • returns ghostTownPurrgyGate

  • requires: classes.spawnables.sensorDoor

  • ghostTownPurrgyGate:new(_options, _tiledProperties)

grassArea

classes.spawnables.grassArea

  • returns grassArea

  • requires: classes.spawnables.bottomMaskArea, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.burnableTilesPlugin, classes.spawnables.plugins.burnableSpawnablePlugin

  • grassArea:new(_options, _tiledProperties)

Instance / other functions (13)
  • class:getBottomMaskType()
  • class:getBottomMaskHeight()
  • class:shouldChangeBottomMaskPerFrame()
  • class:hasSprite()
  • class:createSprite()
  • class:onTileBurned(_tileX, _tileY)
  • class:getRequiredSounds()
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)
  • class:removeSprite()
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:onAttractOrRepelModuleActivated(_gauntletModule, _onComplete)
  • class:isAttractOrRepelModuleActivated()
  • class:tryRollMonsters()

gridOffsetArea

classes.spawnables.gridOffsetArea

  • returns gridOffsetArea

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.triggerableSpawnablePlugin

  • gridOffsetArea:new(_options, _tiledProperties)

Instance / other functions (1)
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)

hedgeArea

classes.spawnables.hedgeArea

  • returns hedgeArea

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.burnableSpawnablePlugin, classes.spawnables.plugins.burnableTilesPlugin

  • hedgeArea:new(_options, _tiledProperties)

Instance / other functions (2)
  • class:hasSprite()
  • class:createSprite()

hiddenItem

classes.spawnables.hiddenItem

  • returns hiddenItem

  • requires: classes.spawnables.abstractItemCollection

  • hiddenItem:new(_options, _tiledProperties)

Instance / other functions (6)
  • class:getRandomizableItemFor(_key)
  • class:onAfterSpawn()
  • self.setVisibility()
  • class:finalize()
  • class:blink(_onComplete)
  • class:onInteractReceiveItems(_spawnable, _onComplete)

houseTransferBeamLight

classes.spawnables.houseTransferBeamLight

  • returns houseTransferBeamLight

  • requires: classes.spawnables.worldObjectSpawnable

  • houseTransferBeamLight:new(_options, _tiledProperties)

Instance / other functions (5)
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:removeSprite()
  • class:setVisible(_bool)
  • class:setFrame(_frame)
  • class:setColor(_color)

houseTransferCapsule

classes.spawnables.houseTransferCapsule

  • returns houseTransferCapsule

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.teleporterPlugin, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.interactableSpawnablePlugin

  • houseTransferCapsule:new(_options, _tiledProperties)

Instance / other functions (10)
  • class:getRequiredSounds()
  • class:doPreLaunchSequence(_onComplete)
  • class:undoPreLaunchSequence(_onComplete)
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractAction(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:isCullable()
  • class:enterCapsule(_player, _onComplete)
  • class:closeCapsuleDoors(_onComplete)
  • class:showLaunchLights(_onComplete)
  • class:launch(_playerSprite, _capsuleSprite, _onComplete)

iceArea

classes.spawnables.iceArea

  • returns iceArea

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.triggerableSpawnablePlugin

  • iceArea:new(_options, _tiledProperties)

Instance / other functions (2)
  • class:getRequiredSounds()
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)

interactDoor

classes.spawnables.interactDoor

  • returns interactDoor

  • requires: classes.spawnables.abstractInteractDoor

  • interactDoor:new(_options, _tiledProperties)

Instance / other functions (2)
  • class:shouldSaveDoorState()
  • class:onOpenedByInteract(_spawnable, _nextTileX, _nextTileY, _direction, _optionalOnComplete)

item

classes.spawnables.item

  • returns item

  • requires: classes.spawnables.abstractItemSpawnable

  • item:new(_options, _tiledProperties)

Instance / other functions (1)
  • class:getFoundObtainableItems()

itemChest

classes.spawnables.itemChest

  • returns itemChest

  • requires: classes.spawnables.abstractItemChest

  • itemChest:new(_options, _tiledProperties)

Instance / other functions (2)
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:removeSprite()

ladder

classes.spawnables.ladder

  • returns ladder

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.teleporterPlugin, classes.spawnables.plugins.blockingSpawnablePlugin, classes.spawnables.plugins.constrainingSpawnablePlugin, classes.spawnables.plugins.interactableSpawnablePlugin

  • ladder:new(_options, _tiledProperties)

Instance / other functions (4)
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)
  • class:doConstrainingAction(_spawnable, _direction, _isGridMoveOff)
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractAction(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)

ledgeArea

classes.spawnables.ledgeArea

  • returns ledgeArea

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.triggerableSpawnablePlugin, classes.spawnables.plugins.blockingSpawnablePlugin, classes.spawnables.plugins.interactableSpawnablePlugin

  • ledgeArea:new(_options, _tiledProperties)

Instance / other functions (5)
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractAction(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:doInteractJump(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)

lockCameraArea

classes.spawnables.lockCameraArea

  • returns lockCameraArea

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.triggerableSpawnablePlugin

  • lockCameraArea:new(_options, _tiledProperties)

Instance / other functions (1)
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)

lockedRoomSprite

classes.spawnables.lockedRoomSprite

  • returns lockedRoomSprite

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin

  • lockedRoomSprite:new(_options, _tiledProperties)

Instance / other functions (4)
  • class:getRequiredSounds()
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:doLockedAnimation(_onComplete)
  • class:doOpenAnimation(_optionsOrOnComplete)

luxCannonTeleporter

classes.spawnables.luxCannonTeleporter

  • returns luxCannonTeleporter

  • requires: classes.spawnables.worldObjectSpawnable, classes.hexagon.RogueWorldInterface, classes.spawnables.plugins.floorIndicatorTargetSpawnablePlugin

  • luxCannonTeleporter:new(_options, _tiledProperties)

Instance / other functions (11)
  • class:hasSprite()
  • class:createSprite()
  • class:createOutlineSprite()
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:removeSprite()
  • class:onGainTraceFocus()
  • class:onLoseTraceFocus()
  • class:triggerCameraRecoil(_angle, _magnitude, _recoilDuration, _onComplete)
  • class:spawnTeleporterDiskTrail(_x, _y)
  • class:teleportToNextBiome(_spawnable)
  • class:onTriggeredByFloorIndicator(_spawnable, _onComplete)

luxElevator

classes.spawnables.luxElevator

  • returns luxElevator

  • requires: classes.spawnables.abstractInteractDoor, classes.spawnables.plugins.teleporterPlugin, classes.spawnables.plugins.triggerableSpawnablePlugin

  • luxElevator:new(_options, _tiledProperties)

Instance / other functions (10)
  • class:getRequiredSounds()
  • class:setFloorIndicatorArrivedState(_bool)
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:removeSprite()
  • class:transitionFloorSprite(_direction, _mode, _onComplete)
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onOpenedByInteract(_spawnable, _nextTileX, _nextTileY, _direction, _optionalOnComplete)
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)
  • class:onAllSpawnablesSpawned()

luxEscalator

classes.spawnables.luxEscalator

  • returns luxEscalator

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.teleporterPlugin, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.blockingSpawnablePlugin, classes.spawnables.plugins.triggerableSpawnablePlugin

  • luxEscalator:new(_options, _tiledProperties)

Instance / other functions (5)
  • class:getRequiredSounds()
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:removeSprite()

luxHealingMachine

classes.spawnables.luxHealingMachine

  • returns luxHealingMachine

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.interface.monsterHealthBarBuilder

  • luxHealingMachine:new(_options, _tiledProperties)

Instance / other functions (14)
  • class:getRequiredSounds()
  • class:getMonsters()
  • class:doHealingStartAnimation(_onComplete)
  • class:doRestore()
  • class:doHealingEndAnimation()
  • class:createMonitorOverlay(_onComplete)
  • monsterFillBarGreen:refreshAnimated()
  • monsterFillBar:refreshAnimated()
  • class:destroyMonitorOverlay()
  • class:createSpinners()
  • class:destroySpinners()
  • class:removeSprite()
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:doPlatesAnimation(_onComplete)

luxHealingMachineForBattleDome

classes.spawnables.luxHealingMachineForBattleDome

  • returns luxHealingMachineForBattleDome

  • requires: classes.spawnables.luxHealingMachine, classes.spawnables.plugins.interactableSpawnablePlugin, classes.spawnables.extensions.cutsceneInteractableSpawnableExtension

  • luxHealingMachineForBattleDome:new(_options, _tiledProperties)

Instance / other functions (8)
  • class:createSprite()
  • class:createMonitorOverlay(_onComplete)
  • class:setRestoredMonsters(_monsters)
  • class:getMonsters()
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:getRequiredSounds()
  • class:doRestore()
  • class:unlockRecoverEnergy(_onComplete)

luxSolisBoat

classes.spawnables.luxSolisBoat

  • returns luxSolisBoat

  • requires: classes.spawnables.abstractBoat

  • luxSolisBoat:new(_options, _tiledProperties)

luxStorageMachine

classes.spawnables.luxStorageMachine

  • returns luxStorageMachine

  • requires: classes.spawnables.worldObjectSpawnable

  • luxStorageMachine:new(_options, _tiledProperties)

luxTeleporter

classes.spawnables.luxTeleporter

  • returns luxTeleporter

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.blockingSpawnablePlugin, classes.spawnables.plugins.interactableSpawnablePlugin

  • luxTeleporter:new(_options, _tiledProperties)

Instance / other functions (8)
  • class:getRequiredSounds()
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractAction(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:doTeleportAnimation(_playerSpawnable, _onComplete)
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:removeSprite()
  • class:onAllSpawnablesSpawned()

mainCharacter

classes.spawnables.mainCharacter

  • returns mainCharacter

  • requires: classes.spawnables.abstractCharacter, classes.spawnables.plugins.inputReceivingMovingSpawnablePlugin

  • mainCharacter:new(_options, _tiledProperties)

Instance / other functions (22)
  • class:isNextTileBlocking(_nextTileX, _nextTileY, _direction, _speed)
  • class:isCurrentTileConstraining(_direction)
  • class:shouldRun()
  • class:getSelectedGauntletModuleUID()
  • class:mount(_mountableObject)
  • class:unmount()
  • class:getSpeakerName()
  • class:getSpeakerStyle()
  • class:isCullable()
  • class:onAllSpawnablesSpawned()
  • class:setTileLocation(_tileX, _tileY)
  • class:onRotate(_direction, _isInitialRotation)
  • class:updateInteractButton(_shouldUpdateInteractButtonTile)
  • class:setShouldHideWorldInterfaceUponStartCutscene(_shouldHideWorldInterfaceUponStartCutscene)
  • class:onStartCutscene()
  • class:onEndCutscene()
  • class:getCharacterConfig()
  • class:shouldIncludeCharacterArmAnimations(params)
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:onBodySlamStart()
  • class:onBodySlamComplete()
  • class:onGridMoveComplete(_tileX, _tileY)

mansionMazeTeleporterArea

classes.spawnables.mansionMazeTeleporterArea

  • returns mansionMazeTeleporterArea

  • requires: classes.spawnables.teleporterArea

  • mansionMazeTeleporterArea:new(_options, _tiledProperties)

Instance / other functions (1)
  • class:onBeforeTriggerTeleport(_abstractMovingSpawnable, _onComplete)

mescherRealmBridge

classes.spawnables.mescherRealmBridge

  • returns mescherRealmBridge

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.triggerableSpawnablePlugin

  • mescherRealmBridge:new(_options, _tiledProperties)

Instance / other functions (3)
  • class:getRequiredSounds()
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)
  • class:removeSprite()

mescherRealmDarkSoul

classes.spawnables.mescherRealmDarkSoul

  • returns mescherRealmDarkSoul

  • requires: classes.spawnables.abstractMescherRealmDarkSoul, classes.interface.overlays.worldLostOverlayBuilder, classes.spawnables.plugins.triggerableSpawnablePlugin

  • mescherRealmDarkSoul:new(_options, _tiledProperties)

Instance / other functions (8)
  • class:isCullable()
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:update()
  • class:onAllSpawnablesSpawned()
  • class:finalize()
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)
  • class:canBeBlockedBy(_spawnable)
  • class:doHitAnimation(_mountablePurrgy)

mescherRealmDreamSoul

classes.spawnables.mescherRealmDreamSoul

  • returns mescherRealmDreamSoul

  • requires: classes.spawnables.abstractMescherRealmDarkSoul, classes.spawnables.plugins.interactableSpawnablePlugin, classes.spawnables.extensions.cutsceneInteractableSpawnableExtension, classes.spawnables.plugins.dialogSpeakerSpawnablePlugin

  • mescherRealmDreamSoul:new(_options, _tiledProperties)

Instance / other functions (8)
  • class:getSpeakerName()
  • class:getSpeakerType()
  • class:getSpeakerStyle()
  • class:getSpeakerHead(_parent)
  • class:getDefaultInteractIcon()
  • class:getDefaultInteractText()
  • class:getSpeakerSpawnableAtTopCenterOffsetX()
  • class:getSpeakerSpawnableAtTopCenterOffsetY()

mescherRealmHumanSoul

classes.spawnables.mescherRealmHumanSoul

  • returns mescherRealmHumanSoul

  • requires: classes.spawnables.abstractMescherRealmDarkSoul, classes.spawnables.plugins.mountableObjectPlugin, classes.spawnables.plugins.rotatableSpawnablePlugin, classes.spawnables.extensions.autoRotatableSpawnableExtension, classes.spawnables.plugins.inputReceivingMovingSpawnablePlugin, classes.interface.overlays.worldLostOverlayBuilder

  • mescherRealmHumanSoul:new(_options, _tiledProperties)

Instance / other functions (9)
  • class:isCullable()
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)
  • class:canBeBlockedBy(_spawnable)
  • class:getGridMoveTimeBySpeed()
  • class:onGridMoveComplete(_tileX, _tileY)
  • class:onRotate(_direction, _isInitialRotation)
  • class:onRegisterMountedSpawnable(_mountingSpawnable)
  • class:onUnregisterMountedSpawnable(_mountingSpawnable)
  • class:doHitAnimation(_mountablePurrgy)

mescherRealmLightSoul

classes.spawnables.mescherRealmLightSoul

  • returns mescherRealmLightSoul

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.shadowSpawnablePlugin, classes.spawnables.plugins.triggerableSpawnablePlugin

  • mescherRealmLightSoul:new(_options, _tiledProperties)

Instance / other functions (5)
  • class:createShadowSprite()
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:getRequiredSounds()
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)
  • class:showAndHideBigFlasks(_amountOfFlasks, _amountOfFlasksObtained, _onComplete)

mescherRealmObstacle

classes.spawnables.mescherRealmObstacle

  • returns mescherRealmLightSoul

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.blockingSpawnablePlugin

  • mescherRealmObstacle:new(_options, _tiledProperties)

Instance / other functions (2)
  • class:switchActiveState()
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)

mescherRealmObstacleSwitch

classes.spawnables.mescherRealmObstacleSwitch

  • returns mescherRealmObstacleSwitch

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.interactableSpawnablePlugin

  • mescherRealmObstacleSwitch:new(_options, _tiledProperties)

Instance / other functions (6)
  • class:getRequiredSounds()
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:removeSprite()
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractAction(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:doCatScratch(_player, _onHit)
Fields with default values (18)
  • mescherRealmObstacleSwitch.switch_pink_purple.width = 15
  • mescherRealmObstacleSwitch.switch_pink_purple.height = 20
  • mescherRealmObstacleSwitch.switch_pink_purple.amount_frames = 7
  • mescherRealmObstacleSwitch.switch_pink_purple.path = "maps/mescherRealm/objects/mescherRealmObstacle/"
  • mescherRealmObstacleSwitch.switch_pink_purple.file = "switch_pink_purple.png"
  • mescherRealmObstacleSwitch.switch_pink_purple.sequences = {}
  • mescherRealmObstacleSwitch.switch_pink_red.width = 15
  • mescherRealmObstacleSwitch.switch_pink_red.height = 20
  • mescherRealmObstacleSwitch.switch_pink_red.amount_frames = 7
  • mescherRealmObstacleSwitch.switch_pink_red.path = "maps/mescherRealm/objects/mescherRealmObstacle/"
  • mescherRealmObstacleSwitch.switch_pink_red.file = "switch_pink_red.png"
  • mescherRealmObstacleSwitch.switch_pink_red.sequences = {}
  • mescherRealmObstacleSwitch.switch_purple_red.width = 13
  • mescherRealmObstacleSwitch.switch_purple_red.height = 16
  • mescherRealmObstacleSwitch.switch_purple_red.amount_frames = 7
  • mescherRealmObstacleSwitch.switch_purple_red.path = "maps/mescherRealm/objects/mescherRealmObstacle/"
  • mescherRealmObstacleSwitch.switch_purple_red.file = "switch_purple_red.png"
  • mescherRealmObstacleSwitch.switch_purple_red.sequences = {}

minecart

classes.spawnables.minecart

  • returns minecart

  • requires: classes.spawnables.abstractMovingSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.mountableObjectPlugin, classes.spawnables.plugins.interactableSpawnablePlugin, classes.spawnables.plugins.constrainingSpawnablePlugin

  • minecart:new(_options, _tiledProperties)

Instance / other functions (14)
  • class:getSelectedGauntletModuleUID()
  • class:getRequiredSounds()
  • class:receiveInput(_direction)
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractAction(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:doBeforeMountedSpawnableInteractAction(_spawnable, nextTileX, nextTileY, _direction)
  • class:doMountedSpawnableInteractAction(_spawnable, nextTileX, nextTileY, _direction, _onComplete)
  • class:onRegisterMountedSpawnable(_mountingSpawnable)
  • class:onUnregisterMountedSpawnable(_mountingSpawnable)
  • class:getGridMoveTimeBySpeed()
  • class:addMinecartTrackMove(_direction, _onComplete)
  • class:startMinecartTrackMove(_onComplete)
  • class:onBeforeGridMove(_gridMoveData)
  • class:whileMovingOnGrid(_direction, _movedX, _movedY)

minecartHole

classes.spawnables.minecartHole

  • returns minecartHole

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.triggerableSpawnablePlugin, classes.interface.overlays.worldLostOverlayBuilder

  • minecartHole:new(_options, _tiledProperties)

Instance / other functions (1)
  • class:onTriggerActionWithOnComplete(_spawnable, _mode, _tileX, _tileY, _onComplete)

minecartTrack

classes.spawnables.minecartTrack

  • returns minecartTrack

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.pushableSpawnablePlugin, classes.spawnables.plugins.triggerableSpawnablePlugin

  • minecartTrack:new(_options, _tiledProperties)

Instance / other functions (3)
  • class:toggle(_gridMoveDirectionByCharacterDirection)
  • class:onPush(_abstractCharacter, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)

minecartTrackSwitch

classes.spawnables.minecartTrackSwitch

  • returns minecartTrackSwitch

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.interactableSpawnablePlugin

  • minecartTrackSwitch:new(_options, _tiledProperties)

Instance / other functions (5)
  • class:getRequiredSounds()
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractAction(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:onBeforeSpawn()
  • class:onAllSpawnablesSpawned()

monster

classes.spawnables.monster

  • returns monster

  • requires: classes.spawnables.abstractMonster, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.behavingCullablePlugin, classes.spawnables.plugins.rotatableSpawnablePlugin, classes.spawnables.plugins.interactableSpawnablePlugin, classes.spawnables.extensions.cutsceneInteractableSpawnableExtension, classes.spawnables.extensions.cutsceneInteractableDialogSpeakerSpawnableExtension

  • monster:new(_options, _tiledProperties)

Instance / other functions (17)
  • class:setMonsterForIdentifierPropertyWhileDelayed(_monster)
  • class:getMonsterUID()
  • class:getSpeakerName()
  • class:getMonsterSpeakerType()
  • class:getDefaultInteractIcon()
  • class:getDefaultInteractText()
  • class:createSprite()
  • class:resolveSpriteSkinUID()
  • class:getRequiredSounds()
  • class:onInteractAction(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:playCrySound()
  • class:onRotate(_direction, _isInitialRotation)
  • class:doFadeOutAndDestroy(_optionalOnComplete)
  • class:doFadeOutAndDestroySpawnableAndNeverSpawnAgain(_optionalOnComplete)
  • class:getOrCreateMonster(_isStarter)
  • class:createPlayerMonster(_isStarter)
  • class:onRender()

mountablePurrgy

classes.spawnables.mountablePurrgy

  • returns mountablePurrgy

  • requires: classes.spawnables.monster, classes.spawnables.plugins.mountableObjectPlugin, classes.spawnables.plugins.inputReceivingMovingSpawnablePlugin

  • mountablePurrgy:new(_options, _tiledProperties)

Instance / other functions (9)
  • class:doLightSoulObtainedAnimation(_shouldTeleportAway, _onComplete)
  • class:getGridMoveTimeBySpeed()
  • class:onRegisterMountedSpawnable(_mountingSpawnable)
  • class:onUnregisterMountedSpawnable(_mountingSpawnable)
  • class:onRotate(_direction, _isInitialRotation)
  • class:onGridMoveComplete(_tileX, _tileY)
  • class:getSelectedGauntletModuleUID()
  • class:onInteractAction(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:isCullable()

outpostHouse

classes.spawnables.outpostHouse

  • returns outpostHouse

  • requires: classes.spawnables.plugins.floorIndicatorTargetSpawnablePlugin, classes.spawnables.worldObjectSpawnable, classes.hexagon.RogueWorldInterface

  • outpostHouse:new(_options, _tiledProperties)

Instance / other functions (8)
  • class:hasSprite()
  • class:createSprite()
  • class:createOutlineSprite()
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:removeSprite()
  • class:onGainTraceFocus()
  • class:onLoseTraceFocus()
  • class:onTriggeredByFloorIndicator(_spawnable, _onComplete)

palacePrisonGateControlPanel

classes.spawnables.palacePrisonGateControlPanel

  • returns palacePrisonGateControlPanel

  • requires: classes.spawnables.worldObjectSpawnable

  • palacePrisonGateControlPanel:new(_options, _tiledProperties)

Instance / other functions (6)
  • class:hasSprite()
  • class:createSprite()
  • class:showScanlineSuccessAnimation(_onComplete)
  • class:getDoor()
  • class:doLockDoor(_onComplete)
  • class:doUnlockDoor(_onComplete)

portal

classes.spawnables.portal

  • returns portal

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin

  • portal:new(_options, _tiledProperties)

Instance / other functions (5)
  • class:getRequiredSounds()
  • class:enableIndicator()
  • class:activateBeam(_onFullyCovered)
  • class:activateBeamReversed(_onFullyCovered, _onComplete)
  • class:onAfterSpawn()

portalLantern

classes.spawnables.portalLantern

  • returns portalLantern

  • requires: classes.spawnables.worldObjectSpawnable

  • portalLantern:new(_options, _tiledProperties)

Instance / other functions (1)
  • class:disable()

portalPillar

classes.spawnables.portalPillar

  • returns portalPillar

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.interactableSpawnablePlugin

  • portalPillar:new(_options, _tiledProperties)

Instance / other functions (11)
  • class:getRequiredSounds()
  • class:enable(_onTriggered)
  • class:disable()
  • class:spawnAnimation(_file, _isReverse, _onComplete)
  • class:changeStateToPuzzle(_index)
  • class:changeStateToPuzzleOnce()
  • class:animateToTypeLoop()
  • class:animateToTypeLoopDisabled()
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractAction(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:onAfterSpawn()

portalStone

classes.spawnables.portalStone

  • returns portalStone, uses coroutines

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.interactableSpawnablePlugin

  • portalStone:new(_options, _tiledProperties)

Instance / other functions (6)
  • class:getRequiredSounds()
  • class:walkToCenter(_spawnable, _onComplete)
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractAction(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:walkToCenterAndActivateTeleportation(_spawnable, _onComplete)
  • class:onAllSpawnablesSpawned()

potentialStatHardResetMachine

classes.spawnables.potentialStatHardResetMachine

  • returns potentialStatHardResetMachine

  • requires: classes.spawnables.abstractPotentialStatResetMachine

  • potentialStatHardResetMachine:new(_options, _tiledProperties)

Instance / other functions (6)
  • class:willGiveAwayMonster()
  • class:getPotentialStatResetGoldCost()
  • class:getNewPotentialStats(_monster)
  • class:getTallMonsterButtonOverlayContextText()
  • class:onBeforeShowTallMonsterButtonOverlay(_endCutscene, _showTallMonsterButtonOverlay)
  • class:onAfterMonsterGiven(_monster, _onComplete)

potentialStatHardResetMachineForBattleDome

classes.spawnables.potentialStatHardResetMachineForBattleDome

  • returns potentialStatHardResetMachineForBattleDome

  • requires: classes.spawnables.potentialStatHardResetMachine, classes.spawnables.extensions.cutsceneInteractableSpawnableExtension

  • potentialStatHardResetMachineForBattleDome:new(_options, _tiledProperties)

Instance / other functions (5)
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:createSprite()
  • class:getRequiredSounds()
  • class:unlockStageReset(_onComplete)
  • class:unlockPotentialStatReset(_onComplete)

potentialStatSoftResetMachine

classes.spawnables.potentialStatSoftResetMachine

  • returns potentialStatSoftResetMachine

  • requires: classes.spawnables.abstractPotentialStatResetMachine

  • potentialStatSoftResetMachine:new(_options, _tiledProperties)

Instance / other functions (6)
  • class:willGiveAwayMonster()
  • class:getPotentialStatResetGoldCost()
  • class:getNewPotentialStats(_monster)
  • class:getTallMonsterButtonOverlayContextText()
  • class:onBeforeShowTallMonsterButtonOverlay(_endCutscene, _showTallMonsterButtonOverlay)
  • class:onAfterMonsterGiven(_monster, _onComplete)

powerTowerDoorSwitch

classes.spawnables.powerTowerDoorSwitch

  • returns powerTowerDoorSwitch

  • requires: classes.spawnables.abstractPowerTowerSwitch

  • powerTowerDoorSwitch:new(_options, _tiledProperties)

Instance / other functions (3)
  • class:toggleDoors()
  • class:onInteractActivate(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractDeactivate(_spawnable, _nextTileX, _nextTileY, _direction)

powerTowerElevatorPlatformDown

classes.spawnables.powerTowerElevatorPlatformDown

  • returns powerTowerElevatorPlatformDown

  • requires: classes.spawnables.abstractPowerTowerElevatorPlatform

  • powerTowerElevatorPlatformDown:new(_options, _tiledProperties)

Instance / other functions (2)
  • class:onSteppedOnCenterOfPowerTowerPlatform(_playerSpawnable)
  • class:onSpawnedOnPowerTowerElevatorPlatformLocation(_playerSpawnable, _onComplete)

powerTowerElevatorPlatformUp

classes.spawnables.powerTowerElevatorPlatformUp

  • returns powerTowerElevatorPlatformUp

  • requires: classes.spawnables.abstractPowerTowerElevatorPlatform

  • powerTowerElevatorPlatformUp:new(_options, _tiledProperties)

Instance / other functions (3)
  • class:onSteppedOnCenterOfPowerTowerPlatform(_playerSpawnable)
  • class:onSpawnedOnPowerTowerElevatorPlatformLocation(_playerSpawnable)
  • class:onSpawn()

powerTowerMastermindButton

classes.spawnables.powerTowerMastermindButton

  • returns powerTowerMastermindButton

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.blockingSpawnablePlugin, classes.spawnables.plugins.constrainingSpawnablePlugin, classes.spawnables.plugins.interactableSpawnablePlugin

  • powerTowerMastermindButton:new(_options, _tiledProperties)

Instance / other functions (3)
  • class:doConstrainingAction(_spawnable, _direction, _isGridMoveOff)
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractAction(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)

powerTowerMastermindDoor

classes.spawnables.powerTowerMastermindDoor

  • returns powerTowerMastermindDoor

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.blockingSpawnablePlugin, classes.spawnables.plugins.interactableSpawnablePlugin

  • powerTowerMastermindDoor:new(_options, _tiledProperties)

Instance / other functions (23)
  • class:getRequiredSounds()
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractAction(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:setFuseSprite(_index, _itemUID)
  • class:setFuse(_index, _itemUID)
  • class:ejectFuse(_index, _onComplete)
  • class:ejectFuses(_onComplete)
  • class:getColorsWithNils()
  • class:hideWires(_onComplete)
  • class:showWire(_index, _color)
  • class:showTimer(_seconds)
  • class:destroyTimer()
  • class:showSuccessIndicator()
  • class:hideSuccessIndicator(_onComplete)
  • class:showFailIndicator(_faultyWireIndices)
  • class:open(_onComplete)
  • class:close(_onComplete)
  • class:setClosed()
  • class:hasSprite()
  • class:createSprite()
  • class:onSpawn()
  • class:remove()

powerTowerMastermindScreen

classes.spawnables.powerTowerMastermindScreen

  • returns powerTowerMastermindScreen

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin

  • powerTowerMastermindScreen:new(_options, _tiledProperties)

Instance / other functions (18)
  • class:getPossibleFuseColors()
  • class:getRequiredSounds()
  • class:hasSprite()
  • class:createSprite()
  • class:setCodePeg(_parent, _column, _row, _color, _isAnimatedOrOnComplete)
  • class:setFeedback(_parent, _keyPegMode, _row, _optionalAmount)
  • class:calculateFeedback(_row, _colors, _onComplete)
  • class:clearHistoryPegs(_onComplete)
  • class:clearActivePegs(_onComplete)
  • class:failFlashAndHideWires(_emptyColors, _onComplete)
  • class:successFlash(_onComplete)
  • class:resetGame()
  • class:showActivePegs(_colorsWithNils, _onComplete)
  • class:guess(_onComplete)
  • class:unglitchHistory()
  • class:glitchHistory()
  • class:onCull()
  • class:onAfterSpawn()

powerTowerSwitch

classes.spawnables.powerTowerSwitch

  • returns powerTowerSwitch

  • requires: classes.spawnables.abstractPowerTowerSwitch

  • powerTowerSwitch:new(_options, _tiledProperties)

Instance / other functions (3)
  • class:shouldSaveActiveState()
  • class:onInteractActivate(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractDeactivate(_spawnable, _nextTileX, _nextTileY, _direction)

puddleReflectionArea

classes.spawnables.puddleReflectionArea

  • returns puddleReflectionArea

  • requires: classes.spawnables.reflectionArea, classes.spawnables.plugins.soundSpawnablePlugin

  • puddleReflectionArea:new(_options, _tiledProperties)

Instance / other functions (2)
  • class:getRequiredSounds()
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)

punchPlate

classes.spawnables.punchPlate

  • returns punchPlate

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.blockingSpawnablePlugin, classes.spawnables.plugins.pushableSpawnablePlugin

  • punchPlate:new(_options, _tiledProperties)

Instance / other functions (4)
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)
  • class:canBePushed(_abstractCharacter, _nextTileX, _nextTileY, _direction)
  • class:onPush(_abstractCharacter, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:onAfterSpawn()
Fields with default values (6)
  • punchPlate.luxSolis_left.width = 16
  • punchPlate.luxSolis_left.height = 32
  • punchPlate.luxSolis_left.path = "maps/all/objects/punchPlates/"
  • punchPlate.luxSolis_left.file = "luxSolis_left.png"
  • punchPlate.luxSolis_left.amount_frames = 9
  • punchPlate.luxSolis_left.sequences = {}

pushableObject

classes.spawnables.pushableObject

  • returns pushableObject

  • requires: classes.spawnables.abstractMovingSpawnable, classes.spawnables.plugins.pushableSpawnablePlugin, classes.spawnables.plugins.reflectionSpawnablePlugin

  • pushableObject:new(_options, _tiledProperties)

Instance / other functions (2)
  • class:onPush(_abstractCharacter, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:onBeforeGridMove(_gridMoveData)

pushableRollingObject

classes.spawnables.pushableRollingObject

  • returns pushableRollingObject

  • requires: classes.spawnables.abstractMovingSpawnable, classes.spawnables.plugins.pushableSpawnablePlugin

  • pushableRollingObject:new(_options, _tiledProperties)

Instance / other functions (4)
  • class:canBePushed(_abstractCharacter, _nextTileX, _nextTileY, _direction)
  • class:onPush(_abstractCharacter, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:getGridMoveEasing(_stepSpeed)
  • class:getGridMoveTimeBySpeed()
Fields with default values (144)
  • pushableRollingObject.winebarrel_vertical.width = 16
  • pushableRollingObject.winebarrel_vertical.height = 17
  • pushableRollingObject.winebarrel_vertical.path = "maps/all/objects/pushables/"
  • pushableRollingObject.winebarrel_vertical.file = "winebarrel_vertical.png"
  • pushableRollingObject.winebarrel_vertical.amount_frames = 3
  • pushableRollingObject.winebarrel_vertical.sequences = {}
  • pushableRollingObject.winebarrel_horizontal.width = 16
  • pushableRollingObject.winebarrel_horizontal.height = 20
  • pushableRollingObject.winebarrel_horizontal.path = "maps/all/objects/pushables/"
  • pushableRollingObject.winebarrel_horizontal.file = "winebarrel_horizontal.png"
  • pushableRollingObject.winebarrel_horizontal.amount_frames = 4
  • pushableRollingObject.winebarrel_horizontal.sequences = {}
  • pushableRollingObject.log_vertical.width = 31
  • pushableRollingObject.log_vertical.height = 16
  • pushableRollingObject.log_vertical.path = "maps/all/objects/pushables/"
  • pushableRollingObject.log_vertical.file = "log_vertical.png"
  • pushableRollingObject.log_vertical.amount_frames = 6
  • pushableRollingObject.log_vertical.sequences = {}
  • pushableRollingObject.log_horizontal.width = 16
  • pushableRollingObject.log_horizontal.height = 35
  • pushableRollingObject.log_horizontal.path = "maps/all/objects/pushables/"
  • pushableRollingObject.log_horizontal.file = "log_horizontal.png"
  • pushableRollingObject.log_horizontal.amount_frames = 6
  • pushableRollingObject.log_horizontal.spriteSortLayerOffset = -2
  • pushableRollingObject.log_horizontal.sequences = {}
  • pushableRollingObject.bigLog_vertical.width = 47
  • pushableRollingObject.bigLog_vertical.height = 16
  • pushableRollingObject.bigLog_vertical.path = "maps/all/objects/pushables/"
  • pushableRollingObject.bigLog_vertical.file = "bigLog_vertical.png"
  • pushableRollingObject.bigLog_vertical.amount_frames = 6
  • pushableRollingObject.bigLog_vertical.sequences = {}
  • pushableRollingObject.bigLog_horizontal.width = 16
  • pushableRollingObject.bigLog_horizontal.height = 47
  • pushableRollingObject.bigLog_horizontal.path = "maps/all/objects/pushables/"
  • pushableRollingObject.bigLog_horizontal.file = "bigLog_horizontal.png"
  • pushableRollingObject.bigLog_horizontal.amount_frames = 6
  • pushableRollingObject.bigLog_horizontal.spriteSortLayerOffset = -3
  • pushableRollingObject.bigLog_horizontal.sequences = {}
  • pushableRollingObject.log_swamp_vertical.width = 31
  • pushableRollingObject.log_swamp_vertical.height = 16
  • ... 104 more in api.json

pyramidDart

classes.spawnables.pyramidDart

  • returns pyramidDart

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.interface.overlays.worldLostOverlayBuilder

  • pyramidDart:new(_options, _tiledProperties)

Instance / other functions (7)
  • class:shootDart()
  • class:getRequiredSounds()
  • class:isCullable()
  • class:hasSprite()
  • class:createSprite()
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:removeSprite()

pyramidDartFloorSwitch

classes.spawnables.pyramidDartFloorSwitch

  • returns pyramidDartFloorSwitch

  • requires: classes.spawnables.abstractPyramidFloorSwitch

  • pyramidDartFloorSwitch:new(_options, _tiledProperties)

Instance / other functions (1)
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)

pyramidItemChest

classes.spawnables.pyramidItemChest

  • returns pyramidItemChest

  • requires: classes.spawnables.abstractItemChest

  • pyramidItemChest:new(_options, _tiledProperties)

Instance / other functions (1)
  • class:shouldAutomaticallyRemoveItemSpawnable()

pyramidSandArea

classes.spawnables.pyramidSandArea

  • returns grassArea

  • requires: classes.spawnables.bottomMaskArea, classes.spawnables.plugins.soundSpawnablePlugin

  • pyramidSandArea:new(_options, _tiledProperties)

Instance / other functions (5)
  • class:getBottomMaskType()
  • class:getBottomMaskHeight()
  • class:shouldChangeBottomMaskPerFrame()
  • class:getRequiredSounds()
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)

pyramidTableRiddleStatue

classes.spawnables.pyramidTableRiddleStatue

  • returns pyramidTableRiddleStatue

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.interactableSpawnablePlugin

  • pyramidTableRiddleStatue:new(_options, _tiledProperties)

Instance / other functions (5)
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractAction(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:setGem(_pyramidGemUID, _onComplete)
  • class:hasSprite()
  • class:createSprite()

pyramidWall

classes.spawnables.pyramidWall

  • returns pyramidWall

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.blockingSpawnablePlugin

  • pyramidWall:new(_options, _tiledProperties)

Instance / other functions (6)
  • class:setAllowPassthrough(_boolean)
  • class:getRequiredSounds()
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)
  • class:hasSprite()
  • class:createSprite()
  • class:transitionTo(_direction, _onComplete)

pyramidWallFloorSwitch

classes.spawnables.pyramidWallFloorSwitch

  • returns pyramidWallFloorSwitch

  • requires: classes.spawnables.abstractPyramidFloorSwitch

  • pyramidWallFloorSwitch:new(_options, _tiledProperties)

Instance / other functions (3)
  • class:getPyramidWallMotors()
  • class:createFloorSwitchIndicator(_floorSwitchContainer)
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)

pyramidWallMotor

classes.spawnables.pyramidWallMotor

  • returns pyramidWallMotor

  • requires: classes.spawnables.worldObjectSpawnable

  • pyramidWallMotor:new(_options, _tiledProperties)

Instance / other functions (4)
  • class:getPyramidWall()
  • class:show(_onComplete)
  • class:hide(_onComplete)
  • class:startRolling(_onComplete)

receptionGauntletPlatform

classes.spawnables.receptionGauntletPlatform

  • returns receptionGauntletPlatform

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin

  • receptionGauntletPlatform:new(_options, _tiledProperties)

Instance / other functions (4)
  • class:getRequiredSounds()
  • class:getItemUID()
  • class:open(_onComplete)
  • class:closeAndRemove(_onComplete)

reflectionArea

classes.spawnables.reflectionArea

  • returns reflectionArea

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.triggerableSpawnablePlugin

  • reflectionArea:new(_options, _tiledProperties)

Instance / other functions (1)
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)

reflectionCube

classes.spawnables.reflectionCube

  • returns reflectionCube

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.dialogSpeakerSpawnablePlugin

  • reflectionCube:new(_options, _tiledProperties)

Instance / other functions (12)
  • class:getCharacterConfig()
  • class:getRequiredSounds()
  • class:getSpeakerName()
  • class:getSpeakerType()
  • class:getSpeakerStyle()
  • class:getSpeakerHead(_parent)
  • class:getSpeakerSpawnableAtTopCenterOffsetX()
  • class:getSpeakerSpawnableAtTopCenterOffsetY()
  • class:startScanning()
  • class:stopScanning()
  • class:showSpinners(_onComplete)
  • class:destroySpinners()

researchLabFloatingCrimsoniteLumon

classes.spawnables.researchLabFloatingCrimsoniteLumon

  • returns researchLabFloatingCrimsoniteLumon

  • requires: classes.spawnables.monster

  • researchLabFloatingCrimsoniteLumon:new(_options, _tiledProperties)

Instance / other functions (4)
  • class:createSprite()
  • class:createShadowSprite()
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:removeSprite()

researchLabGauntletModuleTestMachine

classes.spawnables.researchLabGauntletModuleTestMachine

  • returns researchLabGauntletModuleTestMachine

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.sprites.LuxSolisHatch

  • researchLabGauntletModuleTestMachine:new(_options, _tiledProperties)

Instance / other functions (8)
  • class:getRequiredSounds()
  • class:isCullable()
  • class:hasSprite()
  • class:createSprite()
  • class:doBurnModuleTestAnimation(_onComplete)
  • class:doGauntletModuleTestAnimation(_onComplete)
  • class:doGauntletModuleTestAnimationAfterDelay(_isFromSpawn)
  • class:onSpawn()

researchLabTitanEssence

classes.spawnables.researchLabTitanEssence

  • returns researchLabTitanEssence

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.interactableSpawnablePlugin, classes.spawnables.extensions.cutsceneInteractableSpawnableExtension

  • researchLabTitanEssence:new(_options, _tiledProperties)

Instance / other functions (1)
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)

rogueMainCharacter

classes.spawnables.rogueMainCharacter

  • returns rogueMainCharacter

  • requires: classes.spawnables.roguePlayableCharacter, classes.hexagon.RogueWorldInterface, classes.spawnables.plugins.eightDirectionalInputReceivingMovingSpawnablePlugin

  • rogueMainCharacter:new(_options, _tiledProperties)

Instance / other functions (10)
  • class:getSpeakerName()
  • class:onAllSpawnablesSpawned()
  • class:setTileLocation(_tileX, _tileY)
  • class:updateInteractButton(_shouldUpdateInteractButtonTile)
  • class:ignorePlayerInput()
  • class:stopIgnoringPlayerInput()
  • class:isIgnoringPlayerInput()
  • class:onStartCutscene()
  • class:onEndCutscene()
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)

rogueMonster

classes.spawnables.rogueMonster

  • returns monster

  • requires: classes.spawnables.abstractMonster, classes.spawnables.abstractEightDirectionalMovingSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.expressiveSpawnablePlugin, classes.spawnables.plugins.rogueDialogSpeakerSpawnablePlugin, classes.spawnables.plugins.shadowSpawnablePlugin, classes.spawnables.plugins.rotatableSpawnablePlugin

  • rogueMonster:new(_options, _tiledProperties)

Instance / other functions (18)
  • class:getMonsterUID()
  • class:getMonsterData()
  • class:getSpeakerName()
  • class:getMonsterSpeakerType()
  • class:getRequiredSounds()
  • class:playCrySound()
  • class:onRotate(_direction, _isInitialRotation)
  • class:resolvePotential()
  • class:resolvePotentialCategory()
  • class:getRogueDialogSpeakerName()
  • class:getRogueDialogSpeakerPortraitUID()
  • class:getExpressiveSpawnableAtTopCenterOffsetX()
  • class:getExpressiveSpawnableAtTopCenterOffsetY()
  • class:getSpeakerSpawnableAtTopCenterOffsetX()
  • class:getSpeakerSpawnableAtTopCenterOffsetY()
  • class:createShadowSprite()
  • class:hasSprite()
  • class:createSprite()

roguePlayableCharacter

classes.spawnables.roguePlayableCharacter

  • returns roguePlayableCharacter

  • requires: classes.spawnables.abstractRogueCharacter, classes.spawnables.plugins.floorIndicatorTargetSpawnablePlugin, classes.hexagon.RogueWorldInterface

  • roguePlayableCharacter:createSprite(_parent, _rogueCharacter, _isOutline)

  • roguePlayableCharacter:new(_options, _tiledProperties)

Instance / other functions (10)
  • class:getSpeakerName()
  • class:spawnStarter(_monsterDirection, _spawnAtDirection)
  • class:createRogueCharacterSprite(_isOutline)
  • class:hasSprite()
  • class:createSprite()
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:removeSprite()
  • class:onGainTraceFocus()
  • class:onLoseTraceFocus()
  • class:onTriggeredByFloorIndicator(_spawnable, _onComplete)

sandFootstepArea

classes.spawnables.sandFootstepArea

  • returns sandFootstepArea

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.triggerableSpawnablePlugin

  • sandFootstepArea:new(_options, _tiledProperties)

Instance / other functions (2)
  • class:getRequiredSounds()
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)

sensorDoor

classes.spawnables.sensorDoor

  • returns sensorDoor

  • requires: classes.spawnables.abstractDoor, classes.spawnables.plugins.triggerableSpawnablePlugin

  • sensorDoor:new(_options, _tiledProperties)

Instance / other functions (6)
  • class:isDoorTile(_nextTileX, _nextTileY)
  • class:isBlockingTile(_nextTileX, _nextTileY)
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)
  • class:onBeforeSpawn()
Fields with default values (8)
  • sensorDoor.shop_interior.doorTiles = {}
  • sensorDoor.shop_interior.blockingTiles = {}
  • sensorDoor.electricTown_lab_interior.doorTiles = {}
  • sensorDoor.electricTown_lab_interior.blockingTiles = {}
  • sensorDoor.luxSolisCampus_interior.doorTiles = {}
  • sensorDoor.luxSolisCampus_interior.blockingTiles = {}
  • sensorDoor.ghostTown_gate.doorTiles = {}
  • sensorDoor.ghostTown_gate.blockingTiles = {}

skiLift

classes.spawnables.skiLift

  • returns skiLift

  • requires: classes.spawnables.worldObjectSpawnable

  • skiLift:new(_options, _tiledProperties)

Instance / other functions (4)
  • class:isCullable()
  • class:onRender()
  • class:onCull()
  • class:startMovingCarts()

soundPlayer

classes.spawnables.soundPlayer

  • returns soundPlayer

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin

  • soundPlayer:new(_options, _tiledProperties)

Instance / other functions (2)
  • class:getRequiredSounds()
  • class:onSpawn()

sprite

classes.spawnables.sprite

  • returns sprite

  • requires: classes.spawnables.worldObjectSpawnable

  • sprite:new(_options, _tiledProperties)

stairsArea

classes.spawnables.stairsArea

  • returns stairsArea

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.triggerableSpawnablePlugin, classes.spawnables.plugins.blockingSpawnablePlugin, classes.spawnables.plugins.constrainingSpawnablePlugin

  • stairsArea:new(_options, _tiledProperties)

Instance / other functions (4)
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)
  • class:doConstrainingAction(_spawnable, _direction, _isGridMoveOff)
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)
  • class:onSpawn()

stationDoor

classes.spawnables.stationDoor

  • returns stationDoor

  • requires: classes.spawnables.abstractInteractDoor

  • stationDoor:new(_options, _tiledProperties)

Instance / other functions (2)
  • class:getRequiredSounds()
  • class:onOpenedByInteract(_spawnable, _nextTileX, _nextTileY, _direction, _optionalOnComplete)

surfboard

classes.spawnables.surfboard

  • returns surfboard

  • requires: classes.spawnables.abstractMovingSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.mountableObjectPlugin, classes.spawnables.plugins.rotatableSpawnablePlugin, classes.spawnables.extensions.autoRotatableSpawnableExtension, classes.spawnables.plugins.inputReceivingMovingSpawnablePlugin

  • surfboard:new(_options, _tiledProperties)

Instance / other functions (20)
  • class:getSelectedGauntletModuleUID()
  • class:getRequiredSounds()
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:isCullable()
  • class:spawnSplashSpite()
  • class:setUpSpriteLocation(_mountedSpawnable)
  • class:setDownSpriteLocation(_mountedSpawnable, _shouldSpawnSplashSprite)
  • class:doAscendAnimation(_onComplete)
  • class:doDescendAnimation(_onComplete)
  • class:doJumpImpactAnimation(_spawnable)
  • class:onRegisterMountedSpawnable(_mountingSpawnable)
  • class:onUnregisterMountedSpawnable(_mountingSpawnable)
  • class:onRotate(_direction, _isInitialRotation)
  • class:onBeforeGridMove(_gridMoveData)
  • class:gridMove(_gridMoveData, _onComplete)
  • class:getGridMoveTimeBySpeed()
  • class:onStartedMoving()
  • class:onStoppedMoving(_blocked)
  • class:finalize()
  • class:onGridMoveComplete(_tileX, _tileY)

surfboardInteractLedge

classes.spawnables.surfboardInteractLedge

  • returns surfboardInteractLedge

  • requires: classes.spawnables.ledgeArea

  • surfboardInteractLedge:new(_options, _tiledProperties)

Instance / other functions (3)
  • class:spawnSurfboard(_spawnable, _tileX, _tileY)
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:doInteractJump(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)

surfboardShortInteractLedge

classes.spawnables.surfboardShortInteractLedge

  • returns surfboardShortInteractLedge

  • requires: classes.spawnables.surfboardInteractLedge, classes.spawnables.plugins.constrainingSpawnablePlugin

  • surfboardShortInteractLedge:new(_options, _tiledProperties)

Instance / other functions (3)
  • class:doConstrainingAction(_spawnable, _direction, _isGridMoveOff)
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)

swampAlarm

classes.spawnables.swampAlarm

  • returns swampAlarm

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin

  • swampAlarm:new(_options, _tiledProperties)

Instance / other functions (5)
  • class:getRequiredSounds()
  • class:createHiddenScreenRect(_fillColor)
  • class:enable()
  • class:disable()
  • class:showWhitelistedIndicator(_onComplete)

swampMushroom

classes.spawnables.swampMushroom

  • returns swampMushroom

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.interactableSpawnablePlugin

  • swampMushroom:new(_options, _tiledProperties)

Instance / other functions (4)
  • class:onCull()
  • class:onRender()
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractAction(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)

swampPurrgyBell

classes.spawnables.swampPurrgyBell

  • returns swampPurrgyBell

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.interactableSpawnablePlugin

  • swampPurrgyBell:new(_options, _tiledProperties)

Instance / other functions (3)
  • class:getRequiredSounds()
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractAction(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)

swampRaft

classes.spawnables.swampRaft

  • returns swampRaft

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.teleporterPlugin, classes.spawnables.plugins.blockingSpawnablePlugin, classes.spawnables.plugins.triggerableSpawnablePlugin, classes.spawnables.plugins.constrainingSpawnablePlugin, classes.spawnables.plugins.interactableSpawnablePlugin

  • swampRaft:new(_options, _tiledProperties)

Instance / other functions (9)
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)
  • class:doConstrainingAction(_spawnable, _direction, _isGridMoveOff)
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractAction(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:removeSprite()
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)
  • class:onAllSpawnablesSpawned()
  • class:startSailing(_player, _isMapLoad)

teleporterArea

classes.spawnables.teleporterArea

  • returns teleporterArea

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.teleporterPlugin, classes.spawnables.plugins.triggerableSpawnablePlugin, classes.spawnables.plugins.triggerableTeleporterPlugin

  • teleporterArea:new(_options, _tiledProperties)

Instance / other functions (1)
  • class:onTriggerActionWithOnComplete(_spawnable, _mode, _tileX, _tileY, _onComplete)

teleporterDoor

classes.spawnables.teleporterDoor

  • returns teleporterDoor

  • requires: classes.spawnables.abstractDoor, classes.spawnables.plugins.teleporterPlugin, classes.spawnables.plugins.pushableSpawnablePlugin, classes.spawnables.plugins.triggerableSpawnablePlugin, classes.spawnables.plugins.triggerableTeleporterPlugin

  • teleporterDoor:new(_options, _tiledProperties)

Instance / other functions (3)
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)
  • class:onTriggerActionWithOnComplete(_spawnable, _mode, _tileX, _tileY, _onComplete)
  • class:onPush(_abstractCharacter, _nextTileX, _nextTileY, _direction, _onComplete)

teleporterHole

classes.spawnables.teleporterHole

  • returns teleporterHole

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.blockingSpawnablePlugin, classes.spawnables.plugins.triggerableSpawnablePlugin

  • teleporterHole:new(_options, _tiledProperties)

Instance / other functions (2)
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)
  • class:onTriggerActionWithOnComplete(_spawnable, _mode, _tileX, _tileY, _onComplete)

templeDungeonFallPlatform

classes.spawnables.templeDungeonFallPlatform

  • returns templeDungeonFallPlatform

  • requires: classes.spawnables.abstractTempleDungeonPlatform

  • templeDungeonFallPlatform:new(_options, _tiledProperties)

Instance / other functions (2)
  • class:alignHauntedGlowSprite(_hauntedGlowSprite)
  • class:onPlatformTriggered(_abstractCharacter)

templeDungeonSpringPlatform

classes.spawnables.templeDungeonSpringPlatform

  • returns templeDungeonSpringPlatform

  • requires: classes.spawnables.abstractTempleDungeonPlatform

  • templeDungeonSpringPlatform:new(_options, _tiledProperties)

Instance / other functions (4)
  • class:alignHauntedGlowSprite(_hauntedGlowSprite)
  • class:getRequiredSounds()
  • class:onPlatformTriggerCanceled(_abstractCharacter)
  • class:onPlatformTriggered(_abstractCharacter)

text

classes.spawnables.text

  • returns text

  • requires: classes.spawnables.worldObjectSpawnable

  • text:new(_options, _tiledProperties)

Instance / other functions (2)
  • class:hasSprite()
  • class:createSprite()

tiledSpawnable

classes.spawnables.tiledSpawnable

  • returns tiledSpawnable

  • requires: classes.spawnables.abstractSpawnable

  • tiledSpawnable:new(_options, _tiledProperties)

Instance / other functions (19)
  • class:getTileXInside(_tileX)
  • class:getTileYInside(_tileY)
  • class:getTilesInside(_tileX, _tileY)
  • class:hasReachedNewTile(_tileX, _tileY, _isSpawn)
  • class:setTileLocation(_tileX, _tileY)
  • class:setTileLocationX(_tileX)
  • class:setTileLocationY(_tileY)
  • class:translateTileLocation(_deltaTileX, _deltaTileY)
  • class:setLocation(_x, _y)
  • class:setLocationX(_x)
  • class:setLocationY(_y)
  • class:spawn()
  • class:spawnDelayed()
  • class:isDelayed()
  • class:setCurrentObjectLayerPropertiesByName(_layerName)
  • class:onBeforeSpawn()
  • class:onSpawn()
  • class:onAfterSpawn()
  • class:onAllSpawnablesSpawned()

titan

classes.spawnables.titan

  • returns titan

  • requires: classes.spawnables.abstractMonster, classes.spawnables.plugins.soundSpawnablePlugin

  • titan:new(_options, _tiledProperties)

Instance / other functions (8)
  • class:getMonsterUID()
  • class:resolveSpriteSkinUID()
  • class:getSpeakerName()
  • class:getMonsterSpeakerType()
  • class:doFadeOutAndDestroy(_optionalOnComplete)
  • class:createMonster()
  • class:getRequiredSounds()
  • class:doAbsorbAnimation(_onOutAnimation)

titanEssence

classes.spawnables.titanEssence

  • returns titanEssence

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.dialogSpeakerSpawnablePlugin, classes.spawnables.plugins.soundSpawnablePlugin

  • titanEssence:new(_options, _tiledProperties)

Instance / other functions (12)
  • class:getRequiredSounds()
  • class:getSpeakerName()
  • class:getSpeakerHead(_parent)
  • class:getSpeakerType()
  • class:getSpeakerStyle()
  • class:getSpeakerSpawnableAtTopCenterOffsetX()
  • class:getSpeakerSpawnableAtTopCenterOffsetY()
  • class:playSpawnSound()
  • class:showEssence(_onComplete)
  • class:doFadeOutAndDestroy(_optionalOnComplete)
  • class:showTitan()
  • class:hideTitan()

train

classes.spawnables.train

  • returns train

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin

  • train:new(_options, _tiledProperties)

Instance / other functions (11)
  • class:getRequiredSounds()
  • class:playWhistleSound()
  • class:hasSprite()
  • class:saveCurrentPositionState()
  • class:createTrainSprite(_suffix)
  • class:createSprite()
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:removeSprite()
  • class:openDoors(_onComplete)
  • class:closeDoors(_onComplete)
  • class:start(_distanceInTiles, _shouldAccelerate, _shouldDecelerate, _onComplete)

trainerHubBannerDisplay

classes.spawnables.trainerHubBannerDisplay

  • returns trainerHubBannerDisplay

  • requires: classes.spawnables.worldObjectSpawnable

  • trainerHubBannerDisplay:new(_options, _tiledProperties)

Instance / other functions (9)
  • class:hasSprite()
  • class:createSprite()
  • class:languageCodeChanged()
  • class:onBeforeSpawn()
  • class:finalize()
  • class:showRandomText(_onComplete)
  • class:showRandomTextAfterDelay(_delay)
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:removeSprite()

trainerHubConsecutiveWinsText

classes.spawnables.trainerHubConsecutiveWinsText

  • returns trainerHubConsecutiveWinsText

  • requires: classes.spawnables.worldObjectSpawnable

  • trainerHubConsecutiveWinsText:new(_options, _tiledProperties)

Instance / other functions (5)
  • class:hasSprite()
  • class:createSprite()
  • class:onlineConsecutiveWinsChanged()
  • class:onRender()
  • class:onCull()

treadmillArea

classes.spawnables.treadmillArea

  • returns treadmillArea

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.triggerableSpawnablePlugin

  • treadmillArea:new(_options, _tiledProperties)

Instance / other functions (9)
  • class:hasSprite()
  • class:getRequiredSounds()
  • class:getDirection()
  • class:setDirection(_direction)
  • class:createSprite()
  • class:onRender()
  • self.onFakeTreadmillSpriteFrameChanged()
  • class:onCull()
  • class:onTriggerAction(_spawnable, _mode, _tileX, _tileY)

treeItem

classes.spawnables.treeItem

  • returns treeItem

  • requires: classes.spawnables.abstractItemSpawnable, classes.spawnables.plugins.blockingSpawnablePlugin, classes.spawnables.plugins.tremorInteractSpawnablePlugin

  • treeItem:new(_options, _tiledProperties)

Instance / other functions (5)
  • class:getFoundObtainableItems()
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)
  • class:onTremorInteract(_onComplete)
  • class:onAfterTremorInteract(_onComplete)

tremorableCaveEntrance

classes.spawnables.tremorableCaveEntrance

  • returns tremorableCaveEntrance

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.tremorInteractSpawnablePlugin, classes.spawnables.plugins.blockingSpawnablePlugin, classes.spawnables.plugins.soundSpawnablePlugin

  • tremorableCaveEntrance:new(_options, _tiledProperties)

Instance / other functions (4)
  • class:getRequiredSounds()
  • class:doBlockingAction(_spawnable, _nextTileX, _nextTileY, _isGridMoveOn, _direction, _speed)
  • class:onTremorInteract(_onComplete)
  • class:onAfterTremorInteract(_onComplete)

vendingMachine

classes.spawnables.vendingMachine

  • returns vendingMachine

  • requires: classes.spawnables.worldObjectSpawnable, classes.spawnables.plugins.soundSpawnablePlugin, classes.spawnables.plugins.interactableSpawnablePlugin

  • vendingMachine:new(_options, _tiledProperties)

Instance / other functions (5)
  • class:setSprite(_sprite, _tileOffsetX, _tileOffsetY)
  • class:removeSprite()
  • class:getRequiredSounds()
  • class:doBeforeInteractAction(_spawnable, _nextTileX, _nextTileY, _direction)
  • class:onInteractAction(_spawnable, _nextTileX, _nextTileY, _direction, _onComplete)

worldObjectSpawnable

classes.spawnables.worldObjectSpawnable

  • returns worldObjectSpawnable

  • requires: classes.spawnables.tiledSpawnable, classes.spawnables.plugins.tiledObjectSpawnablePlugin, classes.spawnables.plugins.cullableSpawnablePlugin, classes.spawnables.plugins.saveableSpawnablePlugin, classes.spawnables.plugins.spriteSpawnablePlugin

  • worldObjectSpawnable:new(_options, _tiledProperties)

Instance / other functions (35)
  • class:saveCurrentPositionState()
  • class:startCutscene()
  • class:onStartCutscene()
  • class:endCutscene()
  • class:onEndCutscene()
  • class:isInCutscene()
  • class:getDynamicSoundVolume(_options, _minRange, _maxRange)
  • class:stopSound(_channel, _optionalOnCompleteToPreventSoundBug)
  • class:stopSounds()
  • class:playSound(_pathAlias, _options, _onComplete)
  • class:playUpdateableSound(_pathAlias, _options, _onComplete)
  • class:hasSprite()
  • class:createSprite()
  • class:doFadeIn(_onComplete)
  • class:doFadeOut(_onComplete)
  • class:onRender()
  • class:onCull()
  • class:isCullable()
  • class:calculateCullingOptions()
  • class:setCurrentTileProperties(_tileX, _tileY)
  • class:hasReachedNewTile(_tileX, _tileY, _isSpawn)
  • class:setTileLocation(_tileX, _tileY)
  • class:setLocation(_x, _y)
  • class:isWestOf(_spawnable)
  • class:isEastOf(_spawnable)
  • class:isNorthOf(_spawnable)
  • class:isSouthOf(_spawnable)
  • class:getRelativeDirectionOf(_spawnable)
  • class:getHorizontalRelativeDirectionOf(_spawnable)
  • class:getVerticalRelativeDirectionOf(_spawnable)
  • class:finalize()
  • class:remove()
  • class:setCurrentSpriteLayerPropertiesByName(_layerName)
  • class:onBeforeSpawn()
  • class:onSpawn()

wubbonianBoat

classes.spawnables.wubbonianBoat

  • returns wubbonianBoat

  • requires: classes.spawnables.abstractBoat

  • wubbonianBoat:new(_options, _tiledProperties)

zoneArea

classes.spawnables.zoneArea

  • returns zoneArea

  • requires: classes.spawnables.abstractActionTileZoneArea

  • zoneArea:new(_options, _tiledProperties)

Clone this wiki locally