Looking for High Fidelity
Documentation?

LODManager

• Properties • Methods • Signals • Type Definitions • Method Details • Signal Details •

Description

Supported Script Types: Interface Scripts • Client Entity Scripts • Avatar Scripts

The LOD class manages your Level of Detail functions within Interface.

Properties

Name Type Summary
presentTime number

Read-only.
engineRunTime number

Read-only.
gpuTime number

Read-only.

Methods

Name Return Value Summary
getAutomaticLODAdjust boolean
getBoundaryLevelAdjust number

Deprecated: This function is deprecated and will be removed.
getDesktopLODTargetFPS number
getHMDLODTargetFPS number
getLODFeedbackText string
getLODTargetFPS number
getOctreeSizeScale number

Deprecated: This function is deprecated and will be removed. Use the LODManager.lodAngleDeg property instead.
setAutomaticLODAdjust None
setBoundaryLevelAdjust None

Deprecated: This function is deprecated and will be removed.
setDesktopLODTargetFPS None
setHMDLODTargetFPS None
setOctreeSizeScale None

Deprecated: This function is deprecated and will be removed. Use the LODManager.lodAngleDeg property instead.

Signals

Name Summary
LODDecreased
LODIncreased

Type Definitions

WorldDetailQuality
Type: number

The world detail quality rendered.

ValueDescription
0Low world detail quality.
1Medium world detail quality.
2High world detail quality.

Method Details

(static) getAutomaticLODAdjust( ) → {boolean}
Returns: boolean
(static) getBoundaryLevelAdjust( ) → {number}
Returns: number

Deprecated: This function is deprecated and will be removed.
(static) getDesktopLODTargetFPS( ) → {number}
Returns: number
(static) getHMDLODTargetFPS( ) → {number}
Returns: number
(static) getLODFeedbackText( ) → {string}
Returns: string
(static) getLODTargetFPS( ) → {number}
Returns: number
(static) getOctreeSizeScale( ) → {number}
Returns: number

Deprecated: This function is deprecated and will be removed. Use the LODManager.lodAngleDeg property instead.
(static) setAutomaticLODAdjust( value )

Parameters

Name Type Description
value boolean
(static) setBoundaryLevelAdjust( boundaryLevelAdjust )

Deprecated: This function is deprecated and will be removed.

Parameters

Name Type Description
boundaryLevelAdjust number
(static) setDesktopLODTargetFPS( value )

Parameters

Name Type Description
value number
(static) setHMDLODTargetFPS( value )

Parameters

Name Type Description
value number
(static) setOctreeSizeScale( sizeScale )

Deprecated: This function is deprecated and will be removed. Use the LODManager.lodAngleDeg property instead.

Parameters

Name Type Description
sizeScale number

Signal Details

LODDecreased( )
Returns: Signal
LODIncreased( )
Returns: Signal