Creating a Time-Based Effect

A Timed Effect is an effect that runs for a specific amount of time. When a viewer activates a timed effect, the effect will start and run for the duration specified in the inspector. Once the timer expires, the effect will automatically stop.

The initial class should look like this:

using CrowdControl.Client.Unity;
using CrowdControl.Common;
using UnityEngine;

namespace Assets.Scripts.Crowd_Control.Effects
{
    internal class ExampleEffect : UnityEffectBase
    {
        public override EffectStatus StartEffect(EffectRequest request)
        {
            //example with a single parameter called "itemType" of type **string**
            Debug.Log($"ExampleEffect started with itemType: {(string)request.Parameters["itemType"].Value}.");

            return EffectStatus.Success;
        }

        public override EffectStatus? TickEffect(EffectRequest request)
        {
            Debug.Log("ExampleEffect tick...");

            //this function should normally return null for standard effect implementations
            //returning EffectStatus.TimedPause indicates that the effect should be paused until //TODO

            //if an exception is thrown here, the effect will be automatically canceled with EffectStatus.TimedAborted, which indicates that the effect failed to perform its tick, cannot be ticked later, and should be cleaned up immediately

            return null;
        }

        public override EffectStatus? PauseEffect(EffectRequest request)
        {
            Debug.Log("ExampleEffect paused...");

            //returning null here is equivalent to returning EffectStatus.TimedPause

            //if an exception is thrown here, the effect will be automatically canceled with EffectStatus.TimedAborted, which indicates that the effect failed to pause and cannot be paused, resumed, or ended later and should be cleaned up immediately
            return null;
        }

        public override EffectStatus? ResumeEffect(EffectRequest request)
        {
            Debug.Log("ExampleEffect resumed...");

            //returning null here is equivalent to returning EffectStatus.TimedResume

            //if an exception is thrown here, the effect will be automatically canceled with EffectStatus.TimedAborted, which indicates that the effect failed to resume and cannot be resumed, paused, or ended later and should be cleaned up immediately

            return null;
        }

        public override EffectStatus? StopEffect(EffectRequest request)
        {
            Debug.Log("ExampleEffect stopped...");

            //returning null here is equivalent to returning EffectStatus.TimedEnd or EffectStatus.TimedCanceled automatically, as-appropriate
            //returning EffectStatus.FailTemporary indicates that the effect failed to be stopped, but may be able to be stopped later (e.g. if the effect is waiting for an animation to finish before it can be stopped).

            //if an exception is thrown here, the effect will be automatically canceled with EffectStatus.TimedAborted, which indicates that the effect failed to stop and cannot be stopped or ended later and should be cleaned up immediately

            return null;
        }
    }
}

A timed effect still inherits from CrowdControl.Client.Unity.UnityEffectBase, but overrides the following methods:

StartEffect: Ran when the effect starts.
TickEffect: Ran every frame while the effect is running. This is optional to implement, and is not necessary for all effects.
PauseEffect: Ran when the effect needs to be paused. This is optional to implement, and is not necessary for all effects.
ResumeEffect: Ran when the effect needs to be resumed after it's been paused. The timer resumes where it left off. This is optional to implement, and is not necessary for all effects.
StopEffect: Ran when the effect needs to be stopped. This is optional to implement, and is not necessary for all effects.

Creating a Time-Based Effect ​

Creating a Time-Based Effect