Class: Sprite_Character

Inherits:
RPG::Sprite show all
Defined in:
docs/01450_Systems_00003_Map_Engine.rb

Overview

Class that describe a Character Sprite on the Map

Constant Summary collapse

TILE_ZOOM =

Zoom of a tile and factor used to fix coordinate

Configs.display.tilemap_settings.character_tile_zoom
SPRITE_ZOOM =

Zoom of a Sprite

Configs.display.tilemap_settings.character_sprite_zoom
SHADOW_TAG =

Tag that disable shadow

'§'
SHADOW_FILE =

Name of the shadow file

'0 Ombre Translucide'
REALISTIC_SHADOW =

Enable or disable realistic shadow

true
SUP_TAG =

Tag that add 1 to the superiority of the Sprite_Character

'¤'
REFLECTION_BLEND_MODE =

Blend mode for Reflection

BlendMode.new

Constants inherited from RPG::Sprite

RPG::Sprite::SHADER, RPG::Sprite::TARGET_SHADER

Instance Attribute Summary collapse

Attributes inherited from LiteRGSS::ShaderedSprite

#blendmode, #shader

Attributes inherited from LiteRGSS::Sprite

#__index__, #angle, #bitmap, #height, #mirror, #opacity, #ox, #oy, #src_rect, #viewport, #visible, #width, #x, #y, #z, #zoom, #zoom_x, #zoom_y

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Sprite

#load, #mouse_in?, #set_origin_div, #set_rect, #set_rect_div, #set_z, #simple_mouse_in?, #translate_mouse_coords

Methods inherited from LiteRGSS::Sprite

new, #set_origin, #set_position

Methods inherited from LiteRGSS::Disposable

#disposed?

Constructor Details

#initialize(viewport, character = nil) ⇒ Sprite_Character

Initialize a new Sprite_Character

Parameters:



209
210
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 209

def initialize(viewport, character = nil)
end

Instance Attribute Details

#bush_depth ⇒ Integer

Return the Sprite bush_depth

Returns:

  • (Integer) 


205
206
207
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 205

def bush_depth
  @bush_depth
end

#character ⇒ Game_Character

Character displayed by the Sprite_Character

Returns:



202
203
204
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 202

def character
  @character
end

Class Method Details

.fix_rmxp_animations

Fix the animation file



269
270
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 269

def self.fix_rmxp_animations
end

Instance Method Details

#dispose

Dispose the Sprite_Character and its shadow



248
249
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 248

def dispose
end

#dispose_reflection

Dispose the reflection sprite



266
267
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 266

def dispose_reflection
end

#dispose_shadow

Dispose the shadow sprite



257
258
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 257

def dispose_shadow
end

#init(character)

Initialize the specific parameters of the Sprite_Character (shadow, add_z etc…)

Parameters:



213
214
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 213

def init(character)
end

#init_add_z_shadow

Initialize the add_z info & the shadow sprite of the Sprite_Character



216
217
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 216

def init_add_z_shadow
end

#init_reflection

Init the reflection sprite



260
261
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 260

def init_reflection
end

#init_shadow

Initialize the shadow display



251
252
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 251

def init_shadow
end

#update

Update every informations about the Sprite_Character



219
220
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 219

def update
end

#update_bush_depth

Update the bush depth effect



241
242
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 241

def update_bush_depth
end

#update_graphics

Update the graphics of the Sprite_Character



222
223
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 222

def update_graphics
end

#update_load_animation

Load the animation when there’s one on the character



238
239
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 238

def update_load_animation
end

#update_pattern

Update the pattern animation



235
236
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 235

def update_pattern
end

#update_position ⇒ Boolean

Update the position of the Sprite_Character on the screen

Returns:

  • (Boolean) —

    if the update can continue after the call of this function or not



232
233
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 232

def update_position
end

#update_reflection_graphics

Update the reflection graphics



263
264
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 263

def update_reflection_graphics
end

#update_shadow

Update the shadow



254
255
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 254

def update_shadow
end

#update_sprite_graphic

Update the sprite graphics



225
226
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 225

def update_sprite_graphic
end

#update_tile_graphic

Update the tile graphic of the sprite



228
229
 
# File 'docs/01450_Systems_00003_Map_Engine.rb', line 228

def update_tile_graphic
end