Legacy Documentation: Version 4.6.2
Language: English
  • C#
  • JS
  • Boo

Script language

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

Flare

Namespace: UnityEngine

/

Inherits from: Object

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

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

hideFlags Should the object be hidden, saved with the scene or modifiable by the user?
name The name of the object.

Functions

GetInstanceID Returns the instance id of the object.
ToString Returns the name of the game object.

Static Functions

Destroy Removes a gameobject, component or asset.
DestroyImmediate Destroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoad Makes the object target not be destroyed automatically when loading a new scene.
FindObjectOfType Returns the first active loaded object of Type type.
FindObjectsOfType Returns a list of all active loaded objects of Type type.
Instantiate Clones the object original and returns the clone.

Operators

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