Api ITemporaryEffect
interface

ITemporaryEffect

public interface ITemporaryEffect

Allows components to indicate their state in a generic way. This is useful if you have a temporary effect system in which you want to remove GameObjects when their effects have all finished.

Properties

Name Type Description
IsActive virtual Boolean Should return true if the effect is active in a visible way

Methods

virtual Void DisableLooping()

Indicates to the target object that we want it to die. If it's looping then it should stop now and put itself in a state where it will eventually die.

static Void DisableLoopingEffects(GameObject go)

Disable the any looping effects. This indicates to the target object that we want it to die soon.

Assembly: Sandbox.Engine Declaring Type: Component Full Name: Sandbox.Component.ITemporaryEffect