Class: Studio::CreatureForm

Inherits:
Creature show all
Defined in:
docs/3_Studio.rb

Overview

Data class describing a creature form

Defined Under Namespace

Classes: Evolution, FormTextId, ItemHeld, Resources

Instance Attribute Summary collapse

Attributes inherited from Creature

#db_symbol, #forms, #id

Instance Method Summary collapse

Methods inherited from Creature

#description, #name, #species

Instance Attribute Details

#abilities ⇒ Array<Symbol> (readonly)

Abilities the creature can have

Returns:

  • (Array<Symbol>) 


679
680
681
 
# File 'docs/3_Studio.rb', line 679

def abilities
  @abilities
end

#baby_db_symbol ⇒ Symbol (readonly)

db_symbol of the baby creature

Returns:

  • (Symbol) 


670
671
672
 
# File 'docs/3_Studio.rb', line 670

def baby_db_symbol
  @baby_db_symbol
end

#baby_form ⇒ Integer (readonly)

Form of the baby

Returns:

  • (Integer) 


673
674
675
 
# File 'docs/3_Studio.rb', line 673

def baby_form
  @baby_form
end

#base_atk ⇒ Integer (readonly)

Base atk of the form

Returns:

  • (Integer) 


613
614
615
 
# File 'docs/3_Studio.rb', line 613

def base_atk
  @base_atk
end

#base_ats ⇒ Integer (readonly)

Base ats of the form

Returns:

  • (Integer) 


622
623
624
 
# File 'docs/3_Studio.rb', line 622

def base_ats
  @base_ats
end

#base_dfe ⇒ Integer (readonly)

Base dfe of the form

Returns:

  • (Integer) 


616
617
618
 
# File 'docs/3_Studio.rb', line 616

def base_dfe
  @base_dfe
end

#base_dfs ⇒ Integer (readonly)

Base dfs of the form

Returns:

  • (Integer) 


625
626
627
 
# File 'docs/3_Studio.rb', line 625

def base_dfs
  @base_dfs
end

#base_experience ⇒ Integer (readonly)

Base experience use in exp calculation when fainted

Returns:

  • (Integer) 


652
653
654
 
# File 'docs/3_Studio.rb', line 652

def base_experience
  @base_experience
end

#base_hp ⇒ Integer (readonly)

Base hp of the form

Returns:

  • (Integer) 


610
611
612
 
# File 'docs/3_Studio.rb', line 610

def base_hp
  @base_hp
end

#base_loyalty ⇒ Integer (readonly)

Loyalty the creature have when caught

Returns:

  • (Integer) 


655
656
657
 
# File 'docs/3_Studio.rb', line 655

def base_loyalty
  @base_loyalty
end

#base_spd ⇒ Integer (readonly)

Base spd of the form

Returns:

  • (Integer) 


619
620
621
 
# File 'docs/3_Studio.rb', line 619

def base_spd
  @base_spd
end

#breed_groups ⇒ Array<Integer> (readonly)

List of breed groups of the creature

Returns:

  • (Array<Integer>) 


664
665
666
 
# File 'docs/3_Studio.rb', line 664

def breed_groups
  @breed_groups
end

#catch_rate ⇒ Integer (readonly)

Catch rate of the creature

Returns:

  • (Integer) 


658
659
660
 
# File 'docs/3_Studio.rb', line 658

def catch_rate
  @catch_rate
end

#ev_atk ⇒ Integer (readonly)

Atk EV given by this form when fainted

Returns:

  • (Integer) 


631
632
633
 
# File 'docs/3_Studio.rb', line 631

def ev_atk
  @ev_atk
end

#ev_ats ⇒ Integer (readonly)

Ats EV given by this form when fainted

Returns:

  • (Integer) 


640
641
642
 
# File 'docs/3_Studio.rb', line 640

def ev_ats
  @ev_ats
end

#ev_dfe ⇒ Integer (readonly)

Dfe EV given by this form when fainted

Returns:

  • (Integer) 


634
635
636
 
# File 'docs/3_Studio.rb', line 634

def ev_dfe
  @ev_dfe
end

#ev_dfs ⇒ Integer (readonly)

Dfs EV given by this form when fainted

Returns:

  • (Integer) 


643
644
645
 
# File 'docs/3_Studio.rb', line 643

def ev_dfs
  @ev_dfs
end

#ev_hp ⇒ Integer (readonly)

HP EV given by this form when fainted

Returns:

  • (Integer) 


628
629
630
 
# File 'docs/3_Studio.rb', line 628

def ev_hp
  @ev_hp
end

#ev_spd ⇒ Integer (readonly)

Spd EV given by this form when fainted

Returns:

  • (Integer) 


637
638
639
 
# File 'docs/3_Studio.rb', line 637

def ev_spd
  @ev_spd
end

#evolutions ⇒ Array<Evolution> (readonly)

All the evolutions of that form

Returns:



646
647
648
 
# File 'docs/3_Studio.rb', line 646

def evolutions
  @evolutions
end

#experience_type ⇒ Integer (readonly)

Type of exp curve for the form

Returns:

  • (Integer) 


649
650
651
 
# File 'docs/3_Studio.rb', line 649

def experience_type
  @experience_type
end

#female_rate ⇒ Integer (readonly)

Female rate of the creature

Returns:

  • (Integer) 


661
662
663
 
# File 'docs/3_Studio.rb', line 661

def female_rate
  @female_rate
end

#form ⇒ Integer (readonly)

Current form ID

Returns:

  • (Integer) 


592
593
594
 
# File 'docs/3_Studio.rb', line 592

def form
  @form
end

#form_text_id ⇒ FormTextId (readonly)

Current form text ID

Returns:



595
596
597
 
# File 'docs/3_Studio.rb', line 595

def form_text_id
  @form_text_id
end

#front_offset_y ⇒ Integer (readonly)

Front offset y of the creature so it can be centered in the UI

Returns:

  • (Integer) 


682
683
684
 
# File 'docs/3_Studio.rb', line 682

def front_offset_y
  @front_offset_y
end

#hatch_steps ⇒ Integer (readonly)

Number of steps before the egg hatches

Returns:

  • (Integer) 


667
668
669
 
# File 'docs/3_Studio.rb', line 667

def hatch_steps
  @hatch_steps
end

#height ⇒ Float (readonly)

Height of the form

Returns:

  • (Float) 


598
599
600
 
# File 'docs/3_Studio.rb', line 598

def height
  @height
end

#item_held ⇒ Array<ItemHeld> (readonly)

Item held by the creature when encountered

Returns:



676
677
678
 
# File 'docs/3_Studio.rb', line 676

def item_held
  @item_held
end

#move_set ⇒ Array<LearnableMove> (readonly)

Moveset of the creature

Returns:



685
686
687
 
# File 'docs/3_Studio.rb', line 685

def move_set
  @move_set
end

#resources ⇒ Resources (readonly)

Resources of the creature

Returns:



688
689
690
 
# File 'docs/3_Studio.rb', line 688

def resources
  @resources
end

#type1 ⇒ Symbol (readonly)

Symbol of the first type of the form

Returns:

  • (Symbol) 


604
605
606
 
# File 'docs/3_Studio.rb', line 604

def type1
  @type1
end

#type2 ⇒ Symbol (readonly)

Symbol of the second type of the form

Returns:

  • (Symbol) 


607
608
609
 
# File 'docs/3_Studio.rb', line 607

def type2
  @type2
end

#weight ⇒ Float (readonly)

Weight of the form

Returns:

  • (Float) 


601
602
603
 
# File 'docs/3_Studio.rb', line 601

def weight
  @weight
end

Instance Method Details

#form_description ⇒ string Also known as: form_descr

Get the creature form description

Returns:

  • (string) 


695
696
 
# File 'docs/3_Studio.rb', line 695

def form_description
end

#form_name ⇒ string

Get the creature form name

Returns:

  • (string) 


691
692
 
# File 'docs/3_Studio.rb', line 691

def form_name
end