Class: PFM::Ribbon

Inherits:
Object show all
Defined in:
docs/4_Systems_000_General_1_PFM.rb

Overview

Class defining a ribbon that can be given to creatures

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(symbol) ⇒ Ribbon

Create a new ribbon

Parameters:

  • symbol (Symbol) —

    symbol of the ribbon



2262
2263
# File 'docs/4_Systems_000_General_1_PFM.rb', line 2262

def initialize(symbol)
end

Instance Attribute Details

#id ⇒ Integer (readonly)

Id of the ribbon

Returns:

  • (Integer)


2256
2257
2258
# File 'docs/4_Systems_000_General_1_PFM.rb', line 2256

def id
  @id
end

#symbol ⇒ Symbol (readonly)

Symbol of the ribbon

Returns:

  • (Symbol)


2259
2260
2261
# File 'docs/4_Systems_000_General_1_PFM.rb', line 2259

def symbol
  @symbol
end

Instance Method Details

#description ⇒ String

Get the ribbon description

Returns:



2270
2271
# File 'docs/4_Systems_000_General_1_PFM.rb', line 2270

def description
end

#gives_title? ⇒ Boolean

Tell if the ribbon has an associated title it can give to a creature

Returns:

  • (Boolean)


2282
2283
# File 'docs/4_Systems_000_General_1_PFM.rb', line 2282

def gives_title?
end

#name ⇒ String

Get the ribbon name

Returns:



2266
2267
# File 'docs/4_Systems_000_General_1_PFM.rb', line 2266

def name
end

#sprite_name ⇒ String

Get the name of the sprite associated to the ribbon

Returns:



2278
2279
# File 'docs/4_Systems_000_General_1_PFM.rb', line 2278

def sprite_name
end

#title ⇒ String

Get the title given by the ribbon

Returns:



2274
2275
# File 'docs/4_Systems_000_General_1_PFM.rb', line 2274

def title
end