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>)


798
799
800
# File 'docs/3_Studio.rb', line 798

def abilities
  @abilities
end

#baby_db_symbol ⇒ Symbol (readonly)

db_symbol of the baby creature

Returns:

  • (Symbol)


789
790
791
# File 'docs/3_Studio.rb', line 789

def baby_db_symbol
  @baby_db_symbol
end

#baby_form ⇒ Integer (readonly)

Form of the baby

Returns:

  • (Integer)


792
793
794
# File 'docs/3_Studio.rb', line 792

def baby_form
  @baby_form
end

#base_atk ⇒ Integer (readonly)

Base atk of the form

Returns:

  • (Integer)


732
733
734
# File 'docs/3_Studio.rb', line 732

def base_atk
  @base_atk
end

#base_ats ⇒ Integer (readonly)

Base ats of the form

Returns:

  • (Integer)


741
742
743
# File 'docs/3_Studio.rb', line 741

def base_ats
  @base_ats
end

#base_dfe ⇒ Integer (readonly)

Base dfe of the form

Returns:

  • (Integer)


735
736
737
# File 'docs/3_Studio.rb', line 735

def base_dfe
  @base_dfe
end

#base_dfs ⇒ Integer (readonly)

Base dfs of the form

Returns:

  • (Integer)


744
745
746
# File 'docs/3_Studio.rb', line 744

def base_dfs
  @base_dfs
end

#base_experience ⇒ Integer (readonly)

Base experience use in exp calculation when fainted

Returns:

  • (Integer)


771
772
773
# File 'docs/3_Studio.rb', line 771

def base_experience
  @base_experience
end

#base_hp ⇒ Integer (readonly)

Base hp of the form

Returns:

  • (Integer)


729
730
731
# File 'docs/3_Studio.rb', line 729

def base_hp
  @base_hp
end

#base_loyalty ⇒ Integer (readonly)

Loyalty the creature have when caught

Returns:

  • (Integer)


774
775
776
# File 'docs/3_Studio.rb', line 774

def base_loyalty
  @base_loyalty
end

#base_spd ⇒ Integer (readonly)

Base spd of the form

Returns:

  • (Integer)


738
739
740
# File 'docs/3_Studio.rb', line 738

def base_spd
  @base_spd
end

#breed_groups ⇒ Array<Integer> (readonly)

List of breed groups of the creature

Returns:

  • (Array<Integer>)


783
784
785
# File 'docs/3_Studio.rb', line 783

def breed_groups
  @breed_groups
end

#catch_rate ⇒ Integer (readonly)

Catch rate of the creature

Returns:

  • (Integer)


777
778
779
# File 'docs/3_Studio.rb', line 777

def catch_rate
  @catch_rate
end

#ev_atk ⇒ Integer (readonly)

Atk EV given by this form when fainted

Returns:

  • (Integer)


750
751
752
# File 'docs/3_Studio.rb', line 750

def ev_atk
  @ev_atk
end

#ev_ats ⇒ Integer (readonly)

Ats EV given by this form when fainted

Returns:

  • (Integer)


759
760
761
# File 'docs/3_Studio.rb', line 759

def ev_ats
  @ev_ats
end

#ev_dfe ⇒ Integer (readonly)

Dfe EV given by this form when fainted

Returns:

  • (Integer)


753
754
755
# File 'docs/3_Studio.rb', line 753

def ev_dfe
  @ev_dfe
end

#ev_dfs ⇒ Integer (readonly)

Dfs EV given by this form when fainted

Returns:

  • (Integer)


762
763
764
# File 'docs/3_Studio.rb', line 762

def ev_dfs
  @ev_dfs
end

#ev_hp ⇒ Integer (readonly)

HP EV given by this form when fainted

Returns:

  • (Integer)


747
748
749
# File 'docs/3_Studio.rb', line 747

def ev_hp
  @ev_hp
end

#ev_spd ⇒ Integer (readonly)

Spd EV given by this form when fainted

Returns:

  • (Integer)


756
757
758
# File 'docs/3_Studio.rb', line 756

def ev_spd
  @ev_spd
end

#evolutions ⇒ Array<Evolution> (readonly)

All the evolutions of that form

Returns:



765
766
767
# File 'docs/3_Studio.rb', line 765

def evolutions
  @evolutions
end

#experience_type ⇒ Integer (readonly)

Type of exp curve for the form

Returns:

  • (Integer)


768
769
770
# File 'docs/3_Studio.rb', line 768

def experience_type
  @experience_type
end

#female_rate ⇒ Integer (readonly)

Female rate of the creature

Returns:

  • (Integer)


780
781
782
# File 'docs/3_Studio.rb', line 780

def female_rate
  @female_rate
end

#form ⇒ Integer (readonly)

Current form ID

Returns:

  • (Integer)


711
712
713
# File 'docs/3_Studio.rb', line 711

def form
  @form
end

#form_text_id ⇒ FormTextId (readonly)

Current form text ID

Returns:



714
715
716
# File 'docs/3_Studio.rb', line 714

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)


801
802
803
# File 'docs/3_Studio.rb', line 801

def front_offset_y
  @front_offset_y
end

#hatch_steps ⇒ Integer (readonly)

Number of steps before the egg hatches

Returns:

  • (Integer)


786
787
788
# File 'docs/3_Studio.rb', line 786

def hatch_steps
  @hatch_steps
end

#height ⇒ Float (readonly)

Height of the form

Returns:

  • (Float)


717
718
719
# File 'docs/3_Studio.rb', line 717

def height
  @height
end

#item_held ⇒ Array<ItemHeld> (readonly)

Item held by the creature when encountered

Returns:



795
796
797
# File 'docs/3_Studio.rb', line 795

def item_held
  @item_held
end

#move_set ⇒ Array<LearnableMove> (readonly)

Moveset of the creature

Returns:



804
805
806
# File 'docs/3_Studio.rb', line 804

def move_set
  @move_set
end

#resources ⇒ Resources (readonly)

Resources of the creature

Returns:



807
808
809
# File 'docs/3_Studio.rb', line 807

def resources
  @resources
end

#type1 ⇒ Symbol (readonly)

Symbol of the first type of the form

Returns:

  • (Symbol)


723
724
725
# File 'docs/3_Studio.rb', line 723

def type1
  @type1
end

#type2 ⇒ Symbol (readonly)

Symbol of the second type of the form

Returns:

  • (Symbol)


726
727
728
# File 'docs/3_Studio.rb', line 726

def type2
  @type2
end

#weight ⇒ Float (readonly)

Weight of the form

Returns:

  • (Float)


720
721
722
# File 'docs/3_Studio.rb', line 720

def weight
  @weight
end

Instance Method Details

#form_description ⇒ string Also known as: form_descr

Get the creature form description

Returns:

  • (string)


814
815
# File 'docs/3_Studio.rb', line 814

def form_description
end

#form_name ⇒ string

Get the creature form name

Returns:

  • (string)


810
811
# File 'docs/3_Studio.rb', line 810

def form_name
end