TextureSheetAnimationModule

struct in UnityEngine

Switch to Manual

Description

Script interface for the Texture Sheet Animation module.

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 will loop during the lifetime of the particle.
enabledEnable/disable the Texture Sheet Animation module.
fpsControl how quickly the animation plays.
frameOverTimeCurve to control which frame of the texture sheet animation to play.
frameOverTimeMultiplierFrame 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 is used, when ParticleSystem.TextureSheetAnimationModule.useRandomRow is set to false.
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.
startFrameMultiplierStarting frame multiplier.
timeModeSelect whether the playback is based 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.
useRandomRowUse a random row of the texture sheet for each particle emitted.
uvChannelMaskChoose which UV channels will 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.