Class: Battle::Visual::Transition::HGSSSeaWild

Inherits:
RBYWild show all
Defined in:
docs/5_Battle_02_Visual.rb

Overview

Wild Sea transition of HeartGold/SoulSilver games

Constant Summary collapse

SPRITE_NAMES =

A hash mapping symbolic names to sprite paths

Returns:

{first: 'assets/heartgold_soulsilver_sea_wild_01', second: 'assets/heartgold_soulsilver_sea_wild_02', third: 'black_screen'}

Constants inherited from RBYWild

RBYWild::DISPLACEMENT_X

Instance Method Summary collapse

Methods inherited from Base

#dispose, #done?, #initialize, #pre_transition, #start_actor_send_animation, #start_enemy_send_animation, #transition, #transition_battle_end, #update

Constructor Details

This class inherits a constructor from Battle::Visual::Transition::Base

Instance Method Details

#black_animation ⇒ Yuki::AnimationMixin

Start the animation of the black sprite



1179
1180
# File 'docs/5_Battle_02_Visual.rb', line 1179

def black_animation
end

#bubble_animation ⇒ Yuki::AnimationMixin

Start the animation of the bubble sprite



1171
1172
# File 'docs/5_Battle_02_Visual.rb', line 1171

def bubble_animation
end

#create_fade_in_animation ⇒ Yuki::AnimationMixin

Function that creates the fade in animation



1163
1164
# File 'docs/5_Battle_02_Visual.rb', line 1163

def create_fade_in_animation
end

#create_sprite(sprite_name, z_factor, y_offset = 0) ⇒ Sprite

Function that create a sprite

Parameters:

  • sprite_name (Symbol)
  • z_factor (Integer)
  • y_offset (Integer) (defaults to: 0)

Returns:



1156
1157
# File 'docs/5_Battle_02_Visual.rb', line 1156

def create_sprite(sprite_name, z_factor, y_offset = 0)
end

#create_top_sprite

Function that creates the top sprite



1159
1160
# File 'docs/5_Battle_02_Visual.rb', line 1159

def create_top_sprite
end

#pre_transition_sprite_name(sprite_name) ⇒ String

Function that returns an image name

Returns:



1149
1150
# File 'docs/5_Battle_02_Visual.rb', line 1149

def pre_transition_sprite_name(sprite_name)
end

#shader_animation ⇒ Yuki::Animation::ScalarAnimation

Start the animation of the shader



1167
1168
# File 'docs/5_Battle_02_Visual.rb', line 1167

def shader_animation
end

#shader_name ⇒ Symbol

Return the shader name

Returns:

  • (Symbol)


1183
1184
# File 'docs/5_Battle_02_Visual.rb', line 1183

def shader_name
end

#wave_animation ⇒ Yuki::AnimationMixin

Start the animation of the wave sprite



1175
1176
# File 'docs/5_Battle_02_Visual.rb', line 1175

def wave_animation
end