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[event_id] = [berry_id, stage, timer, stage_time, water_timer, water_time, water_counter, info_fertilizer]
Constant Summary collapse
- PLANTED_CHAR =
The base name of berry character
'Z_BP'
Class Method Summary collapse
-
.data
Return the berry data.
-
.event_direction(stage)
Retrieve the event direction based on the berry stage.
-
.find_berry_data(map_id)
Search the Berry data of the map.
-
.get_berry_id(event_id) ⇒ Integer
Retrieve the ID of the berry that is planted on an event.
-
.get_berry_internal_id(event_id) ⇒ Integer
Retrieve the Internal ID of the berry (text_id).
-
.get_stage(event_id) ⇒ Integer
Retrieve the stage of a berry.
-
.here?(event_id) ⇒ Boolean
Test if a berry is on an event.
-
.init
Initialization of the Berry management.
-
.init_berry(map_id, event_id, berry_id, state = 4)
Init a berry tree.
-
.plant(event_id, berry_id)
Plant a berry.
-
.take(event_id) ⇒ Integer
Take the berries from the berry tree.
-
.update
Update of the berry management.
-
.update_event(event_id, data)
Update of the berry event graphics.
-
.water(event_id)
Water a berry.
-
.watered?(event_id) ⇒ Boolean
Tell if the berry is watered.
Class Method Details
.data
Return the berry data
1802 1803 |
# File 'docs/4_Systems_003_Map_Engine.rb', line 1802 def data end |
.event_direction(stage)
Retrieve the event direction based on the berry stage
1795 1796 |
# File 'docs/4_Systems_003_Map_Engine.rb', line 1795 def event_direction(stage) end |
.find_berry_data(map_id)
Search the Berry data of the map
1799 1800 |
# File 'docs/4_Systems_003_Map_Engine.rb', line 1799 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
1751 1752 |
# File 'docs/4_Systems_003_Map_Engine.rb', line 1751 def get_berry_id(event_id) end |
.get_berry_internal_id(event_id) ⇒ Integer
Retrieve the Internal ID of the berry (text_id)
1756 1757 |
# File 'docs/4_Systems_003_Map_Engine.rb', line 1756 def get_berry_internal_id(event_id) end |
.get_stage(event_id) ⇒ Integer
Retrieve the stage of a berry
1761 1762 |
# File 'docs/4_Systems_003_Map_Engine.rb', line 1761 def get_stage(event_id) end |
.here?(event_id) ⇒ Boolean
Test if a berry is on an event
1746 1747 |
# File 'docs/4_Systems_003_Map_Engine.rb', line 1746 def here?(event_id) end |
.init
Initialization of the Berry management
1783 1784 |
# File 'docs/4_Systems_003_Map_Engine.rb', line 1783 def init end |
.init_berry(map_id, event_id, berry_id, state = 4)
Init a berry tree
1741 1742 |
# File 'docs/4_Systems_003_Map_Engine.rb', line 1741 def init_berry(map_id, event_id, berry_id, state = 4) end |
.plant(event_id, berry_id)
Plant a berry
1775 1776 |
# File 'docs/4_Systems_003_Map_Engine.rb', line 1775 def plant(event_id, berry_id) end |
.take(event_id) ⇒ Integer
Take the berries from the berry tree
1780 1781 |
# File 'docs/4_Systems_003_Map_Engine.rb', line 1780 def take(event_id) end |
.update
Update of the berry management
1786 1787 |
# File 'docs/4_Systems_003_Map_Engine.rb', line 1786 def update end |
.update_event(event_id, data)
Update of the berry event graphics
1791 1792 |
# File 'docs/4_Systems_003_Map_Engine.rb', line 1791 def update_event(event_id, data) end |
.water(event_id)
Water a berry
1770 1771 |
# File 'docs/4_Systems_003_Map_Engine.rb', line 1770 def water(event_id) end |
.watered?(event_id) ⇒ Boolean
Tell if the berry is watered
1766 1767 |
# File 'docs/4_Systems_003_Map_Engine.rb', line 1766 def watered?(event_id) end |