Skip to content
Overlunky/Playlunky Lua API
Search the API
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Menu
Home
Lua libraries
Global variables
STD library containers
Functions
Callback functions
Debug functions
Entity functions
Feat functions
Flag functions
Game patching functions
Generic functions
Input functions
Lighting functions
Message functions
Movable Behavior functions
Network functions
Option functions
Particle functions
Position functions
Room functions
Shop functions
Sound functions
Spawn functions
String functions
Texture functions
Theme functions
Tile code functions
io
os
package
Deprecated functions
Types
All types
Entity types
Background entities
BGBackLayerDoor
BGEggshipRoom
BGFloatingDebris
BGMovingStar
BGRelativeElement
BGShootingStar
BGShopEntrance
BGShopKeeperPrime
BGSurfaceLayer
BGSurfaceStar
BGTutorialSign
DestructibleBG
Effect entities
BurningRopeEffect
CursedEffect
FrostBreathEffect
OnFireEffect
PoisonedEffect
WetEffect
Floor entities
Altar
Arrowtrap
BigSpearTrap
CityOfGoldDoor
ConveyorBelt
DecoratedDoor
Door
EggShipDoor
EggShipDoorS
ExitDoor
Floor
ForceField
Generator
HorizontalForceField
JungleSpearTrap
LaserTrap
LockedDoor
MainExit
MotherStatue
Pipe
PoleDeco
QuickSand
SlidingWallCeiling
SparkTrap
SpikeballTrap
StickyTrap
TeleportingBorder
TentacleBottom
TimedForceField
TotemTrap
TransferFloor
Generic entities
BoulderSpawner
CameraFlash
CinematicAnchor
CrossBeam
DMAlienBlast
DMSpawning
DecoRegeneratingBlock
DustWallApep
EggplantThrower
Entity
IceSlidingSound
JungleTrapTrigger
Lava
LimbAnchor
Liquid
MummyFliesSound
OuroboroCameraAnchor
OuroboroCameraZoomin
PalaceSign
PipeTravelerSound
Portal
QuickSandSound
RoomLight
ShootingStarSpawner
SplashBubbleGenerator
Logical entities
LogicalAnchovyFlock
LogicalConveyorbeltSound
LogicalDoor
LogicalDrain
LogicalLiquidStreamSound
LogicalMiniGame
LogicalRegeneratingBlock
LogicalSound
LogicalStaticSound
LogicalTrapTrigger
Monsters, Inc.
Alien
Ammit
Anubis
ApepHead
ApepPart
Axolotl
Bat
Bee
Beg
Bodyguard
CatMummy
Caveman
CavemanShopkeeper
Cobra
Crabman
Critter
CritterBeetle
CritterButterfly
CritterCrab
CritterDrone
CritterFirefly
CritterFish
CritterLocust
CritterPenguin
CritterSlime
CritterSnail
Crocman
EggplantMinister
FireFrog
Firebug
FirebugUnchained
Fish
ForestSister
Frog
Ghist
Ghost
GiantFish
GiantFly
GiantFrog
GoldMonkey
Grub
HangSpider
Hermitcrab
HornedLizard
Hundun
HundunHead
Imp
Jiangshi
JumpDog
Kingu
Lahamu
Lamassu
Lavamander
Leprechaun
MagmaMan
Mantrap
Mech
MegaJellyfish
Mole
Monkey
Monster
Mosquito
Mount
Mummy
NPC
Necromancer
Octopus
Olmite
OsirisHand
OsirisHead
Pet
Player
PowerupCapable
ProtoShopkeeper
Qilin
Quillback
Robot
Rockdog
RoomOwner
Scarab
Scorpion
Shopkeeper
Skeleton
Sorceress
Spider
Tadpole
Terra
Tiamat
Tun
UFO
Vampire
VanHorsing
Vlad
Waddler
WalkingMonster
WitchDoctor
WitchDoctorSkull
Yama
Yang
YetiKing
YetiQueen
Movable entities
AcidBubble
AnkhPowerup
Arrow
AxolotlShot
Backpack
Birdies
Bomb
BoneBlock
Boombox
Boomerang
Boulder
Bow
Bullet
Button
Cape
Chain
ChainedPushBlock
Chest
ClamBase
Claw
ClimbableRope
CloneGunShot
Coffin
Coin
Container
CookFire
CrushElevator
Crushtrap
CursedPot
CustomMovableBehavior
Drill
DummyPurchasableEntity
EggSac
EggshipCenterJetFlame
Elevator
EmpressGrave
Excalibur
Explosion
FallingPlatform
Fireball
Flame
FlameSize
Fly
FlyHead
FrozenLiquid
FxAlienBlast
FxAnkhBrokenPiece
FxAnkhRotatingSpark
FxCompass
FxEmpress
FxFireflyLight
FxHundunNeckPiece
FxJellyfishStar
FxJetpackFlame
FxKinguSliding
FxLamassuAttack
FxMainExitDoor
FxNecromancerANKH
FxOuroboroDragonPart
FxOuroboroOccluder
FxPickupEffect
FxPlayerIndicator
FxQuickSand
FxSaleContainer
FxShotgunBlast
FxSorceressAttack
FxSparkSmall
FxSpringtrapRing
FxTiamatHead
FxTiamatTail
FxTiamatTorso
FxTornJournalPage
FxUnderwaterBubble
FxVatBubble
FxWaterDrop
FxWebbedEffect
FxWitchdoctorHint
GhostBreath
GiantClamTop
Goldbar
Gun
HangAnchor
HangStrand
Honey
Hoverpack
HundunChest
Idol
Jetpack
JungleSpearCosmetic
KapalaPowerup
LampFlame
Landmine
LaserBeam
Leaf
LightArrow
LightArrowPlatform
LightEmitter
LightShot
LiquidSurface
Mattock
MegaJellyfishEye
MiniGameAsteroid
MiniGameShip
MiniGameShipOffset
Movable
MovingIcon
Olmec
OlmecCannon
OlmecFloater
OlmecShip
Orb
ParachutePowerup
PlayerBag
PlayerGhost
Pot
Powerup
Present
PrizeDispenser
Projectile
PunishBall
Purchasable
PushBlock
RegenBlock
RollingItem
Rubble
Scepter
ScepterShot
Shield
SkullDropTrap
SleepBubble
SnapTrap
SoundShot
Spark
Spear
SpecialShot
StretchChain
Switch
TV
Teleporter
TeleporterBackpack
Telescope
Tentacle
ThinIce
TiamatShot
TimedPowderkeg
TimedShot
Torch
TorchFlame
TrapPart
Treasure
TreasureHook
TrueCrownPowerup
UdjatSocket
UnchainedSpikeBall
Ushabti
VanillaMovableBehavior
VladsCape
WallTorch
Web
WebShot
Whip
WoodenlogTrap
YellowCape
Non-Entity types
Arena types
ArenaConfigArenas
ArenaConfigEquippedItems
ArenaConfigItems
ArenaState
LogicArena1
LogicArenaAlienBlast
LogicArenaLooseBombs
Callback context types
GuiDrawContext
LoadContext
PostRoomGenerationContext
PreHandleRoomTilesContext
PreLoadLevelFilesContext
SaveContext
VanillaRenderContext
Entity related types
Ai
Animation
EntityDB
HudInventory
Inventory
Generic types
AABB
BackgroundMusic
Bucket
Color
ControllerButton
CustomBank
CustomEventDescription
CustomEventInstance
CutsceneBehavior
FMODguidMap
Hud
HudData
HudElement
HudMoney
HudPlayer
ItemOwnerDetails
JournalPageData
KeyboardKey
Letter
MagmamanSpawnPosition
MovableBehavior
Overlunky
PRNG
ParameterDescription
ParameterId
PauseAPI
Quad
RenderInfo
RoomOwnerDetails
RoomOwnersInfo
SaveState
SharedIO
ShortTileCodeDef
SpawnInfo
SpritePosition
StickersData
Triangle
UdpServer
Vec2
Input types
ControllerInput
Gamepad
ImGuiIO
InputMapping
PlayerInputs
RawInput
Journal types
JournalBestiaryData
JournalPage
JournalPageBestiary
JournalPageDeathCause
JournalPageDeathMenu
JournalPageDiscoverable
JournalPageFeats
JournalPageItems
JournalPageJournalMenu
JournalPageLastGamePlayed
JournalPagePeople
JournalPagePlaces
JournalPagePlayerProfile
JournalPageProgress
JournalPageTraps
JournalPeopleData
JournalTrapData
Levelgen types
LevelGenSystem
Lighting types
Illumination
LightParams
Liquid types
LiquidPhysics
LiquidPhysicsEngine
LiquidPhysicsParams
LiquidPool
Logic types
Logic
LogicApepTrigger
LogicBasecampSpeedrun
LogicCOGAnkhSacrifice
LogicChallenge
LogicDiceShop
LogicGhostToast
LogicList
LogicMagmamanSpawn
LogicMoonChallenge
LogicOlmecCutscene
LogicOuroboros
LogicStarChallenge
LogicSunChallenge
LogicTiamatBubbles
LogicTiamatCutscene
LogicTunPreChallenge
LogicTuskPleasurePalace
LogicTutorial
LogicUnderwaterBubbles
Online types
Online
OnlineLobby
OnlinePlayer
Particle types
Particle
ParticleDB
ParticleEmitterInfo
Savegame types
Constellation
ConstellationLine
ConstellationStar
SaveData
Screen types
FlyingThing
JournalPopupUI
JournalUI
MenuScreenPanels
OnlineLobbyScreenPlayer
PauseUI
SaveRelated
Screen
ScreenArenaIntro
ScreenArenaItems
ScreenArenaLevel
ScreenArenaMenu
ScreenArenaScore
ScreenArenaScoreLavaBubble
ScreenArenaStagesSelect
ScreenCamp
ScreenCharacterSelect
ScreenCodeInput
ScreenConstellation
ScreenControls
ScreenCredits
ScreenDeath
ScreenEnterOnlineCode
ScreenIntro
ScreenLevel
ScreenLogo
ScreenMenu
ScreenOnlineLoading
ScreenOnlineLobby
ScreenOptions
ScreenPrologue
ScreenRecap
ScreenScores
ScreenStateCamp
ScreenStateLevel
ScreenTeamSelect
ScreenTitle
ScreenTransition
ScreenWin
Sound types
BackgroundSound
CustomSound
PlayingSound
SoundInfo
SoundMeta
State types
Camera
GameManager
GameProps
Items
JournalProgressStainSlot
JournalProgressStickerSlot
PlayerSlot
PlayerSlotSettings
QuestsInfo
SelectPlayerSlot
StateMemory
Texture types
TextRenderingInfo
TextureDefinition
TextureRenderingInfo
Theme types
CustomTheme
ThemeInfo
Events
ON
THEME_OVERRIDE
Enums
About enums
BEG
BUTTON
CAUSE_OF_DEATH
CHAR_STATE
CONST
CORNER_FINISH
COSUBTHEME
DAMAGE_TYPE
DRAW_LAYER
DROP
DROPCHANCE
DYNAMIC_TEXTURE
ENTITY_OVERRIDE
ENT_FLAG
ENT_MORE_FLAG
ENT_TYPE
FADE
FEAT
FLOOR_SIDE
FMOD_LOADING_STATE
FMOD_LOAD_BANK_FLAGS
FMOD_PARAMETER_FLAGS
FMOD_PARAMETER_TYPE
FMOD_PLAYBACK_STATE
FMOD_STOP_MODE
GAMEPAD
GAMEPAD_FLAG
GAME_MODE
GAME_SETTING
GHOST_BEHAVIOR
HOTKEY_TYPE
HUNDUNFLAGS
INPUTS
INPUT_FLAG
JOURNALUI_PAGE_SHOWN
JOURNALUI_STATE
JOURNAL_FLAG
JOURNAL_PAGE_TYPE
JUNGLESISTERS
KEY
KEY_TYPE
LAYER
LEVEL_CONFIG
LIGHT_TYPE
LIQUID_POOL
LOGIC
MASK
MENU_INPUT
ON
PARTICLEEMITTER
PAUSE
PAUSEUI_VISIBILITY
PAUSE_SCREEN
PAUSE_TRIGGER
PAUSE_TYPE
PLATFORM
POS_TYPE
PRESENCE_FLAG
PRNG_CLASS
PROCEDURAL_CHANCE
QUEST_FLAG
RAW_BUTTON
RAW_DUALSHOCK
RAW_KEY
READY_STATE
RECURSIVE_MODE
RENDER_INFO_OVERRIDE
REPEAT_TYPE
ROOM_TEMPLATE
ROOM_TEMPLATE_TYPE
SAFE_SETTING
SCREEN
SHAPE
SHOP_TYPE
SOUND_LOOP_MODE
SOUND_TYPE
SPARROW
SPAWN_TYPE
TEXTURE
THEME
THEME_OVERRIDE
TILE_CODE
TUSK
VANHORSING
VANILLA_FONT_STYLE
VANILLA_SOUND
VANILLA_SOUND_CALLBACK_TYPE
VANILLA_SOUND_PARAM
VANILLA_TEXT_ALIGNMENT
WIN_STATE
WORLD_SHADER
YANG
Casting
Aliases
GitHub
Select theme
Dark
Light
Auto
SHAPE
source
Name
Value
Description
SHAPE.CIRCLE
CIRCLE
2
SHAPE.RECTANGLE
RECTANGLE
1