ParticleEmitter2D

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

Properties

Property	Type	Default
`Enabled`	`boolean`	`true`
`Rate`	`number`	`10`
`Lifetime`	`any`	`NumberRange.new(1, 2)`
`Speed`	`any`	`NumberRange.new(30, 60)`
`Rotation`	`any`	`NumberRange.new(0, 0)`
`RotSpeed`	`any`	`NumberRange.new(0, 0)`
`Size`	`Vector2`	`Vector2.new(16, 16)`
`SizeScale`	`any`	`buildDefaultSize()`
`SizeSpread`	`Vector2`	`Vector2.new(0, 0)`
`Shape`	`EnumItem`	`Enum.UIParticleEmitterShape.Point`
`ShapeSize`	`Vector2`	`Vector2.new(100, 100)`
`ShapeThickness`	`number`	`0`
`ShapeRotation`	`number`	`0`
`EmitFromEdge`	`boolean`	`false`
`AlignToVelocity`	`boolean`	`false`
`Color`	`any`	`buildDefaultColor()`
`Transparency`	`any`	`buildDefaultTransparency()`
`Acceleration`	`Vector2`	`Vector2.new(0, 0)`
`Drag`	`number`	`0`
`EmissionDirection`	`EnumItem`	`Enum.NormalId.Top`
`SpreadAngle`	`Vector2`	`Vector2.new(0, 0)`
`Texture`	`string`	`"./src/assets/images/placeholder.png"`
`BlendMode`	`EnumItem`	`Enum.ParticleBlendMode.Mix`
`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`
`LockedToParent`	`boolean`	`false`
`Position`	`Vector2`	`Vector2.new(0, 0)`

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.

`evalNumberSequence`

Arguments

seq, t, fallback

Returns

This function returns nothing.

`evalColorSequence`

Arguments

seq, t, fallback

Returns

This function returns nothing.

`getSpreadAngle`

Arguments

spread

Returns

This function returns nothing.

`resolveUIBlendMode`

Arguments

value

Returns

This function returns nothing.

`getFlipbookMode`

Arguments

value

Returns

This function returns nothing.

`getEmissionDirection`

Arguments

direction

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.

`getEnumValue`

Arguments

value, fallback

Returns

This function returns nothing.

`rotateVector2`

Arguments

vec, degrees

Returns

This function returns nothing.

`randomSign`

Arguments

This function takes no arguments.

Returns

This function returns nothing.

`randomPointInShape`

Arguments

shapeValue, shapeSize, shapeThickness, emitFromEdge, shapeRotation

Returns

This function returns nothing.

`updateTexture`

Arguments

This function takes no arguments.

Returns

This function returns nothing.

`updateFlipbook`

Arguments

dt

Returns

This function returns nothing.

`emitParticle`

Arguments

origin

Returns

This function returns nothing.

`updateParticles`

Arguments

dt

Returns

This function returns nothing.

`instance.Emit`

Emits a specified amount of particles

Arguments

self: table, count: number

Returns

This function returns nothing.

API

instance:getRange(value, defaultMin, defaultMax)
instance:randomRange(value, defaultMin, defaultMax)
instance:clamp01(v)
instance:evalNumberSequence(seq, t, fallback)
instance:evalColorSequence(seq, t, fallback)
instance:getSpreadAngle(spread)
instance:resolveUIBlendMode(value)
instance:getFlipbookMode(value)
instance:getEmissionDirection(direction)
instance:buildDefaultColor()
instance:buildDefaultTransparency()
instance:buildDefaultSize()
instance:getEnumValue(value, fallback)
instance:rotateVector2(vec, degrees)
instance:randomSign()
instance:randomPointInShape(shapeValue, shapeSize, shapeThickness, emitFromEdge, shapeRotation)
instance:updateTexture()
instance:updateFlipbook(dt)
instance:emitParticle(origin)
instance:updateParticles(dt)
instance:Emit(self: table, count: number)

ParticleEmitter

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

PathfindingModifier

Represents a PathfindingModifier in the environment.