Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Flare

Namespace: UnityEngine

/

Inherits from: Object

Description

A flare asset. Read more about flares in the components reference.

The flare class has no properties. It needs to be setup up in the inspector. You can reference flares and assign them to a Light at runtime.

// Expose a reference to a flare in the inspector
var newFlare : Flare;

// Assign the flare light.flare = newFlare;

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public Flare newFlare;
    void Example() {
        light.flare = newFlare;
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public newFlare as Flare

	def Example() as void:
		light.flare = newFlare

See Also: Flare assets, LensFlare class.

Inherited members

Variables

hideFlagsShould the object be hidden, saved with the scene or modifiable by the user?
nameThe name of the object.

Functions

GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the game object.

Static Functions

DestroyRemoves a gameobject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadMakes the object target not be destroyed automatically when loading a new scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeReturns a list of all active loaded objects of Type type.
InstantiateClones the object original and returns the clone.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares if two objects refer to the same.