Screen Fader
Main features:
- Screen transitions with different effects
- Fading of GameObjects
- Fading of UI elements
- Load Levels with fading effect
- Makes any fading with one line of code
- Chain calls, like: Fader.Instance.FadeIn().Pause(10).FadeOut()
- Easy to extend with own Actions and Coroutines
- Dynamic change of fading color
- Compatible with Unity 5
- Friendly Price
Get it here:
Play demo
This easy-to-use script will allow you to fade in or out your screen with only one line of code, so all you need is to write:
Fader.Instance.FadeIn();
Very easy, but on the other hand, you will get infinite possibilities. You can fade the screen, UI elements or objects, change the speed and colors, join methods in chains, call Coroutines and your own actions. You can subscribe on events and get notifications when fading will be started or completed. Screen Fader also supports fluent interface, so you can make more readable code with chains of methods, for example:
Fader.Instance.FadeIn().Pause(10).FadeOut();
This script also support invoking of coroutines and any actions (itās realy any actions that implement IAction or IParametrizedAction interface), so you can write such sequences:
Fader.Instance.FadeIn().StartCoroutine(this, PostMyScoreCoroutine()).FadeOut();
//or
Fader.Instance.FadeIn().StartAction(new MyMostLovelyAction(), parameter).FadeOut()
At the last version (1.3) was added LoadLevel method, and fading of game objects:
/// Load "Scene2", it's also possible to load level by its index
Fader.Instance.FadeIn().Pause().LoadLevel("Scene2").FadeOut(2);
/// Hide character
Fader.Instance.FadeIn(characterGameObject);
This works well on Free and Pro Unity, suitable for Web, Standalone, Android and iOS platform. And all this takes less then 50kb on your drive and costs less then your morning coffee.
So, the another features of Screen Fader are:
- Easy-to-use, easy-to-write and easy-to-read what you wrote - it is just one line of code!
- Powerfull sequences
- Possibility to call coroutines
- Possibility to make you own actions
- All Screen Faderās code gathered into couple of files, that takes only 10kb.
ā¦and some other cool features are coming soonā¦
What is more: youāll get 2 extra scripts that will allow you to fade your screen with squares or stripes effect, and of course you can also setup their additional parameters, such as number of stripes or squares and direction of effect.
API Example of usage screenshots
API Help
Table of content
- FadeIn
- FadeOut
- Pause
- Flash
- LoadLevel
- SetColor
- StartAction
- StartCoroutine
- StopAllFadings
FadeIn( time )
Fade-in screen in ātimeā seconds. ātimeā argument is optional, default value - 1.
Fader.Instance.FadeIn();
Fader.Instance.FadeIn( 3 ); /// Fade screen in in 3 seconds
FadeIn( GameObject, time )
FadeIn( UI.Element, time )
FadeIn( UI.Image, time )
Fade-in gameobject. GameObjectās material should support transparency. ātimeā argument is optional, default value - 1.
/// Hide characterGO in 3 seconds
Fader.Instance.FadeIn( characterGO, 3 );
/// Change characterā hemlet
Fader.Instance.FadeIn( HemletOfWarion ).FadeOut( HemletOfKing );
FadeOut( time )
Fade screen out in ātimeā seconds. ātimeā argument is optional, default value - 1.
Fader.Instance.FadeOut();
Fader.Instance.FadeOut( 3 ); /// Fade screen out in 3 seconds
FadeOut( GameObject, time )
FadeOut( UI.Element, time )
FadeOut( UI.Image, time )
Fade gameobject out. GameObjectās material should support transparency. ātimeā argument is optional, default value - 1.
/// Hide wall and show Enemy Boss character.
Fader.Instance.FadeOut( Wall ).FadeIn( EnemyBoss );
Pause( time )
Make pause in chain of fadings or actions.
Fader.Instance.FadeIn().Pause().FadeOut(); /// pause 1 second
Fader.Instance.FadeIn().Pause( 3 ).FadeOut(); /// pause 3 second
Flash( inTime, outTime )
Make flash - quick fade-in and fade-out. Arguments inTime and outTime are optional. Default values are inTime = 0.075, outTime = 0.15
Fader.Instance.Flash();
Fader.Instance.Flash( 0.1, 3 ); /// Quickly fade screen in and slowly out
LoadLevel( name )
Load new scene by its name
Fader.Instance.LoadLevel( "IntroScene" );
Fader.Instance.FadeIn().LoadLevel( "Scene-1" ).FadeOut();
LoadLevel( index )
Load new scene by its index
Fader.Instance.LoadLevel( 1 );
Fader.Instance.FadeIn().LoadLevel( 1 ).FadeOut();
SetColor( color )
Default color of fading is black, but this method allow changing of color at runtime.
Fader.Instance.SetColor( Color.white ).FadeIn().LoadLevel( 0 ).FadeOut();
Fader.Instance.SetColor( Color.red ).Flash(); /// Damage - red flash
StartAction( IAction )
Execute a custom action. Custom action is an instance of class implementing IAction interface. Here is an example:
HidePrincessAction action = new HidePrincessAction();
Fader.Instance.StartAction( action );
/// Hide princess while screen is faded, and then fade screen out.
Fader.Instance.FadeIn().StartAction( action ).FadeOut();
IAction interface, defines Execute() method that will be called and Completed property, that you should set to ātrueā when action will completed:
public interface IAction
{
bool Completed { get; set; }
void Execute();
}
public interface HidePrincessAction: IAction
{
public bool Completed { get; set; }
public void Execute()
{
GameObject.Find("MarioPrincess").GetComponent<Renderer>().enabled = false;
/// It lets screen fader know that action is completed
/// and next action could started.
this.Completed = true;
}
}
StartAction( IParametrizedAction, object[ ] )
Execute a custom action that accept some parameters. Here, custom action is an instance of class implementing IParametrizedAction interface. Letās improve our example:
ChangeCharacterAction param_action = new ChangeCharacterAction();
/// Hide Mario and show Princess
Fader.Instance.StartAction( param_action, "Mario", "Princess" );
/// Hide Princess and show Mario
Fader.Instance.StartAction( param_action, "Princess", "Mario" );
IParametrizedActionās Execute() method can get any number of parameters. See the implementation of ChangeCharacterAction:
public interface ChangeCharacterAction: IParametrizedAction
{
public bool Completed { get; set; }
public void Execute( params object[] args )
{
GameObject.Find( args[0] ).GetComponent<Renderer>().enabled = false;
GameObject.Find( args[1] ).GetComponent<Renderer>().enabled = true;
/// It lets screen fader know that action is completed
/// and next action can be started.
this.Completed = true;
}
}
StartCoroutine( MonoBehaviour, Coroutine )
Start coroutine method in series. Next fading tasks will be starter after coroutine finish. MonoBehaviour is an game object where coroutine ( IEnumerator method ) located. NOTE: This Conoutineās methods have to have āyield breakā operator!
/// Show 'Game Over' for 5 sec and fade-in screen.
Fader.Instance.StartCoroutine( this, ShowGameOver() ).Pause( 5 ).FadeIn();
...
IEnumerator ShowGameOver()
{
text.text = "Game Over";
yield return new WaitForSeconds( 5 );
}
StartCoroutine( MonoBehaviour, methodName, methodParameter )
Start coroutine method in parallel and pass parameter to it. Next fading tasks will be starter right after coroutine was started.
/// Show 'You Game is Over, Mario' text for 5 sec and fade-in screen.
Fader.Instance.StartCoroutine( this, "ShowGameOver", "Mario" ).Pause( 5 ).FadeIn();
...
IEnumerator ShowText( string name )
{
text.text = "You Game is Over, " + name;
yield return new WaitForSeconds( 5 );
}
StopAllFadings()
Brakes all fadings immediately.
Fader.Instance.StopAllFadings();
Video tutorial:
Thank you!
