Class: Sprite_Character

Inherits:
RPG::Sprite show all
Defined in:
docs/4_Systems_003_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

Instance Attribute Summary collapse

Attributes inherited from RPG::Sprite

#blend_type, #color, #tone

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 RPG::Sprite

#animation, #animation_process_timing, #animation_set_sprites, #appear, #blink?, #blink_off, #blink_on, #collapse, #damage, #dispose_animation, #dispose_damage, #dispose_loop_animation, #effect?, #escape, #flash, #handle_flash, #loop_animation, #register_position, #reset_position, #update_animation, #update_loop_animation, #whiten, #x=, #y=

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:



332
333
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 332

def initialize(viewport, character = nil)
end

Instance Attribute Details

#bush_depth ⇒ Integer

Return the Sprite bush_depth

Returns:

  • (Integer) 


328
329
330
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 328

def bush_depth
  @bush_depth
end

#character ⇒ Game_Character

Character displayed by the Sprite_Character

Returns:



325
326
327
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 325

def character
  @character
end

Class Method Details

.fix_rmxp_animations

Fix the animation file



392
393
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 392

def self.fix_rmxp_animations
end

Instance Method Details

#dispose

Dispose the Sprite_Character and its shadow



371
372
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 371

def dispose
end

#dispose_reflection

Dispose the reflection sprite



389
390
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 389

def dispose_reflection
end

#dispose_shadow

Dispose the shadow sprite



380
381
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 380

def dispose_shadow
end

#init(character)

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

Parameters:



336
337
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 336

def init(character)
end

#init_add_z_shadow

Initialize the add_z info & the shadow sprite of the Sprite_Character



339
340
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 339

def init_add_z_shadow
end

#init_reflection

Init the reflection sprite



383
384
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 383

def init_reflection
end

#init_shadow

Initialize the shadow display



374
375
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 374

def init_shadow
end

#update

Update every informations about the Sprite_Character



342
343
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 342

def update
end

#update_bush_depth

Update the bush depth effect



364
365
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 364

def update_bush_depth
end

#update_graphics

Update the graphics of the Sprite_Character



345
346
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 345

def update_graphics
end

#update_load_animation

Load the animation when there’s one on the character



361
362
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 361

def update_load_animation
end

#update_pattern

Update the pattern animation



358
359
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 358

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



355
356
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 355

def update_position
end

#update_reflection_graphics

Update the reflection graphics



386
387
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 386

def update_reflection_graphics
end

#update_shadow

Update the shadow



377
378
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 377

def update_shadow
end

#update_sprite_graphic

Update the sprite graphics



348
349
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 348

def update_sprite_graphic
end

#update_tile_graphic

Update the tile graphic of the sprite



351
352
 
# File 'docs/4_Systems_003_Map_Engine.rb', line 351

def update_tile_graphic
end