---
name: ParticleEmitter2D
last_updated: 2026-11-20T01:32:50Z
inherits:
  - Instance
  - Object
type: class
memory_category: Instances
tags:
  - NotBrowsable
summary: "A special object that emits customizable 2D particles from a GuiObject."
---

# Class: ParticleEmitter2D

> A special object that emits customizable 2D particles from a
> [GuiObject](/docs/reference/engine/classes/GuiObject.md).

## Description

A `ParticleEmitter2D` is a special object that emits customizable 2D particles
for use in UI. To emit and render particles, it must be parented to a
[GuiObject](/docs/reference/engine/classes/GuiObject.md), such as within a [ScreenGui](/docs/reference/engine/classes/ScreenGui.md), [SurfaceGui](/docs/reference/engine/classes/SurfaceGui.md), or
[BillboardGui](/docs/reference/engine/classes/BillboardGui.md). Particles spawn from the very top layer of the parent
[GuiObject](/docs/reference/engine/classes/GuiObject.md), above its strokes and inset shadows.

Particles emit automatically when the emitter is
[Enabled](/docs/reference/engine/classes/ParticleEmitter2D.md) with a non-zero
[Rate](/docs/reference/engine/classes/ParticleEmitter2D.md), or manually when the
[Emit](/docs/reference/engine/classes/ParticleEmitter2D.md) method is called. By default, particles
emit upward in the parent's local canvas direction. The parent's rotation is
inherited and combined with
[EmissionAngle](/docs/reference/engine/classes/ParticleEmitter2D.md) and
[SpreadAngle](/docs/reference/engine/classes/ParticleEmitter2D.md) to vary the emission
direction further. With a non-zero [Speed](/docs/reference/engine/classes/ParticleEmitter2D.md),
particles are set in motion in that direction.

Several properties, including [Size](/docs/reference/engine/classes/ParticleEmitter2D.md),
[Speed](/docs/reference/engine/classes/ParticleEmitter2D.md), and
[Acceleration](/docs/reference/engine/classes/ParticleEmitter2D.md), are measured in **offset
units**, the logical pixel offset component of a [UDim2](/docs/reference/engine/datatypes/UDim2.md) and the same
units used by [GuiObject.Size](/docs/reference/engine/classes/GuiObject.md) and [GuiBase2d.AbsoluteSize](/docs/reference/engine/classes/GuiBase2d.md). This
differs from [EmissionOffset](/docs/reference/engine/classes/ParticleEmitter2D.md) and
[EmissionSpread](/docs/reference/engine/classes/ParticleEmitter2D.md) which are scalar
fractions of the [GuiObject](/docs/reference/engine/classes/GuiObject.md) parent's own size rather than fixed offset
units.

During the [Lifetime](/docs/reference/engine/classes/ParticleEmitter2D.md) of the particles, they
can change appearance according to the [Color](/docs/reference/engine/classes/ParticleEmitter2D.md)
and [Size](/docs/reference/engine/classes/ParticleEmitter2D.md). Their motion can change over time
according to the [Drag](/docs/reference/engine/classes/ParticleEmitter2D.md) and
[Acceleration](/docs/reference/engine/classes/ParticleEmitter2D.md) properties, and they can
also move as their parent moves when they are
[LockedToParent](/docs/reference/engine/classes/ParticleEmitter2D.md).

## Properties

### Property: ParticleEmitter2D.Acceleration

```json
{
  "type": "Vector2",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Motion",
  "capabilities": [
    "Basic"
  ]
}
```

The `Acceleration` property determines how the
[Speed](/docs/reference/engine/classes/ParticleEmitter2D.md) of particles changes over their
lifetime. It is defined using a [Vector2](/docs/reference/engine/datatypes/Vector2.md) to determine the
acceleration on the [GuiObject](/docs/reference/engine/classes/GuiObject.md) parent's local **X**/**Y** canvas
axes, measured in offset units per second squared. When changed, this
property affects all particles emitted by the emitter, both current and
future.

Acceleration will slow particles down if the vector points in the opposite
direction in which they are emitted. Otherwise, it will speed them up.

### Property: ParticleEmitter2D.Blend

```json
{
  "type": "float",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Appearance",
  "capabilities": [
    "Basic"
  ]
}
```

The `Blend` property determines the blending of the
[TextureContent](/docs/reference/engine/classes/ParticleEmitter2D.md) colors with the
colors behind them, the same role
[LightEmission](/docs/reference/engine/classes/ParticleEmitter.md) plays on
[ParticleEmitter](/docs/reference/engine/classes/ParticleEmitter.md). A value of `0` uses normal blending mode while a
value of `1` uses additive blending. When changed, this property instantly
affects all particles owned by the emitter, both current and future.

### Property: ParticleEmitter2D.Brightness

```json
{
  "type": "float",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Appearance",
  "capabilities": [
    "Basic"
  ]
}
```

The `Brightness` property scales the brightness of all active particles.
Values above `1` can be used to make particles appear to glow brighter
than fully opaque white.

### Property: ParticleEmitter2D.Color

```json
{
  "type": "ColorSequence",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Appearance",
  "capabilities": [
    "Basic"
  ]
}
```

The `Color` property determines the color of all active particles over
their individual lifetimes. The color applies to the
[TextureContent](/docs/reference/engine/classes/ParticleEmitter2D.md) when rendering and
it uses the texture alpha along with the emitter's
[Transparency](/docs/reference/engine/classes/ParticleEmitter2D.md).

Changing this property affects all particles emitted by the emitter, both
current and future.

When this property uses a gradient [ColorSequence](/docs/reference/engine/datatypes/ColorSequence.md), a particle's
present color is determined by linearly interpolating on the sequence
using the particle's age and its total lifetime. For example, if a
particle spawned 2 seconds ago and has a 4 second lifetime, the color will
be whatever is 50% of the way through the [ColorSequence](/docs/reference/engine/datatypes/ColorSequence.md).

### Property: ParticleEmitter2D.Drag

```json
{
  "type": "float",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Motion",
  "capabilities": [
    "Basic"
  ]
}
```

The `Drag` property determines the rate in seconds at which individual
particles will lose half their speed via exponential decay. Drag is
applied by scaling the expected velocity from
[Speed](/docs/reference/engine/classes/ParticleEmitter2D.md). Setting this property to a negative
value will cause particles' velocities to grow exponentially.

### Property: ParticleEmitter2D.EmissionAngle

```json
{
  "type": "float",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Emission",
  "capabilities": [
    "Basic"
  ]
}
```

The `EmissionAngle` property determines the angle, in degrees, that
particles are emitted towards within the plane of the parent
[GuiObject](/docs/reference/engine/classes/GuiObject.md). This angle is combined with the parent's own rotation,
so rotating the parent also rotates the emission direction.
[SpreadAngle](/docs/reference/engine/classes/ParticleEmitter2D.md) further randomizes the
emission direction around this angle.

### Property: ParticleEmitter2D.EmissionMode

```json
{
  "type": "ParticleEmitter2DEmissionMode",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Emission",
  "capabilities": [
    "Basic"
  ]
}
```

The `EmissionMode` property determines the region of the parent
[GuiObject](/docs/reference/engine/classes/GuiObject.md) that particles emit from. It can be any value of the
[ParticleEmitter2DEmissionMode](/docs/reference/engine/enums/ParticleEmitter2DEmissionMode.md) enum:

- [Point](/docs/reference/engine/enums/ParticleEmitter2DEmissionMode.md) &ndash; Particles emit from a
  single point at the center of the [GuiObject](/docs/reference/engine/classes/GuiObject.md), or from an ellipse
  around it if [EmissionSpread](/docs/reference/engine/classes/ParticleEmitter2D.md) is
  increased.
- [BoundingBox](/docs/reference/engine/enums/ParticleEmitter2DEmissionMode.md) &ndash; Particles emit
  from anywhere within the bounds of the [GuiObject](/docs/reference/engine/classes/GuiObject.md).

[EmissionSpread](/docs/reference/engine/classes/ParticleEmitter2D.md) further adjusts
the size of the point or bounding box emission region, and
[EmissionOffset](/docs/reference/engine/classes/ParticleEmitter2D.md) shifts it from the
[GuiObject](/docs/reference/engine/classes/GuiObject.md) parent's center.

### Property: ParticleEmitter2D.EmissionOffset

```json
{
  "type": "Vector2",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Emission",
  "capabilities": [
    "Basic"
  ]
}
```

The `EmissionOffset` property determines the scalar translation of the
particle emission region from the center of the parent [GuiObject](/docs/reference/engine/classes/GuiObject.md).
It is a scalar translation, meaning the actual pixel offset is determined
by the [AbsoluteSize](/docs/reference/engine/classes/GuiBase2d.md) of the parent
[GuiObject](/docs/reference/engine/classes/GuiObject.md). For example, a value of `(1, 0)` shifts the emission
region horizontally to the right by a distance equal to the parent
object's size.

### Property: ParticleEmitter2D.EmissionSpread

```json
{
  "type": "Vector2",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Emission",
  "capabilities": [
    "Basic"
  ]
}
```

The `EmissionSpread` property determines the size of the particle emission
region, depending on [EmissionMode](/docs/reference/engine/classes/ParticleEmitter2D.md):

- For [BoundingBox](/docs/reference/engine/enums/ParticleEmitter2DEmissionMode.md), it adds to the
  width and height of the [GuiObject](/docs/reference/engine/classes/GuiObject.md) parent's bounding box.
- For [Point](/docs/reference/engine/enums/ParticleEmitter2DEmissionMode.md), it adds to the width and
  height of an ellipse centered on the emission point. A value of `(0, 0)`
  results in true point emission.

### Property: ParticleEmitter2D.Enabled

```json
{
  "type": "boolean",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Emission",
  "capabilities": [
    "Basic"
  ]
}
```

The `Enabled` property determines if particles emit from the emitter.
Setting this to `false` stops further particles from spawning, but any
existing particles remain active until they expire. This property is
useful when you have a pre-made particle effect that you want to remain
disabled until you need it to emit particles.

If you want to clear all particles from a disabled emitter, call
[Clear()](/docs/reference/engine/classes/ParticleEmitter2D.md). Then, if desired, call
[Emit()](/docs/reference/engine/classes/ParticleEmitter2D.md) on the emitter to emit and render
particles.

### Property: ParticleEmitter2D.FlipbookBlendFrames

```json
{
  "type": "boolean",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Flipbook",
  "capabilities": [
    "Basic"
  ]
}
```

The `FlipbookBlendFrames` property determines whether the frames in the
flipbook texture are blended between using a linear crossfade, or swapped
instantly.

### Property: ParticleEmitter2D.FlipbookFramerate

```json
{
  "type": "NumberRange",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Flipbook",
  "capabilities": [
    "Basic"
  ]
}
```

The `FlipbookFramerate` property determines how fast the flipbook texture
animates in frames per second. You can set a minimum and maximum range to
randomize the framerate of the flipbook, with a maximum of 30 frames per
second.

### Property: ParticleEmitter2D.FlipbookLayout

```json
{
  "type": "ParticleFlipbookLayout",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Flipbook",
  "capabilities": [
    "Basic"
  ]
}
```

The `FlipbookLayout` property determines the layout of the texture. It can
be any value of the [ParticleFlipbookLayout](/docs/reference/engine/enums/ParticleFlipbookLayout.md) enum:

- [None](/docs/reference/engine/enums/ParticleFlipbookLayout.md) — Disable flipbook features and use
  the texture as a single static texture over the particle's lifetime.
- [Grid2x2](/docs/reference/engine/enums/ParticleFlipbookLayout.md) — 2&times;2 frames for a 4-frame
  animation.
- [Grid4x4](/docs/reference/engine/enums/ParticleFlipbookLayout.md) — 4&times;4 frames for a 16-frame
  animation.
- [Grid8x8](/docs/reference/engine/enums/ParticleFlipbookLayout.md) — 8&times;8 frames for a 64-frame
  animation.
- [Custom](/docs/reference/engine/enums/ParticleFlipbookLayout.md) — A custom grid size defined by
  [FlipbookSizeX](/docs/reference/engine/classes/ParticleEmitter2D.md) and
  [FlipbookSizeY](/docs/reference/engine/classes/ParticleEmitter2D.md).

### Property: ParticleEmitter2D.FlipbookMode

```json
{
  "type": "ParticleFlipbookMode",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Flipbook",
  "capabilities": [
    "Basic"
  ]
}
```

The `FlipbookMode` property determines the type of the flipbook animation.
It can be any value of the [ParticleFlipbookMode](/docs/reference/engine/enums/ParticleFlipbookMode.md) enum:

- [Loop](/docs/reference/engine/enums/ParticleFlipbookMode.md) — Continuously play through all frames,
  starting back at the first frame after playing the last.
- [OneShot](/docs/reference/engine/enums/ParticleFlipbookMode.md) — Play through the animation only
  once across the particle's lifetime. With this setting, the
  [FlipbookFramerate](/docs/reference/engine/classes/ParticleEmitter2D.md) property
  doesn't apply; instead, the framerate is determined by the particle's
  [Lifetime](/docs/reference/engine/classes/ParticleEmitter2D.md) divided evenly by the number
  of frames in the animation.
- [PingPong](/docs/reference/engine/enums/ParticleFlipbookMode.md) — Play from the first to the last
  frame, then in reverse from the last to the first, repeating throughout
  the [Lifetime](/docs/reference/engine/classes/ParticleEmitter2D.md) of the particle.
- [Random](/docs/reference/engine/enums/ParticleFlipbookMode.md) — Play the frames in a random order,
  blending/crossfading from one frame to the next.

### Property: ParticleEmitter2D.FlipbookSizeX

```json
{
  "type": "int",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Flipbook",
  "capabilities": [
    "Basic"
  ]
}
```

The `FlipbookSizeX` property defines the number of horizontal frames
(columns) in a custom flipbook layout. This property only applies when
[FlipbookLayout](/docs/reference/engine/classes/ParticleEmitter2D.md) is set to
[Custom](/docs/reference/engine/enums/ParticleFlipbookLayout.md).

### Property: ParticleEmitter2D.FlipbookSizeY

```json
{
  "type": "int",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Flipbook",
  "capabilities": [
    "Basic"
  ]
}
```

The `FlipbookSizeY` property defines the number of vertical frames (rows)
in a custom flipbook layout. This property only applies when
[FlipbookLayout](/docs/reference/engine/classes/ParticleEmitter2D.md) is set to
[Custom](/docs/reference/engine/enums/ParticleFlipbookLayout.md).

### Property: ParticleEmitter2D.FlipbookStartRandom

```json
{
  "type": "boolean",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Flipbook",
  "capabilities": [
    "Basic"
  ]
}
```

The `FlipbookStartRandom` property determines whether each particle begins
at a random frame of the animation instead of always starting at the first
frame. One use case is to enable this property and also set
[FlipbookFramerate](/docs/reference/engine/classes/ParticleEmitter2D.md) to zero,
causing each emitted particle to be a static frame chosen randomly from
the flipbook texture.

### Property: ParticleEmitter2D.Lifetime

```json
{
  "type": "NumberRange",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Emission",
  "capabilities": [
    "Basic"
  ]
}
```

The `Lifetime` property defines the maximum and minimum ages for newly
emitted particles. Lifetimes are stored on a per-particle basis, so if
this value is changed, existing particles will stay active until their
randomly chosen lifetime ends. A lifetime of `0` will prevent particles
from emitting at all.

### Property: ParticleEmitter2D.LightInfluence

```json
{
  "type": "float",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Appearance",
  "capabilities": [
    "Basic"
  ]
}
```

The `LightInfluence` property determines how much environmental light
affects the color of individual particles when they render, the same role
[LightInfluence](/docs/reference/engine/classes/ParticleEmitter.md) plays on
[ParticleEmitter](/docs/reference/engine/classes/ParticleEmitter.md). At `0`, particles are not influenced by light at
all and they retain full brightness. At `1`, particles are fully
influenced by light (in complete darkness, particles will be black).

This property only has an effect when the emitter's parent
[GuiBase2d](/docs/reference/engine/classes/GuiBase2d.md) renders in world space on a [SurfaceGui](/docs/reference/engine/classes/SurfaceGui.md) or a
[BillboardGui](/docs/reference/engine/classes/BillboardGui.md), excluding always-on-top. On an emitter in a
[ScreenGui](/docs/reference/engine/classes/ScreenGui.md), [BillboardGui](/docs/reference/engine/classes/BillboardGui.md) with
[AlwaysOnTop](/docs/reference/engine/classes/BillboardGui.md) set to `true`, or
[SurfaceGui](/docs/reference/engine/classes/SurfaceGui.md) with `ClassSurfaceGui.AlwaysOnTop|AlwaysOnTop` set to
`true`, `LightInfluence` has no visible effect.

### Property: ParticleEmitter2D.LockedToParent

```json
{
  "type": "boolean",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Particles",
  "capabilities": [
    "Basic"
  ]
}
```

The `LockedToParent` property determines if particles "stick" to the
emission source, the parent [GuiObject](/docs/reference/engine/classes/GuiObject.md). If `true`, active particles
will move in lock step if the parent object moves.

### Property: ParticleEmitter2D.Rate

```json
{
  "type": "float",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Emission",
  "capabilities": [
    "Basic"
  ]
}
```

The `Rate` property determines how many particles are emitted per second
while the emitter is [Enabled](/docs/reference/engine/classes/ParticleEmitter2D.md). It is the
inverse of frequency, meaning that a rate of `5` emits a particle every
`0.2` seconds. When changed, this property has no effect on any active
particles.

### Property: ParticleEmitter2D.Rotation

```json
{
  "type": "NumberRange",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Emission",
  "capabilities": [
    "Basic"
  ]
}
```

The `Rotation` property determines the range of rotations in degrees for
newly emitted particles, measured in degrees. Positive values are in the
clockwise direction. This property is commonly set to `[0, 360]` to
provide a completely random rotation to new particles.
[RotSpeed](/docs/reference/engine/classes/ParticleEmitter2D.md) also influences the rotation
of a particle over its lifetime.

Changes to this value only affect new particles. Existing particles
maintain the rotation at which they were originally emitted.

### Property: ParticleEmitter2D.RotSpeed

```json
{
  "type": "NumberRange",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Emission",
  "capabilities": [
    "Basic"
  ]
}
```

The `RotSpeed` property determines a random range of angular speeds for
newly emitted particles, measured in degrees per second. Positive values
spin particles in the clockwise direction, the same convention used by
[Rotation](/docs/reference/engine/classes/ParticleEmitter2D.md). A random angular speed is
chosen upon emission, so changing this property doesn't affect active
particles. This property, along with
[Rotation](/docs/reference/engine/classes/ParticleEmitter2D.md), affects the angle of the
rendered particle image.

### Property: ParticleEmitter2D.Size

```json
{
  "type": "NumberSequence",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Appearance",
  "capabilities": [
    "Basic"
  ]
}
```

The `Size` property determines the size of all active particles, in offset
units, over their individual lifetimes. The value represents the **half**
size (center-to-edge distance) of the square
[TextureContent](/docs/reference/engine/classes/ParticleEmitter2D.md) for each particle.
For example, a `Size` of `100` renders a particle that is 200×200 offset
units across. It is a [NumberSequence](/docs/reference/engine/datatypes/NumberSequence.md) that works similarly to
[Transparency](/docs/reference/engine/classes/ParticleEmitter2D.md).

A particle's present size is determined by linearly interpolating on this
sequence using the particle's age and its total lifetime. For example, if
a particle spawned 2 seconds ago and has a 4 second lifetime, the size
will be whatever is 50% of the way through the [NumberSequence](/docs/reference/engine/datatypes/NumberSequence.md).
For any [NumberSequenceKeypoint](/docs/reference/engine/datatypes/NumberSequenceKeypoint.md) with a non-zero envelope value,
a random value in the envelope range is chosen for each keypoint for each
particle when it emits.

### Property: ParticleEmitter2D.Speed

```json
{
  "type": "NumberRange",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Emission",
  "capabilities": [
    "Basic"
  ]
}
```

The `Speed` property determines a random range of velocities (minimum to
maximum) at which new particles will emit, measured in offset units per
second. Each particle's velocity is chosen upon emission and it applies in
the direction determined by
[EmissionAngle](/docs/reference/engine/classes/ParticleEmitter2D.md). Negative values
cause particles to travel in reverse.

Note that changing [Speed](/docs/reference/engine/classes/ParticleEmitter2D.md) does not affect
active particles and they retain whatever speed they already have.
However, [Acceleration](/docs/reference/engine/classes/ParticleEmitter2D.md) and
[Drag](/docs/reference/engine/classes/ParticleEmitter2D.md) can be used to affect the speed of
active particles over their lifetime.

### Property: ParticleEmitter2D.SpreadAngle

```json
{
  "type": "float",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Emission",
  "capabilities": [
    "Basic"
  ]
}
```

The `SpreadAngle` property determines the random angle, in degrees, over
which a particle may be emitted around
[EmissionAngle](/docs/reference/engine/classes/ParticleEmitter2D.md).

Setting this to `360` will cause particles to emit in all directions
around the emission point or region.

### Property: ParticleEmitter2D.Squash

```json
{
  "type": "NumberSequence",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Appearance",
  "capabilities": [
    "Basic"
  ]
}
```

Allows for non-uniform scaling of particles, curve-controlled over their
lifetime. Values greater than `0` cause particles to both shrink
horizontally and grow vertically, while values less than `0` cause
particles to both grow horizontally and shrink vertically.

### Property: ParticleEmitter2D.TextureContent

```json
{
  "type": "Content",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Appearance",
  "capabilities": [
    "Basic"
  ]
}
```

The `TextureContent` property determines the image rendered on particles.
Supports [asset URIs](/docs/en-us/projects/assets.md#asset-uris). The
appearance of the texture is influenced by
[Color](/docs/reference/engine/classes/ParticleEmitter2D.md),
[Transparency](/docs/reference/engine/classes/ParticleEmitter2D.md),
[Blend](/docs/reference/engine/classes/ParticleEmitter2D.md), and
[LightInfluence](/docs/reference/engine/classes/ParticleEmitter2D.md). Textures with
transparent backgrounds work best for particles.

### Property: ParticleEmitter2D.TimeScale

```json
{
  "type": "float",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Particles",
  "capabilities": [
    "Basic"
  ]
}
```

A value between `0` and `1` that controls the speed of the particle
effect. At `1`, it runs at normal speed; at `0.5` it runs at half speed;
at `0` it freezes in time.

### Property: ParticleEmitter2D.Transparency

```json
{
  "type": "NumberSequence",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Appearance",
  "capabilities": [
    "Basic"
  ]
}
```

The `Transparency` property determines the transparency of all active
particles over their individual lifetimes. It works similar to
[Size](/docs/reference/engine/classes/ParticleEmitter2D.md) in how it affects particles over time.
In terms of rendering, a value of `0` is completely visible (opaque) and a
value of `1` is completely invisible.

A particle's present transparency is determined by linearly interpolating
on this sequence using the particle's age and its total lifetime. For
example, if a particle spawned 2 seconds ago and has a 4 second lifetime,
the transparency will be whatever is 50% of the way through the
[NumberSequence](/docs/reference/engine/datatypes/NumberSequence.md). For any [NumberSequenceKeypoint](/docs/reference/engine/datatypes/NumberSequenceKeypoint.md) with
a non-zero envelope value, a random value in the envelope range is chosen
for each keypoint for each particle when it emits.

### Property: ParticleEmitter2D.ZIndex

```json
{
  "type": "int",
  "access": "ReadWrite",
  "security": {
    "read": "None",
    "write": "None"
  },
  "serialization": {
    "can_load": true,
    "can_save": true
  },
  "thread_safety": "ReadSafe",
  "category": "Appearance",
  "capabilities": [
    "Basic"
  ]
}
```

The `ZIndex` property determines the render order of this emitter's
particles relative to other [ParticleEmitter2D](/docs/reference/engine/classes/ParticleEmitter2D.md) objects parented to
the same [GuiObject](/docs/reference/engine/classes/GuiObject.md). Higher values render on top of lower values,
similar to [GuiObject.ZIndex](/docs/reference/engine/classes/GuiObject.md).

## Methods

### Method: ParticleEmitter2D:Clear

**Signature:** `ParticleEmitter2D:Clear(): ()`

This method instantly clears all existing particles that have been emitted
by the [ParticleEmitter2D](/docs/reference/engine/classes/ParticleEmitter2D.md) through its natural emission (non-zero
[Rate](/docs/reference/engine/classes/ParticleEmitter2D.md) on an
[Enabled](/docs/reference/engine/classes/ParticleEmitter2D.md) emitter) or via
[Emit()](/docs/reference/engine/classes/ParticleEmitter2D.md).

*Security: None · Thread Safety: Unsafe · Capabilities: Basic*

**Returns:** `()`

### Method: ParticleEmitter2D:Emit

**Signature:** `ParticleEmitter2D:Emit(particleCount?: int): ()`

This method will cause the [ParticleEmitter2D](/docs/reference/engine/classes/ParticleEmitter2D.md) to instantly emit the
given number of particles.

*Security: None · Thread Safety: Unsafe · Capabilities: Basic*

**Parameters:**

| Name | Type | Default | Description |
|------|------|---------|-------------|
| `particleCount` | `int` | `16` | The number of particles to emit. |

**Returns:** `()`

## Inherited Members

### From [Instance](/docs/reference/engine/classes/Instance.md)

- **Property `Archivable`** (`boolean`): Determines if an Instance and its descendants can be cloned using
- **Property `archivable`** (`boolean`):  *(deprecated, hidden)*
- **Property `Capabilities`** (`SecurityCapabilities`): The set of capabilities allowed to be used for scripts inside this
- **Property `IsInSandbox`** (`boolean`): Indicates whether the instance is inside a sandboxed container.
- **Property `Name`** (`string`): A non-unique identifier of the Instance.
- **Property `Parent`** (`Instance`): Determines the hierarchical parent of the Instance.
- **Property `PredictionMode`** (`PredictionMode`): Reflects the client-side prediction mode applied to the instance under
- **Property `RobloxLocked`** (`boolean`): A deprecated property that used to protect CoreGui objects. *(hidden)*
- **Property `Sandboxed`** (`boolean`): When enabled, the instance can only access abilities in its `Capabilities`
- **Property `UniqueId`** (`UniqueId`): A unique identifier for the instance.
- **Method `AddTag(tag: string): ()`**: Applies a tag to the instance.
- **Method `children(): Instances`**: Returns an array of the object's children. *(deprecated)*
- **Method `ClearAllChildren(): ()`**: This method destroys all of an instance's children.
- **Method `Clone(): Instance`**: Create a copy of an instance and all its descendants, ignoring instances
- **Method `clone(): Instance`**:  *(deprecated)*
- **Method `Destroy(): ()`**: Sets the Instance.Parent property to `nil`, locks the
- **Method `destroy(): ()`**:  *(deprecated)*
- **Method `FindFirstAncestor(name: string): Instance?`**: Returns the first ancestor of the Instance whose
- **Method `FindFirstAncestorOfClass(className: string): Instance?`**: Returns the first ancestor of the Instance whose
- **Method `FindFirstAncestorWhichIsA(className: string): Instance?`**: Returns the first ancestor of the Instance for whom
- **Method `FindFirstChild(name: string, recursive?: boolean): Instance?`**: Returns the first child of the Instance found with the given name.
- **Method `findFirstChild(name: string, recursive?: boolean): Instance`**:  *(deprecated)*
- **Method `FindFirstChildOfClass(className: string): Instance?`**: Returns the first child of the Instance whose
- **Method `FindFirstChildWhichIsA(className: string, recursive?: boolean): Instance?`**: Returns the first child of the Instance for whom
- **Method `FindFirstDescendant(name: string): Instance?`**: Returns the first descendant found with the given Instance.Name.
- **Method `GetActor(): Actor?`**: Returns the Actor associated with the Instance, if any.
- **Method `GetAttribute(attribute: string): Variant`**: Returns the value which has been assigned to the given attribute name.
- **Method `GetAttributeChangedSignal(attribute: string): RBXScriptSignal`**: Returns an event that fires when the given attribute changes.
- **Method `GetAttributes(): Dictionary`**: Returns a dictionary of the instance's attributes.
- **Method `GetChildren(): Instances`**: Returns an array containing all of the instance's children.
- **Method `getChildren(): Instances`**:  *(deprecated)*
- **Method `GetDebugId(scopeLength?: int): string`**: Returns a coded string of the debug ID used internally by Roblox.
- **Method `GetDescendants(): Instances`**: Returns an array containing all of the descendants of the instance.
- **Method `GetFullName(): string`**: Returns a string describing the instance's ancestry.
- **Method `GetStyled(name: string, selector: string?): Variant`**: Returns the styled or explicitly modified value of the specified property,
- **Method `GetStyledPropertyChangedSignal(property: string): RBXScriptSignal`**: Returns an event that fires when the given style property changes on the
- **Method `GetTags(): Array`**: Gets an array of all tags applied to the instance.
- **Method `HasTag(tag: string): boolean`**: Check whether the instance has a given tag.
- **Method `IsAncestorOf(descendant: Instance): boolean`**: Returns true if an Instance is an ancestor of the given
- **Method `IsDescendantOf(ancestor: Instance): boolean`**: Returns `true` if an Instance is a descendant of the given
- **Method `isDescendantOf(ancestor: Instance): boolean`**:  *(deprecated)*
- **Method `IsPropertyModified(property: string): boolean`**: Returns `true` if the value stored in the specified property is not equal
- **Method `QueryDescendants(selector: string): Instances`**: Returns an array containing all descendants of the instance that match the
- **Method `Remove(): ()`**: Sets the object's `Parent` to `nil`, and does the same for all its *(deprecated)*
- **Method `remove(): ()`**:  *(deprecated)*
- **Method `RemoveTag(tag: string): ()`**: Removes a tag from the instance.
- **Method `ResetPropertyToDefault(property: string): ()`**: Resets a property to its default value.
- **Method `SetAttribute(attribute: string, value: Variant): ()`**: Sets the attribute with the given name to the given value.
- **Method `WaitForChild(childName: string, timeOut: double): Instance`**: Returns the child of the Instance with the given name. If the
- **Event `AncestryChanged`**: Fires when the Instance.Parent property of this object or one of
- **Event `AttributeChanged`**: Fires whenever an attribute is changed on the Instance.
- **Event `ChildAdded`**: Fires after an object is parented to this Instance.
- **Event `childAdded`**:  *(deprecated)*
- **Event `ChildRemoved`**: Fires after a child is removed from this Instance.
- **Event `DescendantAdded`**: Fires after a descendant is added to the Instance.
- **Event `DescendantRemoving`**: Fires immediately before a descendant of the Instance is removed.
- **Event `Destroying`**: Fires immediately before (or is deferred until after) the instance is
- **Event `StyledPropertiesChanged`**: Fires whenever any style property is changed on the instance, including

### From [Object](/docs/reference/engine/classes/Object.md)

- **Property `ClassName`** (`string`): A read-only string representing the class this Object belongs to.
- **Property `className`** (`string`):  *(deprecated)*
- **Method `GetPropertyChangedSignal(property: string): RBXScriptSignal`**: Get an event that fires when a given property of the object changes.
- **Method `IsA(className: string): boolean`**: Returns true if an object's class matches or inherits from a given class.
- **Method `isA(className: string): boolean`**:  *(deprecated)*
- **Event `Changed`**: Fires immediately after a property of the object changes, with some