Class: UI::WeatherSprite::HailAnimation

Inherits:
WeatherSprite
  • Object
show all
Defined in:
docs/5_Battle_02_Visual.rb

Overview

Class that describes the Hail weather animation

Instance Method Summary collapse

Constructor Details

#initialize(viewport, scene, weather) ⇒ HailAnimation

Initializes the HailAnimation instance

Parameters:

  • viewport (Viewport) —

    The viewport in which the animation is displayed

  • scene (Battle::Scene) —

    The battle scene instance

  • weather (Symbol) —

    The weather type (:hail)



2828
2829
# File 'docs/5_Battle_02_Visual.rb', line 2828

def initialize(viewport, scene, weather)
end

Instance Method Details

#create_hail_animation

This method returns an undefined value.

Creates, configures, and starts the entire hail animation sequence



2837
2838
# File 'docs/5_Battle_02_Visual.rb', line 2837

def create_hail_animation
end

#create_hail_elements

This method returns an undefined value.

Creates all hail sprite elements used in the animation



2841
2842
# File 'docs/5_Battle_02_Visual.rb', line 2841

def create_hail_elements
end

#hail_animation ⇒ Array<Yuki::Animation::Player>

Generates the animation for each hail sprite (falling, rotation, fading)

Returns:



2845
2846
# File 'docs/5_Battle_02_Visual.rb', line 2845

def hail_animation
end

#hail_drop_duration ⇒ Float

Duration of the hailstone fall animation

Returns:

  • (Float)


2861
2862
# File 'docs/5_Battle_02_Visual.rb', line 2861

def hail_drop_duration
end

#hail_number ⇒ Integer

Number of hail sprites generated

Returns:

  • (Integer)


2865
2866
# File 'docs/5_Battle_02_Visual.rb', line 2865

def hail_number
end

#offset_x_coordinates ⇒ Integer

Horizontal movement applied to each hailstone

Returns:

  • (Integer)


2853
2854
# File 'docs/5_Battle_02_Visual.rb', line 2853

def offset_x_coordinates
end

#offset_y_coordinates ⇒ Integer

Vertical movement applied to each hailstone

Returns:

  • (Integer)


2857
2858
# File 'docs/5_Battle_02_Visual.rb', line 2857

def offset_y_coordinates
end

#start_position_coordinates ⇒ Array<Integer>

Computes the initial spawn coordinates for a hail sprite

Returns:

  • (Array<Integer>)


2849
2850
# File 'docs/5_Battle_02_Visual.rb', line 2849

def start_position_coordinates
end

#weather_animation(weather)

This method returns an undefined value.

Starts the hail animation

Parameters:

  • weather (Symbol) —

    The weather animation type (:hail)



2833
2834
# File 'docs/5_Battle_02_Visual.rb', line 2833

def weather_animation(weather)
end

#weather_sound ⇒ RPG::AudioFile

Audio used for hail weather

Returns:



2869
2870
# File 'docs/5_Battle_02_Visual.rb', line 2869

def weather_sound
end