Class EnvironmentVolume

Applies a specific environment setting to an area

Inheritance

System.Object

UnityEngine.Object

UnityEngine.Component

UnityEngine.Behaviour

UnityEngine.MonoBehaviour

EnvironmentVolume

Inherited Members

UnityEngine.MonoBehaviour.IsInvoking()

UnityEngine.MonoBehaviour.CancelInvoke()

UnityEngine.MonoBehaviour.Invoke(System.String, System.Single)

UnityEngine.MonoBehaviour.InvokeRepeating(System.String, System.Single, System.Single)

UnityEngine.MonoBehaviour.CancelInvoke(System.String)

UnityEngine.MonoBehaviour.IsInvoking(System.String)

UnityEngine.MonoBehaviour.StartCoroutine(System.String)

UnityEngine.MonoBehaviour.StartCoroutine(System.String, System.Object)

UnityEngine.MonoBehaviour.StartCoroutine(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StartCoroutine_Auto(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StopCoroutine(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StopCoroutine(UnityEngine.Coroutine)

UnityEngine.MonoBehaviour.StopCoroutine(System.String)

UnityEngine.MonoBehaviour.StopAllCoroutines()

UnityEngine.MonoBehaviour.print(System.Object)

UnityEngine.MonoBehaviour.useGUILayout

UnityEngine.MonoBehaviour.runInEditMode

UnityEngine.Behaviour.enabled

UnityEngine.Behaviour.isActiveAndEnabled

UnityEngine.Component.GetComponent(System.Type)

UnityEngine.Component.GetComponent<T>()

UnityEngine.Component.TryGetComponent(System.Type, UnityEngine.Component)

UnityEngine.Component.TryGetComponent<T>(T)

UnityEngine.Component.GetComponent(System.String)

UnityEngine.Component.GetComponentInChildren(System.Type, System.Boolean)

UnityEngine.Component.GetComponentInChildren(System.Type)

UnityEngine.Component.GetComponentInChildren<T>(System.Boolean)

UnityEngine.Component.GetComponentInChildren<T>()

UnityEngine.Component.GetComponentsInChildren(System.Type, System.Boolean)

UnityEngine.Component.GetComponentsInChildren(System.Type)

UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean)

UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean, System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponentsInChildren<T>()

UnityEngine.Component.GetComponentsInChildren<T>(System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponentInParent(System.Type)

UnityEngine.Component.GetComponentInParent<T>()

UnityEngine.Component.GetComponentsInParent(System.Type, System.Boolean)

UnityEngine.Component.GetComponentsInParent(System.Type)

UnityEngine.Component.GetComponentsInParent<T>(System.Boolean)

UnityEngine.Component.GetComponentsInParent<T>(System.Boolean, System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponentsInParent<T>()

UnityEngine.Component.GetComponents(System.Type)

UnityEngine.Component.GetComponents(System.Type, System.Collections.Generic.List<UnityEngine.Component>)

UnityEngine.Component.GetComponents<T>(System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponents<T>()

UnityEngine.Component.CompareTag(System.String)

UnityEngine.Component.SendMessageUpwards(System.String, System.Object, UnityEngine.SendMessageOptions)

UnityEngine.Component.SendMessageUpwards(System.String, System.Object)

UnityEngine.Component.SendMessageUpwards(System.String)

UnityEngine.Component.SendMessageUpwards(System.String, UnityEngine.SendMessageOptions)

UnityEngine.Component.SendMessage(System.String, System.Object)

UnityEngine.Component.SendMessage(System.String)

UnityEngine.Component.SendMessage(System.String, System.Object, UnityEngine.SendMessageOptions)

UnityEngine.Component.SendMessage(System.String, UnityEngine.SendMessageOptions)

UnityEngine.Component.BroadcastMessage(System.String, System.Object, UnityEngine.SendMessageOptions)

UnityEngine.Component.BroadcastMessage(System.String, System.Object)

UnityEngine.Component.BroadcastMessage(System.String)

UnityEngine.Component.BroadcastMessage(System.String, UnityEngine.SendMessageOptions)

UnityEngine.Component.transform

UnityEngine.Component.gameObject

UnityEngine.Component.tag

UnityEngine.Object.GetInstanceID()

UnityEngine.Object.GetHashCode()

UnityEngine.Object.Equals(System.Object)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)

UnityEngine.Object.Instantiate(UnityEngine.Object)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform, System.Boolean)

UnityEngine.Object.Instantiate<T>(T)

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion)

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform)

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform, System.Boolean)

UnityEngine.Object.Destroy(UnityEngine.Object, System.Single)

UnityEngine.Object.Destroy(UnityEngine.Object)

UnityEngine.Object.DestroyImmediate(UnityEngine.Object, System.Boolean)

UnityEngine.Object.DestroyImmediate(UnityEngine.Object)

UnityEngine.Object.FindObjectsOfType(System.Type)

UnityEngine.Object.FindObjectsOfType(System.Type, System.Boolean)

UnityEngine.Object.DontDestroyOnLoad(UnityEngine.Object)

UnityEngine.Object.DestroyObject(UnityEngine.Object, System.Single)

UnityEngine.Object.DestroyObject(UnityEngine.Object)

UnityEngine.Object.FindSceneObjectsOfType(System.Type)

UnityEngine.Object.FindObjectsOfTypeIncludingAssets(System.Type)

UnityEngine.Object.FindObjectsOfType<T>()

UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)

UnityEngine.Object.FindObjectOfType<T>()

UnityEngine.Object.FindObjectOfType<T>(System.Boolean)

UnityEngine.Object.FindObjectsOfTypeAll(System.Type)

UnityEngine.Object.FindObjectOfType(System.Type)

UnityEngine.Object.FindObjectOfType(System.Type, System.Boolean)

UnityEngine.Object.ToString()

UnityEngine.Object.name

UnityEngine.Object.hideFlags

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Engine.World

Assembly: Engine.World.dll

Syntax

[RequireComponent(typeof(BoxCollider))]
public class EnvironmentVolume : MonoBehaviour

Fields

fogColor

The color of the fog for the volume

Declaration

public Color fogColor

Field Value

Type	Description
UnityEngine.Color

highlightColor

The ambient light for highlights

Declaration

public Color highlightColor

Field Value

Type	Description
UnityEngine.Color

shadowColor

The ambient light for shadows

Declaration

public Color shadowColor

Field Value

Type	Description
UnityEngine.Color

sky

The sky cubemap texture for the volume

Declaration

public Cubemap sky

Field Value

Type	Description
UnityEngine.Cubemap

skyTint

The color of the sky tint

Declaration

public Color skyTint

Field Value

Type	Description
UnityEngine.Color

sunColor

The color of the sun (Default light yellow)

Declaration

public Color sunColor

Field Value

Type	Description
UnityEngine.Color

sunIntensity

The intensity of the sun (Default 1.3f)

Declaration

public float sunIntensity

Field Value

Type	Description
System.Single

sunRotation

The rotation of the sun object

Declaration

public Vector3 sunRotation

Field Value

Type	Description
UnityEngine.Vector3

Methods

isTargetInsideVolume()

Returns if the target gameobject is inside the volume

Declaration

public bool isTargetInsideVolume()

Returns

Type	Description
System.Boolean

SetTarget(GameObject)

Sets the target focus gameobject for volume testing

Declaration

public void SetTarget(GameObject target)

Parameters

Type	Name	Description
UnityEngine.GameObject	target	The target gameobject

Start()

Called on initialize

Declaration

public void Start()

SubscribeToVolumeEnteredEvent(EnvironmentVolume.volumeEnteredDelegate)

Allow classes to subscribe to on trigger events

Declaration

public void SubscribeToVolumeEnteredEvent(EnvironmentVolume.volumeEnteredDelegate function)

Parameters

Type	Name	Description
EnvironmentVolume.volumeEnteredDelegate	function	The function to call upon event

Update()

Called every frame

Declaration

public void Update()