Class: UI::WeatherSprite::SandStormAnimation

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

Overview

Handles the Sandstorm animation in the battle scene

Instance Method Summary collapse

Constructor Details

#initialize(viewport, scene, weather) ⇒ SandStormAnimation

Creates a new Sandstorm animation object

Parameters:

  • viewport (Viewport) —

    The viewport in which the animation is displayed

  • scene (Battle::Visual) —

    The battle scene object

  • weather (Symbol) —

    The weather db_symbol (:sandstorm)



2920
2921
# File 'docs/5_Battle_02_Visual.rb', line 2920

def initialize(viewport, scene, weather)
end

Instance Method Details

#create_sandstorm_animation

This method returns an undefined value.

Creates, configures, and starts the whole sandstorm animation sequence



2929
2930
# File 'docs/5_Battle_02_Visual.rb', line 2929

def create_sandstorm_animation
end

#create_sandstorm_sprites

This method returns an undefined value.

Creates all individual sand grain sprites used in the sandstorm animation



2941
2942
# File 'docs/5_Battle_02_Visual.rb', line 2941

def create_sandstorm_sprites
end

#length_movement ⇒ Integer

Returns the horizontal distance travelled by sand grains

Returns:

  • (Integer)


2957
2958
# File 'docs/5_Battle_02_Visual.rb', line 2957

def length_movement
end

#sand_particle_color ⇒ Array<Integer>

Returns the RGBA color of sand particles

Returns:

  • (Array<Integer>)


2945
2946
# File 'docs/5_Battle_02_Visual.rb', line 2945

def sand_particle_color
end

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

Creates the animation for all individual sand particles

Returns:



2933
2934
# File 'docs/5_Battle_02_Visual.rb', line 2933

def sand_particles_animation
end

#sandstorm_number ⇒ Integer

Returns the number of sand particles generated

Returns:

  • (Integer)


2949
2950
# File 'docs/5_Battle_02_Visual.rb', line 2949

def sandstorm_number
end

#sandstorm_veil_opacity ⇒ Integer

Returns the opacity of the viewport veil during sandstorm

Returns:

  • (Integer)


2953
2954
# File 'docs/5_Battle_02_Visual.rb', line 2953

def sandstorm_veil_opacity
end

#viewport_tone_animation ⇒ Yuki::Animation::Player

Creates the animation responsible for the sandstorm tint applied to the viewport



2937
2938
# File 'docs/5_Battle_02_Visual.rb', line 2937

def viewport_tone_animation
end

#weather_animation(weather)

This method returns an undefined value.

Starts the sandstorm animation

Parameters:

  • weather (Symbol) —

    The type of weather animation (:sandstorm)



2925
2926
# File 'docs/5_Battle_02_Visual.rb', line 2925

def weather_animation(weather)
end

#weather_sound ⇒ RPG::AudioFile

Returns the sound effect played during the sandstorm

Returns:



2961
2962
# File 'docs/5_Battle_02_Visual.rb', line 2961

def weather_sound
end