Module: Yuki::Berries

Defined in:
docs/4_Systems_003_Map_Engine.rb

Overview

Module that manage the growth of berries. The berry informations are stored in PFM.game_state.berries, a 2D Array of berry information

PFM.game_state.berries[map_id][event_id] = [berry_id, stage, timer, stage_time, water_timer, water_time, water_counter, info_fertilizer]

Author:

  • Nuri Yuri

Defined Under Namespace

Classes: Data

Constant Summary collapse

PLANTED_CHAR =

The base name of berry character

'Z_BP'
BERRY_DATA =

Berry data / db_symbol

Returns:

  • (Hash{ symbol => Data }) 
{}

Class Method Summary collapse

Class Method Details

.data

Return the berry data



1611
1612
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 1611

def data
end

.find_berry_data(map_id)

Search the Berry data of the map

Parameters:

  • map_id (Integer) —

    id of the Map



1608
1609
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 1608

def find_berry_data(map_id)
end

.get_berry_id(event_id) ⇒ Integer

Retrieve the ID of the berry that is planted on an event

Parameters:

  • event_id (Integer) —

    ID of the event

Returns:

  • (Integer) 


1564
1565
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 1564

def get_berry_id(event_id)
end

.get_berry_internal_id(event_id) ⇒ Integer

Retrieve the Internal ID of the berry (text_id)

Parameters:

  • event_id (Integer) —

    ID of the event

Returns:

  • (Integer) 


1569
1570
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 1569

def get_berry_internal_id(event_id)
end

.get_stage(event_id) ⇒ Integer

Retrieve the stage of a berry

Parameters:

  • event_id (Integer) —

    ID of the event

Returns:

  • (Integer) 


1574
1575
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 1574

def get_stage(event_id)
end

.here?(event_id) ⇒ Boolean

Test if a berry is on an event

Parameters:

  • event_id (Integer) —

    ID of the event

Returns:

  • (Boolean) 


1559
1560
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 1559

def here?(event_id)
end

.init

Initialization of the Berry management



1596
1597
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 1596

def init
end

.init_berry(map_id, event_id, berry_id, state = 4)

Init a berry tree

Parameters:

  • map_id (Integer) —

    id of the map where the berry tree is

  • event_id (Integer) —

    id of the event where the berry tree is shown

  • berry_id (Symbol, Integer) —

    db_symbol or ID of the berry Item in the database

  • state (Integer) (defaults to: 4) —

    the growth state of the berry



1554
1555
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 1554

def init_berry(map_id, event_id, berry_id, state = 4)
end

.plant(event_id, berry_id)

Plant a berry

Parameters:

  • event_id (Integer) —

    ID of the event

  • berry_id (Integer) —

    ID of the berry Item in the database



1588
1589
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 1588

def plant(event_id, berry_id)
end

.take(event_id) ⇒ Integer

Take the berries from the berry tree

Parameters:

  • event_id (Integer) —

    ID of the event

Returns:

  • (Integer) —

    the number of berry taken from the tree



1593
1594
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 1593

def take(event_id)
end

.update

Update of the berry management



1599
1600
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 1599

def update
end

.update_event(event_id, data)

Update of the berry event graphics

Parameters:

  • event_id (Integer) —

    id of the event where the berry tree is shown

  • data (Array) —

    berry data



1604
1605
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 1604

def update_event(event_id, data)
end

.water(event_id)

Water a berry

Parameters:

  • event_id (Integer) —

    ID of the event



1583
1584
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 1583

def water(event_id)
end

.watered?(event_id) ⇒ Boolean

Tell if the berry is watered

Parameters:

  • event_id (Integer) —

    ID of the event

Returns:

  • (Boolean) 


1579
1580
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 1579

def watered?(event_id)
end