Version: 5.6 (switch to 2017.1b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

TextureSheetAnimationModule

struct in UnityEngine

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

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.
flipUFlip the U coordinate on particles, causing them to appear mirrored horizontally.
flipVFlip the V coordinate on particles, causing them to appear mirrored vertically.
frameOverTimeCurve to control which frame of the texture sheet animation to play.
frameOverTimeMultiplierFrame over time mutiplier.
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.
startFrameDefine a random starting frame for the texture sheet animation.
startFrameMultiplierStarting frame multiplier.
useRandomRowUse a random row of the texture sheet for each particle emitted.
uvChannelMaskChoose which UV channels will receive texture animation.