UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UFoliageType Class Reference

#include <FoliageType.h>

+ Inheritance diagram for UFoliageType:

Public Member Functions

float GetRadius (bool bInSingleInstanceMode) const
 
float GetSeedDensitySquared () const
 
FOLIAGE_API float GetMaxRadius () const
 
FOLIAGE_API float GetScaleForAge (const float Age) const
 
FOLIAGE_API float GetInitAge (FRandomStream &RandomStream) const
 
FOLIAGE_API float GetNextAge (const float CurrentAge, const int32 NumSteps) const
 
FOLIAGE_API bool GetSpawnsInShade () const
 
- Public Member Functions inherited from UObject
COREUOBJECT_API UObject ()
 
COREUOBJECT_API UObject (const FObjectInitializer &ObjectInitializer)
 
COREUOBJECT_API UObject (EStaticConstructor, EObjectFlags InFlags)
 
COREUOBJECT_API UObject (FVTableHelper &Helper)
 
COREUOBJECT_API UObjectCreateDefaultSubobject (FName SubobjectFName, UClass *ReturnType, UClass *ClassToCreateByDefault, bool bIsRequired, bool bIsTransient)
 
template<class TReturnType >
TReturnTypeCreateEditorOnlyDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
COREUOBJECT_API void GetDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects)
 
COREUOBJECT_API UObjectGetDefaultSubobjectByName (FName ToFind)
 
virtual COREUOBJECT_API void PostInitProperties ()
 
virtual COREUOBJECT_API void PostReinitProperties ()
 
virtual void PostCDOContruct ()
 
virtual COREUOBJECT_API void PreSaveRoot (FObjectPreSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PostSaveRoot (FObjectPostSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PreSave (FObjectPreSaveContext SaveContext)
 
virtual COREUOBJECT_API void CollectSaveOverrides (FObjectCollectSaveOverridesContext SaveContext)
 
UE_FORCEINLINE_HINT bool Modify (bool bAlwaysMarkDirty=true)
 
UE_FORCEINLINE_HINT bool IsCapturingAsRootObjectForTransaction () const
 
virtual bool ResolveSubobject (const TCHAR *SubObjectPath, UObject *&OutObject, bool bLoadIfExists)
 
virtual bool IsReadyForAsyncPostLoad () const
 
virtual COREUOBJECT_API void PostLoadSubobjects (FObjectInstancingGraph *OuterInstanceGraph)
 
virtual COREUOBJECT_API void BeginDestroy ()
 
virtual bool IsReadyForFinishDestroy ()
 
virtual COREUOBJECT_API void FinishDestroy ()
 
virtual COREUOBJECT_API void Serialize (FStructuredArchive::FRecord Record)
 
virtual void ShutdownAfterError ()
 
virtual void PostInterpChange (FProperty *PropertyThatChanged)
 
virtual COREUOBJECT_API void PostRename (UObject *OldOuter, const FName OldName)
 
virtual void PreDuplicate (FObjectDuplicationParameters &DupParams)
 
virtual void PostDuplicate (bool bDuplicateForPIE)
 
virtual void PostDuplicate (EDuplicateMode::Type DuplicateMode)
 
virtual COREUOBJECT_API bool NeedsLoadForClient () const
 
virtual COREUOBJECT_API bool NeedsLoadForServer () const
 
virtual COREUOBJECT_API bool NeedsLoadForTargetPlatform (const class ITargetPlatform *TargetPlatform) const
 
virtual bool NeedsLoadForEditorGame () const
 
virtual bool IsEditorOnly () const
 
virtual bool HasNonEditorOnlyReferences () const
 
virtual bool IsPostLoadThreadSafe () const
 
virtual COREUOBJECT_API bool IsDestructionThreadSafe () const
 
virtual COREUOBJECT_API void GetPreloadDependencies (TArray< UObject * > &OutDeps)
 
virtual void GetPrestreamPackages (TArray< UObject * > &OutPrestream)
 
virtual void ExportCustomProperties (FOutputDevice &Out, uint32 Indent)
 
virtual void ImportCustomProperties (const TCHAR *SourceText, FFeedbackContext *Warn)
 
virtual void PostEditImport ()
 
virtual void PostReloadConfig (class FProperty *PropertyThatWasLoaded)
 
virtual COREUOBJECT_API bool Rename (const TCHAR *NewName=nullptr, UObject *NewOuter=nullptr, ERenameFlags Flags=REN_None)
 
virtual FString GetDesc ()
 
COREUOBJECT_API UScriptStructGetSparseClassDataStruct () const
 
virtual bool GetNativePropertyValues (TMap< FString, FString > &out_PropertyValues, uint32 ExportFlags=0) const
 
virtual COREUOBJECT_API void GetResourceSizeEx (FResourceSizeEx &CumulativeResourceSize)
 
SIZE_T GetResourceSizeBytes (EResourceSizeMode::Type Mode)
 
virtual FName GetExporterName (void)
 
COREUOBJECT_API void CallAddReferencedObjects (FReferenceCollector &Collector)
 
virtual FRestoreForUObjectOverwriteGetRestoreForUObjectOverwrite ()
 
virtual bool AreNativePropertiesIdenticalTo (UObject *Other) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetData &Out) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context, FAssetData &Out) const
 
virtual COREUOBJECT_API bool IsAsset () const
 
virtual COREUOBJECT_API FPrimaryAssetId GetPrimaryAssetId () const
 
virtual COREUOBJECT_API bool IsLocalizedResource () const
 
virtual COREUOBJECT_API bool IsSafeForRootSet () const
 
virtual COREUOBJECT_API void TagSubobjects (EObjectFlags NewFlags)
 
virtual COREUOBJECT_API void GetLifetimeReplicatedProps (TArray< class FLifetimeProperty > &OutLifetimeProps) const
 
virtual COREUOBJECT_API void GetReplicatedCustomConditionState (FCustomPropertyConditionState &OutActiveState) const
 
virtual COREUOBJECT_API void RegisterReplicationFragments (UE::Net::FFragmentRegistrationContext &Context, UE::Net::EFragmentRegistrationFlags RegistrationFlags)
 
virtual COREUOBJECT_API bool IsNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsFullNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsSupportedForNetworking () const
 
virtual void GetSubobjectsWithStableNamesForNetworking (TArray< UObject * > &ObjList)
 
virtual COREUOBJECT_API void PreNetReceive ()
 
virtual COREUOBJECT_API void PostNetReceive ()
 
virtual void PostRepNotifies ()
 
virtual COREUOBJECT_API void PreDestroyFromReplication ()
 
COREUOBJECT_API bool IsSelected () const
 
COREUOBJECT_API void SerializeScriptProperties (FArchive &Ar) const
 
COREUOBJECT_API void SerializeScriptProperties (FStructuredArchive::FSlot Slot) const
 
COREUOBJECT_API void ReinitializeProperties (UObject *SourceObject=NULL, struct FObjectInstancingGraph *InstanceGraph=NULL)
 
COREUOBJECT_API FString GetDetailedInfo () const
 
COREUOBJECT_API bool ConditionalBeginDestroy ()
 
COREUOBJECT_API bool ConditionalFinishDestroy ()
 
COREUOBJECT_API void ConditionalPostLoad ()
 
COREUOBJECT_API void ConditionalPreload ()
 
COREUOBJECT_API void ConditionalPostLoadSubobjects (struct FObjectInstancingGraph *OuterInstanceGraph=NULL)
 
bool IsBasedOnArchetype (const UObject *const SomeObject) const
 
COREUOBJECT_API UFunctionFindFunction (FName InName) const
 
COREUOBJECT_API UFunctionFindFunctionChecked (FName InName) const
 
virtual COREUOBJECT_API void BuildSubobjectMapping (UObject *OtherObject, TMap< UObject *, UObject * > &ObjectMapping) const
 
COREUOBJECT_API void CollectDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects, bool bIncludeNestedSubobjects=false) const
 
COREUOBJECT_API bool CheckDefaultSubobjects (bool bForceCheck=false) const
 
COREUOBJECT_API void SaveConfig (uint64 RequiredPropertyFlags=CPF_Config, const TCHAR *Filename=nullptr, FConfigCacheIni *Config=GConfig, bool bAllowCopyToDefaultObject=true)
 
COREUOBJECT_API void SaveConfig (const FSaveConfigContext &Context)
 
COREUOBJECT_API void UpdateDefaultConfigFile (const FString &SpecificFileLocation="")
 
COREUOBJECT_API bool TryUpdateDefaultConfigFile (const FString &SpecificFileLocation="", bool bWarnIfFail=true)
 
COREUOBJECT_API void UpdateGlobalUserConfigFile ()
 
COREUOBJECT_API void UpdateProjectUserConfigFile ()
 
COREUOBJECT_API void UpdateSinglePropertyInConfigFile (const FProperty *InProperty, const FString &InConfigIniName)
 
COREUOBJECT_API FString GetDefaultConfigFilename () const
 
COREUOBJECT_API FString GetGlobalUserConfigFilename () const
 
COREUOBJECT_API FString GetProjectUserConfigFilename () const
 
virtual const TCHARGetConfigOverridePlatform () const
 
virtual void OverrideConfigSection (FString &SectionName)
 
virtual void OverridePerObjectConfigSection (FString &SectionName)
 
COREUOBJECT_API void LoadConfig (UClass *ConfigClass=nullptr, const TCHAR *Filename=nullptr, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=nullptr, TArray< UE::ConfigAccessTracking::FConfigAccessData > *OutAccessedKeys=nullptr)
 
COREUOBJECT_API void ReloadConfig (UClass *ConfigClass=NULL, const TCHAR *Filename=NULL, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=NULL)
 
COREUOBJECT_API void ParseParms (const TCHAR *Parms)
 
COREUOBJECT_API void OutputReferencers (FOutputDevice &Ar, FReferencerInformationList *Referencers=NULL)
 
COREUOBJECT_API void RetrieveReferencers (TArray< FReferencerInformation > *OutInternalReferencers, TArray< FReferencerInformation > *OutExternalReferencers)
 
COREUOBJECT_API void SetLinker (FLinkerLoad *LinkerLoad, int32 LinkerIndex, bool bShouldDetachExisting=true, bool bSilenceLogs=false)
 
COREUOBJECT_API UObjectGetArchetype () const
 
COREUOBJECT_API void GetArchetypeInstances (TArray< UObject * > &Instances)
 
COREUOBJECT_API void InstanceSubobjectTemplates (struct FObjectInstancingGraph *InstanceGraph=NULL)
 
template<class T >
bool Implements () const
 
virtual COREUOBJECT_API void ProcessEvent (UFunction *Function, void *Parms)
 
virtual int32 GetFunctionCallspace (UFunction *Function, FFrame *Stack)
 
virtual bool CallRemoteFunction (UFunction *Function, void *Parms, struct FOutParmRec *OutParms, FFrame *Stack)
 
COREUOBJECT_API bool CallFunctionByNameWithArguments (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor, bool bForceCallWithNonExec=false)
 
COREUOBJECT_API void CallFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
 DECLARE_FUNCTION (ProcessInternal)
 
virtual bool ProcessConsoleExec (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor)
 
COREUOBJECT_API void SkipFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
virtual UClassRegenerateClass (UClass *ClassToRegenerate, UObject *PreviousCDO)
 
COREUOBJECT_API bool IsInBlueprint () const
 
COREUOBJECT_API void DestroyNonNativeProperties ()
 
virtual void MarkAsEditorOnlySubobject ()
 
COREUOBJECT_API void AbortInsideMemberFunction () const
 
 DECLARE_FUNCTION (execUndefined)
 
 DECLARE_FUNCTION (execLocalVariable)
 
 DECLARE_FUNCTION (execInstanceVariable)
 
 DECLARE_FUNCTION (execDefaultVariable)
 
 DECLARE_FUNCTION (execLocalOutVariable)
 
 DECLARE_FUNCTION (execInterfaceVariable)
 
 DECLARE_FUNCTION (execClassSparseDataVariable)
 
 DECLARE_FUNCTION (execInterfaceContext)
 
 DECLARE_FUNCTION (execArrayElement)
 
 DECLARE_FUNCTION (execBoolVariable)
 
 DECLARE_FUNCTION (execClassDefaultVariable)
 
 DECLARE_FUNCTION (execEndFunctionParms)
 
 DECLARE_FUNCTION (execNothing)
 
 DECLARE_FUNCTION (execNothingInt32)
 
 DECLARE_FUNCTION (execNothingOp4a)
 
 DECLARE_FUNCTION (execBreakpoint)
 
 DECLARE_FUNCTION (execTracepoint)
 
 DECLARE_FUNCTION (execWireTracepoint)
 
 DECLARE_FUNCTION (execInstrumentation)
 
 DECLARE_FUNCTION (execEndOfScript)
 
 DECLARE_FUNCTION (execReturnNothing)
 
 DECLARE_FUNCTION (execEmptyParmValue)
 
 DECLARE_FUNCTION (execJump)
 
 DECLARE_FUNCTION (execJumpIfNot)
 
 DECLARE_FUNCTION (execAssert)
 
 DECLARE_FUNCTION (execPushExecutionFlow)
 
 DECLARE_FUNCTION (execPopExecutionFlow)
 
 DECLARE_FUNCTION (execComputedJump)
 
 DECLARE_FUNCTION (execPopExecutionFlowIfNot)
 
 DECLARE_FUNCTION (execLet)
 
 DECLARE_FUNCTION (execLetObj)
 
 DECLARE_FUNCTION (execLetWeakObjPtr)
 
 DECLARE_FUNCTION (execLetBool)
 
 DECLARE_FUNCTION (execLetDelegate)
 
 DECLARE_FUNCTION (execLetMulticastDelegate)
 
 DECLARE_FUNCTION (execAddMulticastDelegate)
 
 DECLARE_FUNCTION (execClearMulticastDelegate)
 
 DECLARE_FUNCTION (execEatReturnValue)
 
 DECLARE_FUNCTION (execRemoveMulticastDelegate)
 
 DECLARE_FUNCTION (execSelf)
 
 DECLARE_FUNCTION (execContext)
 
 DECLARE_FUNCTION (execContext_FailSilent)
 
 DECLARE_FUNCTION (execStructMemberContext)
 
 DECLARE_FUNCTION (execVirtualFunction)
 
 DECLARE_FUNCTION (execFinalFunction)
 
 DECLARE_FUNCTION (execLocalVirtualFunction)
 
 DECLARE_FUNCTION (execLocalFinalFunction)
 
 DECLARE_FUNCTION (execStructCmpEq)
 
 DECLARE_FUNCTION (execStructCmpNe)
 
 DECLARE_FUNCTION (execStructMember)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execNotEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execNotEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execIntConst)
 
 DECLARE_FUNCTION (execInt64Const)
 
 DECLARE_FUNCTION (execUInt64Const)
 
 DECLARE_FUNCTION (execSkipOffsetConst)
 
 DECLARE_FUNCTION (execFloatConst)
 
 DECLARE_FUNCTION (execDoubleConst)
 
 DECLARE_FUNCTION (execStringConst)
 
 DECLARE_FUNCTION (execUnicodeStringConst)
 
 DECLARE_FUNCTION (execTextConst)
 
 DECLARE_FUNCTION (execPropertyConst)
 
 DECLARE_FUNCTION (execObjectConst)
 
 DECLARE_FUNCTION (execSoftObjectConst)
 
 DECLARE_FUNCTION (execFieldPathConst)
 
 DECLARE_FUNCTION (execInstanceDelegate)
 
 DECLARE_FUNCTION (execNameConst)
 
 DECLARE_FUNCTION (execByteConst)
 
 DECLARE_FUNCTION (execIntZero)
 
 DECLARE_FUNCTION (execIntOne)
 
 DECLARE_FUNCTION (execTrue)
 
 DECLARE_FUNCTION (execFalse)
 
 DECLARE_FUNCTION (execNoObject)
 
 DECLARE_FUNCTION (execNullInterface)
 
 DECLARE_FUNCTION (execIntConstByte)
 
 DECLARE_FUNCTION (execRotationConst)
 
 DECLARE_FUNCTION (execVectorConst)
 
 DECLARE_FUNCTION (execVector3fConst)
 
 DECLARE_FUNCTION (execTransformConst)
 
 DECLARE_FUNCTION (execStructConst)
 
 DECLARE_FUNCTION (execSetArray)
 
 DECLARE_FUNCTION (execSetSet)
 
 DECLARE_FUNCTION (execSetMap)
 
 DECLARE_FUNCTION (execArrayConst)
 
 DECLARE_FUNCTION (execSetConst)
 
 DECLARE_FUNCTION (execMapConst)
 
 DECLARE_FUNCTION (execBitFieldConst)
 
 DECLARE_FUNCTION (execNew)
 
 DECLARE_FUNCTION (execClassContext)
 
 DECLARE_FUNCTION (execNativeParm)
 
 DECLARE_FUNCTION (execCast)
 
 DECLARE_FUNCTION (execDynamicCast)
 
 DECLARE_FUNCTION (execMetaCast)
 
 DECLARE_FUNCTION (execInterfaceCast)
 
 DECLARE_FUNCTION (execDoubleToFloatCast)
 
 DECLARE_FUNCTION (execFloatToDoubleCast)
 
 DECLARE_FUNCTION (execObjectToBool)
 
 DECLARE_FUNCTION (execInterfaceToBool)
 
 DECLARE_FUNCTION (execObjectToInterface)
 
 DECLARE_FUNCTION (execInterfaceToInterface)
 
 DECLARE_FUNCTION (execInterfaceToObject)
 
 DECLARE_FUNCTION (execGetDynArrayElement)
 
 DECLARE_FUNCTION (execSetDynArrayElement)
 
 DECLARE_FUNCTION (execGetDynArrayLength)
 
 DECLARE_FUNCTION (execSetDynArrayLength)
 
 DECLARE_FUNCTION (execDynArrayInsert)
 
 DECLARE_FUNCTION (execDynArrayRemove)
 
 DECLARE_FUNCTION (execDynArrayFind)
 
 DECLARE_FUNCTION (execDynArrayFindStruct)
 
 DECLARE_FUNCTION (execDynArrayAdd)
 
 DECLARE_FUNCTION (execDynArrayAddItem)
 
 DECLARE_FUNCTION (execDynArrayInsertItem)
 
 DECLARE_FUNCTION (execDynArrayRemoveItem)
 
 DECLARE_FUNCTION (execDynArraySort)
 
 DECLARE_FUNCTION (execBindDelegate)
 
 DECLARE_FUNCTION (execCallMulticastDelegate)
 
 DECLARE_FUNCTION (execLetValueOnPersistentFrame)
 
 DECLARE_FUNCTION (execCallMathFunction)
 
 DECLARE_FUNCTION (execSwitchValue)
 
 DECLARE_FUNCTION (execArrayGetByRef)
 
 DECLARE_FUNCTION (execAutoRtfmTransact)
 
 DECLARE_FUNCTION (execAutoRtfmStopTransact)
 
 DECLARE_FUNCTION (execAutoRtfmAbortIfNot)
 
void ExecuteUbergraph (int32 EntryPoint)
 
virtual void ValidateGeneratedRepEnums (const TArray< struct FRepRecord > &ClassReps) const
 
virtual uint64 GetNetPushIdDynamic () const
 
- Public Member Functions inherited from UObjectBaseUtility
 UObjectBaseUtility ()
 
 UObjectBaseUtility (EObjectFlags InFlags)
 
void SetFlags (EObjectFlags NewFlags)
 
void ClearFlags (EObjectFlags FlagsToClear)
 
bool HasAnyFlags (EObjectFlags FlagsToCheck) const
 
bool HasAllFlags (EObjectFlags FlagsToCheck) const
 
UE_FORCEINLINE_HINT EObjectFlags GetMaskedFlags (EObjectFlags Mask=RF_AllFlags) const
 
UE_FORCEINLINE_HINT void Mark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT void UnMark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAnyMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAllMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT EObjectMark GetAllMarks () const
 
void MarkAsGarbage ()
 
void ClearGarbage ()
 
UE_FORCEINLINE_HINT void AddToRoot ()
 
UE_FORCEINLINE_HINT void RemoveFromRoot ()
 
UE_FORCEINLINE_HINT bool IsRooted () const
 
UE_FORCEINLINE_HINT int32 GetRefCount () const
 
bool ThisThreadAtomicallyClearedRFUnreachable ()
 
UE_FORCEINLINE_HINT bool IsUnreachable () const
 
UE_FORCEINLINE_HINT bool IsNative () const
 
void SetInternalFlags (EInternalObjectFlags FlagsToSet) const
 
UE_FORCEINLINE_HINT EInternalObjectFlags GetInternalFlags () const
 
UE_FORCEINLINE_HINT bool HasAnyInternalFlags (EInternalObjectFlags FlagsToCheck) const
 
void ClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
bool AtomicallyClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
COREUOBJECT_API FString GetFullName (const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (const UObject *StopOuter, FString &ResultString, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (FStringBuilderBase &ResultString, const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API FString GetPathName (const UObject *StopOuter=NULL) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FString &ResultString) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FStringBuilderBase &ResultString) const
 
virtual bool CanBeClusterRoot () const
 
virtual COREUOBJECT_API bool CanBeInCluster () const
 
virtual COREUOBJECT_API void CreateCluster ()
 
virtual void OnClusterMarkedAsPendingKill ()
 
COREUOBJECT_API void AddToCluster (UObjectBaseUtility *ClusterRootOrObjectFromCluster, bool bAddAsMutableObject=false)
 
COREUOBJECT_API FString GetFullGroupName (bool bStartWithOuter) const
 
UE_FORCEINLINE_HINT FString GetName () const
 
UE_FORCEINLINE_HINT void GetName (FString &ResultString) const
 
UE_FORCEINLINE_HINT void AppendName (FString &ResultString) const
 
COREUOBJECT_API bool IsPackageExternal () const
 
COREUOBJECT_API void DetachExternalPackage ()
 
COREUOBJECT_API void ReattachExternalPackage ()
 
COREUOBJECT_API UObjectGetOutermostObject () const
 
COREUOBJECT_API UPackageGetPackage () const
 
UE_INTERNAL virtual COREUOBJECT_API UE::Core::FVersePath GetVersePath () const
 
COREUOBJECT_API UPackageGetOutermost () const
 
COREUOBJECT_API bool MarkPackageDirty () const
 
COREUOBJECT_API bool IsTemplate (EObjectFlags TemplateTypes=RF_ArchetypeObject|RF_ClassDefaultObject) const
 
COREUOBJECT_API UObjectGetTypedOuter (UClass *Target) const
 
template<typename T >
T * GetTypedOuter () const
 
template<typename InterfaceClassType >
InterfaceClassTypeGetImplementingOuter () const
 
COREUOBJECT_API UObjectBaseUtilityGetImplementingOuterObject (const UClass *InInterfaceClass) const
 
COREUOBJECT_API bool IsIn (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsIn (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInOuter (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsInPackage (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInA (const UClass *SomeBaseClass) const
 
COREUOBJECT_API bool RootPackageHasAnyFlags (uint32 CheckFlagMask) const
 
template<typename OtherClassType >
bool IsA (OtherClassType SomeBase) const
 
template<class T >
bool IsA () const
 
COREUOBJECT_API const UClassFindNearestCommonBaseClass (const UClass *TestClass) const
 
COREUOBJECT_API voidGetInterfaceAddress (UClass *InterfaceClass)
 
COREUOBJECT_API voidGetNativeInterfaceAddress (UClass *InterfaceClass)
 
const voidGetNativeInterfaceAddress (UClass *InterfaceClass) const
 
COREUOBJECT_API bool IsTemplateForSubobjects (EObjectFlags TemplateTypes=RF_ClassDefaultObject|RF_DefaultSubObject|RF_InheritableComponentTemplate) const
 
COREUOBJECT_API bool IsDefaultSubobject () const
 
COREUOBJECT_API class FLinkerLoadGetLinker () const
 
COREUOBJECT_API int32 GetLinkerIndex () const
 
COREUOBJECT_API FPackageFileVersion GetLinkerUEVersion () const
 
int32 GetLinkerUE4Version () const
 
COREUOBJECT_API int32 GetLinkerLicenseeUEVersion () const
 
int32 GetLinkerLicenseeUE4Version () const
 
COREUOBJECT_API int32 GetLinkerCustomVersion (FGuid CustomVersionKey) const
 
UE_FORCEINLINE_HINT bool operator< (const UObjectBaseUtility &Other) const
 
TStatId GetStatID (bool bForDeferredUse=false) const
 
- Public Member Functions inherited from UObjectBase
COREUOBJECT_API UObjectBase (UClass *InClass, EObjectFlags InFlags, EInternalObjectFlags InInternalFlags, UObject *InOuter, FName InName, int32 InInternalIndex=-1, int32 InSerialNumber=0, FRemoteObjectId InRemoteId=FRemoteObjectId())
 
virtual COREUOBJECT_API ~UObjectBase ()
 
COREUOBJECT_API bool IsValidLowLevel () const
 
COREUOBJECT_API bool IsValidLowLevelFast (bool bRecursive=true) const
 
FORCEINLINE uint32 GetUniqueID () const
 
FORCEINLINE UClassGetClass () const
 
FORCEINLINE UObjectGetOuter () const
 
FORCEINLINE FName GetFName () const
 
virtual COREUOBJECT_API FName GetFNameForStatID () const
 
COREUOBJECT_API UPackageGetExternalPackage () const
 
COREUOBJECT_API void SetExternalPackage (UPackage *InPackage)
 
COREUOBJECT_API UPackageGetExternalPackageInternal () const
 
COREUOBJECT_API void MarkAsReachable () const
 
COREUOBJECT_API void AddRef () const
 
COREUOBJECT_API void ReleaseRef () const
 
FORCEINLINE EObjectFlags GetFlags () const
 
FORCENOINLINE void AtomicallySetFlags (EObjectFlags FlagsToAdd)
 
FORCENOINLINE void AtomicallyClearFlags (EObjectFlags FlagsToClear)
 

Public Attributes

float Density
 
float DensityAdjustmentFactor
 
float Radius
 
bool bSingleInstanceModeOverrideRadius = false
 
float SingleInstanceModeRadius = 0.f
 
EFoliageScaling Scaling
 
FFloatInterval ScaleX
 
FFloatInterval ScaleY
 
FFloatInterval ScaleZ
 
FFoliageVertexColorChannelMask VertexColorMaskByChannel [(uint8) EVertexColorMaskChannel::MAX_None]
 
TEnumAsByte< enum FoliageVertexColorMaskVertexColorMask_DEPRECATED
 
float VertexColorMaskThreshold_DEPRECATED
 
uint32 VertexColorMaskInvert_DEPRECATED:1
 
FFloatInterval ZOffset
 
uint32 AlignToNormal:1
 
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Placement, meta=(ToolTip="Will average normal based on Foliage Type base radius (this as a cost as it will do extra line traces)")) uint32 AverageNormal uint32 AverageNormalSingleComponent:1
 
float AlignMaxAngle
 
uint32 RandomYaw:1
 
float RandomPitchAngle
 
FFloatInterval GroundSlopeAngle
 
FFloatInterval Height
 
TArray< FNameLandscapeLayers
 
float MinimumLayerWeight
 
TArray< FNameExclusionLandscapeLayers
 
float MinimumExclusionLayerWeight
 
FName LandscapeLayer_DEPRECATED
 
uint32 CollisionWithWorld:1
 
FVector CollisionScale
 
int32 AverageNormalSampleCount
 
FBoxSphereBounds MeshBounds
 
FVector LowBoundOriginRadius
 
TEnumAsByte< EComponentMobility::TypeMobility
 
FInt32Interval CullDistance
 
uint32 bEnableStaticLighting_DEPRECATED: 1
 
uint32 CastShadow:1
 
uint32 bAffectDynamicIndirectLighting:1
 
uint32 bAffectDistanceFieldLighting:1
 
uint32 bCastDynamicShadow:1
 
uint32 bCastStaticShadow:1
 
uint8 bCastContactShadow: 1
 
uint32 bCastShadowAsTwoSided:1
 
uint32 bReceivesDecals: 1
 
uint32 bOverrideLightMapRes:1
 
EShadowCacheInvalidationBehavior ShadowCacheInvalidationBehavior
 
int32 OverriddenLightMapRes
 
ELightmapType LightmapType
 
uint32 bUseAsOccluder: 1
 
uint8 bVisibleInRayTracing: 1
 
uint8 bEvaluateWorldPositionOffset: 1
 
int32 WorldPositionOffsetDisableDistance
 
struct FBodyInstance BodyInstance
 
TEnumAsByte< EHasCustomNavigableGeometry::TypeCustomNavigableGeometry
 
FLightingChannels LightingChannels
 
uint32 bRenderCustomDepth:1
 
ERendererStencilMask CustomDepthStencilWriteMask
 
int32 CustomDepthStencilValue
 
int32 TranslucencySortPriority
 
float CollisionRadius
 
float ShadeRadius
 
int32 NumSteps
 
float InitialSeedDensity
 
float AverageSpreadDistance
 
float SpreadVariance
 
int32 SeedsPerStep
 
int32 DistributionSeed
 
float MaxInitialSeedOffset
 
bool bCanGrowInShade
 
bool bSpawnsInShade
 
float MaxInitialAge
 
float MaxAge
 
float OverlapPriority
 
FFloatInterval ProceduralScale
 
FRuntimeFloatCurve ScaleCurve
 
FFoliageDensityFalloff DensityFalloff
 
int32 ChangeCount
 
uint32 ReapplyDensity:1
 
uint32 ReapplyRadius:1
 
uint32 ReapplyAlignToNormal:1
 
uint32 ReapplyRandomYaw:1
 
uint32 ReapplyScaling:1
 
uint32 ReapplyScaleX:1
 
uint32 ReapplyScaleY:1
 
uint32 ReapplyScaleZ:1
 
uint32 ReapplyRandomPitchAngle:1
 
uint32 ReapplyGroundSlope:1
 
uint32 ReapplyHeight:1
 
uint32 ReapplyLandscapeLayers:1
 
uint32 ReapplyZOffset:1
 
uint32 ReapplyCollisionWithWorld:1
 
uint32 ReapplyVertexColorMask:1
 
uint32 bEnableDensityScaling:1
 
uint32 bEnableDiscardOnLoad:1
 
uint32 bEnableCullDistanceScaling: 1
 
TArray< TObjectPtr< URuntimeVirtualTexture > > RuntimeVirtualTextures
 
int32 VirtualTextureCullMips = 0
 
ERuntimeVirtualTextureMainPassType VirtualTextureRenderPassType = ERuntimeVirtualTextureMainPassType::Exclusive
 

Additional Inherited Members

- Public Types inherited from UObject
enum class  ENetFields_Private { NETFIELD_REP_START = 0 , NETFIELD_REP_END = -1 }
 
typedef UObject WithinClass
 
- Static Public Member Functions inherited from UObject
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedServer (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedClient (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API bool CanCreateInCurrentContext (UObject *Template)
 
static COREUOBJECT_API void AddReferencedObjects (UObject *InThis, FReferenceCollector &Collector)
 
static COREUOBJECT_API const FNameSourceFileTagName ()
 
static COREUOBJECT_API UObjectGetArchetypeFromRequiredInfo (const UClass *Class, const UObject *Outer, FName Name, EObjectFlags ObjectFlags)
 
- Static Public Member Functions inherited from UObjectBaseUtility
static bool IsGarbageEliminationEnabled ()
 
static bool IsPendingKillEnabled ()
 
static void SetGarbageEliminationEnabled (bool bEnabled)
 
static COREUOBJECT_API void ReloadObjectsFromModifiedConfigSections (const class FConfigModificationTracker *ChangeTracker)
 
- Static Public Member Functions inherited from UObjectBase
static COREUOBJECT_API FString RemoveClassPrefix (const TCHAR *ClassName)
 
static void PrefetchClass (UObject *Object)
 
static void PrefetchOuter (UObject *Object)
 
- Protected Member Functions inherited from UObject
virtual FString GetDetailedInfoInternal () const
 
COREUOBJECT_API bool CanCheckDefaultSubObjects (bool bForceCheck, bool &bResult) const
 
virtual COREUOBJECT_API bool CheckDefaultSubobjectsInternal () const
 
- Protected Member Functions inherited from UObjectBase
 UObjectBase ()
 
COREUOBJECT_API UObjectBase (EObjectFlags InFlags)
 
COREUOBJECT_API void LowLevelRename (FName NewName, UObject *NewOuter=NULL)
 
virtual void RegisterDependencies ()
 
COREUOBJECT_API void Register (class UClass *(*StaticClassFn)(), const TCHAR *PackageName, const TCHAR *Name)
 
COREUOBJECT_API void Register (const TCHAR *PackageName, const TCHAR *Name)
 
virtual COREUOBJECT_API void DeferredRegister (UClass *UClassStaticClass, const TCHAR *PackageName, const TCHAR *Name)
 
FORCEINLINE void SetFlagsTo (EObjectFlags NewFlags)
 

Member Function Documentation

◆ GetInitAge()

float UFoliageType::GetInitAge ( FRandomStream RandomStream) const

◆ GetMaxRadius()

float UFoliageType::GetMaxRadius ( ) const

◆ GetNextAge()

float UFoliageType::GetNextAge ( const float  CurrentAge,
const int32  NumSteps 
) const

◆ GetRadius()

float UFoliageType::GetRadius ( bool  bInSingleInstanceMode) const
inline

◆ GetScaleForAge()

float UFoliageType::GetScaleForAge ( const float  Age) const

◆ GetSeedDensitySquared()

float UFoliageType::GetSeedDensitySquared ( ) const
inline

◆ GetSpawnsInShade()

bool UFoliageType::GetSpawnsInShade ( ) const

Member Data Documentation

◆ AlignMaxAngle

float UFoliageType::AlignMaxAngle

The maximum angle in degrees that foliage instances will be adjusted away from the vertical

◆ AlignToNormal

uint32 UFoliageType::AlignToNormal

Whether foliage instances should have their angle adjusted away from vertical to match the normal of the surface they're painted on If AlignToNormal is enabled and RandomYaw is disabled, the instance will be rotated so that the +X axis points down-slope

◆ AverageNormalSampleCount

int32 UFoliageType::AverageNormalSampleCount

Line trace count to use around hit location when averaging normal

◆ AverageNormalSingleComponent

UPROPERTY (EditAnywhere, BlueprintReadWrite, Category=Placement, meta=(ToolTip="Will average normal based on Foliage Type base radius (this as a cost as it will do extra line traces)")) uint32 AverageNormal uint32 UFoliageType::AverageNormalSingleComponent

Whether the normal should be averaged on a number of samples around the hit location Average Normal should use all hit components or only the original hit component

◆ AverageSpreadDistance

float UFoliageType::AverageSpreadDistance

The average distance between the spreading instance and its seeds. For example, a tree with an AverageSpreadDistance 10 will ensure the average distance between the tree and its seeds is 10cm

◆ bAffectDistanceFieldLighting

uint32 UFoliageType::bAffectDistanceFieldLighting

Controls whether the primitive should affect dynamic distance field lighting methods. This flag is only used if CastShadow is true.

◆ bAffectDynamicIndirectLighting

uint32 UFoliageType::bAffectDynamicIndirectLighting

Controls whether the foliage should inject light into the Light Propagation Volume. This flag is only used if CastShadow is true.

◆ bCanGrowInShade

bool UFoliageType::bCanGrowInShade

If true, seeds of this type will ignore shade radius during overlap tests with other types.

◆ bCastContactShadow

uint8 UFoliageType::bCastContactShadow

Whether the object should cast contact shadows. This flag is only used if CastShadow is true.

◆ bCastDynamicShadow

uint32 UFoliageType::bCastDynamicShadow

Controls whether the foliage should cast shadows in the case of non precomputed shadowing. This flag is only used if CastShadow is true.

◆ bCastShadowAsTwoSided

uint32 UFoliageType::bCastShadowAsTwoSided

Whether this foliage should cast dynamic shadows as if it were a two sided material.

◆ bCastStaticShadow

uint32 UFoliageType::bCastStaticShadow

Whether the foliage should cast a static shadow from shadow casting lights. This flag is only used if CastShadow is true.

◆ bEnableCullDistanceScaling

uint32 UFoliageType::bEnableCullDistanceScaling

◆ bEnableDensityScaling

uint32 UFoliageType::bEnableDensityScaling

Whether this foliage type should be affected by the Engine Scalability system's Foliage scalability setting. Enable for detail meshes that don't really affect the game. Disable for anything important. Typically, this will be enabled for small meshes without collision (e.g. grass) and disabled for large meshes with collision (e.g. trees)

◆ bEnableDiscardOnLoad

uint32 UFoliageType::bEnableDiscardOnLoad

Whether this foliage type should be discarded when CVarFoliageDiscardDataOnLoad is enabled.

◆ bEnableStaticLighting_DEPRECATED

uint32 UFoliageType::bEnableStaticLighting_DEPRECATED

Deprecated. Now use the Mobility setting to control static/dynamic lighting

◆ bEvaluateWorldPositionOffset

uint8 UFoliageType::bEvaluateWorldPositionOffset

◆ BodyInstance

struct FBodyInstance UFoliageType::BodyInstance

Custom collision for foliage

◆ bOverrideLightMapRes

uint32 UFoliageType::bOverrideLightMapRes

Whether to override the lightmap resolution defined in the static mesh.

◆ bReceivesDecals

uint32 UFoliageType::bReceivesDecals

Whether the foliage receives decals.

◆ bRenderCustomDepth

uint32 UFoliageType::bRenderCustomDepth

If true, the foliage will be rendered in the CustomDepth pass (usually used for outlines)

◆ bSingleInstanceModeOverrideRadius

bool UFoliageType::bSingleInstanceModeOverrideRadius = false

Option to override radius used to detect collision with other instances when painting in single instance mode

◆ bSpawnsInShade

bool UFoliageType::bSpawnsInShade

Whether new seeds are spawned exclusively in shade. Occurs in a second pass after all types that do not spawn in shade have been simulated. Only valid when CanGrowInShade is true.

◆ bUseAsOccluder

uint32 UFoliageType::bUseAsOccluder

If enabled, foliage will render a pre-pass which allows it to occlude other primitives, and also allows it to correctly receive DBuffer decals. Enabling this setting may have a negative performance impact.

◆ bVisibleInRayTracing

uint8 UFoliageType::bVisibleInRayTracing

◆ CastShadow

uint32 UFoliageType::CastShadow

Controls whether the foliage should cast a shadow or not.

◆ ChangeCount

int32 UFoliageType::ChangeCount

◆ CollisionRadius

float UFoliageType::CollisionRadius

The CollisionRadius determines when two instances overlap. When two instances overlap a winner will be picked based on rules and priority.

◆ CollisionScale

FVector UFoliageType::CollisionScale

◆ CollisionWithWorld

uint32 UFoliageType::CollisionWithWorld

◆ CullDistance

FInt32Interval UFoliageType::CullDistance

The distance where instances will begin to fade out if using a PerInstanceFadeAmount material node. 0 disables. When the entire cluster is beyond this distance, the cluster is completely culled and not rendered at all.

◆ CustomDepthStencilValue

int32 UFoliageType::CustomDepthStencilValue

Optionally write this 0-255 value to the stencil buffer in CustomDepth pass (Requires project setting or r.CustomDepth == 3)

◆ CustomDepthStencilWriteMask

ERendererStencilMask UFoliageType::CustomDepthStencilWriteMask

Mask used for stencil buffer writes.

◆ CustomNavigableGeometry

TEnumAsByte<EHasCustomNavigableGeometry::Type> UFoliageType::CustomNavigableGeometry

Force navmesh

◆ Density

float UFoliageType::Density

Foliage instances will be placed at this density, specified in instances per 1000x1000 unit area

◆ DensityAdjustmentFactor

float UFoliageType::DensityAdjustmentFactor

The factor by which to adjust the density of instances. Values >1 will increase density while values <1 will decrease it.

◆ DensityFalloff

FFoliageDensityFalloff UFoliageType::DensityFalloff

◆ DistributionSeed

int32 UFoliageType::DistributionSeed

The seed that determines placement of initial seeds.

◆ ExclusionLandscapeLayers

TArray<FName> UFoliageType::ExclusionLandscapeLayers

If layer names are specified, painting on landscape will exclude the foliage to areas of landscape without the specified layers painted

◆ GroundSlopeAngle

FFloatInterval UFoliageType::GroundSlopeAngle

◆ Height

FFloatInterval UFoliageType::Height

◆ InitialSeedDensity

float UFoliageType::InitialSeedDensity

Specifies the number of seeds to populate along 10 meters. The number is implicitly squared to cover a 10m x 10m area

◆ LandscapeLayer_DEPRECATED

FName UFoliageType::LandscapeLayer_DEPRECATED

◆ LandscapeLayers

TArray<FName> UFoliageType::LandscapeLayers

If layer names are specified, painting on landscape will limit the foliage to areas of landscape with the specified layers painted

◆ LightingChannels

FLightingChannels UFoliageType::LightingChannels

Lighting channels that placed foliage will be assigned. Lights with matching channels will affect the foliage. These channels only apply to opaque materials, direct lighting, and dynamic lighting and shadowing.

◆ LightmapType

ELightmapType UFoliageType::LightmapType

Controls the type of lightmap used for this component.

◆ LowBoundOriginRadius

FVector UFoliageType::LowBoundOriginRadius

◆ MaxAge

float UFoliageType::MaxAge

Specifies the oldest a seed can be. After reaching this age the instance will still spread seeds, but will not get any older

◆ MaxInitialAge

float UFoliageType::MaxInitialAge

Allows a new seed to be older than 0 when created. New seeds will be randomly assigned an age in the range [0,MaxInitialAge]

◆ MaxInitialSeedOffset

float UFoliageType::MaxInitialSeedOffset

The max seed used to compute global offset.

◆ MeshBounds

FBoxSphereBounds UFoliageType::MeshBounds

◆ MinimumExclusionLayerWeight

float UFoliageType::MinimumExclusionLayerWeight

Specifies the minimum value above which the landscape exclusion layer weight value must be, in order for foliage instances to be excluded in a specific area

◆ MinimumLayerWeight

float UFoliageType::MinimumLayerWeight

Specifies the minimum value above which the landscape layer weight value must be, in order for foliage instances to be placed in a specific area

◆ Mobility

TEnumAsByte<EComponentMobility::Type> UFoliageType::Mobility

Mobility property to apply to foliage components

◆ NumSteps

int32 UFoliageType::NumSteps

The number of times we age the species and spread its seeds.

◆ OverlapPriority

float UFoliageType::OverlapPriority

When two instances overlap we must determine which instance to remove. The instance with a lower OverlapPriority will be removed. In the case where OverlapPriority is the same regular simulation rules apply.

◆ OverriddenLightMapRes

int32 UFoliageType::OverriddenLightMapRes

Overrides the lightmap resolution defined in the static mesh

◆ ProceduralScale

FFloatInterval UFoliageType::ProceduralScale

The scale range of this type when being procedurally generated. Configured with the Scale Curve.

◆ Radius

float UFoliageType::Radius

The minimum distance between foliage instances

◆ RandomPitchAngle

float UFoliageType::RandomPitchAngle

A random pitch adjustment can be applied to each instance, up to the specified angle in degrees, from the original vertical

◆ RandomYaw

uint32 UFoliageType::RandomYaw

If selected, foliage instances will have a random yaw rotation around their vertical axis applied

◆ ReapplyAlignToNormal

uint32 UFoliageType::ReapplyAlignToNormal

If checked, foliage instances will have their normal alignment adjusted by the Reapply tool

◆ ReapplyCollisionWithWorld

uint32 UFoliageType::ReapplyCollisionWithWorld

◆ ReapplyDensity

uint32 UFoliageType::ReapplyDensity

If checked, the density of foliage instances already placed will be adjusted by the density adjustment factor.

◆ ReapplyGroundSlope

uint32 UFoliageType::ReapplyGroundSlope

If checked, foliage instances not meeting the ground slope condition will be removed by the Reapply too

◆ ReapplyHeight

uint32 UFoliageType::ReapplyHeight

◆ ReapplyLandscapeLayers

uint32 UFoliageType::ReapplyLandscapeLayers

◆ ReapplyRadius

uint32 UFoliageType::ReapplyRadius

If checked, foliage instances not meeting the new Radius constraint will be removed

◆ ReapplyRandomPitchAngle

uint32 UFoliageType::ReapplyRandomPitchAngle

If checked, foliage instances will have their pitch adjusted by the Reapply tool

◆ ReapplyRandomYaw

uint32 UFoliageType::ReapplyRandomYaw

If checked, foliage instances will have their yaw adjusted by the Reapply tool

◆ ReapplyScaleX

uint32 UFoliageType::ReapplyScaleX

If checked, foliage instances will have their X scale adjusted by the Reapply tool

◆ ReapplyScaleY

uint32 UFoliageType::ReapplyScaleY

If checked, foliage instances will have their Y scale adjusted by the Reapply tool

◆ ReapplyScaleZ

uint32 UFoliageType::ReapplyScaleZ

If checked, foliage instances will have their Z scale adjusted by the Reapply tool

◆ ReapplyScaling

uint32 UFoliageType::ReapplyScaling

If checked, foliage instances will have their scale adjusted to fit the specified scaling behavior by the Reapply tool

◆ ReapplyVertexColorMask

uint32 UFoliageType::ReapplyVertexColorMask

◆ ReapplyZOffset

uint32 UFoliageType::ReapplyZOffset

If checked, foliage instances will have their Z offset adjusted by the Reapply tool

◆ RuntimeVirtualTextures

TArray<TObjectPtr<URuntimeVirtualTexture> > UFoliageType::RuntimeVirtualTextures

Array of runtime virtual textures into which we draw the instances. The mesh material also needs to be set up to output to a virtual texture.

◆ ScaleCurve

FRuntimeFloatCurve UFoliageType::ScaleCurve

Instance scale factor as a function of normalized age (i.e. Current Age / Max Age). X = 0 corresponds to Age = 0, X = 1 corresponds to Age = Max Age. Y = 0 corresponds to Min Scale, Y = 1 corresponds to Max Scale.

◆ ScaleX

FFloatInterval UFoliageType::ScaleX

Specifies the range of scale, from minimum to maximum, to apply to a foliage instance's X Scale property

◆ ScaleY

FFloatInterval UFoliageType::ScaleY

Specifies the range of scale, from minimum to maximum, to apply to a foliage instance's Y Scale property

◆ ScaleZ

FFloatInterval UFoliageType::ScaleZ

Specifies the range of scale, from minimum to maximum, to apply to a foliage instance's Z Scale property

◆ Scaling

EFoliageScaling UFoliageType::Scaling

Specifies foliage instance scaling behavior when painting.

◆ SeedsPerStep

int32 UFoliageType::SeedsPerStep

The number of seeds an instance will spread in a single step of the simulation.

◆ ShadeRadius

float UFoliageType::ShadeRadius

The ShadeRadius determines when two instances overlap. If an instance can grow in the shade this radius is ignored.

◆ ShadowCacheInvalidationBehavior

EShadowCacheInvalidationBehavior UFoliageType::ShadowCacheInvalidationBehavior

Control shadow invalidation behavior, in particular with respect to Virtual Shadow Maps and material effects like World Position Offset.

◆ SingleInstanceModeRadius

float UFoliageType::SingleInstanceModeRadius = 0.f

The radius used in single instance mode to detect collision with other instances

◆ SpreadVariance

float UFoliageType::SpreadVariance

Specifies how much seed distance varies from the average. For example, a tree with an AverageSpreadDistance 10 and a SpreadVariance 1 will produce seeds with an average distance of 10cm plus or minus 1cm

◆ TranslucencySortPriority

int32 UFoliageType::TranslucencySortPriority

Translucent objects with a lower sort priority draw behind objects with a higher priority. Translucent objects with the same priority are rendered from back-to-front based on their bounds origin. This setting is also used to sort objects being drawn into a runtime virtual texture.

Ignored if the object is not translucent. The default priority is zero. Warning: This should never be set to a non-default value unless you know what you are doing, as it will prevent the renderer from sorting correctly. It is especially problematic on dynamic gameplay effects.

◆ VertexColorMask_DEPRECATED

TEnumAsByte<enum FoliageVertexColorMask> UFoliageType::VertexColorMask_DEPRECATED

When painting on static meshes, foliage instance placement can be limited to areas where the static mesh has values in the selected vertex color channel(s). This allows a static mesh to mask out certain areas to prevent foliage from being placed there

◆ VertexColorMaskByChannel

FFoliageVertexColorChannelMask UFoliageType::VertexColorMaskByChannel[(uint8) EVertexColorMaskChannel::MAX_None]

◆ VertexColorMaskInvert_DEPRECATED

uint32 UFoliageType::VertexColorMaskInvert_DEPRECATED

When unchecked, foliage instances will be placed only when the vertex color in the specified channel(s) is above the threshold amount. When checked, the vertex color must be less than the threshold amount

◆ VertexColorMaskThreshold_DEPRECATED

float UFoliageType::VertexColorMaskThreshold_DEPRECATED

Specifies the threshold value above which the static mesh vertex color value must be, in order for foliage instances to be placed in a specific area

◆ VirtualTextureCullMips

int32 UFoliageType::VirtualTextureCullMips = 0

Number of lower mips in the runtime virtual texture to skip for rendering this primitive. Larger values reduce the effective draw distance in the runtime virtual texture. This culling method doesn't take into account primitive size or virtual texture size.

◆ VirtualTextureRenderPassType

ERuntimeVirtualTextureMainPassType UFoliageType::VirtualTextureRenderPassType = ERuntimeVirtualTextureMainPassType::Exclusive

Controls if this component draws in the main pass as well as in the virtual texture.

◆ WorldPositionOffsetDisableDistance

int32 UFoliageType::WorldPositionOffsetDisableDistance

◆ ZOffset

FFloatInterval UFoliageType::ZOffset

Specifies a range from minimum to maximum of the offset to apply to a foliage instance's Z location


The documentation for this class was generated from the following files: