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.Sprite.animateOffCamera

C#: bool animateOffCamera
JS: var animateOffCamera : boolean

Description
Determines whether the Sprite continues animating when not visible by a camera.

True = Continue animating when not visible by any camera.
False = Animation does not take place when not visible by any camera.

Note that all frame-dependent functions will also be affected such as frame events, so if you have, for example a walk cycle with footstep sounds attached to frame events, the footsteps will cease if animateOffCamera = false and the Sprite exits the viewport. Animated colliders and animated locators are affected as well.

Note that Sprite display meshes are never updated when not visible by a camera, so mesh vertices and uvs are not updated saving processing time regardless of this variable's setting.