Pokémon 3D Wiki - User contributions [en]

Attack Scripting Portal

2013-03-03T11:52:30Z

DracoHouston:

'''Attack Scripting''' involves using LUA scripts to create attacks for pokemon.

==Tools==
* [http://unknownworlds.com/decoda/ Decoda] A free, open source LUA IDE with debugger
* [http://notepad-plus-plus.org/ Notepad++] Free text editor with LUA syntax highlighting

==Documentation==
* [[Attacks API]]

==Introduction==
Internally, an attack is an Attack object, which contains its stats and what it does. To set these attacks up we use LUA scripts. On launch, the engine will run a script called Attacks.lua contained in /Scripts/. Inside that is the move index, for example:

<syntaxhighlight lang="lua">
RegisterAttack(1,"Pound","The target is physically pounded with a long tail or a foreleg, etc.","Attacks\\Normal\\Pound")
RegisterAttack(2,"Karate Chop","The target is attacked with a sharp chop. Critical hits land more easily.","Attacks\\Fighting\\KarateChop")
RegisterAttack(3,"DoubleSlap","The target is slapped repeatedly and forth, two to five times in a row.","Attacks\\Normal\\DoubleSlap")
RegisterAttack(4,"Comet Punch","The target is hit with a flurry of punches that strike two to five times in a row.","Attacks\\Normal\\CometPunch")
RegisterAttack(5,"Mega Punch","The target is slugged by a punch thrown with muscle-packed power.","Attacks\\Normal\\MegaPunch")
</syntaxhighlight>

RegisterAttack is a global function that hooks into an engine function, the first of many such interfaces you will encounter. It sets up a move, giving it an ID number, name and description, then a script file to read for the rest. Let's look at attack #1, Pound

<syntaxhighlight lang="lua">
SetAttackBaseDamage(1,40)
SetAttackMaxPP(1,35)
SetAttackCategory(1,0)
SetAttackContestCategory(1,0)
SetAttackType(1,0)
SetAttackPriority(1,0)
SetAttackAccuracy(1,255)
</syntaxhighlight>

This is the most basic of attacks, it merely sets the stats up and it is done. Each of these functions take the attack ID number then the value. There are more settings. For example, this is Ember, a fully animated attack with a special effect

<syntaxhighlight lang="lua">
SetAttackBaseDamage(52,40)
SetAttackMaxPP(52,25)
SetAttackCategory(52,1)
SetAttackContestCategory(52,2)
SetAttackType(52,9)
SetAttackPriority(52,0)
SetAttackAccuracy(52,255)
SetAttackAttackingAnimationDelegate(52, "ATTACKS_FIRE_EMBER_ATTACKING_ANIMATION")
SetAttackHitAnimationDelegate(52, "ATTACKS_FIRE_EMBER_HIT_ANIMATION")
SetAttackSpecialAttackDelegate(52, "ATTACKS_FIRE_EMBER_SPECIAL")

function ATTACKS_FIRE_EMBER_SPECIAL()
Attacks_TryToBurn(30, "target")
end

function ATTACKS_FIRE_EMBER_ATTACKING_ANIMATION()
AnimationSequenceBegin()
AttacksSpawnMovingAnimation(0.0,0.0,0.0,"Textures\\Battle\\Fire\\EmberBall", 0.2, 0.2, 0.2, 4.0, 0.0, 0.0, 0.036, false, true, 0.0, 0.0)
for i = 0, 12, 1 do
AttacksSpawnOpacityAnimation(i * 0.2, 0.0, 0.0, "Textures\\Battle\\Fire\\Fire", 0.2, 0.2, 0.2, 0.01, false, 0.0, i * 0.6, 0.0)
end
AnimationSequenceEnd()
end

function ATTACKS_FIRE_EMBER_HIT_ANIMATION()
AnimationSequenceBegin()
AttacksSpawnMovingAnimation(2.4,0.0,0.0,"Textures\\Battle\\Fire\\EmberBall", 0.2, 0.2, 0.2, 0.0, 0.0, 0.0, 0.036, false, true, 0.0, 0.0)
for i = 0, 12, 1 do
AttacksSpawnOpacityAnimation(i * 0.2, 0.0, 0.0, "Textures\\Battle\\Fire\\Fire", 0.2, 0.2, 0.2, 0.01, false, 0.0, 7.2 - (i * 0.6), 0.0)
end
AttacksSpawnOpacityAnimation(0.1, 0.0, 0.0, "Textures\\Battle\\Fire\\Fire", 1.0, 1.0, 1.0, 0.01, false, 0.0, 7.2, 1.0)
AnimationSequenceEnd()
end
</syntaxhighlight>

Attacks API

2013-03-03T06:42:23Z

DracoHouston:

==Interface Functions==

===Attack Registration===

====[[RegisterAttack|RegisterAttack(ByVal ID As Integer, ByVal Name As String, ByVal Description As String, ByVal Script As String)]]====
====[[SetAttackBaseDamage|SetAttackBaseDamage(ByVal ID As Integer, ByVal val As Integer)]]====
====[[SetAttackMaxPP|SetAttackMaxPP(ByVal ID As Integer, ByVal val As Integer)]]====
====[[SetAttackType|SetAttackType(ByVal ID As Integer, ByVal val As Integer)]]====
====[[SetAttackAccuracy|SetAttackAccuracy(ByVal ID As Integer, ByVal val As Integer)]]====
====[[SetAttackContestCategory|SetAttackContestCategory(ByVal ID As Integer, ByVal val As Integer)]]====
====[[SetAttackCategory|SetAttackCategory(ByVal ID As Integer, ByVal val As Integer)]]====
====[[SetAttackAttackCategory|SetAttackAttackCategory(ByVal ID As Integer, ByVal val As Integer)]]====
====[[SetAttackAccuracyCheck|SetAttackAccuracyCheck(ByVal ID As Integer, ByVal val As Boolean)]]====
====[[SetAttackKingStoneAffected|SetAttackKingStoneAffected(ByVal ID As Integer, ByVal val As Boolean)]]====
====[[SetAttackPriority|SetAttackPriority(ByVal ID As Integer, ByVal val As Integer)]]====
====[[SetAttackEffectChance|SetAttackEffectChance(ByVal ID As Integer, ByVal val As Integer)]]====
====[[SetAttackHasAttackEffect|SetAttackHasAttackEffect(ByVal ID As Integer, ByVal val As Boolean)]]====
====[[SetAttackHasHitEffect|SetAttackHasHitEffect(ByVal ID As Integer, ByVal val As Boolean)]]====
====[[SetAttackIsHMMove|SetAttackIsHMMove(ByVal ID As Integer, ByVal val As Boolean)]]====
====[[SetAttackProtectDetectWorks|SetAttackProtectDetectWorks(ByVal ID As Integer, ByVal val As Boolean)]]====
====[[SetAttackMagicCatAffected|SetAttackMagicCatAffected(ByVal ID As Integer, ByVal val As Boolean)]]====
====[[SetAttackCanBeCopiedByMirrorMove|SetAttackCanBeCopiedByMirrorMove(ByVal ID As Integer, ByVal val As Boolean)]]====
====[[SetAttackRemoveFrozen|SetAttackRemoveFrozen(ByVal ID As Integer, ByVal val As Boolean)]]====
====[[SetAttackHighCriticalChance|SetAttackHighCriticalChance(ByVal ID As Integer, ByVal val As Boolean)]]====
====[[SetAttackIsHealingMove|SetAttackIsHealingMove(ByVal ID As Integer, ByVal val As Boolean)]]====
====[[SetAttackIsRoundBasedMove|SetAttackIsRoundBasedMove(ByVal ID As Integer, ByVal val As Boolean)]]====
====[[SetAttackDisabledWhileGravity|SetAttackDisabledWhileGravity(ByVal ID As Integer, ByVal val As Boolean)]]====
====[[SetAttackUseSuperEffective|SetAttackUseSuperEffective(ByVal ID As Integer, ByVal val As Boolean)]]====
====[[SetAttackUseNotEffective|SetAttackUseNotEffective(ByVal ID As Integer, ByVal val As Boolean)]]====
====[[SetAttackUseNotAffected|SetAttackUseNotAffected(ByVal ID As Integer, ByVal val As Boolean)]]====
====[[SetAttackTimesToAttack|SetAttackTimesToAttack(ByVal ID As Integer, ByVal val As Integer)]]====
====[[SetAttackAbsoluteDamage|SetAttackAbsoluteDamage(ByVal ID As Integer, ByVal val As Integer)]]====
====[[SetAttackAttackingAnimationDelegate|SetAttackAttackingAnimationDelegate(ByVal ID As Integer, ByVal s As String)]]====
====[[SetAttackHitAnimationDelegate|SetAttackHitAnimationDelegate(ByVal ID As Integer, ByVal s As String)]]====
====[[SetAttackSpecialAttackDelegate|SetAttackSpecialAttackDelegate(ByVal ID As Integer, ByVal s As String)]]====
====[[SetAttackOnUserSwitchDelegate|SetAttackOnUserSwitchDelegate(ByVal ID As Integer, ByVal s As String)]]====
====[[SetAttackPreAttackDelegate|SetAttackPreAttackDelegate(ByVal ID As Integer, ByVal s As String)]]====
====[[SetAttackMissedDelegate|SetAttackMissedDelegate(ByVal ID As Integer, ByVal s As String)]]====

===Event-Time Functions (non-animation)===
====[[Attacks_SetBaseDamage|Attacks_SetBaseDamage(ByVal val As Integer)]]====
====[[Attacks_SetStore|Attacks_SetStore(ByVal val As String)]]====
====[[Attacks_SetTimesToAttack|Attacks_SetTimesToAttack(ByVal val As Integer)]]====
====[[Attacks_SetAbsoluteDamage|Attacks_SetAbsoluteDamage(ByVal val As Integer)]]====
====[[Attacks_SetAccuracy|Attacks_SetAccuracy(ByVal val As Integer)]]====
====[[Attacks_AddBattleStep|Attacks_AddBattleStep(ByVal bstep As String, ByVal args As String)]]====
====[[Attacks_TryAddVolitileStatus|Attacks_TryAddVolitileStatus(ByVal target As String, ByVal statuseffect As String) As Boolean]]====
====[[Attacks_TryRemoveVolitileStatus|Attacks_TryRemoveVolitileStatus(ByVal target As String, ByVal statuseffect As String) As Boolean]]====
====[[Attacks_GetTargetAffectedByVolitileStatus|Attacks_GetTargetAffectedByVolitileStatus(ByVal target As String, ByVal statuseffect As String) As Boolean]]====
====[[Attacks_GetTargetStatusEffect|Attacks_GetTargetStatusEffect(ByVal target As String) As String]]====
====[[Attacks_GetTargetMoveTypeByIndex|Attacks_GetTargetMoveTypeByIndex(ByVal target As String, ByVal moveidx As Integer) As Integer]]====
====[[Attacks_GetTargetMovesByIndex|Attacks_GetTargetMovesByIndex(ByVal target As String, ByVal moveidx As Integer) As Integer]]====
====[[Attacks_SetTargetMoves|Attacks_SetTargetMoves(ByVal target As String, ByVal newmove1 As Integer, ByVal newmove2 As Integer, ByVal newmove3 As Integer, ByVal newmove4 As Integer)]]====
====[[Attacks_GetTargetStatsByName|Attacks_GetTargetStatsByName(ByVal target As String, ByVal statname As String) As Integer]]====
====[[Attacks_SetTargetStats|Attacks_SetTargetStats(ByVal target As String, ByVal atk As Integer, ByVal def As Integer, ByVal spatk As Integer, ByVal spdef As Integer, ByVal speed As Integer)]]====
====[[Attacks_SetTargetAnimationName|Attacks_SetTargetAnimationName(ByVal target As String, ByVal newname As String)]]====
====[[Attacks_GetTargetAnimationName|Attacks_GetTargetAnimationName(ByVal target As String) As String]]====
====[[Attacks_SetTargetTypes|Attacks_SetTargetTypes(ByVal target As String, ByVal type1idx As Integer, ByVal type2idx As Integer)]]====

===Animation Event Functions===

====[[AnimationSequenceBegin|AnimationSequenceBegin()]]====
====[[AnimationSequenceEnd|AnimationSequenceEnd()]]====
====[[AttacksSpawnOpacityAnimation|AttacksSpawnOpacityAnimation(ByVal PositionX As Single, ByVal PositionY As Single, ByVal PositionZ As Single, ByVal Texture As String, ByVal ScaleX As Single, ByVal ScaleY As Single, ByVal ScaleZ As Single, ByVal TransitionSpeed As Single, ByVal FadeIn As Boolean, ByVal EndState As Single, ByVal startDelay As Single, ByVal endDelay As Single)]]====
====[[AttacksSpawnMovingAnimation|AttacksSpawnMovingAnimation(ByVal PositionX As Single, ByVal PositionY As Single, ByVal PositionZ As Single, ByVal Texture As String, ByVal ScaleX As Single, ByVal ScaleY As Single, ByVal ScaleZ As Single, ByVal DestinationX As Single, ByVal DestinationY As Single, ByVal DestinationZ As Single, ByVal Speed As Single, ByVal SpinX As Boolean, ByVal SpinZ As Boolean, ByVal startDelay As Single, ByVal endDelay As Single)]]====
====[[AttacksSpawnBillMoveAnimation|AttacksSpawnBillMoveAnimation(ByVal DestinationX As Single, ByVal DestinationY As Single, ByVal DestinationZ As Single, ByVal Speed As Single, ByVal SpinX As Boolean, ByVal SpinZ As Boolean, ByVal startDelay As Single, ByVal endDelay As Single)]]====
====[[AttacksSpawnSoundAnimation|AttacksSpawnSoundAnimation(ByVal s As String, ByVal startDelay As Single, ByVal endDelay As Single)]]====
====[[AttacksSpawnSizeAnimation|AttacksSpawnSizeAnimation(ByVal PositionX As Single, ByVal PositionY As Single, ByVal PositionZ As Single, ByVal Texture As String, ByVal ScaleX As Single, ByVal ScaleY As Single, ByVal ScaleZ As Single, ByVal Grow As Boolean, ByVal EndSizeX As Single, ByVal EndSizeY As Single, ByVal EndSizeZ As Single, ByVal SizeSpeed As Single, ByVal startDelay As Single, ByVal endDelay As Single)]]====

==Event-Time Globals==
'''PLEASE NOTE THAT DURING ANIMATION DELEGATES YOU CAN ONLY ACCESS YOUR OWN GLOBALS, TARGET IS ALSO SET TO THE USER, IF YOUR ANIMATION REPLIES ON TARGET INFORMATION DO THE CHECK IN THE SPECIAL OR PREATTACK DELEGATE'''

'' '''ALSO, THESE ARE READ ONLY, SETTING THEM DOES NOTHING''' ''

====[[Attacks_Store]]====
String, unique to this instance of the attack, can be set at runtime [[Attacks_SetStore|see Attacks_SetStore]]
====[[Attacks_DamageDealt]]====
Number, the damage dealt by this attack. Always set to 0 except for inside Special Attack Delegates. For attacks with multiple hits, this is not the total damage dealt, but the damage dealt by that hit.
====[[Attacks_MyHP]]====
The user's HP
====[[Attacks_MyMaxHP]]====
The user's max HP
====[[Attacks_MyLevel]]====
The user's level
====[[Attacks_MyName]]====
The user's name
====[[Attacks_MyWeight]]====
The user's weight according to the pokedex
====[[Attacks_MyType1]]====
The user's 1st type
====[[Attacks_MyType2]]====
The user's 2nd type
====[[Attacks_PrimaryTargetHP]]====
The primary target of this attack's HP
====[[Attacks_PrimaryTargetMaxHP]]====
The primary target of this attack's max HP
====[[Attacks_PrimaryTargetLevel]]====
The primary target of this attack's level
====[[Attacks_PrimaryTargetName]]====
The primary target of this attack's name
====[[Attacks_PrimaryTargetWeight]]====
The primary target of this attack's weight according to the pokedex
====[[Attacks_PrimaryTargetType1]]====
The primary target of this attack's 1st type
====[[Attacks_PrimaryTargetType2]]====
The primary target of this attack's 2nd type
====[[Attacks_AdjacentTargetHP]]====
Does nothing, for double battles
====[[Attacks_AdjacentTargetHP1]]====
Does nothing, for double battles
====[[Attacks_AdjacentTargetHP2]]====
Does nothing, for double battles
====[[Attacks_AdjacentTargetLevel]]====
Does nothing, for double battles
====[[Attacks_AdjacentTargetLevel1]]====
Does nothing, for double battles
====[[Attacks_AdjacentTargetLevel2]]====
Does nothing, for double battles
====[[Attacks_AdjacentTargetName]]====
Does nothing, for double battles
====[[Attacks_AdjacentTargetName1]]====
Does nothing, for double battles
====[[Attacks_AdjacentTargetName2]]====
Does nothing, for double battles
====[[Attacks_AdjacentTargetWeight]]====
Does nothing, for double battles
====[[Attacks_AdjacentTargetWeight1]]====
Does nothing, for double battles
====[[Attacks_AdjacentTargetWeight2]]====
Does nothing, for double battles
====[[Attacks_AdjacentTargetType1]]====
Does nothing, for double battles
====[[Attacks_AdjacentTargetType11]]====
Does nothing, for double battles
====[[Attacks_AdjacentTargetType12]]====
Does nothing, for double battles
====[[Attacks_AdjacentTargetType2]]====
Does nothing, for double battles
====[[Attacks_AdjacentTargetType21]]====
Does nothing, for double battles
====[[Attacks_AdjacentTargetType22]]====
Does nothing, for double battles
====[[Attacks_AdjacentTargetMaxHP]]====
Does nothing, for double battles
====[[Attacks_AdjacentTargetMaxHP1]]====
Does nothing, for double battles
====[[Attacks_AdjacentTargetMaxHP2]]====
Does nothing, for double battles
====[[Attacks_EnvironmentType]]====
The map's environment type
* 0 = auto (day/night cycle)
* 1 = always day
* 2 = cave
* 3 = always dark
* 4 = underwater
====[[Attacks_EnvironmentDayPhase]]====
The map's day phase
* 0 = night
* 1 = dawn
* 2 = day
* 3 = dusk
====[[Attacks_EnvironmentWeather]]====
The map's weather (not battle weather)
* 0 = calm day
* 1 = raining
* 2 = snowing
* 3 = underwater
====[[Attacks_IsTrainerBattleFalse]]====
Set to true if in a trainer battle, false if in a battle with a wild pokemon
====[[Attacks_TargetString]]====
An internal engine string representing the target of the attack. If the target string is "0" it is targeting player 1, if it is "1" it is targeting player 2

==Helper Functions==
The following are not engine interfaces, but helper functions in the base game's Attacks.lua
====[[DoStatChanceAnimation|DoStatChanceAnimation(Change, startDelay)]]====
====[[Attacks_PlaceholderFireAttackAnimation|Attacks_PlaceholderFireAttackAnimation()]]====
====[[Attacks_PlaceholderFireHitAnimation|Attacks_PlaceholderFireHitAnimation()]]====
====[[Attacks_GetTypeIndexByName|Attacks_GetTypeIndexByName(typename)]]====
====[[Attacks_GetCategoryIndexByName|Attacks_GetCategoryIndexByName(typename)]]====
====[[Attacks_GetAttackCategoryIndexByName|Attacks_GetAttackCategoryIndexByName(typename)]]====
====[[Attacks_GetContestCategoryIndexByName|Attacks_GetContestCategoryIndexByName(typename)]]====
====[[Attacks_GetTypeNameByIndex|Attacks_GetTypeNameByIndex(typeidx)]]====
====[[Attacks_GetTargetStringByAttackTarget|Attacks_GetTargetStringByAttackTarget(desiredtarget)]]====
====[[Attacks_TryToSleep|Attacks_TryToSleep(chance, target)]]====
====[[Attacks_TryToParalyze|Attacks_TryToParalyze(chance, target)]]====
====[[Attacks_TryToBurn|Attacks_TryToBurn(chance, target)]]====
====[[Attacks_TryToFreeze|Attacks_TryToFreeze(chance, target)]]====
====[[Attacks_TryToPoison|Attacks_TryToPoison(chance, target)]]====
====[[Attacks_TryToConfuse|Attacks_TryToConfuse(chance, target)]]====
====[[Attacks_TryToFlinch|Attacks_TryToFlinch(chance, target)]]====
====[[Attacks_TryStatChange|Attacks_TryStatChange(chance, target, targetstat, change)]]====

2013-01-16T07:59:31Z

DracoHouston:

2013-01-01T14:17:24Z

DracoHouston:

Pokéditor

2013-01-01T14:14:31Z

DracoHouston: Initial edit. Just needed something for a help page. Will refine more later.

File:Editicon.png

2013-01-01T14:04:28Z

DracoHouston: The edit selected entities button in Pokéditor.

== Summary ==
The edit selected entities button in Pokéditor.
== Licensing ==
{{kolbengameslicense}}

File:Addicon.png

2013-01-01T14:04:00Z

DracoHouston: The add entities button in Pokéditor.

== Summary ==
The add entities button in Pokéditor.
== Licensing ==
{{kolbengameslicense}}

File:Removeicon.png

2013-01-01T14:03:34Z

DracoHouston: The remove selected entities button in Pokéditor.

== Summary ==
The remove selected entities button in Pokéditor.
== Licensing ==
{{kolbengameslicense}}

File:Selectfieldicon.png

2013-01-01T14:02:50Z

DracoHouston: The select entity field mode button in Pokéditor.

== Summary ==
The select entity field mode button in Pokéditor.
== Licensing ==
{{kolbengameslicense}}

File:Selecticon.png

2013-01-01T14:02:04Z

DracoHouston: The select single entity mode button in Pokéditor.

== Summary ==
The select single entity mode button in Pokéditor.
== Licensing ==
{{kolbengameslicense}}

User:DracoHouston

2012-12-26T05:37:21Z

DracoHouston: Created page with "hello gamers!"

hello gamers!