G1R AngelScript
Scripting reference for the Gothic 1 Remake
Loading...
Searching...
No Matches
USoundSubmixBase Class Reference

Public Member Functions

Submix
bool DynamicDisconnect ()
 Dynamically Disconnect from a parent.
USoundSubmixBase FindDynamicAncestor ()
 Searching upwards from this Submix to the root looking for the first Submix marked Dynamic If this Submix is Dynamic this will be returned.
bool DynamicConnect (USoundSubmixBase InParent)
 Dynamically Connects to a parent submix.
Public Member Functions inherited from UObject
bool MarkPackageDirty () const
void RemoveFromRoot ()
bool GetIsRooted () const
bool IsTransient () const
bool Modify (bool bAlwaysMarkDirty=true)
void SetTransactional (bool bTransactional)
bool IsSupportedForNetworking () const
UClass GetClass () const
UObject GetOuter () const
UObject GetTypedOuter (TSubclassOf< UObject > Target) const
 Traverses the outer chain searching for the next object of a certain type.
UPackage GetOutermost () const
UPackage GetPackage () const
void AddToRoot ()
UWorld GetWorld () const
FName GetName () const
FString GetFullName (const UObject StopOuter=nullptr) const
FString GetPathName (const UObject StopOuter=nullptr) const
bool IsA (const UClass Class) const
 Returns true if this object is of the specified type, or a child of that type.
void SaveConfig ()
void LoadConfig ()
void ReloadConfig ()
void CopyScriptPropertiesFrom (const UObject OtherObject)
void opCast (?&Address) const
FString ToString () const

Static Public Member Functions

Static Functions
static UClass StaticClass ()
Static Public Member Functions inherited from UObject
static UClass StaticClass ()

Public Attributes

AutoDisablement
float32 AutoDisableTime
 The minimum amount of time to wait before automatically disabling a submix if it is silent. Will immediately re-enable if source audio is sent to it.
bool bAutoDisable
 Auto-manage enabling and disabling the submix as a CPU optimization. It will be disabled if the submix and all child submixes are silent. It will re-enable if a sound is sent to the submix or a child submix is audible.
SoundSubmix
TArray< TObjectPtr< USoundSubmixBase > > ChildSubmixes
 Child submixes to this sound mix.
Public Attributes inherited from UObject
const UClass Class
const UObject Outer
const UPackage Outermost
const UPackage Package
const UWorld World
const FName Name
const bool IsRooted

Member Function Documentation

◆ DynamicConnect()

bool DynamicConnect ( USoundSubmixBase InParent)

Dynamically Connects to a parent submix.

Parameters
WorldContextObjectUObject that's used to GetWorld
InParentParent Submix to connect to

◆ DynamicDisconnect()

bool DynamicDisconnect ( )

Dynamically Disconnect from a parent.

Parameters
WorldContextObjectUObject that's used to GetWorld

◆ FindDynamicAncestor()

USoundSubmixBase FindDynamicAncestor ( )

Searching upwards from this Submix to the root looking for the first Submix marked Dynamic If this Submix is Dynamic this will be returned.

◆ StaticClass()

UClass StaticClass ( )
static

Member Data Documentation

◆ AutoDisableTime

float32 AutoDisableTime

The minimum amount of time to wait before automatically disabling a submix if it is silent. Will immediately re-enable if source audio is sent to it.

◆ bAutoDisable

bool bAutoDisable

Auto-manage enabling and disabling the submix as a CPU optimization. It will be disabled if the submix and all child submixes are silent. It will re-enable if a sound is sent to the submix or a child submix is audible.

◆ ChildSubmixes

Child submixes to this sound mix.