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`
`randomRange`
`clamp01`
`resolveTransparencyMode`
`resolveBillboardMode`
`resolveCullMode`
`resolveBlendMode`
`getVector2`
`getColor3`
`evalNumberSequence`
`evalColorSequence`
`getFlipbookMode`
`getEmitterCFrame`
`getEmissionDirection`
`getEmitterVelocity`
`applySpread`
`buildDefaultColor`
`buildDefaultTransparency`
`buildDefaultSize`
`createMaterial`
`writePositionMapped`
`writeRotationMapped`
`writeScaleMapped`
`writeColorMapped`
`writePositionBuffer`
`writeRotationBuffer`
`writeScaleBuffer`
`writeColorBuffer`
`rebuildInstanceBuffer`
`applyMaterialSettings`
`updateMaterial`
`applyShadowMode`
`emitParticle`
`emit`
`updateParticles`
`updateInstanceBuffer`
`writeInstances`
Writes instances.
`instance.Emit`
Emits a specified amount of particles.
`updateFlipbook`
Updates flipbook.
getRange
Arguments
value, defaultMin, defaultMaxReturns
This function returns nothing.
randomRange
Arguments
value, defaultMin, defaultMaxReturns
This function returns nothing.
clamp01
Arguments
vReturns
This function returns nothing.
resolveTransparencyMode
Arguments
valueReturns
This function returns nothing.
resolveBillboardMode
Arguments
valueReturns
This function returns nothing.
resolveCullMode
Arguments
valueReturns
This function returns nothing.
resolveBlendMode
Arguments
valueReturns
This function returns nothing.
getVector2
Arguments
value, fallbackReturns
This function returns nothing.
getColor3
Arguments
value, fallbackReturns
This function returns nothing.
evalNumberSequence
Arguments
seq, t, fallbackReturns
This function returns nothing.
evalColorSequence
Arguments
seq, t, fallbackReturns
This function returns nothing.
getFlipbookMode
Arguments
valueReturns
This function returns nothing.
getEmitterCFrame
Arguments
instanceReturns
This function returns nothing.
getEmissionDirection
Arguments
cf, normalIdReturns
This function returns nothing.
getEmitterVelocity
Arguments
instanceReturns
This function returns nothing.
applySpread
Arguments
baseDir, basisRight, basisUp, spreadReturns
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.
createMaterial
Arguments
texturePathReturns
This function returns nothing.
writePositionMapped
Arguments
mappedPositionReturns
This function returns nothing.
writeRotationMapped
Arguments
mappedRotationReturns
This function returns nothing.
writeScaleMapped
Arguments
mappedScaleReturns
This function returns nothing.
writeColorMapped
Arguments
mappedColorReturns
This function returns nothing.
writePositionBuffer
Arguments
targetBufferReturns
This function returns nothing.
writeRotationBuffer
Arguments
targetBufferReturns
This function returns nothing.
writeScaleBuffer
Arguments
targetBufferReturns
This function returns nothing.
writeColorBuffer
Arguments
targetBufferReturns
This function returns nothing.
rebuildInstanceBuffer
Arguments
This function takes no arguments.
Returns
This function returns nothing.
applyMaterialSettings
Arguments
This function takes no arguments.
Returns
This function returns nothing.
updateMaterial
Arguments
This function takes no arguments.
Returns
This function returns nothing.
applyShadowMode
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
countReturns
This function returns nothing.
updateParticles
Arguments
self: table, count: numberReturns
This function returns nothing.
updateInstanceBuffer
Arguments
This function takes no arguments.
Returns
This function returns nothing.
writeInstances
Writes instances.
Arguments
writePosition: any, writeRotation: number, writeScale: number, writeColor: numberReturns
This function returns nothing.
instance.Emit
Emits a specified amount of particles.
Arguments
self: table, count: numberReturns
This function returns nothing.
updateFlipbook
Updates flipbook.
Arguments
dt: numberReturns
This function returns nothing.
API
instance:getRange(value, defaultMin, defaultMax)
instance:randomRange(value, defaultMin, defaultMax)
instance:clamp01(v)
instance:resolveTransparencyMode(value)
instance:resolveBillboardMode(value)
instance:resolveCullMode(value)
instance:resolveBlendMode(value)
instance:getVector2(value, fallback)
instance:getColor3(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:createMaterial(texturePath)
instance:writePositionMapped(mappedPosition)
instance:writeRotationMapped(mappedRotation)
instance:writeScaleMapped(mappedScale)
instance:writeColorMapped(mappedColor)
instance:writePositionBuffer(targetBuffer)
instance:writeRotationBuffer(targetBuffer)
instance:writeScaleBuffer(targetBuffer)
instance:writeColorBuffer(targetBuffer)
instance:rebuildInstanceBuffer()
instance:applyMaterialSettings()
instance:updateMaterial()
instance:applyShadowMode()
instance:emitParticle()
instance:emit(count)
instance:updateParticles(self: table, count: number)
instance:updateInstanceBuffer()
instance:writeInstances(writePosition: any, writeRotation: number, writeScale: number, writeColor: number)
instance:Emit(self: table, count: number)
instance:updateFlipbook(dt: number)