Lua Scripting for Animations

Thanks to T6 for allowing me to reuse the UD wiki!

Be sure to check out his new Dokkan Wiki

Learn Lua

If you already have some minimal experience with programming: http://tylerneylon.com/a/learn-lua/
If you’re completely new to programming general: https://youtu.be/iMacxZQMPXs

Lua in Dokkan

Lua scripts for battle animations are not run live. The scripts are not executing while the animation is playing. The scripts are run before the animation plays to build a queue of instructions that the game code will execute.

Most of the scripts are…poorly maintained.

Variable Definitions:

-- The values of variables like the ones below are references to sound effects
-- They link to sound_effect_offsets.sound_effect_id
SE_01 = 1035;
SE_02 = 1036;
SE_XX = XXXX;

-- The values of the variables below are references LWF files
-- They link to effect_packs.id
SP_01 = 100230;
SP_02 = 100231;
SP_XX = XXXXXX;

-- These are not hard rules. Variables can be named anything, you don't have to follow the SE_XX nomenclature they established. (and they break this themselves)

How Lua Controls the Target

setDisp(frame, 1, 0) -- hide enemy
setDisp(frame, 1, 1) -- show enemy
changeAnime(frame, 1, sprite_sheet_scene_id - 100) -- change enemy sprite
setMoveKey(frame 1, x, y, z) -- move sprite to x, y, z
setScaleKey(frame, 1, width, height) -- change sprite size
setRotateKey(frame, 1, angle) -- change sprite rotation

Dokkan provides the following special functions that scripts can call:

-- I will provide parameters for all of these functions in the future
changeAnime()
dealDamage()
delayAll()
delayChara()
endPhase()
entryEffect(startCount, effectPackId, attributes, targetAssignMode, target, startOffsetPosX, startOffsetPosY, isPausable)
entryEffectAwaken()
entryEffectLife(startCount, effectPackId, life, attributes, targetAssignMode, target, startOffsetPosX, startOffsetPosY, isPausable)
entryEffectTraining()
entryEffectUnpausable(startCount, effectPackId, attributes, targetAssignMode, target, startOffsetPosX, startOffsetPosY)
entryFade()
entryFadeBg()
entryFlash()
entryFlashBg()
entryKakimoji()
gotoPhase()
hideCountdownLabel()
hideMessageLabel()
pauseAll()
pauseChara()
playSe()
playSeLife()
playVoice()
recover()
removeAllEffect()
removeAllFade()
removeAllFadeBg()
setAnimeLoop()
setBgGaussBlurKey()
setBgScroll()
setDamage()
setDisp()
setDrawFront()
setEffAlphaKey()
setEffColorKey()
setEffMoveKey()
setEffReplaceTexture()
setEffRotateKey()
setEffScaleKey()
setEffShake()
setEnableAutoXFlip()
setEnvZoomEnable()
setGaussBlurKey()
setLastPosKey()
setMoveKey()
setPhase()
setQuake()
setRotateKey()
setScaleKey()
setSeVolume()
setShake()
setShakeChara()
setVisibleUI()
setVoiceVolume()
setZanzou()
setZanzouColor()
setZanzouSpeed()
showCountdownLabel()
showMessageLabel()
startBgScroll()
stopBgScroll()
stopSe()
stopSeQueueId()
stopVoice()

ATTR_ENABLED = 0x01 -- ?
ATTR_LOADED = 0x02 -- ?
ATTR_PLAYING = 0x04 -- ?
ATTR_FINISHED = 0x08
ATTR_HASLIFE = 0x10
ATTR_UNKNOWN1 = 0x20
ATTR_UNKNOWN2 = 0x40 -- scale?
ATTR_BACKGROUND = 0x80
ATTR_UNKNOWN2 = 0x100
ATTR_REVERSE = 0x1000

Dokkan provides the following global variables that scripts can access:

_IS_DEAD_
_IS_DEAD_LAST_
_IS_PLAYER_SIDE_
_IS_EXTRA_ATTACK_
_IS_KI_100_
_IS_DOKKAN_MODE_
_IS_SPECIAL_ATTACK_
_IS_SPECIAL_AIM_ALL_
_IS_GUARD_
_IS_ZAWAKEN_
_IS_ATK_FLASH_MOVE_END_
_IS_DFC_FLASH_MOVE_END_
_IS_FINISH_SPECIAL_ONLY_
_IS_DODGE_
_IS_CRITICAL_
_SPECIAL_ENERGY_COLOR_
_SPECIAL_SKILL_LEVEL_