MasterUnitSettings

Inherits from DataContainer

Summary

Constructors

MasterUnitSettings()
MasterUnitSettings(guid: Guid)
MasterUnitSettings(other: DataContainer)

Properties

Name Type
name string
equalizer EqualizerSettings | nil
compressor CompressorSettings | nil
masterVolume float
masterLfeGain float
masterDialogGain float
reverbVolume float
mainMixVolume float
distortionClipLevel float
parallelDistortionGain float
postEffectsGain float
fadeTime float

Static members

Name Type
MasterUnitSettings.typeInfo TypeInformation

Constructors

MasterUnitSettings

MasterUnitSettings()

Creates a new MasterUnitSettings frostbite instance.

MasterUnitSettings

MasterUnitSettings(guid: Guid)

Creates a new MasterUnitSettings frostbite instance and assigns it the provided Guid.

Parameters

Name Type Description
guid Guid The Guid to assign to the newly created instance.

MasterUnitSettings

MasterUnitSettings(other: DataContainer)

Casts an instance of type DataContainer to MasterUnitSettings. Will throw an error when trying to cast from an unsupported type.

Parameters

Name Type Description
other DataContainer The instance to cast to MasterUnitSettings.

Properties

name

string

equalizer

EqualizerSettings | nil

compressor

CompressorSettings | nil

masterVolume

float

masterLfeGain

float

masterDialogGain

float

reverbVolume

float

mainMixVolume

float

distortionClipLevel

float

parallelDistortionGain

float

postEffectsGain

float

fadeTime

float

Static members

typeInfo

TypeInformation

The type information for the MasterUnitSettings type.

Last modified April 26, 2020: Update frostbite type documentation (8b14351)