Module: Yuki::Particles
- Defined in:
- docs/4_Systems_003_Map_Engine.rb
Overview
Module that manage the particle display
Defined Under Namespace
Modules: LoadParticles
Constant Summary collapse
- Data =
The particle data
[]
- EMPTY =
The empty actions
{max_counter: 1, loop: false, data: []}
Class Attribute Summary collapse
-
.named ⇒ Hash{ Symbol => Particle_Object }
readonly
Return the list of named particles.
Class Method Summary collapse
-
.add_building(image, x, y, oy = 0, visible_from1 = false, visible_from2 = false) ⇒ Building_Object
Add a building.
-
.add_named_particle(name, character, particle_tag, params = {})
Add a named particle (particle that has a specific flow).
-
.add_parallax(image, x, y, z, zoom_x = 1, zoom_y = 1, opacity = 255, blend_type = 0) ⇒ Parallax_Object
Add a parallax.
-
.add_particle(character, particle_tag, params = {}) ⇒ Particle_Object
Add a particle to the stack.
-
.clean_stack
Request to clean the stack.
-
.dispose
Dispose each particle.
-
.find_particle(terrain_tag, particle_tag)
Function that find the data for a particle according to the terrain_tag & the particle tag.
-
.init(viewport)
Init the particle display on a new viewport.
-
.ready? ⇒ Boolean
Tell if the system is ready to work.
-
.set_on_teleportation(v)
Tell the particle manager the game is warping the player.
-
.update
Update of the particles & stack cleaning if requested.
-
.viewport
Return the viewport of in which the Particles are shown.
Class Attribute Details
.named ⇒ Hash{ Symbol => Particle_Object } (readonly)
Return the list of named particles
976 977 978 |
# File 'docs/4_Systems_003_Map_Engine.rb', line 976 def named @named end |
Class Method Details
.add_building(image, x, y, oy = 0, visible_from1 = false, visible_from2 = false) ⇒ Building_Object
Add a building
957 958 |
# File 'docs/4_Systems_003_Map_Engine.rb', line 957 def add_building(image, x, y, oy = 0, visible_from1 = false, visible_from2 = false) end |
.add_named_particle(name, character, particle_tag, params = {})
Add a named particle (particle that has a specific flow)
935 936 |
# File 'docs/4_Systems_003_Map_Engine.rb', line 935 def add_named_particle(name, character, particle_tag, params = {}) end |
.add_parallax(image, x, y, z, zoom_x = 1, zoom_y = 1, opacity = 255, blend_type = 0) ⇒ Parallax_Object
Add a parallax
947 948 |
# File 'docs/4_Systems_003_Map_Engine.rb', line 947 def add_parallax(image, x, y, z, zoom_x = 1, zoom_y = 1, opacity = 255, blend_type = 0) end |
.add_particle(character, particle_tag, params = {}) ⇒ Particle_Object
Add a particle to the stack
928 929 |
# File 'docs/4_Systems_003_Map_Engine.rb', line 928 def add_particle(character, particle_tag, params = {}) end |
.clean_stack
Request to clean the stack
921 922 |
# File 'docs/4_Systems_003_Map_Engine.rb', line 921 def clean_stack end |
.dispose
Dispose each particle
971 972 |
# File 'docs/4_Systems_003_Map_Engine.rb', line 971 def dispose end |
.find_particle(terrain_tag, particle_tag)
This function will try $game_variables & 0 as terrain_tag if the particle_tag wasn't found
Function that find the data for a particle according to the terrain_tag & the particle tag
988 989 |
# File 'docs/4_Systems_003_Map_Engine.rb', line 988 def find_particle(terrain_tag, particle_tag) end |
.init(viewport)
Init the particle display on a new viewport
915 916 |
# File 'docs/4_Systems_003_Map_Engine.rb', line 915 def init() end |
.ready? ⇒ Boolean
Tell if the system is ready to work
964 965 |
# File 'docs/4_Systems_003_Map_Engine.rb', line 964 def ready? end |
.set_on_teleportation(v)
Tell the particle manager the game is warping the player. Particle will skip the :enter phase.
968 969 |
# File 'docs/4_Systems_003_Map_Engine.rb', line 968 def set_on_teleportation(v) end |
.update
Update of the particles & stack cleaning if requested
918 919 |
# File 'docs/4_Systems_003_Map_Engine.rb', line 918 def update end |
.viewport
Return the viewport of in which the Particles are shown
960 961 |
# File 'docs/4_Systems_003_Map_Engine.rb', line 960 def end |