Class: Studio::Group

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

Overview

Data class describing a wild Group

Defined Under Namespace

Classes: CustomCondition, Encounter

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#custom_conditions ⇒ Array<CustomCondition> (readonly)

All the custom condition for the group to be active

Returns:



272
273
274
# File 'docs/3_Studio.rb', line 272

def custom_conditions
  @custom_conditions
end

#db_symbol ⇒ Symbol (readonly)

db_symbol of the group

Returns:

  • (Symbol)


257
258
259
# File 'docs/3_Studio.rb', line 257

def db_symbol
  @db_symbol
end

#encounters ⇒ Array<Encounter> (readonly)

All the wild encounters

Returns:



275
276
277
# File 'docs/3_Studio.rb', line 275

def encounters
  @encounters
end

#id ⇒ Integer (readonly)

ID of the group

Returns:

  • (Integer)


254
255
256
# File 'docs/3_Studio.rb', line 254

def id
  @id
end

#steps_average ⇒ Integer (readonly)

Average number of steps for the group to have a creature spawn

Returns:

  • (Integer)


278
279
280
# File 'docs/3_Studio.rb', line 278

def steps_average
  @steps_average
end

#system_tag ⇒ Symbol (readonly)

System tag in which the wild creature should appear

Returns:

  • (Symbol)


260
261
262
# File 'docs/3_Studio.rb', line 260

def system_tag
  @system_tag
end

#terrain_tag ⇒ Integer (readonly)

Terrain tag in which the wild creature should appear

Returns:

  • (Integer)


263
264
265
# File 'docs/3_Studio.rb', line 263

def terrain_tag
  @terrain_tag
end

#tool ⇒ Symbol? (readonly)

Tool used to trigger that group (:old_rod, :good_rod, :super_rod, :rock_smash, :head_butt)

Returns:

  • (Symbol, nil)


266
267
268
# File 'docs/3_Studio.rb', line 266

def tool
  @tool
end

#vs_type ⇒ Symbol (readonly)

The type of the wild battle (:simple, :double, :triple, :horde)

Returns:

  • (Symbol)


269
270
271
# File 'docs/3_Studio.rb', line 269

def vs_type
  @vs_type
end

Instance Method Details

#is_double_battle ⇒ Boolean

Deprecated.

Will be removed

If the wild battle should be a double battle

Returns:

  • (Boolean)


282
283
# File 'docs/3_Studio.rb', line 282

def is_double_battle
end

#is_horde_battle ⇒ Boolean

Deprecated.

Will be removed

If the wild battle should be a horde battle

Returns:

  • (Boolean)


287
288
# File 'docs/3_Studio.rb', line 287

def is_horde_battle
end