TextureSheetAnimationModule

struct in UnityEngine

Switch to Manual

Description

Script interface for the TextureSheetAnimationModule of a Particle System.

This module allows you to add animations to your particle textures. This is achieved by authoring flipbook textures, which look like this:



Each numbered region represents a frame of the animation, and must be distributed evenly across the texture. Select a variable below to see script examples. You may want to use this texture on your Particle System with each example, to see how the module works.

See Also: ParticleSystem, ParticleSystem.textureSheetAnimation.

Variables

animationSpecifies the animation type.
cycleCountSpecifies how many times the animation loops during the lifetime of the particle.
enabledSpecifies whether the TextureSheetAnimationModule is enabled or disabled.
fpsControl how quickly the animation plays.
frameOverTimeA curve to control which frame of the Texture sheet animation to play.
frameOverTimeMultiplierThe frame over time mutiplier.
modeSelect whether the animated Texture information comes from a grid of frames on a single Texture, or from a list of Sprite objects.
numTilesXDefines the tiling of the Texture in the x-axis.
numTilesYDefines the tiling of the texture in the y-axis.
rowIndexExplicitly select which row of the Texture sheet to use. The system uses this property when ParticleSystem.TextureSheetAnimationModule.rowMode is set to Custom.
rowModeSelect how particles choose which row of a Texture Sheet Animation to use.
speedRangeSpecify how particle speeds are mapped to the animation frames.
spriteCountThe total number of sprites.
startFrameDefine a random starting frame for the Texture sheet animation.
startFrameMultiplierThe starting frame multiplier.
timeModeSelect whether the system bases the playback on mapping a curve to the lifetime of each particle, by using the particle speeds, or if playback simply uses a constant frames per second.
uvChannelMaskChoose which UV channels receive Texture animation.

Public Functions

AddSpriteAdd a new Sprite.
GetSpriteGet the Sprite at the given index.
RemoveSpriteRemove a Sprite from the given index in the array.
SetSpriteSet the Sprite at the given index.