ParticleBase

ParticleBase

Default Particle System Class Outputs a basic system expecting uniforms, vertex shader, and fragment shader to be passed into `build()`

Constructor

new ParticleBase(room, systemNameopt)

Description:
  • Create a ParticleBase instance.
Source:
Properties:
Name Type Description
name string The name of the particle system.
room Object The room object where the particles will be added.
geometry BufferGeometry The geometry of the particle system.
material Material The material of the particle system.
points Points The points object of the particle system.
count number The number of particles.
pscale Vector2 The scale of the particles.
position Vector3 The position of the particle system.
atlasPath string The path to the atlas texture file.
atlasAlphaPath string The path to the atlas alpha texture file.
hasAlphaMap boolean Flag for whether the atlas texture has an alpha map.
shaderSettings Object Shader settings for the particle system.
knownKeys Array.<string> Known keys for shader settings.
Parameters:
Name Type Attributes Default Description
room Object null The room object where the particle system will be added.
systemName string <optional>
 'particles' The name of the particle system.

Members

knownKeys :Array.<string>

Description:
  • Known keys for shader settings.
Source:
Known keys for shader settings.
Type:
  • Array.<string>

shaderSettings :Object

Description:
  • Shader settings for the floating dust particles.
Source:
Properties:
Name Type Description
vertCount number Number of vertices.
pScale number Scale of the particles.
atlasRes number Atlas resolution.
atlasPicks Array Atlas picks.
randomAtlas boolean Random atlas flag.
additiveBlend boolean Additive blending flag.
hasLights boolean Lights flag.
Shader settings for the floating dust particles.
Type:
  • Object