Class: Battle::Move

Inherits:
Object show all
Defined in:
docs/5_Battle_10_Move.rb

Overview

Generic class describing a move

Defined Under Namespace

Modules: Mechanics, StatStageReset Classes: AbilityChanging, Absorb, Acrobatics, Acupressure, AddThirdType, AfterYou, AlluringVoice, AllySwitch, AquaRing, Assist, Assurance, Attract, AuraWheel, Autotomize, Avalanche, BaddyBad, Basic, BasicWithSuccessfulEffect, BatonPass, BeakBlast, BeatUp, Belch, BellyDrum, Bestow, Bide, Bind, BodyPress, BrickBreak, Brine, BurnUp, BurningJealousy, Camouflage, CantSwitch, Captivate, CeaselessEdge, ChangeType, Charge, ChillyReception, ClangorousSoul, ClearSmog, Conversion, Conversion2, CoreEnforcer, CorrosiveGas, Counter, CounterBase, CourtChange, CraftyShield, Curse, CustomStatsBased, Defog, DestinyBond, Disable, DoNothing, Doodle, DoubleIronBash, DragonCheer, DragonDarts, EchoedVoice, EerieSpell, Electrify, ElectroBall, ElectroShot, Embargo, Encore, Endeavor, Entrainment, Eruption, ExpandingForce, Facade, FairyLock, FakeOut, FalseSwipe, Fangs, Feint, FellStinger, FickleBeam, FilletAway, FinalGambit, FishiousRend, FixedDamages, Flail, FlameBurst, Fling, FloralHealing, FlowerShield, FlyingPress, FocusEnergy, FocusPunch, FollowMe, ForceSwitch, Foresight, FoulPlay, FreezyFrost, Frustration, FullCrit, FuryCutter, FusionBolt, FusionFlare, FutureSight, GastroAcid, GearUp, GeniesStorm, Geomancy, GigatonHammer, GlaiveRush, GlitzyGlow, GrassyGlide, GravApple, Gravity, Growth, Grudge, GuardSplit, GuardSwap, GyroBall, HPEqLevel, HappyHour, HardPress, Haze, HealBell, HealBlock, HealMove, HealWeather, HealingSacrifice, HealingWish, HeartSwap, HeavySlam, HelpingHand, Hex, HiddenPower, HighJumpKick, HitThenCureStatus, IceSpinner, Imprison, Incinerate, InfernalParade, Ingrain, Instruct, IonDeluge, IvyCudgel, JawLock, Judgment, JungleHealing, KnockOff, LaserFocus, LashOut, LastResort, LastRespects, LeechSeed, LifeDew, LockOn, LowKick, LuckyChant, LunarDance, MagicCoat, MagicPowder, MagicRoom, MagnetRise, MagneticFlux, Magnitude, MakeItRain, MeFirst, Memento, MetalBurst, Metronome, Mimic, MindBlown, Minimize, MiracleEye, MirrorCoat, MirrorMove, Mist, MistyExplosion, MudSport, MultiAttack, MultiHit, NaturalGift, NaturePower, Nightmare, NoRetreat, OHKO, Octolock, OrderUp, PainSplit, PartingShot, PayBack, PayDay, PerishSong, PhotonGeyser, PlasmaFists, Pledge, Pluck, PollenPuff, Poltergeist, PopulationBomb, Powder, PowerSplit, PowerSwap, PowerTrick, PreAttackBase, Present, Protect, PsychUp, PsychicNoise, PsychoShift, Psywave, Purify, Pursuit, Quash, Rage, RageFist, RagingBull, RapidSpin, RecoilMove, Recycle, Reflect, ReflectType, RelicSong, Reload, Rest, Retaliate, Return, RevelationDance, Revenge, RevivalBlessing, RisingVoltage, RolePlay, Rollout, Roost, Rototiller, Round, SacredSword, Safeguard, SaltCure, SappySeed, ScaleShot, SecretPower, SelfDestruct, SelfStat, SelfStatus, ShedTail, ShellSideArm, ShellTrap, ShoreUp, SimpleBeam, Sketch, SkillSwap, SkyDrop, SleepTalk, SmackDown, SmellingSalts, Snatch, Snore, SolarBeam, SparklingAria, SparklySwirl, SpectralThief, SpeedSwap, Spikes, SpitUp, Spite, Splash, StatAndStageEdit, StatAndStageEditBypassAccuracy, StatusBoostedMove, StatusStat, StealthRock, SteelRoller, StickyWeb, Stockpile, Stomp, StompingTantrum, StoneAxe, StoredPower, StrengthSap, Struggle, StuffCheeks, Substitute, SuckerPunch, SuperDuperEffective, SuperFang, Swallow, Switcheroo, Synchronoise, SyrupBomb, Tailwind, TakeHeart, TarShot, Taunt, Teatime, TechnoBlast, Telekinesis, Teleport, TerrainBoosting, TerrainMove, TerrainPulse, Thief, Thrash, ThreeHit, ThroatChop, Thunder, TidyUp, TopsyTurvy, Torment, ToxicSpikes, ToxicThread, Transform, TriAttack, TrickRoom, TripleArrows, TripleKick, TrumpCard, TwoHit, TwoTurnBase, UTurn, UpRoar, UpperHand, VenomDrench, Venoshock, WakeUpSlap, WaterShuriken, WeatherBall, WeatherMove, Wish, WonderRoom, WorrySeed, WringOut, Yawn

Constant Summary collapse

REGISTERED_MOVES =

List of the registered moves

Returns:

  • (Hash{Symbol => Class}) —

    list of the registered moves mapped by their be_method

Hash.new(Move)
R_RANGE =

Range of the R random factor

Returns:

  • (Range)
85..100
OneTarget =

List of symbol describe a one target aim

Returns:

  • (Array<Symbol>)
%i[any_other_pokemon random_foe adjacent_pokemon adjacent_foe user user_or_adjacent_ally adjacent_ally]
TargetNoAsk =

List of symbol that doesn't show any choice of target

Returns:

  • (Array<Symbol>)
%i[adjacent_all_foe all_foe adjacent_all_pokemon all_pokemon user all_ally all_ally_but_user random_foe]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(db_symbol, pp, ppmax, scene) ⇒ Move

Create a new move

Parameters:

  • db_symbol (Symbol) —

    db_symbol of the move in the database

  • pp (Integer) —

    number of pp the move currently has

  • ppmax (Integer) —

    maximum number of pp the move currently has

  • scene (Battle::Scene) —

    current battle scene



48
49
# File 'docs/5_Battle_10_Move.rb', line 48

def initialize(db_symbol, pp, ppmax, scene)
end

Instance Attribute Details

#consecutive_use_count ⇒ Integer

Number of time the move was used consecutively

Returns:

  • (Integer)


21
22
23
# File 'docs/5_Battle_10_Move.rb', line 21

def consecutive_use_count
  @consecutive_use_count
end

#damage_dealt ⇒ Integer

Number of damage dealt last time the move was used (to be used with move history)

Returns:

  • (Integer)


33
34
35
# File 'docs/5_Battle_10_Move.rb', line 33

def damage_dealt
  @damage_dealt
end

#effectiveness ⇒ Float (readonly)

Get the effectiveness

Returns:

  • (Float)


297
298
299
# File 'docs/5_Battle_10_Move.rb', line 297

def effectiveness
  @effectiveness
end

#forced_next_move_decrease_pp ⇒ Boolean

Tell if forced next move decreases PP

Returns:

  • (Boolean)


667
668
669
# File 'docs/5_Battle_10_Move.rb', line 667

def forced_next_move_decrease_pp
  @forced_next_move_decrease_pp
end

#id ⇒ Integer (readonly)

ID of the move in the database

Returns:

  • (Integer)


9
10
11
# File 'docs/5_Battle_10_Move.rb', line 9

def id
  @id
end

#logic ⇒ Battle::Logic (readonly)

The battle logic

Returns:



24
25
26
# File 'docs/5_Battle_10_Move.rb', line 24

def logic
  @logic
end

#original ⇒ Battle::Move

The original move (for cloned moves)

Returns:



30
31
32
# File 'docs/5_Battle_10_Move.rb', line 30

def original
  @original
end

#original_target ⇒ Array<PFM::PokemonBattler>

The original target of the move (to be used with Magic Bounce/Coat)

Returns:



36
37
38
# File 'docs/5_Battle_10_Move.rb', line 36

def original_target
  @original_target
end

#pp ⇒ Integer

Number of pp the move currently has

Returns:

  • (Integer)


12
13
14
# File 'docs/5_Battle_10_Move.rb', line 12

def pp
  @pp
end

#ppmax ⇒ Integer (readonly)

Maximum number of pp the move currently has

Returns:

  • (Integer)


15
16
17
# File 'docs/5_Battle_10_Move.rb', line 15

def ppmax
  @ppmax
end

#scene ⇒ Battle::Scene (readonly)

The battle scene

Returns:



27
28
29
# File 'docs/5_Battle_10_Move.rb', line 27

def scene
  @scene
end

#thrown_item_effect ⇒ Battle::Effects::Item? (readonly)

Get the item effect of the thrown item (to be used with Fling)

Returns:



42
43
44
# File 'docs/5_Battle_10_Move.rb', line 42

def thrown_item_effect
  @thrown_item_effect
end

#used ⇒ Boolean

if the move has been used

Returns:

  • (Boolean)


18
19
20
# File 'docs/5_Battle_10_Move.rb', line 18

def used
  @used
end

#user ⇒ PFM::PokemonBattler? (readonly)

Get the user of the move

Returns:



39
40
41
# File 'docs/5_Battle_10_Move.rb', line 39

def user
  @user
end

Class Method Details

.[](symbol) ⇒ Class<Battle::Move>

Retrieve a registered move

Parameters:

  • symbol (Symbol) —

    be_method of the move

Returns:



302
303
# File 'docs/5_Battle_10_Move.rb', line 302

def [](symbol)
end

.register(symbol, klass)

Register a move

Parameters:

  • symbol (Symbol) —

    be_method of the move

  • klass (Class) —

    class of the move



307
308
# File 'docs/5_Battle_10_Move.rb', line 307

def register(symbol, klass)
end

Instance Method Details

#accuracy ⇒ Integer

Return the current accuracy of the move

Returns:

  • (Integer)


93
94
# File 'docs/5_Battle_10_Move.rb', line 93

def accuracy
end

#accuracy_mod(user) ⇒ Float

Return the accuracy modifier of the user

Parameters:

Returns:

  • (Float)


627
628
# File 'docs/5_Battle_10_Move.rb', line 627

def accuracy_mod(user)
end

#accuracy_text ⇒ String

Return the accuracy text of the skill (for the UI)

Returns:



97
98
# File 'docs/5_Battle_10_Move.rb', line 97

def accuracy_text
end

#atk_class ⇒ Integer

Return the class of the skill (used by the UI)

Returns:

  • (Integer) —

    1, 2, 3



205
206
# File 'docs/5_Battle_10_Move.rb', line 205

def atk_class
end

#authentic? ⇒ Boolean

Tell if the move is a move that can bypass Substitute

Returns:

  • (Boolean)


257
258
# File 'docs/5_Battle_10_Move.rb', line 257

def authentic?
end

#ballistics? ⇒ Boolean

Tell if the move is a ballistic move

Returns:

  • (Boolean)


229
230
# File 'docs/5_Battle_10_Move.rb', line 229

def ballistics?
end

#battle_stage_mod ⇒ Array<Studio::Move::BattleStageMod>

Return the stat stage modifier the skill can apply

Returns:



129
130
# File 'docs/5_Battle_10_Move.rb', line 129

def battle_stage_mod
end

#battler_targets(pokemon, logic) ⇒ Array<PFM::PokemonBattler>

Note:

use one_target? to select the target inside the possible result

List the targets of this move

Parameters:

Returns:



662
663
# File 'docs/5_Battle_10_Move.rb', line 662

def battler_targets(pokemon, logic)
end

#be_method ⇒ Symbol Also known as: symbol

Return the battle engine method of the move

Returns:

  • (Symbol)


71
72
# File 'docs/5_Battle_10_Move.rb', line 71

def be_method
end

#bite? ⇒ Boolean

Tell if the move is biting move

Returns:

  • (Boolean)


233
234
# File 'docs/5_Battle_10_Move.rb', line 233

def bite?
end

#blocable? ⇒ Boolean

Is the skill blocable by Protect and skill like that ?

Returns:

  • (Boolean)


145
146
# File 'docs/5_Battle_10_Move.rb', line 145

def blocable?
end

#blocked_by?(target, symbol) ⇒ Boolean

Detect if the move is protected by another move on target

Parameters:

Returns:

  • (Boolean)


914
915
# File 'docs/5_Battle_10_Move.rb', line 914

def blocked_by?(target, symbol)
end

#bypass_chance_of_hit?(user, target) ⇒ Boolean

Check if the move bypass chance of hit and cannot fail

Parameters:

Returns:

  • (Boolean)


622
623
# File 'docs/5_Battle_10_Move.rb', line 622

def bypass_chance_of_hit?(user, target)
end

#calc_stab(user, types) ⇒ Numeric

STAB calculation

Parameters:

  • user (PFM::PokemonBattler) —

    user of the move

  • types (Array<Integer>) —

    list of definitive types of the move

Returns:

  • (Numeric)


539
540
# File 'docs/5_Battle_10_Move.rb', line 539

def calc_stab(user, types)
end

#chance_of_hit(user, target) ⇒ Float

Return the chance of hit of the move

Parameters:

Returns:

  • (Float)


616
617
# File 'docs/5_Battle_10_Move.rb', line 616

def chance_of_hit(user, target)
end

#check_specific_procedure(user, targets) ⇒ Symbol?

Check if an Effects imposes a specific proceed_internal

Parameters:

Returns:

  • (Symbol, nil) —

    the symbol of the proceed_internal to call, nil if no specific procedure



875
876
# File 'docs/5_Battle_10_Move.rb', line 875

def check_specific_procedure(user, targets)
end

#clone

Clone the move and give a reference to the original one



56
57
# File 'docs/5_Battle_10_Move.rb', line 56

def clone
end

#critical_hit? ⇒ Boolean

Was the move a critical hit

Returns:

  • (Boolean)


217
218
# File 'docs/5_Battle_10_Move.rb', line 217

def critical_hit?
end

#critical_rate ⇒ Integer

Return the critical rate index of the skill

Returns:

  • (Integer)


121
122
# File 'docs/5_Battle_10_Move.rb', line 121

def critical_rate
end

#damages(user, target) ⇒ Integer

Note:
Note:

The formula is the following: (((((((Level * 2 / 5) + 2) * BasePower * [Sp]Atk / 50) / [Sp]Def) * Mod1) + 2) * CH * Mod2 * R / 100) * STAB * Type1 * Type2 * Mod3)

Method calculating the damages done by the actual move

Parameters:

Returns:

  • (Integer)


321
322
# File 'docs/5_Battle_10_Move.rb', line 321

def damages(user, target)
end

#dance? ⇒ Boolean

Tell if the move is a dance move

Returns:

  • (Boolean)


237
238
# File 'docs/5_Battle_10_Move.rb', line 237

def dance?
end

#data ⇒ Studio::Move

Return the data of the skill

Returns:



60
61
# File 'docs/5_Battle_10_Move.rb', line 60

def data
end

#db_symbol ⇒ Symbol

Return the symbol of the move in the database

Returns:

  • (Symbol)


209
210
# File 'docs/5_Battle_10_Move.rb', line 209

def db_symbol
end

#definitive_types(user, target) ⇒ Array<Integer>

Get the types of the move with 1st type being affected by effects

Parameters:

Returns:

  • (Array<Integer>) —

    list of types of the move



545
546
# File 'docs/5_Battle_10_Move.rb', line 545

def definitive_types(user, target)
end

#description ⇒ String

Return the skill description

Returns:



67
68
# File 'docs/5_Battle_10_Move.rb', line 67

def description
end

#direct? ⇒ Boolean

Is the skill direct ?

Returns:

  • (Boolean)


133
134
# File 'docs/5_Battle_10_Move.rb', line 133

def direct?
end

#disable_reason(user) ⇒ #call

Get the reason why the move is disabled

Parameters:

Returns:

  • (#call) —

    Block that should be called when the move is disabled



902
903
# File 'docs/5_Battle_10_Move.rb', line 902

def disable_reason(user)
end

#disabled?(user) ⇒ Boolean

Function that tells if the move is disabled

Parameters:

Returns:

  • (Boolean)


897
898
# File 'docs/5_Battle_10_Move.rb', line 897

def disabled?(user)
end

#drain? ⇒ Boolean

Tell that the move is a drain move

Returns:

  • (Boolean)


289
290
# File 'docs/5_Battle_10_Move.rb', line 289

def drain?
end

#drain_factor ⇒ Integer

Returns the drain factor

Returns:

  • (Integer)


157
158
# File 'docs/5_Battle_10_Move.rb', line 157

def drain_factor
end

#effect_chance ⇒ Integer

Return the chance of effect of the skill

Returns:

  • (Integer)


109
110
# File 'docs/5_Battle_10_Move.rb', line 109

def effect_chance
end

#efficent_message(effectiveness, target)

Show the effectiveness message

Parameters:



676
677
# File 'docs/5_Battle_10_Move.rb', line 676

def efficent_message(effectiveness, target)
end

#evasion_mod(target) ⇒ Float

Return the evasion modifier of the target

Parameters:

Returns:

  • (Float)


632
633
# File 'docs/5_Battle_10_Move.rb', line 632

def evasion_mod(target)
end

#force_switch? ⇒ Boolean

Tell if the move is a move that forces target switch

Returns:

  • (Boolean)


273
274
# File 'docs/5_Battle_10_Move.rb', line 273

def force_switch?
end

#gravity_affected? ⇒ Boolean

Is the skill affected by gravity

Returns:

  • (Boolean)


125
126
# File 'docs/5_Battle_10_Move.rb', line 125

def gravity_affected?
end

#heal? ⇒ Boolean

Tell if the move is a heal move

Returns:

  • (Boolean)


245
246
# File 'docs/5_Battle_10_Move.rb', line 245

def heal?
end

#hit_criticality_message(actual_targets, target)

Show the critical hit message

Parameters:



671
672
# File 'docs/5_Battle_10_Move.rb', line 671

def hit_criticality_message(actual_targets, target)
end

#made_contact? ⇒ Boolean

Tells if the move made contact with target

Returns:

  • (Boolean)


293
294
# File 'docs/5_Battle_10_Move.rb', line 293

def made_contact?
end

#magic_coat_affected? ⇒ Boolean

Is the skill affected by magic coat ?

Returns:

  • (Boolean)


189
190
# File 'docs/5_Battle_10_Move.rb', line 189

def magic_coat_affected?
end

#mental? ⇒ Boolean

Tell if the move is a mental move

Returns:

  • (Boolean)


137
138
# File 'docs/5_Battle_10_Move.rb', line 137

def mental?
end

#mirror_move_affected? ⇒ Boolean

Is the skill affected by Mirror Move

Returns:

  • (Boolean)


141
142
# File 'docs/5_Battle_10_Move.rb', line 141

def mirror_move_affected?
end

#move_blocked_by_target?(user, target) ⇒ Boolean

Note:

Thing that prevents the move from being used should be defined by :move_prevention_target Hook.

Function that tests if the targets blocks the move

Parameters:

Returns:

  • (Boolean) —

    if the target evade the move (and is not selected)



909
910
# File 'docs/5_Battle_10_Move.rb', line 909

def move_blocked_by_target?(user, target)
end

#move_usable_by_user(user, targets) ⇒ Boolean

Function that tests if the user is able to use the move

Parameters:

Returns:

  • (Boolean) —

    if the procedure can continue



892
893
# File 'docs/5_Battle_10_Move.rb', line 892

def move_usable_by_user(user, targets)
end

#multi_hit? ⇒ Boolean

Tells if the move hits multiple times

Returns:

  • (Boolean)


281
282
# File 'docs/5_Battle_10_Move.rb', line 281

def multi_hit?
end

#multi_turn? ⇒ Boolean

Tell if the move will take two or more turns

Returns:

  • (Boolean)


285
286
# File 'docs/5_Battle_10_Move.rb', line 285

def multi_turn?
end

#name

Return the name of the skill



63
64
# File 'docs/5_Battle_10_Move.rb', line 63

def name
end

#no_choice_skill? ⇒ Boolean Also known as: is_no_choice_skill?

Does the skill doesn't show a target choice

Returns:

  • (Boolean)


653
654
# File 'docs/5_Battle_10_Move.rb', line 653

def no_choice_skill?
end

#not_very_effective? ⇒ Boolean

Was the move not very effective ?

Returns:

  • (Boolean)


225
226
# File 'docs/5_Battle_10_Move.rb', line 225

def not_very_effective?
end

#ohko? ⇒ Boolean

Tell if the move is an OHKO move

Returns:

  • (Boolean)


265
266
# File 'docs/5_Battle_10_Move.rb', line 265

def ohko?
end

#one_target? ⇒ Boolean Also known as: is_one_target?

Does the skill aim only one Pokemon

Returns:

  • (Boolean)


643
644
# File 'docs/5_Battle_10_Move.rb', line 643

def one_target?
end

#one_target_from_zone_attack(user) ⇒ Boolean

Check if an attack that targets multiple people is targeting only one

Parameters:

Returns:

  • (Boolean)


649
650
# File 'docs/5_Battle_10_Move.rb', line 649

def one_target_from_zone_attack(user)
end

#physical? ⇒ Boolean

Is the skill physical ?

Returns:

  • (Boolean)


193
194
# File 'docs/5_Battle_10_Move.rb', line 193

def physical?
end

#powder? ⇒ Boolean

Tell if the move is a powder move

Returns:

  • (Boolean)


253
254
# File 'docs/5_Battle_10_Move.rb', line 253

def powder?
end

#power ⇒ Integer Also known as: base_power

Return the actual base power of the move

Returns:

  • (Integer)


80
81
# File 'docs/5_Battle_10_Move.rb', line 80

def power
end

#power_text ⇒ String

Return the text of the power of the skill (for the UI)

Returns:



85
86
# File 'docs/5_Battle_10_Move.rb', line 85

def power_text
end

#pp_text ⇒ String

Return the text of the PP of the skill

Returns:



76
77
# File 'docs/5_Battle_10_Move.rb', line 76

def pp_text
end

#pre_attack? ⇒ Boolean

Is the move doing something before any other moves ?

Returns:

  • (Boolean)


277
278
# File 'docs/5_Battle_10_Move.rb', line 277

def pre_attack?
end

#priority(user = nil) ⇒ Integer

Return the priority of the skill

Parameters:

Returns:

  • (Integer)


102
103
# File 'docs/5_Battle_10_Move.rb', line 102

def priority(user = nil)
end

#proceed(user, target_bank, target_position)

Function starting the move procedure

Parameters:

  • user (PFM::PokemonBattler) —

    user of the move

  • target_bank (Integer) —

    bank of the target

  • target_position (Integer)


686
687
# File 'docs/5_Battle_10_Move.rb', line 686

def proceed(user, target_bank, target_position)
end

#proceed_internal_dancer(user, targets)

Internal procedure of the move

Parameters:



885
886
# File 'docs/5_Battle_10_Move.rb', line 885

def proceed_internal_dancer(user, targets)
end

#proceed_internal_parental_bond(user, targets)

Internal procedure of the move for Parental Bond Ability

Parameters:



880
881
# File 'docs/5_Battle_10_Move.rb', line 880

def proceed_internal_parental_bond(user, targets)
end

#proceed_pre_attack(user)

Proceed the procedure before any other attack.

Parameters:



690
691
# File 'docs/5_Battle_10_Move.rb', line 690

def proceed_pre_attack(user)
end

#pulse? ⇒ Boolean

Tell if the move is a pulse move

Returns:

  • (Boolean)


241
242
# File 'docs/5_Battle_10_Move.rb', line 241

def pulse?
end

#punching? ⇒ Boolean

Is the skill a punching move ?

Returns:

  • (Boolean)


161
162
# File 'docs/5_Battle_10_Move.rb', line 161

def punching?
end

#real_base_power(user, target) ⇒ Integer

Get the real base power of the move (taking in account all parameter)

Parameters:

Returns:

  • (Integer)


327
328
# File 'docs/5_Battle_10_Move.rb', line 327

def real_base_power(user, target)
end

#recharge? ⇒ Boolean

Tell if the move is a move is a recharge move

Returns:

  • (Boolean)


261
262
# File 'docs/5_Battle_10_Move.rb', line 261

def recharge?
end

#recoil? ⇒ Boolean

Does the skill has recoil ?

Returns:

  • (Boolean)


149
150
# File 'docs/5_Battle_10_Move.rb', line 149

def recoil?
end

#recoil_factor ⇒ Integer

Returns the recoil factor

Returns:

  • (Integer)


153
154
# File 'docs/5_Battle_10_Move.rb', line 153

def recoil_factor
end

#relative_priority

Move priority



105
106
# File 'docs/5_Battle_10_Move.rb', line 105

def relative_priority
end

#self_user_switch? ⇒ Boolean

Tell if the move is a move that switch the user if that hit

Returns:

  • (Boolean)


269
270
# File 'docs/5_Battle_10_Move.rb', line 269

def self_user_switch?
end

#show_usage_failure(user)

Show the usage failure when move is not usable by user

Parameters:



680
681
# File 'docs/5_Battle_10_Move.rb', line 680

def show_usage_failure(user)
end

#slicing_attack? ⇒ Boolean

Is the skill a slicing attack ?

Returns:

  • (Boolean)


169
170
# File 'docs/5_Battle_10_Move.rb', line 169

def slicing_attack?
end

#snatchable? ⇒ Boolean

Is the skill snatchable ?

Returns:

  • (Boolean)


185
186
# File 'docs/5_Battle_10_Move.rb', line 185

def snatchable?
end

#sound_attack? ⇒ Boolean

Is the skill a sound attack ?

Returns:

  • (Boolean)


165
166
# File 'docs/5_Battle_10_Move.rb', line 165

def sound_attack?
end

#special? ⇒ Boolean

Is the skill special ?

Returns:

  • (Boolean)


197
198
# File 'docs/5_Battle_10_Move.rb', line 197

def special?
end

#status? ⇒ Boolean

Is the skill status ?

Returns:

  • (Boolean)


201
202
# File 'docs/5_Battle_10_Move.rb', line 201

def status?
end

#status_effects ⇒ Array<Studio::Move::MoveStatus>

Get all the status effect of a move

Returns:



113
114
# File 'docs/5_Battle_10_Move.rb', line 113

def status_effects
end

#super_effective? ⇒ Boolean

Was the move super effective ?

Returns:

  • (Boolean)


221
222
# File 'docs/5_Battle_10_Move.rb', line 221

def super_effective?
end

#target ⇒ Symbol

Return the target symbol the skill can aim

Returns:

  • (Symbol)


117
118
# File 'docs/5_Battle_10_Move.rb', line 117

def target
end

#to_s ⇒ String Also known as: inspect

Format move for logging purpose

Returns:



52
53
# File 'docs/5_Battle_10_Move.rb', line 52

def to_s
end

#trigger_king_rock? ⇒ Boolean

Does the skill trigger the king rock

Returns:

  • (Boolean)


181
182
# File 'docs/5_Battle_10_Move.rb', line 181

def trigger_king_rock?
end

#two_turn? ⇒ Boolean

Tell if the move is a two turn move

Returns:

  • (Boolean)


249
250
# File 'docs/5_Battle_10_Move.rb', line 249

def two_turn?
end

#type ⇒ Integer

Return the current type of the move

Returns:

  • (Integer)


89
90
# File 'docs/5_Battle_10_Move.rb', line 89

def type
end

#type?(type_id) ⇒ Boolean

Is the skill a specific type ?

Parameters:

  • type_id (Integer) —

    ID of the type

Returns:

  • (Boolean)


434
435
# File 'docs/5_Battle_10_Move.rb', line 434

def type?(type_id)
end

#type_dark? ⇒ Boolean Also known as: type_tenebre?

Is the skill type dark ?

Returns:

  • (Boolean)


520
521
# File 'docs/5_Battle_10_Move.rb', line 520

def type_dark?
end

#type_dragon? ⇒ Boolean

Is the skill type dragon ?

Returns:

  • (Boolean)


511
512
# File 'docs/5_Battle_10_Move.rb', line 511

def type_dragon?
end

#type_electric? ⇒ Boolean Also known as: type_electrique?

Is the skill type electric ?

Returns:

  • (Boolean)


456
457
# File 'docs/5_Battle_10_Move.rb', line 456

def type_electric?
end

#type_fairy? ⇒ Boolean Also known as: type_fee?

Is the skill type fairy ?

Returns:

  • (Boolean)


525
526
# File 'docs/5_Battle_10_Move.rb', line 525

def type_fairy?
end

#type_fighting? ⇒ Boolean Also known as: type_combat?

Is the skill type fighting ?

Returns:

  • (Boolean)


471
472
# File 'docs/5_Battle_10_Move.rb', line 471

def type_fighting?
end

#type_fire? ⇒ Boolean Also known as: type_feu?

Is the skill type fire ?

Returns:

  • (Boolean)


446
447
# File 'docs/5_Battle_10_Move.rb', line 446

def type_fire?
end

#type_flying? ⇒ Boolean Also known as: type_vol?, type_fly?

Is the skill type fly ?

Returns:

  • (Boolean)


485
486
# File 'docs/5_Battle_10_Move.rb', line 485

def type_flying?
end

#type_ghost? ⇒ Boolean Also known as: type_spectre?

Is the skill type ghost ?

Returns:

  • (Boolean)


506
507
# File 'docs/5_Battle_10_Move.rb', line 506

def type_ghost?
end

#type_grass? ⇒ Boolean Also known as: type_plante?

Is the skill type grass ?

Returns:

  • (Boolean)


461
462
# File 'docs/5_Battle_10_Move.rb', line 461

def type_grass?
end

#type_ground? ⇒ Boolean Also known as: type_sol?

Is the skill type ground ?

Returns:

  • (Boolean)


480
481
# File 'docs/5_Battle_10_Move.rb', line 480

def type_ground?
end

#type_ice? ⇒ Boolean Also known as: type_glace?

Is the skill type ice ?

Returns:

  • (Boolean)


466
467
# File 'docs/5_Battle_10_Move.rb', line 466

def type_ice?
end

#type_insect? ⇒ Boolean Also known as: type_bug?

Is the skill type insect/bug ?

Returns:

  • (Boolean)


496
497
# File 'docs/5_Battle_10_Move.rb', line 496

def type_insect?
end

#type_modifier(user, target) ⇒ Float

Function that calculate the type modifier (for specific uses)

Parameters:

Returns:

  • (Float)


533
534
# File 'docs/5_Battle_10_Move.rb', line 533

def type_modifier(user, target)
end

#type_normal? ⇒ Boolean

Is the skill type normal ?

Returns:

  • (Boolean)


442
443
# File 'docs/5_Battle_10_Move.rb', line 442

def type_normal?
end

#type_poison? ⇒ Boolean

Is the skill type poison ?

Returns:

  • (Boolean)


476
477
# File 'docs/5_Battle_10_Move.rb', line 476

def type_poison?
end

#type_psychic? ⇒ Boolean Also known as: type_psy?

Is the skill type psy ?

Returns:

  • (Boolean)


491
492
# File 'docs/5_Battle_10_Move.rb', line 491

def type_psychic?
end

#type_rock? ⇒ Boolean Also known as: type_roche?

Is the skill type rock ?

Returns:

  • (Boolean)


501
502
# File 'docs/5_Battle_10_Move.rb', line 501

def type_rock?
end

#type_steel? ⇒ Boolean Also known as: type_acier?

Is the skill type steel ?

Returns:

  • (Boolean)


515
516
# File 'docs/5_Battle_10_Move.rb', line 515

def type_steel?
end

#type_water? ⇒ Boolean Also known as: type_eau?

Is the skill type water ?

Returns:

  • (Boolean)


451
452
# File 'docs/5_Battle_10_Move.rb', line 451

def type_water?
end

#typeless? ⇒ Boolean

Is the skill typeless ?

Returns:

  • (Boolean)


438
439
# File 'docs/5_Battle_10_Move.rb', line 438

def typeless?
end

#unfreeze? ⇒ Boolean

Does the skill unfreeze

Returns:

  • (Boolean)


173
174
# File 'docs/5_Battle_10_Move.rb', line 173

def unfreeze?
end

#wind_attack? ⇒ Boolean

Is the skill a wind attack ?

Returns:

  • (Boolean)


177
178
# File 'docs/5_Battle_10_Move.rb', line 177

def wind_attack?
end