Version: 2022.1
LanguageEnglish
  • C#

LODGroup

class in UnityEngine

/

Inherits from:Component

/

Implemented in:UnityEngine.CoreModule

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

Submission failed

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

Close

Cancel

Switch to Manual

Description

LODGroup lets you group multiple Renderers into LOD levels.

This can be used to switch between different LOD levels at runtime based on size on screen.

Static Properties

crossFadeAnimationDurationThe cross-fading animation duration in seconds. ArgumentException will be thrown if it is set to zero or a negative value.

Properties

animateCrossFadingSpecify if the cross-fading should be animated by time. The animation duration is specified globally as crossFadeAnimationDuration.
enabledAllows you to enable or disable the LODGroup.
fadeModeThe LOD fade mode used.
lastLODBillboardSpecify whether the last LOD level is a BillboardRenderer.
localReferencePointThe local reference point against which the LOD distance is calculated.
lodCountThe number of LOD levels.
sizeThe size of the LOD object in local space.

Public Methods

ForceLOD
GetLODsReturns the array of LODs.
RecalculateBoundsRecalculate the bounding region for the LODGroup (Relatively slow, do not call often).
SetLODsSet the LODs for the LOD group. This will remove any existing LODs configured on the LODGroup.

Inherited Members

Properties

gameObjectThe game object this component is attached to. A component is always attached to a game object.
tagThe tag of this game object.
transformThe Transform attached to this GameObject.
hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameThe name of the object.

Public Methods

BroadcastMessageCalls the method named methodName on every MonoBehaviour in this game object or any of its children.
CompareTagChecks the GameObject's tag against the defined tag.
GetComponentReturns the component of type if the GameObject has one attached.
GetComponentInChildrenReturns the Component of type in the GameObject or any of its children using depth first search.
GetComponentInParentReturns the Component of type in the GameObject or any of its parents.
GetComponentsReturns all components of Type type in the GameObject.
GetComponentsInChildrenReturns all components of Type type in the GameObject or any of its children. Works recursively.
GetComponentsInParentReturns all components of Type type in the GameObject or any of its parents.
SendMessageCalls the method named methodName on every MonoBehaviour in this game object.
SendMessageUpwardsCalls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.
TryGetComponentGets the component of the specified type, if it exists.
GetInstanceIDGets the instance ID of the object.
ToStringReturns the name of the object.

Static Methods

DestroyRemoves a GameObject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeGets a list of all 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 two object references to see if they refer to the same object.