Class: Studio::Item

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

Overview

Data class describing an Item (see 0 Item folder for functional items)

Defined Under Namespace

Classes: BerryData, CookingData

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#berry_data ⇒ BerryData? (readonly)

Berry data of the item

Returns:



410
411
412
# File 'docs/3_Studio.rb', line 410

def berry_data
  @berry_data
end

#cooking_data ⇒ CookingData? (readonly)

Cooking data of the item

Returns:



413
414
415
# File 'docs/3_Studio.rb', line 413

def cooking_data
  @cooking_data
end

#db_symbol ⇒ Symbol (readonly)

db_symbol of the item

Returns:

  • (Symbol)


377
378
379
# File 'docs/3_Studio.rb', line 377

def db_symbol
  @db_symbol
end

#fling_power ⇒ Integer (readonly)

Power of the Fling move when item is thrown

Returns:

  • (Integer)


416
417
418
# File 'docs/3_Studio.rb', line 416

def fling_power
  @fling_power
end

#icon ⇒ String (readonly)

Icon of the item (in the bag)

Returns:



380
381
382
# File 'docs/3_Studio.rb', line 380

def icon
  @icon
end

#id ⇒ Integer (readonly)

ID of the item

Returns:

  • (Integer)


374
375
376
# File 'docs/3_Studio.rb', line 374

def id
  @id
end

#is_allowing_mega ⇒ Boolean (readonly)

If the item allows the use of Mega evolution when possessed by the player

Returns:

  • (Boolean)


404
405
406
# File 'docs/3_Studio.rb', line 404

def is_allowing_mega
  @is_allowing_mega
end

#is_battle_usable ⇒ Boolean (readonly)

If the item can be used in battle

Returns:

  • (Boolean)


392
393
394
# File 'docs/3_Studio.rb', line 392

def is_battle_usable
  @is_battle_usable
end

#is_berry ⇒ Boolean (readonly)

If the item is a berry

Returns:

  • (Boolean)


407
408
409
# File 'docs/3_Studio.rb', line 407

def is_berry
  @is_berry
end

#is_holdable ⇒ Boolean (readonly)

If the item can be held by a creature

Returns:

  • (Boolean)


401
402
403
# File 'docs/3_Studio.rb', line 401

def is_holdable
  @is_holdable
end

#is_limited ⇒ Boolean (readonly)

If the item must be consumed when used

Returns:

  • (Boolean)


398
399
400
# File 'docs/3_Studio.rb', line 398

def is_limited
  @is_limited
end

#is_map_usable ⇒ Boolean (readonly)

If the item can be used in the overworld

Returns:

  • (Boolean)


395
396
397
# File 'docs/3_Studio.rb', line 395

def is_map_usable
  @is_map_usable
end

#position ⇒ Integer (readonly)

Relative position of the item (in the socket) in ascending order

Returns:

  • (Integer)


389
390
391
# File 'docs/3_Studio.rb', line 389

def position
  @position
end

#price ⇒ Integer (readonly)

Price of the item (in the shop)

Returns:

  • (Integer)


383
384
385
# File 'docs/3_Studio.rb', line 383

def price
  @price
end

#socket ⇒ Integer (readonly)

Pocket of the item in the bag

Returns:

  • (Integer)


386
387
388
# File 'docs/3_Studio.rb', line 386

def socket
  @socket
end

Instance Method Details

#bitter ⇒ Integer

Get the bitter flavor of the item if it is a berry

Returns:

  • (Integer)


506
507
# File 'docs/3_Studio.rb', line 506

def bitter
end

#description ⇒ String Also known as: descr

Description of the item

Returns:



485
486
# File 'docs/3_Studio.rb', line 485

def description
end

#dry ⇒ Integer

Get the dry flavor of the item if it is a berry

Returns:

  • (Integer)


498
499
# File 'docs/3_Studio.rb', line 498

def dry
end

#exact_name ⇒ String

Get the exact name of the item (including move name)

Returns:



477
478
# File 'docs/3_Studio.rb', line 477

def exact_name
end

#me ⇒ RPG::AudioFile

Get the ME of the item when it's got

Returns:



490
491
# File 'docs/3_Studio.rb', line 490

def me
end

#name ⇒ String

Get the name of the item

Returns:



473
474
# File 'docs/3_Studio.rb', line 473

def name
end

#plural_name ⇒ String

Name of the item in plural

Returns:



481
482
# File 'docs/3_Studio.rb', line 481

def plural_name
end

#sour ⇒ Integer

Get the sour flavor of the item if it is a berry

Returns:

  • (Integer)


510
511
# File 'docs/3_Studio.rb', line 510

def sour
end

#spicy ⇒ Integer

Get the spicy flavor of the item if it is a berry

Returns:

  • (Integer)


494
495
# File 'docs/3_Studio.rb', line 494

def spicy
end

#sweet ⇒ Integer

Get the sweet flavor of the item if it is a berry

Returns:

  • (Integer)


502
503
# File 'docs/3_Studio.rb', line 502

def sweet
end