class MAGES::Interaction::CameraFade

Overview

Camera Fade In-Out effect. More…

class CameraFade
{
public:
    // methods

    static void FadeCamera(
        float delay = 1f,
        bool teleport = false,
        Transform transform = null
    );

    static IEnumerator FadeEffect(float delay = 2f);
};

Detailed Documentation

Camera Fade In-Out effect.

Deprecated This class is obsolete and will be removed in future versions of MAGES. Please use CameraFadeEffect instead.

Methods

static void FadeCamera(
    float delay = 1f,
    bool teleport = false,
    Transform transform = null
)

Function that activates the fade in-out effect and optionally teleports the camera to a specified position.

Parameters:

delay

The duration of the effect. Defaults at 1f.

teleport

Wether we wish to teleport the camera or not.

transform

The transform to teleport the camera to. Optional.

static IEnumerator FadeEffect(float delay = 2f)

Coroutine that spawns the Fade In and Out effects.

Parameters:

delay

The duration of the fade effect before disabling. Defaults at 1f.

Returns:

Delay of delay+2 seconds for the total fade in, out.