Lua API reference (latest)

1.0.0 - Covers all commits from r3504

Table of Contents All Lua Scripts Environment Variables Beauty Exports Boss Exports Buddy Exports Channel Exports Effect Exports Instance Exports Inventory Exports Map Exports Miscellaneous Exports Mob Exports NPC Exports Party Exports Player Exports Quest Exports Rate Exports Skill Exports Time Exports Portal Scripts Environment Variables Portal Exports Reactor Scripts Environment Variables Miscellaneous Exports Mob Exports Reactor Exports NPC Scripts Environment Variables Miscellaneous Exports NPC Exports Quest Exports Utility Lua-Based Scripts

All Lua Scripts

Environment Variables

• system_environment_id
• system_lua_version_major
• system_lua_version_minor
• system_lua_version
• system_player_id
• system_script
• system_path
• system_instance_name
• instance_timer
• msg_blue
• msg_red
• msg_notice
• msg_box
• gender_male
• gender_female
• boat_docked
• boat_undocked
• type_bool
• type_int
• type_num
• type_str
• portal_enabled
• portal_disabled
• line_beginner
• line_warrior
• line_magician
• line_bowman
• line_thief
• line_pirate
• progression_second
• progression_third
• progression_fourth
• item_mesos
• locale_global
• locale_korea
• locale_japan
• locale_china
• locale_europe
• locale_thailand
• locale_taiwan
• locale_sea
• locale_brazil
• env_version
• env_subversion
• env_is_test_server
• env_locale
• env_api_version

Beauty Exports

• getAllFaces
• getAllHairs
• getAllSkins
• getRandomFace
• getRandomHair
• getRandomSkin
• isValidFace
• isValidHair
• isValidSkin

Boss Exports

• getHorntailChannels
• getMaxHorntailBattles
• getMaxPapulatusBattles
• getMaxPianusBattles
• getMaxPinkBeanBattles
• getMaxZakumBattles
• getPapulatusChannels
• getPianusChannels
• getPinkBeanChannels
• getZakumChannels
• isHorntailChannel
• isPapulatusChannel
• isPianusChannel
• isPinkBeanChannel
• isZakumChannel

Buddy Exports

• addBuddySlots
• getBuddySlots

Channel Exports

• deleteChannelVariable
• getChannel
• getChannelVariable
• getWorld
• setChannelVariable
• showChannelMessage

Effect Exports

• playFieldSound
• playMinigameSound
• setMusic
• showMapEffect
• showMapEvent

Instance Exports

• addInstanceMap
• addInstanceParty
• addInstancePlayer
• checkInstanceTimer
• createInstance
• deleteInstanceVariable
• getAllInstancePlayerIds
• getInstancePlayerCount
• getInstancePlayerId
• getInstanceVariable
• isInstance
• isInstanceMap
• isInstancePersistent
• markForDelete
• moveAllPlayers
• passPlayersBetweenInstances
• removeAllInstancePlayers
• removeInstancePlayer
• respawnInstanceMobs
• respawnInstanceReactors
• revertInstance
• setInstance
• setInstancePersistence
• setInstanceReset
• setInstanceVariable
• showInstanceTime
• startInstanceFutureTimer
• startInstanceSecondOfHourTimer
• stopAllInstanceTimers
• stopInstanceTimer

Inventory Exports

• addSlots
• addStorageSlots
• destroyEquippedItem
• getEquippedItemInSlot
• getItemAmount
• getMaxStackSize
• getMesos
• getOpenSlots
• giveItem
• giveItemGachapon
• giveMesos
• hasOpenSlotsFor
• isEquippedItem
• isValidItem
• useItem

Map Exports

• clearDrops
• clearMobs
• countMobs
• setPortalState
• getAllMapPlayerIds
• getNumPlayers
• getReactorState
• killMobs
• setBoatDocked
• setMapSpawn
• setReactorState
• showMapMessage
• showMapTimer
• spawnMob
• spawnMobPos

Miscellaneous Exports

• consoleOutput
• getRandomNumber
• log
• selectDiscrete
• showGlobalMessage
• showWorldMessage
• testExport

Mob Exports

• getMobFh
• getMobHp
• getMobMaxHp
• getMobMaxMp
• getMobMp
• getMobPosX
• getMobPosY
• getRealMobId
• killMob
• mobDropItem

NPC Exports

• isBusy
• removeNpc
• runNpc
• showShop
• spawnNpc

Party Exports

• checkPartyFootholds
• getAllPartyPlayerIds
• getPartyCount
• getPartyId
• getPartyMapCount
• isPartyInLevelRange
• isPartyLeader
• verifyPartyFootholds
• warpParty

Player Exports

• deletePlayerVariable
• endMorph
• getAp
• getDex
• getExp
• getFace
• getFame
• getFh
• getGender
• getGmLevel
• getHair
• getHp
• getHpMpAp
• getId
• getInt
• getJob
• getLevel
• getLuk
• getMap
• getMaxHp
• getMaxMp
• getMp
• getName
• getPlayerVariable
• getPosX
• getPosY
• getRealMaxHp
• getRealMaxMp
• getSkin
• getSp
• getStr
• giveAp
• giveExp
• giveFame
• giveSp
• isActiveItem
• isActiveSkill
• isGm
• isOnline
• revertPlayer
• setAp
• setDex
• setExp
• setHp
• setInt
• setJob
• setLevel
• setLuk
• setMap
• setMaxHp
• setMaxMp
• setMp
• setPlayer
• setPlayerVariable
• setSp
• setStr
• setStyle
• showInstructionBubble
• showMessage

Quest Exports

• getQuestData
• isQuestActive
• isQuestInactive
• isQuestCompleted
• setQuestData

Rate Exports

• getDropMeso
• getDropRate
• getExpRate
• getGlobalDropMeso
• getGlobalDropRate
• getQuestExpRate

Skill Exports

• addSkillLevel
• getSkillLevel
• getMaxSkillLevel
• setMaxSkillLevel

Time Exports

• getDate
• getDay
• getHour
• getMinute
• getMonth
• getNearestMinute
• getSecond
• getTime
• getTimeZoneOffset
• getWeek
• getYear
• isDst

Portal Scripts

Environment Variables

• system_portal_name
• system_map_id

Portal Exports

• instantWarp
• playPortalSe
• portalFailed

Reactor Scripts

Environment Variables

• system_reactor_id
• system_map_id

Miscellaneous Exports

• getDistanceToPlayer

Mob Exports

• spawnZakum

Reactor Exports

• getState
• reset
• setState

NPC Scripts

Environment Variables

• answer_yes
• answer_no
• answer_accept
• answer_decline
• quiz_npc
• quiz_mob
• quiz_item

Miscellaneous Exports

• getDistanceToPlayer
• getNpcId
• showStorage

NPC Exports

• addText
• askAcceptDecline
• askAcceptDeclineNoExit
• askChoice
• askNumber
• askQuestion
• askQuiz
• askStyle
• askText
• askYesNo
• sendBackNext
• sendBackOk
• sendNext
• sendOk

Quest Exports

• addQuest
• endQuest

Utility Lua-Based Scripts

• beautyHelper.lua
• boatHelper.lua
• bossHelper.lua
• debugHelper.lua
• freeMarketHelper.lua
• gachaponHelper.lua
• itemProductionHelper.lua
• jobHelper.lua
• jsonHelper.lua
• mapManagerHelper.lua
• miniDungeonHelper.lua
• miscHelper.lua
• npcHelper.lua
• partyQuestHelper.lua
• quizHelper.lua
• signupHelper.lua
• tableHelper.lua