particleSystem.functions.d.ts 3.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. import { Vector3 } from "../Maths/math.vector.js";
  2. import { PointParticleEmitter } from "./EmitterTypes/pointParticleEmitter";
  3. import { HemisphericParticleEmitter } from "./EmitterTypes/hemisphericParticleEmitter";
  4. import { SphereDirectedParticleEmitter, SphereParticleEmitter } from "./EmitterTypes/sphereParticleEmitter";
  5. import { CylinderDirectedParticleEmitter, CylinderParticleEmitter } from "./EmitterTypes/cylinderParticleEmitter";
  6. import { ConeParticleEmitter } from "./EmitterTypes/coneParticleEmitter";
  7. /**
  8. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  9. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  10. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  11. * @returns the emitter
  12. */
  13. export declare function CreatePointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  14. /**
  15. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  16. * @param radius The radius of the hemisphere to emit from
  17. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  18. * @returns the emitter
  19. */
  20. export declare function CreateHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  21. /**
  22. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  23. * @param radius The radius of the sphere to emit from
  24. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  25. * @returns the emitter
  26. */
  27. export declare function CreateSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  28. /**
  29. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  30. * @param radius The radius of the sphere to emit from
  31. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  32. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  33. * @returns the emitter
  34. */
  35. export declare function CreateDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  36. /**
  37. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  38. * @param radius The radius of the emission cylinder
  39. * @param height The height of the emission cylinder
  40. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  41. * @param directionRandomizer How much to randomize the particle direction [0-1]
  42. * @returns the emitter
  43. */
  44. export declare function CreateCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  45. /**
  46. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  47. * @param radius The radius of the cylinder to emit from
  48. * @param height The height of the emission cylinder
  49. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  50. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  51. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  52. * @returns the emitter
  53. */
  54. export declare function CreateDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  55. /**
  56. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  57. * @param radius The radius of the cone to emit from
  58. * @param angle The base angle of the cone
  59. * @returns the emitter
  60. */
  61. export declare function CreateConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;