Sprite Factory

ReadMe
Release Notes
Overview
Using the Editor
Upgrading

Concepts
Sprites
Master Sprites
Sprite Groups
Colliders
Locators
Material Sets
SpriteUpdater
SpriteCamera

Advanced
Working in Multiple Projects

Classes
Runtime Classes

Videos
Overview
Creating Sprites
Sprite Inspector
Frame Events
Collision System
Locator System
Material Sets

Links
Sprite Factory Site
Web Documentation
Support
Contact

SpriteFactory.SpriteUpdater

Namespace: SpriteFactory
Inherits from MonoBehaviour

SpriteUpdater drives the main animation update in Sprites assigned to it.

See SpriteUpdater for more information about SpriteUpdaters in general.

Variables

       
Name   Type   Description
updateCycle   SpriteUpdater.UpdateCycle   Sprites controlled by this SpriteUpdater will be updated on the specified update cycle.
dontDestroyThisOnLoad   bool   True = Prevent this SpriteUpdater from being destroyed on level load.
startingPoolSize   int   The number of Sprites to track before expanding the pool size.
poolExpansionIncrement   int   The number of entries added to the pool each time it is expanded.
maxPoolExpansions   int   The maximum number of times the pool can be expanded. 0 = Infinite.

Functions

Name   Description
UpdateSprites   Update all Sprites assigned to this SpriteUpdater.
AddSprite   Add a sprite to SpriteUpdater.
AddAllSprites   Add all Sprite components in hierarchy to SpriteUpdater.
RemoveSprite   Remove Sprite from SpriteUpdater.
RemoveSpriteAt   Remove Sprite at index from SpriteUpdater.
InstantiateSprite   Instantiate a GameObject and add all Sprite components in hierarchy to SpriteUpdater.
Clear   Remove all Sprites from SpriteUpdater and reset the pool.

Inherited Variables and Functions

All variables and functions in MonoBehaviour are inherited by this class.