struct in UnityEngine
/
Implemented in:UnityEngine.ParticleSystemModule
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.
CloseFor 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.
CloseScript interface for the TextureSheetAnimationModule.
This module allows you to add animations to your particle textures. To author an animation, you must use a flipbook Texture, which look like this:
Each numbered region represents a frame of the animation, which you must distribute 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.
Additional resources: ParticleSystem, ParticleSystem.textureSheetAnimation.
animation | Specifies the animation type. |
cycleCount | Specifies how many times the animation loops during the lifetime of the particle. |
enabled | Specifies whether the TextureSheetAnimationModule is enabled or disabled. |
fps | Control how quickly the animation plays. |
frameOverTime | A curve to control which frame of the Texture sheet animation to play. |
frameOverTimeMultiplier | The frame over time mutiplier. |
mode | Select whether the animated Texture information comes from a grid of frames on a single Texture, or from a list of Sprite objects. |
numTilesX | Defines the tiling of the Texture in the x-axis. |
numTilesY | Defines the tiling of the texture in the y-axis. |
rowIndex | Explicitly select which row of the Texture sheet to use. The system uses this property when ParticleSystem.TextureSheetAnimationModule.rowMode is set to Custom. |
rowMode | Select how particles choose which row of a Texture Sheet Animation to use. |
speedRange | Specify how particle speeds are mapped to the animation frames. |
spriteCount | The total number of sprites. |
startFrame | Define a random starting frame for the Texture sheet animation. |
startFrameMultiplier | The starting frame multiplier. |
timeMode | Select 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. |
uvChannelMask | Choose which UV channels receive Texture animation. |
AddSprite | Add a new Sprite. |
GetSprite | Get the Sprite at the given index. |
RemoveSprite | Remove a Sprite from the given index in the array. |
SetSprite | Set the Sprite at the given index. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.