rojo/.cursor/rules/roblox/reference/engine/enums/ParticleFlipbookMode.yaml
2026-02-02 12:08:47 -06:00

50 lines
1.7 KiB
YAML

# This file is automatically generated. Please don't edit it manually.
# To submit a bug report on the content, see
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
name: ParticleFlipbookMode
type: enum
summary: |
Determines the type of the flipbook animation.
description: |
Determines the type of the flipbook animation.
code_samples: []
tags: []
deprecation_message: ''
items:
- name: Loop
summary: |
Continuously play through all frames, starting back at the first frame
after playing the last.
value: 0
tags: []
deprecation_message: ''
- name: OneShot
summary: |
Play through the animation only once across the particle's lifetime. With
this setting, the `Class.ParticleEmitter.FlipbookFramerate` property
doesn't apply; instead, the framerate is determined by the particle's
`Class.ParticleEmitter.Lifetime` divided evenly by the number of frames in
the animation. **OneShot** animations are useful for clear non-repeating
animations, such as an explosion that creates a puff of smoke and then
fades out.
value: 1
tags: []
deprecation_message: ''
- name: PingPong
summary: |
Play from the first to the last frame, then in reverse from the last to
the first, repeating throughout the `Class.ParticleEmitter.Lifetime` of
the particle.
value: 2
tags: []
deprecation_message: ''
- name: Random
summary: |
Play the frames in a random order, blending/crossfading from one frame to
the next. This can be useful for organic particle textures at low
framerates, such as stars slowly twinkling between subtly different
shapes.
value: 3
tags: []
deprecation_message: ''