Class: Studio::Item

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

Overview

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

Constant Summary collapse

ItemGetME =

List of get item ME

['Audio/ME/ROSA_ItemObtained.ogg', 'Audio/ME/ROSA_KeyItemObtained.ogg', 'Audio/ME/ROSA_TMObtained.ogg']

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#db_symbol ⇒ Symbol (readonly)

db_symbol of the item

Returns:

  • (Symbol) 


363
364
365
 
# File 'docs/3_Studio.rb', line 363

def db_symbol
  @db_symbol
end

#fling_power ⇒ Integer (readonly)

Power of the Fling move when item is thrown

Returns:

  • (Integer) 


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

def fling_power
  @fling_power
end

#icon ⇒ String (readonly)

Icon of the item (in the bag)

Returns:



366
367
368
 
# File 'docs/3_Studio.rb', line 366

def icon
  @icon
end

#id ⇒ Integer (readonly)

ID of the item

Returns:

  • (Integer) 


360
361
362
 
# File 'docs/3_Studio.rb', line 360

def id
  @id
end

#is_battle_usable ⇒ Boolean (readonly)

If the item can be used in battle

Returns:

  • (Boolean) 


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

def is_battle_usable
  @is_battle_usable
end

#is_holdable ⇒ Boolean (readonly)

If the item can be held by a creature

Returns:

  • (Boolean) 


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

def is_holdable
  @is_holdable
end

#is_limited ⇒ Boolean (readonly)

If the item must be consumed when used

Returns:

  • (Boolean) 


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

def is_limited
  @is_limited
end

#is_map_usable ⇒ Boolean (readonly)

If the item can be used in the overworld

Returns:

  • (Boolean) 


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

def is_map_usable
  @is_map_usable
end

#position ⇒ Integer (readonly)

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

Returns:

  • (Integer) 


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

def position
  @position
end

#price ⇒ Integer (readonly)

Price of the item (in the shop)

Returns:

  • (Integer) 


369
370
371
 
# File 'docs/3_Studio.rb', line 369

def price
  @price
end

#socket ⇒ Integer (readonly)

Pocket of the item in the bag

Returns:

  • (Integer) 


372
373
374
 
# File 'docs/3_Studio.rb', line 372

def socket
  @socket
end

Instance Method Details

#description ⇒ String Also known as: descr

Description of the item

Returns:



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

def description
end

#exact_name ⇒ String

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

Returns:



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

def exact_name
end

#me ⇒ String

Get the ME of the item when it’s got

Returns:



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

def me
end

#name ⇒ String

Get the name of the item

Returns:



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

def name
end

#plural_name ⇒ String

Name of the item in plural

Returns:



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

def plural_name
end