SoundState
Inherits from DataContainer
Summary
Constructors
| SoundState() |
| SoundState(guid: Guid) |
| SoundState(other: DataContainer) |
Properties
| Name | Type |
|---|---|
| name | string |
| lpCutoffFrequency | float |
| duration | float |
| fadeInTime | float |
| fadeOutTime | float |
| bypassSound | SoundAsset | nil |
| hdrSetting | HdrSetting | nil |
| mixer | MixerAsset | nil |
| fadeSound | bool |
Static members
| Name | Type |
|---|---|
| SoundState.typeInfo | TypeInformation |
Constructors
SoundState
SoundState()
Creates a new SoundState frostbite instance.
SoundState
SoundState(guid: Guid)
Creates a new SoundState frostbite instance and assigns it the provided Guid.
Parameters
| Name | Type | Description |
|---|---|---|
| guid | Guid | The Guid to assign to the newly created instance. |
SoundState
SoundState(other: DataContainer)
Casts an instance of type DataContainer to SoundState. Will throw an error when trying to cast from an unsupported type.
Parameters
| Name | Type | Description |
|---|---|---|
| other | DataContainer | The instance to cast to SoundState. |
Properties
name
string
lpCutoffFrequency
float
duration
float
fadeInTime
float
fadeOutTime
float
bypassSound
SoundAsset | nil
hdrSetting
HdrSetting | nil
mixer
MixerAsset | nil
fadeSound
bool
Static members
typeInfo
The type information for the SoundState type.
Last modified April 26, 2020: Update frostbite type documentation (8b14351c)