ParticleEmitter

Emits particles in 3D space with a custom image template, and with configurable properties such as Color, Transparency, etc

Properties

Property	Type	Default
`Enabled`	`boolean`	`true`
`Rate`	`number`	`20`
`Lifetime`	`any`	`NumberRange.new(1, 2)`
`Speed`	`any`	`NumberRange.new(4, 7)`
`Rotation`	`any`	`NumberRange.new(0, 0)`
`RotSpeed`	`any`	`NumberRange.new(0, 0)`
`Size`	`any`	`buildDefaultSize()`
`Color`	`any`	`buildDefaultColor()`
`Transparency`	`any`	`buildDefaultTransparency()`
`Acceleration`	`Vector3`	`Vector3.new(0, 0, 0)`
`Drag`	`number`	`0`
`Restitution`	`number`	`0.5`
`CollisionGroup`	`string`	`"Particles"`
`Friction`	`number`	`0.3`
`VelocityInheritance`	`number`	`0`
`TimeScale`	`number`	`1`
`WindAffectsDrag`	`boolean`	`false`
`CollideParticles`	`boolean`	`false`
`CollisionRadius`	`number`	`0.5`
`EmissionDirection`	`EnumItem`	`Enum.NormalId.Top`
`SpreadAngle`	`Vector2`	`Vector2.new(0, 0)`
`Texture`	`string`	`"./src/assets/images/placeholder.png"`
`EmissionTexture`	`any`	`nil`
`EmissionColor`	`Color3`	`Color3.new(1, 1, 1)`
`EmissionEnergy`	`number`	`0`
`TransparencyMode`	`EnumItem`	`Enum.ParticleTransparencyMode.Alpha`
`BlendMode`	`EnumItem`	`Enum.ParticleBlendMode.Mix`
`CullMode`	`EnumItem`	`Enum.ParticleCullMode.None`
`BillboardMode`	`EnumItem`	`Enum.ParticleBillboardMode.Front`
`UVScale`	`Vector2`	`Vector2.new(1, 1)`
`UVOffset`	`Vector2`	`Vector2.new(0, 0)`
`FlipbookColumns`	`number`	`1`
`FlipbookRows`	`number`	`1`
`FlipbookFramerate`	`number`	`0`
`FlipbookMode`	`EnumItem`	`Enum.ParticleFlipbookMode.Loop`
`FlipbookStartRandom`	`boolean`	`false`
`MaxParticles`	`number`	`256`
`LockedToPart`	`boolean`	`false`
`CastShadow`	`boolean`	`true`

Functions

`getRange`

Arguments

value, defaultMin, defaultMax

Returns

This function returns nothing.

`randomRange`

Arguments

value, defaultMin, defaultMax

Returns

This function returns nothing.

`clamp01`

Arguments

Returns

This function returns nothing.

`resolveCullMode`

Arguments

value

Returns

This function returns nothing.

`getVector2`

Arguments

value, fallback

Returns

This function returns nothing.

`evalNumberSequence`

Arguments

seq, t, fallback

Returns

This function returns nothing.

`evalColorSequence`

Arguments

seq, t, fallback

Returns

This function returns nothing.

`getFlipbookMode`

Arguments

value

Returns

This function returns nothing.

`getEmitterCFrame`

Arguments

instance

Returns

This function returns nothing.

`getEmissionDirection`

Arguments

cf, normalId

Returns

This function returns nothing.

`getEmitterVelocity`

Arguments

instance

Returns

This function returns nothing.

`applySpread`

Arguments

baseDir, basisRight, basisUp, spread

Returns

This function returns nothing.

`buildDefaultColor`

Arguments

This function takes no arguments.

Returns

This function returns nothing.

`buildDefaultTransparency`

Arguments

This function takes no arguments.

Returns

This function returns nothing.

`buildDefaultSize`

Arguments

This function takes no arguments.

Returns

This function returns nothing.

`loadTexture`

Arguments

This function takes no arguments.

Returns

This function returns nothing.

`resizeItemBuffer`

Arguments

This function takes no arguments.

Returns

This function returns nothing.

`getCameraCFrame`

Arguments

This function takes no arguments.

Returns

This function returns nothing.

`emitParticle`

Arguments

This function takes no arguments.

Returns

This function returns nothing.

`emit`

Arguments

count

Returns

This function returns nothing.

`updateParticles`

Arguments

self: table, count: number

Returns

This function returns nothing.

`writeMatrix`

Arguments

base, pos, right, up, look, size

Returns

This function returns nothing.

`buildParticleItems`

Arguments

This function takes no arguments.

Returns

This function returns nothing.

`instance.Emit`

Emits a specified amount of particles.

Arguments

self: table, count: number

Returns

This function returns nothing.

`updateFlipbook`

Updates flipbook.

Arguments

dt: number

Returns

This function returns nothing.

API

instance:getRange(value, defaultMin, defaultMax)
instance:randomRange(value, defaultMin, defaultMax)
instance:clamp01(v)
instance:resolveCullMode(value)
instance:getVector2(value, fallback)
instance:evalNumberSequence(seq, t, fallback)
instance:evalColorSequence(seq, t, fallback)
instance:getFlipbookMode(value)
instance:getEmitterCFrame(instance)
instance:getEmissionDirection(cf, normalId)
instance:getEmitterVelocity(instance)
instance:applySpread(baseDir, basisRight, basisUp, spread)
instance:buildDefaultColor()
instance:buildDefaultTransparency()
instance:buildDefaultSize()
instance:loadTexture()
instance:resizeItemBuffer()
instance:getCameraCFrame()
instance:emitParticle()
instance:emit(count)
instance:updateParticles(self: table, count: number)
instance:writeMatrix(base, pos, right, up, look, size)
instance:buildParticleItems()
instance:Emit(self: table, count: number)
instance:updateFlipbook(dt: number)

Part2D

A visible rectangular 2D world part with Box2D body properties.

ParticleEmitter2D

Emits 2D particles in 2D space, Works if parented under a gui container.