The following section describes the exposed properties of the controller script, as well as its methods. You can use the controller script to perform the fullscreen pulse effect without having to manually control its values.

Properties

Fade On Screen Pulse

If checked, the controller script will perform a screen fade in and out effect along with the pulse.

Full Screen Pulse Effect Material

Main Camera

The scene's main camera game object.

Methods

public void PerformFullscreenPulse()

This method initiates the fullscreen pulse effect in a non-blocking coroutine. It also takes care of repeat calls, making sure only one effect can be started at a time. You can call this method from your own scripts if you would like to dynamically start the effect during gameplay.

private IEnumerator LaunchFullScreenPulseEffect()

This method is private, meaning that it is not meant to be called from outside of the controller script. It takes care of the fullscreen pulse effect itself by calculating the screen size ratio and by lerping the controller (and if needs be, the fade controller) values.