Class: PFM::Pokemon

Inherits:
Object show all
Includes:
Hooks
Defined in:
docs/01450_Systems_09000_GTS.rb,
docs/01450_Systems_00000_General_00001_PFM.rb

Overview

The InGame Pokemon management

Author:

  • Nuri Yuri

Direct Known Subclasses

PokemonBattler

Defined Under Namespace

Classes: ExpList

Constant Summary collapse

ABILITY_CHANCES =

List of chance to get a specific ability on Pokemon generation

[49, 98, 100]
FLAG_UNKOWN_USE =

Unknown flag (should always be up in Pokemon)

0x0080_0000
FLAG_FROM_THIS_GAME =

Flag telling the Pokemon comes from this game (this fangame)

0x0040_0000
FLAG_CAUGHT_BY_PLAYER =

Flag telling the Pokemon has been caught by the player

0x0020_0000
FLAG_PRESENT_TIME =

Flag telling the Pokemon comes from present time (used to distinguish pokemon imported from previous games)

0x0010_0000
Shiny_IV =

Flag that tells the Pokemon object to generate Shiny with IV starting at 15

false
EGG_FILENAMES =
TODO:

Change this later

All possible attempt of finding an egg (for legacy)

['egg_%<id>03d_%<form>02d', 'egg_%<id>03d', 'egg_%<name>s_%<form>02d', 'egg_%<name>s', 'egg']
BATTLER_SIZE =

Size of a battler

96
ICON_SIZE =

Size of an icon

32
FOOT_SIZE =

Size of a footprint

16
SPECIAL_EVOLUTION_ID =

List of key in evolution Hash that corresponds to the expected ID when evolution is valid

Returns:

  • (Array<Symbol>) 
%i[trade id]
FORM_CALIBRATE =

List of form calibration hook for Creatures that needs form calibration (when switching items, being place in computer or when team changes)

{}
FORM_GENERATION =

List of form generation hook for Creatures that needs an initial form when the PFM::Pokemon object is generated.

{}
ArceusItem =

List of items (in the form index order) that change the form of Arceus

%i[__undef__ flame_plate splash_plate zap_plate meadow_plate icicle_plate fist_plate toxic_plate earth_plate sky_plate mind_plate insect_plate stone_plate spooky_plate draco_plate iron_plate dread_plate pixie_plate]
GenesectModules =

List of items (in the form index order) that change the form of Genesect

%i[__undef__ burn_drive chill_drive douse_drive shock_drive]
SilvallyROM =

List of item (in the form index oreder) that change the form of Silvally

%i[__undef__ fighting_memory flying_memory poison_memory ground_memory rock_memory bug_memory ghost_memory steel_memory __undef__ fire_memory water_memory grass_memory electric_memory psychic_memory ice_memory dragon_memory dark_memory fairy_memory]
G_ID =

PSP 0.7 ID Hash key

'ID'
G_NV =

PSP 0.7 level Hash key

'NV'
G_OBJ =

PSP 0.7 item hash key

'OBJ'
G_STAT =

PSP 0.7 stat hash key

'STAT'
G_MOVE =

PSP 0.7 move hash key

'MOVE'
G_GR =

PSP 0.7 gender hash key

'GR'
G_FORM =

PSP 0.7 form hash key

'FORM'
G_SHINY =

PSP 0.7 shiny hash key

'SHINY'

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Hooks

#exec_hooks, #force_return, included, register, remove, remove_without_name

Constructor Details

#initialize(id, level, force_shiny = false, no_shiny = false, form = -1,, opts = {}) ⇒ Pokemon

Create a new Pokemon with specific parameters

Parameters:

  • id (Integer, Symbol) —

    ID of the Pokemon in the database

  • level (Integer) —

    level of the Pokemon

  • force_shiny (Boolean) (defaults to: false) —

    if the Pokemon have 100% chance to be shiny

  • no_shiny (Boolean) (defaults to: false) —

    if the Pokemon have 0% chance to be shiny (override force_shiny)

  • form (Integer) (defaults to: -1,) —

    Form index of the Pokemon (-1 = automatic generation)

  • opts (Hash) (defaults to: {}) —

    Hash describing optional value you want to assign to the Pokemon

Options Hash (opts):

  • :given_name (String) —

    Nickname of the Pokemon

  • :captured_with (Integer, Symbol) —

    ID of the ball used to catch the Pokemon

  • :captured_in (Integer) —

    ID of the zone where the Pokemon was caught

  • :captured_at (Integer, Time) —

    Time when the Pokemon was caught

  • :captured_level (Integer) —

    Level of the Pokemon when it was caught

  • :egg_in (Integer) —

    ID of the zone where the egg was layed/found

  • :egg_at (Integer, Time) —

    Time when the egg was layed/found

  • :gender (Integer, String) —

    Forced gender of the Pokemon

  • :nature (Integer) —

    Nature of the Pokemon

  • :stats (Array<Integer>) —

    IV array ([hp, atk, dfe, spd, ats, dfs])

  • :bonus (Array<Integer>) —

    EV array ([hp, atk, dfe, spd, ats, dfs])

  • :item (Integer, Symbol) —

    ID of the item the Pokemon is holding

  • :ability (Integer, Symbol) —

    ID of the ability the Pokemon has

  • :rareness (Integer) —

    Rareness of the Pokemon (0 = not catchable, 255 = always catchable)

  • :loyalty (Integer) —

    Happiness of the Pokemon

  • :moves (Array<Integer, Symbol>) —

    Current Moves of the Pokemon (0 = default)

  • :memo_text (Array(Integer, Integer)) —

    Text used for the memo ([file_id, text_id])

  • :trainer_name (String) —

    Name of the trainer that caught / got the Pokemon

  • :trainer_id (Integer) —

    ID of the trainer that caught / got the Pokemon



332
333
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 332

def initialize(id, level, force_shiny = false, no_shiny = false, form = -1, opts = {})
end

Class Attribute Details

.evolution_criteria ⇒ Hash{ Symbol => Proc } (readonly)

List of evolution criteria

Returns:

  • (Hash{ Symbol => Proc }) 


907
908
909
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 907

def evolution_criteria
  @evolution_criteria
end

.evolution_reason_required_criteria ⇒ Hash{ Symbol => Array<Symbol> } (readonly)

List of evolution criteria required for specific reason

Returns:

  • (Hash{ Symbol => Array<Symbol> }) 


910
911
912
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 910

def evolution_reason_required_criteria
  @evolution_reason_required_criteria
end

Instance Attribute Details

#ability ⇒ Integer

Return the current ability of the Pokemon

Returns:

  • (Integer) 


701
702
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 701

def ability
end

#ability_index ⇒ Integer?

Index of the ability in the Pokemon data

Returns:

  • (Integer, nil) 


525
526
527
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 525

def ability_index
  @ability_index
end

#ability_used ⇒ Boolean

Check whether the ability has been already used in battle

Returns:

  • (Boolean) 


519
520
521
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 519

def ability_used
  @ability_used
end

#attack_order ⇒ Integer

Attack order value tells when the Pokemon attacks (used to test if attack before another pokemon)

Returns:

  • (Integer) 


551
552
553
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 551

def attack_order
  @attack_order
end

#battle_item ⇒ Integer?

ID of the item the Pokemon is holding in battle

Returns:

  • (Integer, nil) 


566
567
568
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 566

def battle_item
  @battle_item
end

#battle_item_data ⇒ Array?

Various data information of the item during battle

Returns:

  • (Array, nil) 


569
570
571
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 569

def battle_item_data
  @battle_item_data
end

#battle_stage ⇒ Array(Integer, Integer, Integer, Integer, Integer, Integer, Integer)

The battle Stage of the Pokemon [atk, dfe, spd, ats, dfs, eva, acc]

Returns:

  • (Array(Integer, Integer, Integer, Integer, Integer, Integer, Integer)) 


534
535
536
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 534

def battle_stage
  @battle_stage
end

#battle_turns ⇒ Integer

Number of turn the Pokemon has fought

Returns:

  • (Integer) 


548
549
550
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 548

def battle_turns
  @battle_turns
end

#captured_at ⇒ Integer

Time when the Pokemon was captured (in seconds from jan 1970)

Returns:

  • (Integer) 


417
418
419
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 417

def captured_at
  @captured_at
end

#captured_in ⇒ Integer

Zone (id) where the Pokemon was captured mixed with the Gemme 4.0 Flag

Returns:

  • (Integer) 


414
415
416
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 414

def captured_in
  @captured_in
end

#captured_level ⇒ Integer

Level of the Pokemon when the Pokemon was caught

Returns:

  • (Integer) 


420
421
422
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 420

def captured_level
  @captured_level
end

#captured_with ⇒ Integer

ID of the item used to catch the Pokemon

Returns:

  • (Integer) 


411
412
413
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 411

def captured_with
  @captured_with
end

#character ⇒ String

Character filename of the Pokemon (FollowMe optimizations)

Returns:



504
505
506
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 504

def character
  @character
end

#code ⇒ Integer

Code of the pokemon

Returns:

  • (Integer) 


405
406
407
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 405

def code
  @code
end

#confuse ⇒ Boolean

If the pokemon is confused

Returns:

  • (Boolean) 


545
546
547
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 545

def confuse
  @confuse
end

#critical_modifier 



538
539
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 538

def critical_modifier
end

#egg_at ⇒ Integer

Time when the Egg has been obtained

Returns:

  • (Integer) 


426
427
428
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 426

def egg_at
  @egg_at
end

#egg_in ⇒ Integer

Zone (id) where the Egg has been obtained

Returns:

  • (Integer) 


423
424
425
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 423

def egg_in
  @egg_in
end

#ev_atk ⇒ Integer

ATK Effort Value

Returns:

  • (Integer) 


450
451
452
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 450

def ev_atk
  @ev_atk
end

#ev_ats ⇒ Integer

ATS Effort Value

Returns:

  • (Integer) 


459
460
461
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 459

def ev_ats
  @ev_ats
end

#ev_dfe ⇒ Integer

DFE Effort Value

Returns:

  • (Integer) 


453
454
455
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 453

def ev_dfe
  @ev_dfe
end

#ev_dfs ⇒ Integer

DFS Effort Value

Returns:

  • (Integer) 


462
463
464
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 462

def ev_dfs
  @ev_dfs
end

#ev_hp ⇒ Integer

HP Effort Value

Returns:

  • (Integer) 


447
448
449
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 447

def ev_hp
  @ev_hp
end

#ev_spd ⇒ Integer

SPD Effort Value

Returns:

  • (Integer) 


456
457
458
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 456

def ev_spd
  @ev_spd
end

#exp ⇒ Integer

The total amount of exp the Pokemon got

Returns:

  • (Integer) 


399
400
401
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 399

def exp
  @exp
end

#exp_rate ⇒ Float

The rate of exp point the Pokemon has in its level

Returns:

  • (Float) 


489
490
491
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 489

def exp_rate
  @exp_rate
end

#form ⇒ Integer

Form Index of the Pokemon, ex: Unkown A = 0, Unkown Z = 25

Returns:

  • (Integer) 


444
445
446
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 444

def form
  @form
end

#game_code ⇒ Integer?

Code of the game where the Pokemon comes from (nil if the Pokemon hasn’t been tainted by GTS system)

Returns:

  • (Integer, nil) 


311
312
313
 
# File 'docs/01450_Systems_09000_GTS.rb', line 311

def game_code
  @game_code
end

#gender ⇒ Integer

Gender of the Pokemon : 0 = no gender, 1 = male, 2 = female

Returns:

  • (Integer) 


438
439
440
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 438

def gender
  @gender
end

#given_name ⇒ String Also known as: nickname

Return the given name of the Pokemon (Pokedex name if no given name)

Returns:



435
436
437
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 435

def given_name
  @given_name
end

#hp ⇒ Integer

The current HP the Pokemon has

Returns:

  • (Integer) 


402
403
404
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 402

def hp
  @hp
end

#hp_rate ⇒ Float

The rate of HP the Pokemon has

Returns:

  • (Float) 


486
487
488
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 486

def hp_rate
  @hp_rate
end

#id ⇒ Integer

ID of the Pokemon in the database

Returns:

  • (Integer) 


393
394
395
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 393

def id
  @id
end

#item_holding ⇒ Integer

ID of the item the Pokemon is holding

Returns:

  • (Integer) 


492
493
494
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 492

def item_holding
  @item_holding
end

#iv_atk ⇒ Integer

ATK Individual Value

Returns:

  • (Integer) 


468
469
470
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 468

def iv_atk
  @iv_atk
end

#iv_ats ⇒ Integer

ATS Individual Value

Returns:

  • (Integer) 


477
478
479
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 477

def iv_ats
  @iv_ats
end

#iv_dfe ⇒ Integer

DFE Individual Value

Returns:

  • (Integer) 


471
472
473
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 471

def iv_dfe
  @iv_dfe
end

#iv_dfs ⇒ Integer

DFS Individual Value

Returns:

  • (Integer) 


480
481
482
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 480

def iv_dfs
  @iv_dfs
end

#iv_hp ⇒ Integer

HP Individual Value

Returns:

  • (Integer) 


465
466
467
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 465

def iv_hp
  @iv_hp
end

#iv_spd ⇒ Integer

SPD Individual Value

Returns:

  • (Integer) 


474
475
476
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 474

def iv_spd
  @iv_spd
end

#level ⇒ Integer

Current Level of the Pokemon

Returns:

  • (Integer) 


396
397
398
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 396

def level
  @level
end

#loyalty ⇒ Integer

Happiness/loyalty of the Pokemon (0 no bonds, 255 full bonds)

Returns:

  • (Integer) 


441
442
443
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 441

def loyalty
  @loyalty
end

#memo_text ⇒ Array<Integer>

Memo text [file_id, text_id]

Returns:

  • (Array<Integer>) 


507
508
509
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 507

def memo_text
  @memo_text
end

#nature ⇒ Array<Integer>

Return the nature data of the Pokemon

Returns:

  • (Array<Integer>) —
    text_id, atk%, dfe%, spd%, ats%, dfs% 


653
654
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 653

def nature
end

#position ⇒ Integer?

The position in the Battle, > 0 = actor, < 0 = enemy (index = -position-1), nil = not fighting

Returns:

  • (Integer, nil) 


542
543
544
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 542

def position
  @position
end

#prepared_skill ⇒ Integer

ID of the skill the Pokemon would like to use

Returns:

  • (Integer) 


554
555
556
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 554

def prepared_skill
  @prepared_skill
end

#ribbons ⇒ Array<Integer>

List of Ribbon ID the Pokemon got

Returns:

  • (Array<Integer>) 


510
511
512
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 510

def ribbons
  @ribbons
end

#skill_learnt ⇒ Array<Integer> (readonly)

List of Skill id the Pokemon learnt during its life

Returns:

  • (Array<Integer>) 


513
514
515
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 513

def skill_learnt
  @skill_learnt
end

#skills_set ⇒ Array<PFM::Skill> Also known as: moveset

The current moveset of the Pokemon

Returns:



516
517
518
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 516

def skills_set
  @skills_set
end

#status ⇒ Integer

ID of the status of the Pokemon

Returns:

  • (Integer) 


528
529
530
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 528

def status
  @status
end

#status_count ⇒ Integer

Internal status counter that helps some status to terminate or worsen

Returns:

  • (Integer) 


531
532
533
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 531

def status_count
  @status_count
end

#step_remaining ⇒ Integer

Number of step before the egg hatch (thus the Pokemon is an egg)

Returns:

  • (Integer) 


408
409
410
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 408

def step_remaining
  @step_remaining
end

#sub_code ⇒ Integer?

Real code of the Pokemon when used transform (needed to test if roaming pokemon is ditto)

Returns:

  • (Integer, nil) 


560
561
562
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 560

def sub_code
  @sub_code
end

#sub_form ⇒ Integer?

Real form index of the Pokemon when used transform (needed to test if roaming pokemon is ditto)

Returns:

  • (Integer, nil) 


563
564
565
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 563

def sub_form
  @sub_form
end

#sub_id ⇒ Integer?

Real id of the Pokemon when used transform

Returns:

  • (Integer, nil) 


557
558
559
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 557

def sub_id
  @sub_id
end

#trainer_id ⇒ Integer

Return the normalized trainer id of the Pokemon

Returns:

  • (Integer) 


685
686
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 685

def trainer_id
end

#trainer_name ⇒ String

Name of the original trainer

Returns:



432
433
434
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 432

def trainer_name
  @trainer_name
end

#type1 ⇒ Integer

Return the current first type of the Pokemon

Returns:

  • (Integer) 


1641
1642
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1641

def type1
end

#type2 ⇒ Integer

Return the current second type of the Pokemon

Returns:

  • (Integer) 


1645
1646
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1645

def type2
end

#type3 ⇒ Integer

Return the current third type of the Pokemon

Returns:

  • (Integer) 


1649
1650
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1649

def type3
end

Class Method Details

.add_evolution_criteria(key, reasons = nil, &block)

Add a new evolution criteria

Parameters:

  • key (Symbol) —

    hash key expected in special evolution

  • reasons (Array<Symbol>) (defaults to: nil) —

    evolution reasons that require this criteria in order to allow evolution

  • block (Proc) —

    executed proc for special evolution test, will receive : value, extend_data, reason



915
916
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 915

def add_evolution_criteria(key, reasons = nil, &block)
end

.back_filename(id, form, female, shiny, egg) ⇒ String

Return the back battler name

Parameters:

  • id (Integer) —

    ID of the Pokemon

  • form (Integer) —

    form index of the Pokemon

  • female (Boolean) —

    if the Pokemon is a female

  • shiny (Boolean) —

    shiny state of the Pokemon

  • egg (Boolean) —

    egg state of the Pokemon

Returns:



764
765
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 764

def back_filename(id, form, female, shiny, egg)
end

.back_gif_filename(id, form, female, shiny, egg) ⇒ String?

Return the back gif name

Parameters:

  • id (Integer) —

    ID of the Pokemon

  • form (Integer) —

    form index of the Pokemon

  • female (Boolean) —

    if the Pokemon is a female

  • shiny (Boolean) —

    shiny state of the Pokemon

  • egg (Boolean) —

    egg state of the Pokemon

Returns:



773
774
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 773

def back_gif_filename(id, form, female, shiny, egg)
end

.front_filename(id, form, female, shiny, egg) ⇒ String

Return the front battler name

Parameters:

  • id (Integer) —

    ID of the Pokemon

  • form (Integer) —

    form index of the Pokemon

  • female (Boolean) —

    if the Pokemon is a female

  • shiny (Boolean) —

    shiny state of the Pokemon

  • egg (Boolean) —

    egg state of the Pokemon

Returns:



746
747
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 746

def front_filename(id, form, female, shiny, egg)
end

.front_gif_filename(id, form, female, shiny, egg) ⇒ String?

Return the front gif name

Parameters:

  • id (Integer) —

    ID of the Pokemon

  • form (Integer) —

    form index of the Pokemon

  • female (Boolean) —

    if the Pokemon is a female

  • shiny (Boolean) —

    shiny state of the Pokemon

  • egg (Boolean) —

    egg state of the Pokemon

Returns:



755
756
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 755

def front_gif_filename(id, form, female, shiny, egg)
end

.generate_from_hash(hash) ⇒ PFM::Pokemon

Generate a Pokemon from a hash

Parameters:

  • hash (Hash) —

    Hash describing optional value you want to assign to the Pokemon

Options Hash (hash):

  • :id (Integer, Symbol) —

    ID of the Pokemon

  • :level (Integer) —

    level of the Pokemon

  • :shiny (Boolean) —

    if the pokemon will be shiny

  • :no_shiny (Boolean) —

    if the pokemon will never be shiny

  • :form (Integer) —

    form index of the Pokemon

  • :given_name (String) —

    Nickname of the Pokemon

  • :captured_with (Integer, Symbol) —

    ID of the ball used to catch the Pokemon

  • :captured_in (Integer) —

    ID of the zone where the Pokemon was caught

  • :captured_at (Integer, Time) —

    Time when the Pokemon was caught

  • :captured_level (Integer) —

    Level of the Pokemon when it was caught

  • :egg_in (Integer) —

    ID of the zone where the egg was layed/found

  • :egg_at (Integer, Time) —

    Time when the egg was layed/found

  • :gender (Integer, String) —

    Forced gender of the Pokemon

  • :nature (Integer) —

    Nature of the Pokemon

  • :stats (Array<Integer>) —

    IV array ([hp, atk, dfe, spd, ats, dfs])

  • :bonus (Array<Integer>) —

    EV array ([hp, atk, dfe, spd, ats, dfs])

  • :item (Integer, Symbol) —

    ID of the item the Pokemon is holding

  • :ability (Integer, Symbol) —

    ID of the ability the Pokemon has

  • :rareness (Integer) —

    Rareness of the Pokemon (0 = not catchable, 255 = always catchable)

  • :loyalty (Integer) —

    Happiness of the Pokemon

  • :moves (Array<Integer, Symbol>) —

    Current Moves of the Pokemon (0 = default)

  • :memo_text (Array(Integer, Integer)) —

    Text used for the memo ([file_id, text_id])

  • :trainer_name (String) —

    Name of the trainer that caught / got the Pokemon

  • :trainer_id (Integer) —

    ID of the trainer that caught / got the Pokemon

Returns:



1801
1802
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1801

def generate_from_hash(hash)
end

.icon_filename(id, form, female, shiny, egg) ⇒ String

Icon filename of a Pokemon

Parameters:

  • id (Integer) —

    ID of the Pokemon

  • form (Integer) —

    form index of the Pokemon

  • female (Boolean) —

    if the Pokemon is a female

  • shiny (Boolean) —

    shiny state of the Pokemon

  • egg (Boolean) —

    egg state of the Pokemon

Returns:



737
738
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 737

def icon_filename(id, form, female, shiny, egg)
end

.missing_resources_error(id) ⇒ String

Display an error in case of missing resources and fallback to the default one

Parameters:

  • id (Integer, Symbol) —

    ID of the Pokemon

Returns:



778
779
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 778

def missing_resources_error(id)
end

Instance Method Details

#ability_db_symbol ⇒ Symbol

Return the db_symbol of the Pokemon’s Ability

Returns:

  • (Symbol) 


705
706
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 705

def ability_db_symbol
end

#ability_descr ⇒ String

Reture the description of the current ability of the Pokemon

Returns:



1852
1853
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1852

def ability_descr
end

#ability_name ⇒ String

Return the name of the current ability of the Pokemon

Returns:



1848
1849
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1848

def ability_name
end

#absofusion(pokemon)

Absofusion of the Pokemon (if possible)

Parameters:

  • pokemon —

    PFM::Pokemon The Pokemon used in the fusion



1131
1132
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1131

def absofusion(pokemon)
end

#absofusionned? ⇒ Boolean

If the Pokemon is a absofusion

Returns:

  • (Boolean) 


1137
1138
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1137

def absofusionned?
end

#acc_stage ⇒ Integer

Return the accuracy stage

Returns:

  • (Integer) 


1375
1376
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1375

def acc_stage
end

#add_bonus(list) ⇒ Boolean?

Add ev bonus to a Pokemon (with item interaction : x2)

Parameters:

  • list (Array<Integer>) —

    an ev list : [hp, atk, dfe, spd, ats, dfs]

Returns:

  • (Boolean, nil) —

    if the ev had totally been added or not (nil = couldn’t be added at all)



836
837
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 836

def add_bonus(list)
end

#add_ev_atk(n, evs) ⇒ Boolean

Safely add ATK EV

Parameters:

  • n (Integer) —

    amount of EV to add

  • evs (Integer) —

    total ev

Returns:

  • (Boolean) —

    if the ev has successfully been added



871
872
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 871

def add_ev_atk(n, evs)
end

#add_ev_ats(n, evs) ⇒ Boolean

Safely add ATS EV

Parameters:

  • n (Integer) —

    amount of EV to add

  • evs (Integer) —

    total ev

Returns:

  • (Boolean) —

    if the ev has successfully been added



889
890
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 889

def add_ev_ats(n, evs)
end

#add_ev_dfe(n, evs) ⇒ Boolean

Safely add DFE EV

Parameters:

  • n (Integer) —

    amount of EV to add

  • evs (Integer) —

    total ev

Returns:

  • (Boolean) —

    if the ev has successfully been added



877
878
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 877

def add_ev_dfe(n, evs)
end

#add_ev_dfs(n, evs) ⇒ Boolean

Safely add DFS EV

Parameters:

  • n (Integer) —

    amount of EV to add

  • evs (Integer) —

    total ev

Returns:

  • (Boolean) —

    if the ev has successfully been added



895
896
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 895

def add_ev_dfs(n, evs)
end

#add_ev_hp(n, evs) ⇒ Boolean

Safely add HP EV

Parameters:

  • n (Integer) —

    amount of EV to add

  • evs (Integer) —

    total ev

Returns:

  • (Boolean) —

    if the ev has successfully been added



865
866
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 865

def add_ev_hp(n, evs)
end

#add_ev_spd(n, evs) ⇒ Boolean

Safely add SPD EV

Parameters:

  • n (Integer) —

    amount of EV to add

  • evs (Integer) —

    total ev

Returns:

  • (Boolean) —

    if the ev has successfully been added



883
884
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 883

def add_ev_spd(n, evs)
end

#add_ribbon(id)

Add a ribbon to the Pokemon

Parameters:

  • id (Integer) —

    ID of the ribbon (in the ribbon text file)



709
710
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 709

def add_ribbon(id)
end

#alive? ⇒ Boolean

Is the Pokemon able to fight

Returns:

  • (Boolean) 


1549
1550
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1549

def alive?
end

#asleep? ⇒ Boolean

Is the Pokemon asleep?

Returns:

  • (Boolean) 


1600
1601
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1600

def asleep?
end

#atk ⇒ Integer

Return the current atk

Returns:

  • (Integer) 


1331
1332
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1331

def atk
end

#atk_basis ⇒ Integer

Return the atk stat without battle modifier

Returns:

  • (Integer) 


1455
1456
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1455

def atk_basis
end

#atk_modifier ⇒ Float

Return the atk modifier

Returns:

  • (Float) —

    the multiplier



1425
1426
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1425

def atk_modifier
end

#atk_stage ⇒ Integer

Return the atk stage

Returns:

  • (Integer) 


1351
1352
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1351

def atk_stage
end

#ats ⇒ Integer

Return the current ats

Returns:

  • (Integer) 


1343
1344
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1343

def ats
end

#ats_basis ⇒ Integer

Return the ats stat without battle modifier

Returns:

  • (Integer) 


1467
1468
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1467

def ats_basis
end

#ats_modifier ⇒ Float

Return the ats modifier

Returns:

  • (Float) —

    the multiplier



1437
1438
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1437

def ats_modifier
end

#ats_stage ⇒ Integer

Return the ats stage

Returns:

  • (Integer) 


1363
1364
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1363

def ats_stage
end

#ball_color ⇒ Color

Return the ball color of the Pokemon (flash)

Returns:



681
682
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 681

def ball_color
end

#ball_image ⇒ Texture

Return the ball image of the Pokemon

Returns:



727
728
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 727

def ball_image
end

#ball_sprite ⇒ String

Return the ball sprite name of the Pokemon

Returns:

  • (String) —

    Sprite to load in Graphics/ball/



677
678
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 677

def ball_sprite
end

#base_atk ⇒ Integer

Return the base ATK

Returns:

  • (Integer) 


1307
1308
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1307

def base_atk
end

#base_ats ⇒ Integer

Return the base ATS

Returns:

  • (Integer) 


1319
1320
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1319

def base_ats
end

#base_dfe ⇒ Integer

Return the base DFE

Returns:

  • (Integer) 


1311
1312
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1311

def base_dfe
end

#base_dfs ⇒ Integer

Return the base DFS

Returns:

  • (Integer) 


1323
1324
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1323

def base_dfs
end

#base_exp ⇒ Integer

Return the base experience of the Pokemon

Returns:

  • (Integer) 


920
921
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 920

def base_exp
end

#base_hp ⇒ Integer

Return the base HP

Returns:

  • (Integer) 


1303
1304
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1303

def base_hp
end

#base_spd ⇒ Integer

Return the base SPD

Returns:

  • (Integer) 


1315
1316
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1315

def base_spd
end

#battle_list ⇒ Array<Integer>

Return the list of EV the pokemon gives when beaten

Returns:

  • (Array<Integer>) —

    ev list (used in bonus functions) : [hp, atk, dfe, spd, ats, dfs]



831
832
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 831

def battle_list
end

#battler_back ⇒ Texture

Return the back battle of the Pokemon

Returns:



806
807
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 806

def battler_back
end

#battler_face ⇒ Texture Also known as: battler_front

Return the front battler of the Pokemon

Returns:



801
802
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 801

def battler_face
end

#burn? ⇒ Boolean Also known as: burnt?

Is the Pokemon burnt?

Returns:

  • (Boolean) 


1586
1587
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1586

def burn?
end

#calyrex_form(reason)

Determine the form of the Calyrex

Parameters:

  • reason (Symbol) —

    The db_symbol of the Pokemon used for the fusion



1179
1180
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1179

def calyrex_form(reason)
end

#can_be_asleep? ⇒ Boolean

Can the Pokemon be asleep?

Returns:

  • (Boolean) 


1610
1611
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1610

def can_be_asleep?
end

#can_be_burn? ⇒ Boolean

Can the Pokemon be burnt?

Returns:

  • (Boolean) 


1596
1597
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1596

def can_be_burn?
end

#can_be_frozen?(skill_type = 0) ⇒ Boolean

Can the Pokemon be frozen?

Returns:

  • (Boolean) 


1627
1628
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1627

def can_be_frozen?(skill_type = 0)
end

#can_be_paralyzed? ⇒ Boolean

Can the Pokemon be paralyzed?

Returns:

  • (Boolean) 


1582
1583
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1582

def can_be_paralyzed?
end

#can_be_poisoned? ⇒ Boolean

Can the Pokemon be poisoned ?

Returns:

  • (Boolean) 


1569
1570
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1569

def can_be_poisoned?
end

#can_learn?(db_symbol) ⇒ Boolean?

Check if the Pokemon can learn a skill

Parameters:

  • db_symbol (Integer, Symbol) —

    id or db_symbol of the move

Returns:

  • (Boolean, nil) —

    nil = learnt, false = cannot learn, true = can learn



1285
1286
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1285

def can_learn?(db_symbol)
end

#can_learn_skill_at_this_level?(level = @level) ⇒ Boolean

Can learn skill at this level

Parameters:

  • level (Integer) (defaults to: @level)

Returns:

  • (Boolean) 


1280
1281
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1280

def can_learn_skill_at_this_level?(level = @level)
end

#can_mega_evolve? ⇒ Integer, false

Check if the Pokemon can mega evolve

Returns:

  • (Integer, false) —

    form index if the Pokemon can mega evolve, false otherwise



1118
1119
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1118

def can_mega_evolve?
end

#captured_zone_name ⇒ String

Return the name of the zone where the Pokemon has been caught

Returns:



1836
1837
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1836

def captured_zone_name
end

#caught_by_player? ⇒ Boolean

Tell if the Pokemon is caught by the trainer

Returns:

  • (Boolean) 


624
625
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 624

def caught_by_player?
end

#change_acc(amount) ⇒ Integer

Change the acc stage

Parameters:

  • amount (Integer) —

    the amount to change on the stat stage

Returns:

  • (Integer) —

    the difference between the current and the last stage value



1416
1417
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1416

def change_acc(amount)
end

#change_atk(amount) ⇒ Integer

Change the atk stage

Parameters:

  • amount (Integer) —

    the amount to change on the stat stage

Returns:

  • (Integer) —

    the difference between the current and the last stage value



1386
1387
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1386

def change_atk(amount)
end

#change_ats(amount) ⇒ Integer

Change the ats stage

Parameters:

  • amount (Integer) —

    the amount to change on the stat stage

Returns:

  • (Integer) —

    the difference between the current and the last stage value



1401
1402
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1401

def change_ats(amount)
end

#change_dfe(amount) ⇒ Integer

Change the dfe stage

Parameters:

  • amount (Integer) —

    the amount to change on the stat stage

Returns:

  • (Integer) —

    the difference between the current and the last stage value



1391
1392
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1391

def change_dfe(amount)
end

#change_dfs(amount) ⇒ Integer

Change the dfs stage

Parameters:

  • amount (Integer) —

    the amount to change on the stat stage

Returns:

  • (Integer) —

    the difference between the current and the last stage value



1406
1407
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1406

def change_dfs(amount)
end

#change_eva(amount) ⇒ Integer

Change the eva stage

Parameters:

  • amount (Integer) —

    the amount to change on the stat stage

Returns:

  • (Integer) —

    the difference between the current and the last stage value



1411
1412
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1411

def change_eva(amount)
end

#change_spd(amount) ⇒ Integer

Change the spd stage

Parameters:

  • amount (Integer) —

    the amount to change on the stat stage

Returns:

  • (Integer) —

    the difference between the current and the last stage value



1396
1397
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1396

def change_spd(amount)
end

#change_stat(stat_id, amount) ⇒ Integer

Change a stat stage

Parameters:

  • stat_id (Integer) —

    id of the stat : 0 = atk, 1 = dfe, 2 = spd, 3 = ats, 4 = dfs, 5 = eva, 6 = acc

  • amount (Integer) —

    the amount to change on the stat stage

Returns:

  • (Integer) —

    the difference between the current and the last stage value



1381
1382
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1381

def change_stat(stat_id, amount)
end

#character_name ⇒ String

Return the character name of the Pokemon

Returns:



814
815
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 814

def character_name
end

#check_skill_and_learn(silent = false, level = @level)

Check if the Pokemon can learn a new skill and make it learn the skill

Parameters:

  • silent (Boolean) (defaults to: false) —

    if the skill is automatically learnt or not (false = show skill learn interface & messages)

  • level (Integer) (defaults to: @level) —

    The level to check in order to learn the moves (<= 0 = evolution)



1276
1277
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1276

def check_skill_and_learn(silent = false, level = @level)
end

#cramorant_form(reason)

Determine the form of Cramorant

Parameters:

  • reason (Symbol) 


1175
1176
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1175

def cramorant_form(reason)
end

#cry ⇒ String

Return the cry file name of the Pokemon

Returns:



818
819
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 818

def cry
end

#cure

Cure the Pokemon from its statues modifications



1556
1557
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1556

def cure
end

#current_deerling_form ⇒ Integer

Calculate the form of deerling & sawsbuck

Returns:

  • (Integer) —

    the right form



1154
1155
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1154

def current_deerling_form
end

#data ⇒ Studio::CreatureForm Also known as: get_data

Get the current data of the Pokemon

Returns:



576
577
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 576

def data
end

#db_symbol ⇒ Symbol

Return the db_symbol of the Pokemon in the database

Returns:

  • (Symbol) 


603
604
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 603

def db_symbol
end

#dead? ⇒ Boolean

Is the Pokemon not able to fight

Returns:

  • (Boolean) 


1545
1546
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1545

def dead?
end

#dfe ⇒ Integer

Return the current dfe

Returns:

  • (Integer) 


1335
1336
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1335

def dfe
end

#dfe_basis ⇒ Integer

Return the dfe stat without battle modifier

Returns:

  • (Integer) 


1459
1460
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1459

def dfe_basis
end

#dfe_modifier ⇒ Float

Return the dfe modifier

Returns:

  • (Float) —

    the multiplier



1429
1430
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1429

def dfe_modifier
end

#dfe_stage ⇒ Integer

Return the dfe stage

Returns:

  • (Integer) 


1355
1356
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1355

def dfe_stage
end

#dfs ⇒ Integer

Return the current dfs

Returns:

  • (Integer) 


1347
1348
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1347

def dfs
end

#dfs_basis ⇒ Integer

Return the dfs stat without battle modifier

Returns:

  • (Integer) 


1471
1472
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1471

def dfs_basis
end

#dfs_modifier ⇒ Float

Return the dfs modifier

Returns:

  • (Float) —

    the multiplier



1441
1442
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1441

def dfs_modifier
end

#dfs_stage ⇒ Integer

Return the dfs stage

Returns:

  • (Integer) 


1367
1368
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1367

def dfs_stage
end

#dv_modifier(list)

Change the IV and update the statistics

Parameters:

  • list (Array<Integer>) —

    list of new IV [hp, atk, dfe, spd, ats, dfs]



1445
1446
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1445

def dv_modifier(list)
end

#edit_bonus(list) ⇒ Boolean?

Add ev bonus to a Pokemon (without item interaction)

Parameters:

  • list (Array<Integer>) —

    an ev list : [hp, atk, dfe, spd, ats, dfs]

Returns:

  • (Boolean, nil) —

    if the ev had totally been added or not (nil = couldn’t be added at all)



841
842
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 841

def edit_bonus(list)
end

#egg? ⇒ Boolean Also known as: egg

Tell if the Pokemon is an egg or not

Returns:

  • (Boolean) 


607
608
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 607

def egg?
end

#egg_finish

Ends the egg process of the Pokemon



338
339
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 338

def egg_finish
end

#egg_init

Initialize the egg process of the Pokemon



335
336
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 335

def egg_init
end

#egg_zone_name ⇒ String

Return the name of the zone where the egg has been obtained

Returns:



1840
1841
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1840

def egg_zone_name
end

#elv_armulys ⇒ Boolean

Check evolve condition to evolve in Silcoon (Armulys)

Returns:

  • (Boolean) —

    if the condition is valid



1033
1034
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1033

def elv_armulys
end

#elv_blindalys ⇒ Boolean

Check evolve condition to evolve in Cascoon (Blindalys)

Returns:

  • (Boolean) —

    if the condition is valid



1037
1038
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1037

def elv_blindalys
end

#elv_demanta ⇒ Boolean

Check evolve condition to evolve in Mantine

Returns:

  • (Boolean) —

    if the condition is valid



1041
1042
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1041

def elv_demanta
end

#elv_kapoera ⇒ Boolean

Check evolve condition to evolve in Hitmontop (Kapoera)

Returns:

  • (Boolean) —

    if the condition is valid



1029
1030
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1029

def elv_kapoera
end

#elv_kicklee ⇒ Boolean

Check evolve condition to evolve in Hitmonlee (kicklee)

Returns:

  • (Boolean) —

    if the condition is valid



1021
1022
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1021

def elv_kicklee
end

#elv_nymphali ⇒ Boolean

Check evolve condition to evolve in Sylveon (Nymphali)

Returns:

  • (Boolean) —

    if the condition is valid



1054
1055
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1054

def elv_nymphali
end

#elv_pandarbare ⇒ Boolean

Check evolve condition to evolve in Pangoro (Pandarbare)

Returns:

  • (Boolean) —

    if the condition is valid



1045
1046
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1045

def elv_pandarbare
end

#elv_sepiatroce ⇒ Boolean

Note:

uses :DOWN to validate the evolve condition

Check evolve condition to evolve in Malamar (Sepiatroce)

Returns:

  • (Boolean) —

    if the condition is valid



1050
1051
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1050

def elv_sepiatroce
end

#elv_toxtricity_amped

Check evolve condition to evolve in Toxtricity-amped (Salarsen-aigüe)

0, 2, 3, 4, 6, 8, 9, 11, 13, 14, 19, 22, 24

return [Boolean] if the condition is valid



1059
1060
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1059

def elv_toxtricity_amped
end

#elv_toxtricity_low_key

Check evolve condition when not in Toxtricity-amped (Salarsen-aigüe)



1062
1063
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1062

def elv_toxtricity_low_key
end

#elv_tygnon ⇒ Boolean

Check evolve condition to evolve in Hitmonchan (tygnon)

Returns:

  • (Boolean) —

    if the condition is valid



1025
1026
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1025

def elv_tygnon
end

#encode ⇒ String

Encode the Pokemon to a String in order to send it to the GTS system

Returns:



314
315
 
# File 'docs/01450_Systems_09000_GTS.rb', line 314

def encode
end

#ev_atk_text ⇒ String

Return the EV ATK text

Returns:



1484
1485
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1484

def ev_atk_text
end

#ev_ats_text ⇒ String

Return the EV ATS text

Returns:



1496
1497
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1496

def ev_ats_text
end

#ev_check(index, apply = false, count = 1) ⇒ Integer, false

Automatic ev adder using an index

Parameters:

  • index (Integer) —

    ev index (see GameData::EV), should add 10. If index > 10 take index % 10 and add only 1 EV.

  • apply (Boolean) (defaults to: false) —

    if the ev change is applied

  • count (Integer) (defaults to: 1) —

    number of EV to add

Returns:

  • (Integer, false) —

    if not false, the value of the current EV depending on the index



852
853
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 852

def ev_check(index, apply = false, count = 1)
end

#ev_dfe_text ⇒ String

Return the EV DFE text

Returns:



1488
1489
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1488

def ev_dfe_text
end

#ev_dfs_text ⇒ String

Return the EV DFS text

Returns:



1500
1501
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1500

def ev_dfs_text
end

#ev_hp_text ⇒ String

Return the EV HP text

Returns:



1480
1481
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1480

def ev_hp_text
end

#ev_spd_text ⇒ String

Return the EV SPD text

Returns:



1492
1493
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1492

def ev_spd_text
end

#ev_var(index, evs, value = 0) ⇒ Integer

Get and add EV

Parameters:

  • index (Integer) —

    ev index (see GameData::EV)

  • evs (Integer) —

    the total ev

  • value (Integer) (defaults to: 0) —

    the quantity of EV to add (if 0 no add)

Returns:

  • (Integer) 


859
860
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 859

def ev_var(index, evs, value = 0)
end

#eva_stage ⇒ Integer

Return the evasion stage

Returns:

  • (Integer) 


1371
1372
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1371

def eva_stage
end

#evolve(id, form)

Method that actually make a Pokemon evolve

Parameters:

  • id (Integer) —

    ID of the Pokemon that evolve

  • form (Integer, nil) —

    form of the Pokemon that evolve



999
1000
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 999

def evolve(id, form)
end

#evolve_check(reason = :level_up, extend_data = nil) ⇒ Array<Integer, nil>, false

Check if the Pokemon can evolve and return the evolve id if possible

Parameters:

  • reason (Symbol) (defaults to: :level_up) —

    evolve check reason (:level_up, :trade, :stone)

  • extend_data (Hash, nil) (defaults to: nil) —

    extend_data generated by an item

Returns:

  • (Array<Integer, nil>, false) —

    if the Pokemon can evolve, the evolve id, otherwise false



971
972
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 971

def evolve_check(reason = :level_up, extend_data = nil)
end

#exp_list ⇒ ExpList

Return the exp curve

Returns:



928
929
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 928

def exp_list
end

#exp_lvl ⇒ Integer

Return the required total exp (so including old levels) to increase the Pokemon’s level

Returns:

  • (Integer) 


932
933
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 932

def exp_lvl
end

#exp_remaining_text ⇒ String

Return the text of the amount of exp the pokemon needs to go to the next level

Returns:



936
937
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 936

def exp_remaining_text
end

#exp_text ⇒ String

Return the text of the current pokemon experience

Returns:



940
941
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 940

def exp_text
end

#exp_type ⇒ Integer

Return the exp curve type ID

Returns:

  • (Integer) 


924
925
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 924

def exp_type
end

#female? ⇒ Boolean

Tell if the Pokemon is a female

Returns:

  • (Boolean) 


645
646
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 645

def female?
end

#find_skill(db_symbol) ⇒ PFM::Skill, false

Find a skill in the moveset of the Pokemon

Parameters:

  • db_symbol (Symbol) —

    db_symbol of the skill in the database

Returns:



1271
1272
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1271

def find_skill(db_symbol)
end

#flags ⇒ Integer

Get Pokemon flags

Returns:

  • (Integer) 


616
617
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 616

def flags
end

#flags=(flag)

Set the captured_in flags (to know from which game the pokemon came from)

Parameters:

  • flag (Integer) —

    the new flag



612
613
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 612

def flags=(flag)
end

#flavor_disliked?(flavor) ⇒ Boolean

Tell if the Creature dislikes flavor

Parameters:

  • flavor (Symbol)

Returns:

  • (Boolean) 


1902
1903
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1902

def flavor_disliked?(flavor)
end

#flavor_liked?(flavor) ⇒ Boolean

Tell if the Creature likes flavor

Parameters:

  • flavor (Symbol)

Returns:

  • (Boolean) 


1898
1899
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1898

def flavor_liked?(flavor)
end

#forget_skill(db_symbol, delete_from_learnt: false)

Forget a skill by its id

Parameters:

  • db_symbol (Symbol) —

    db_symbol of the move in the database

  • delete_from_learnt (Boolean) (defaults to: false) —

    if the skill should be deleted from the skill_learnt attribute of the Pokemon



1249
1250
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1249

def forget_skill(db_symbol, delete_from_learnt: false)
end

#form_calibrate(reason = :menu) ⇒ Boolean

Note:

It calls the block stored in the hash FORM_CALIBRATE where the key is the Pokemon db_symbol & the block parameter is the reason. The block should change @form

Automatically calibrate the form of the Pokemon

Parameters:

  • reason (Symbol) (defaults to: :menu) —

    what called form_calibrate (:menu, :evolve, :load, …)

Returns:

  • (Boolean) —

    if the Pokemon’s form has changed



1150
1151
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1150

def form_calibrate(reason = :menu)
end

#form_generation(form, old_value = nil) ⇒ Integer

Note:

It calls the block stored in the hash FORM_GENERATION where the key is the Pokemon db_symbol

Automatically generate the form index of the Pokemon

Parameters:

  • form (Integer) —

    if form != 0 does not generate the form (protection)

Returns:

  • (Integer) —

    the form index



1143
1144
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1143

def form_generation(form, old_value = nil)
end

#from_past? ⇒ Boolean

Tell if the pokemon is from a past version

Returns:

  • (Boolean) 


620
621
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 620

def from_past?
end

#from_player? ⇒ Boolean

Return if the Pokemon is from the player (he caught it)

Returns:

  • (Boolean) 


689
690
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 689

def from_player?
end

#front_offset_y ⇒ Integer

Return the front offset y of the Pokemon

Returns:

  • (Integer) 


810
811
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 810

def front_offset_y
end

#frozen? ⇒ Boolean

Is the Pokemon frozen?

Returns:

  • (Boolean) 


1618
1619
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1618

def frozen?
end

#genderless? ⇒ Boolean

Tell if the Pokemon is genderless

Returns:

  • (Boolean) 


637
638
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 637

def genderless?
end

#get_dv_value(value, old) ⇒ Integer

Get the adjusted IV

Parameters:

  • value (Integer) —

    the new value

  • old (Integer) —

    the old value

Returns:

  • (Integer) —

    something between old and 31 (value in most case)



1451
1452
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1451

def get_dv_value(value, old)
end

#gif_back ⇒ ::Yuki::GifReader?

Return the GifReader back of the Pokemon

Returns:



826
827
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 826

def gif_back
end

#gif_face ⇒ ::Yuki::GifReader?

Return the GifReader face of the Pokemon

Returns:



822
823
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 822

def gif_face
end

#height ⇒ Numeric

Return the height of the Pokemon

Returns:

  • (Numeric) 


669
670
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 669

def height
end

#hp_pokemon_number ⇒ String

Returns the HP text (to_pokemon_number)

Returns:



1876
1877
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1876

def hp_pokemon_number
end

#hp_text ⇒ String

Returns the HP text

Returns:



1872
1873
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1872

def hp_text
end

#icon ⇒ Texture

Return the icon of the Pokemon

Returns:



797
798
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 797

def icon
end

#id_text ⇒ String

Return the text of the Pokemon ID

Returns:



1880
1881
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1880

def id_text
end

#id_text2 ⇒ String

Return the text of the Pokemon ID with N°

Returns:



1884
1885
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1884

def id_text2
end

#id_text3 ⇒ String

Return the text of the Pokemon ID to pokemon number

Returns:



1888
1889
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1888

def id_text3
end

#item_db_symbol ⇒ Symbol

Return the db_symbol of the Pokemon’s item held

Returns:

  • (Symbol) 


693
694
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 693

def item_db_symbol
end

#item_hold ⇒ Integer

Alias for item_holding

Returns:

  • (Integer) 


697
698
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 697

def item_hold
end

#item_name ⇒ String

Return the name of the item the Pokemon is holding

Returns:



1844
1845
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1844

def item_name
end

#iv_atk_text ⇒ String

Return the IV ATK text

Returns:



1508
1509
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1508

def iv_atk_text
end

#iv_ats_text ⇒ String

Return the IV ATS text

Returns:



1520
1521
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1520

def iv_ats_text
end

#iv_dfe_text ⇒ String

Return the IV DFE text

Returns:



1512
1513
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1512

def iv_dfe_text
end

#iv_dfs_text ⇒ String

Return the IV DFS text

Returns:



1524
1525
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1524

def iv_dfs_text
end

#iv_hp_text ⇒ String

Return the IV HP text

Returns:



1504
1505
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1504

def iv_hp_text
end

#iv_spd_text ⇒ String

Return the IV SPD text

Returns:



1516
1517
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1516

def iv_spd_text
end

#kyurem_form(reason)

Determine the form of the Kyurem

Parameters:

  • reason (Symbol) —

    The db_symbol of the Pokemon used for the fusion



1162
1163
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1162

def kyurem_form(reason)
end

#learn_skill(db_symbol) ⇒ Boolean?

Learn a new skill

Parameters:

  • db_symbol (Symbol) —

    db_symbol of the move in the database

Returns:

  • (Boolean, nil) —

    true = learnt, false = already learnt, nil = couldn’t learn



1244
1245
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1244

def learn_skill(db_symbol)
end

#level_pokemon_number ⇒ String

Return the level text (to_pokemon_number)

Returns:



1864
1865
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1864

def level_pokemon_number
end

#level_text ⇒ String

Returns the level text

Returns:



1860
1861
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1860

def level_text
end

#level_text2 ⇒ String

Return the level text with “Level: ” inside

Returns:



1868
1869
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1868

def level_text2
end

#level_up ⇒ Boolean

Increase the level of the Pokemon

Returns:

  • (Boolean) —

    if the level has successfully been increased



948
949
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 948

def level_up
end

#level_up_stat_refresh ⇒ Array<Array<Integer>>

Generate the level up stat list for the level up window

Returns:

  • (Array<Array<Integer>>) —

    list0, list1 : old, new basis value



955
956
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 955

def level_up_stat_refresh
end

#level_up_window_call(list0, list1, z_level)

Show the level up window

Parameters:

  • list0 (Array<Integer>) —

    old basis stat list

  • list1 (Array<Integer>) —

    new basis stat list

  • z_level (Integer) —

    z superiority of the Window



961
962
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 961

def level_up_window_call(list0, list1, z_level)
end

#load_skill_from_array(skills)

Load the skill from an Array

Parameters:

  • skills (Array) —

    the skills array (containing IDs or Symbols)



1297
1298
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1297

def load_skill_from_array(skills)
end

#male? ⇒ Boolean

Tell if the Pokemon is a male

Returns:

  • (Boolean) 


641
642
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 641

def male?
end

#max_hp ⇒ Integer

Return the max HP of the Pokemon

Returns:

  • (Integer) 


1327
1328
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1327

def max_hp
end

#max_level ⇒ Integer

Give the maximum level of the Pokemon

Returns:

  • (Integer) 


581
582
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 581

def max_level
end

#max_level=(level)

Set the maximum level of the Pokemon

Parameters:

  • level (Integer, nil) 


585
586
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 585

def max_level=(level)
end

#mega_evolve

Mega evolve the Pokemon (if possible)



1121
1122
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1121

def mega_evolve
end

#mega_evolved? ⇒ Boolean

Is the Pokemon mega evolved ?

Returns:

  • (Boolean) 


1127
1128
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1127

def mega_evolved?
end

#modifier_stage(stage) ⇒ Float

Return the stage modifier (multiplier)

Parameters:

  • stage (Integer) —

    the value of the stage

Returns:

  • (Float) —

    the multiplier



1421
1422
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1421

def modifier_stage(stage)
end

#name ⇒ String

Return the Pokemon name in the Pokedex

Returns:



1810
1811
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1810

def name
end

#name_upper ⇒ String

Return the Pokemon name upcase in the Pokedex

Returns:



1814
1815
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1814

def name_upper
end

#nature_id ⇒ Integer

Return the nature id of the Pokemon

Returns:

  • (Integer) 


657
658
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 657

def nature_id
end

#nature_text ⇒ String

Return the text of the nature

Returns:



1832
1833
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1832

def nature_text
end

#necrozma_form(reason)

Determine the form of the Necrozma

Parameters:

  • reason (Symbol) —

    The db_symbol of the Pokemon used for the fusion



1166
1167
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1166

def necrozma_form(reason)
end

#no_preferences? ⇒ Boolean

Check if the Creature has a nature with no preferences

Returns:

  • (Boolean) 


1905
1906
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1905

def no_preferences?
end

#paralyzed? ⇒ Boolean

Is the Pokemon paralyzed?

Returns:

  • (Boolean) 


1573
1574
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1573

def paralyzed?
end

#poisoned? ⇒ Boolean

Is the Pokemon poisoned?

Returns:

  • (Boolean) 


1560
1561
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1560

def poisoned?
end

#primary_data ⇒ Studio::CreatureForm

Get the primary data of the Pokemon

Returns:



572
573
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 572

def primary_data
end

#rareness ⇒ Integer

Return the Pokemon rareness

Returns:

  • (Integer) 


661
662
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 661

def rareness
end

#rareness=(v)

Change the Pokemon rareness

Parameters:

  • v (Integer, nil) —

    the new rareness of the Pokemon



665
666
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 665

def rareness=(v)
end

#remindable_skills(mode = 0) ⇒ Array<Symbol>

Get the list of all the skill the Pokemon can learn again

Parameters:

  • mode (Integer) (defaults to: 0) —

    Define the moves that can be learnt again : 1 = breed_moves + learnt + potentially_learnt 2 = all moves other = learnt + potentially_learnt

Returns:

  • (Array<Symbol>) 


1293
1294
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1293

def remindable_skills(mode = 0)
end

#replace_skill_index(index, db_symbol)

Replace the skill at a specific index

Parameters:

  • index (Integer) —

    index of the skill to replace by a new skill

  • db_symbol (Symbol) —

    db_symbol of the move in the database



1259
1260
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1259

def replace_skill_index(index, db_symbol)
end

#ribbon_got?(id) ⇒ Boolean

Has the pokemon got a ribbon ?

Returns:

  • (Boolean) 


713
714
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 713

def ribbon_got?(id)
end

#separate

Separate (if possible) the Pokemon and restore the Pokemon used in the fusion



1134
1135
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1134

def separate
end

#shaymin_form(reason)

Determine the form of Shaymin

Parameters:

  • reason (Symbol) 


1158
1159
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1158

def shaymin_form(reason)
end

#shiny=(shiny)

Set the shiny attribut

Parameters:

  • shiny (Boolean) 


594
595
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 594

def shiny=(shiny)
end

#shiny? ⇒ Boolean Also known as: shiny

Get the shiny attribute

Returns:

  • (Boolean) 


589
590
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 589

def shiny?
end

#shiny_rate ⇒ Integer

Give the shiny rate for the Pokemon, The number should be between 0 & 0xFFFF. 0 means absolutely no chance to be shiny, 0xFFFF means always shiny

Returns:

  • (Integer) 


599
600
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 599

def shiny_rate
end

#single_type? ⇒ Boolean

Is the user single typed ?

Returns:

  • (Boolean) 


1750
1751
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1750

def single_type?
end

#skill_learnt?(db_symbol, only_in_move_set: true) ⇒ Boolean Also known as: has_skill?

Has the pokemon already learnt a skill ?

Parameters:

  • db_symbol (Symbol) —

    db_symbol of the move

  • only_in_move_set (Boolean) (defaults to: true) —

    if the function only check in the current move set

Returns:

  • (Boolean) 


1265
1266
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1265

def skill_learnt?(db_symbol, only_in_move_set: true)
end

#sleep_check ⇒ Boolean

Check if the Pokemon is still asleep

Returns:

  • (Boolean) —

    true = the Pokemon is still asleep



1614
1615
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1614

def sleep_check
end

#spd ⇒ Integer

Return the current spd

Returns:

  • (Integer) 


1339
1340
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1339

def spd
end

#spd_basis ⇒ Integer

Return the spd stat without battle modifier

Returns:

  • (Integer) 


1463
1464
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1463

def spd_basis
end

#spd_modifier ⇒ Float

Return the spd modifier

Returns:

  • (Float) —

    the multiplier



1433
1434
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1433

def spd_modifier
end

#spd_stage ⇒ Integer

Return the spd stage

Returns:

  • (Integer) 


1359
1360
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1359

def spd_stage
end

#status? ⇒ Boolean

Is the pokemon affected by a status

Returns:

  • (Boolean) 


1553
1554
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1553

def status?
end

#status_burn(forcing = false) ⇒ Boolean

Burn the Pokemon

Parameters:

  • forcing (Boolean) (defaults to: false) —

    force the new status

Returns:

  • (Boolean) —

    if the pokemon has been burnt



1592
1593
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1592

def status_burn(forcing = false)
end

#status_frozen(forcing = false) ⇒ Boolean

Freeze the Pokemon

Parameters:

  • forcing (Boolean) (defaults to: false) —

    force the new status

Returns:

  • (Boolean) —

    if the pokemon has been frozen



1623
1624
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1623

def status_frozen(forcing = false)
end

#status_paralyze(forcing = false) ⇒ Boolean

Paralyze the Pokemon

Parameters:

  • forcing (Boolean) (defaults to: false) —

    force the new status

Returns:

  • (Boolean) —

    if the pokemon has been paralyzed



1578
1579
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1578

def status_paralyze(forcing = false)
end

#status_poison(forcing = false) ⇒ Boolean

Empoison the Pokemon

Parameters:

  • forcing (Boolean) (defaults to: false) —

    force the new status

Returns:

  • (Boolean) —

    if the pokemon has been empoisoned



1565
1566
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1565

def status_poison(forcing = false)
end

#status_sleep(forcing = false, nb_turn = nil) ⇒ Boolean

Put the Pokemon to sleep

Parameters:

  • forcing (Boolean) (defaults to: false) —

    force the new status

  • nb_turn (Integer, nil) (defaults to: nil) —

    number of turn the Pokemon will sleep

Returns:

  • (Boolean) —

    if the pokemon has been put to sleep



1606
1607
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1606

def status_sleep(forcing = false, nb_turn = nil)
end

#status_toxic(forcing = true) ⇒ Boolean

Intoxicate the Pokemon

Parameters:

  • forcing (Boolean) (defaults to: true) —

    force the new status

Returns:

  • (Boolean) —

    if the pokemon has been intoxicated



1636
1637
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1636

def status_toxic(forcing = true)
end

#swap_skills_index(index1, index2)

Swap the position of two skills in the skills_set

Parameters:

  • index1 (Integer) —

    Index of the first skill to swap

  • index2 (Integer) —

    Index of the second skill to swap



1254
1255
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1254

def swap_skills_index(index1, index2)
end

#third_type? ⇒ Boolean

Has the user a third type ?

Returns:

  • (Boolean) 


1754
1755
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1754

def third_type?
end

#to_s ⇒ String

Convert the Pokemon to a string (battle debug)

Returns:



1828
1829
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1828

def to_s
end

#total_ev ⇒ Integer

Return the total amount of EV

Returns:

  • (Integer) 


845
846
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 845

def total_ev
end

#toxic? ⇒ Boolean

Is the Pokemon in toxic state ?

Returns:

  • (Boolean) 


1631
1632
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1631

def toxic?
end

#trainer_id_text ⇒ String

Return the normalized text trainer id of the Pokemon

Returns:



1856
1857
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1856

def trainer_id_text
end

#type?(type) ⇒ Boolean

Check the Pokemon type by the type ID

Parameters:

  • type (Integer) —

    ID of the type in the database

Returns:

  • (Boolean) 


1742
1743
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1742

def type?(type)
end

#type_bug? ⇒ Boolean Also known as: type_insect?

Is the Pokemon type insect/bug ?

Returns:

  • (Boolean) 


1707
1708
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1707

def type_bug?
end

#type_dark? ⇒ Boolean Also known as: type_tenebre?

Is the Pokemon type dark ?

Returns:

  • (Boolean) 


1731
1732
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1731

def type_dark?
end

#type_dragon? ⇒ Boolean

Is the Pokemon type dragon ?

Returns:

  • (Boolean) 


1722
1723
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1722

def type_dragon?
end

#type_electric? ⇒ Boolean Also known as: type_electrique?

Is the Pokemon type electric ?

Returns:

  • (Boolean) 


1667
1668
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1667

def type_electric?
end

#type_fairy? ⇒ Boolean Also known as: type_fee?

Is the Pokemon type fairy ?

Returns:

  • (Boolean) 


1736
1737
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1736

def type_fairy?
end

#type_fighting? ⇒ Boolean Also known as: type_combat?

Is the Pokemon type fighting ?

Returns:

  • (Boolean) 


1682
1683
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1682

def type_fighting?
end

#type_fire? ⇒ Boolean Also known as: type_feu?

Is the Pokemon type fire ?

Returns:

  • (Boolean) 


1657
1658
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1657

def type_fire?
end

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

Is the Pokemon type fly ?

Returns:

  • (Boolean) 


1696
1697
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1696

def type_flying?
end

#type_ghost? ⇒ Boolean Also known as: type_spectre?

Is the Pokemon type ghost ?

Returns:

  • (Boolean) 


1717
1718
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1717

def type_ghost?
end

#type_grass? ⇒ Boolean Also known as: type_plante?

Is the Pokemon type grass ?

Returns:

  • (Boolean) 


1672
1673
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1672

def type_grass?
end

#type_ground? ⇒ Boolean Also known as: type_sol?

Is the Pokemon type ground ?

Returns:

  • (Boolean) 


1691
1692
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1691

def type_ground?
end

#type_ice? ⇒ Boolean Also known as: type_glace?

Is the Pokemon type ice ?

Returns:

  • (Boolean) 


1677
1678
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1677

def type_ice?
end

#type_normal? ⇒ Boolean

Is the Pokemon type normal ?

Returns:

  • (Boolean) 


1653
1654
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1653

def type_normal?
end

#type_poison? ⇒ Boolean

Is the Pokemon type poison ?

Returns:

  • (Boolean) 


1687
1688
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1687

def type_poison?
end

#type_psychic? ⇒ Boolean Also known as: type_psy?

Is the Pokemon type psy ?

Returns:

  • (Boolean) 


1702
1703
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1702

def type_psychic?
end

#type_rock? ⇒ Boolean Also known as: type_roche?

Is the Pokemon type rock ?

Returns:

  • (Boolean) 


1712
1713
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1712

def type_rock?
end

#type_steel? ⇒ Boolean Also known as: type_acier?

Is the Pokemon type steel ?

Returns:

  • (Boolean) 


1726
1727
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1726

def type_steel?
end

#type_water? ⇒ Boolean Also known as: type_eau?

Is the Pokemon type water ?

Returns:

  • (Boolean) 


1662
1663
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1662

def type_water?
end

#typeless? ⇒ Boolean

Is the Pokemon typeless ?

Returns:

  • (Boolean) 


1746
1747
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1746

def typeless?
end

#unmega_evolve

Reset the Pokemon to its normal form after mega evolution



1124
1125
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1124

def unmega_evolve
end

#update_ability

Update the Pokemon Ability



1017
1018
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1017

def update_ability
end

#update_loyalty

Update the PFM::Pokemon loyalty



951
952
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 951

def update_loyalty
end

#weight ⇒ Numeric

Return the weight of the Pokemon

Returns:

  • (Numeric) 


673
674
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 673

def weight
end

#zone_id(special_zone = nil)

Get the zone id where the Pokemon has been found

Parameters:

  • special_zone (Integer, nil) (defaults to: nil) —

    if you want to use this function for stuff like egg_zone_id



628
629
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 628

def zone_id(special_zone = nil)
end

#zygarde_form(reason) ⇒ Integer

Determine the form of the Zygarde

Parameters:

  • reason (Symbol)

Returns:

  • (Integer) —

    form of zygarde



1171
1172
 
# File 'docs/01450_Systems_00000_General_00001_PFM.rb', line 1171

def zygarde_form(reason)
end