#include <SlateGameResources.h>

Inheritance diagram for FSlateGameResources:

Public Member Functions
ENGINE_API	FSlateGameResources (const FName &InStyleSetName)

virtual ENGINE_API	~FSlateGameResources ()

ENGINE_API void	Initialize (const FString &ScopeToDirectory, const FString &InBasePath)

virtual ENGINE_API void	GetResources (TArray< const FSlateBrush * > &OutResources) const override

virtual ENGINE_API void	SetContentRoot (const FString &InContentRootDir) override

virtual ENGINE_API const FSlateBrush *	GetBrush (const FName PropertyName, const ANSICHAR Specifier=NULL, const ISlateStyle RequestingStyle=nullptr) const override

virtual ENGINE_API const FSlateBrush *	GetOptionalBrush (const FName PropertyName, const ANSICHAR Specifier=NULL, const FSlateBrush const DefaultBrush=FStyleDefaults::GetNoBrush()) const override

ENGINE_API UCurveFloat *	GetCurveFloat (const FName AssetName) const

ENGINE_API UCurveVector *	GetCurveVector (const FName AssetName) const

ENGINE_API UCurveLinearColor *	GetCurveLinearColor (const FName AssetName) const

Public Member Functions inherited from FSlateStyleSet
SLATECORE_API	FSlateStyleSet (const FName &InStyleSetName)

SLATECORE_API	FSlateStyleSet (FSlateStyleSet &&)

SLATECORE_API	FSlateStyleSet (const FSlateStyleSet &)

virtual SLATECORE_API	~FSlateStyleSet ()

virtual SLATECORE_API const FName &	GetStyleSetName () const override

virtual SLATECORE_API TArray< FName >	GetEntriesUsingBrush (const FName BrushName) const override

virtual SLATECORE_API FString	RootToContentDir (const ANSICHAR RelativePath, const TCHAR Extension)

virtual SLATECORE_API FString	RootToContentDir (const WIDECHAR RelativePath, const TCHAR Extension)

virtual SLATECORE_API FString	RootToContentDir (const FString &RelativePath, const TCHAR *Extension)

virtual SLATECORE_API FString	RootToContentDir (const ANSICHAR *RelativePath)

virtual SLATECORE_API FString	RootToContentDir (const WIDECHAR *RelativePath)

virtual SLATECORE_API FString	RootToContentDir (const FString &RelativePath)

virtual FString	GetContentRootDir () const

virtual SLATECORE_API void	SetCoreContentRoot (const FString &InCoreContentRootDir)

virtual SLATECORE_API FString	RootToCoreContentDir (const ANSICHAR RelativePath, const TCHAR Extension)

virtual SLATECORE_API FString	RootToCoreContentDir (const WIDECHAR RelativePath, const TCHAR Extension)

virtual SLATECORE_API FString	RootToCoreContentDir (const FString &RelativePath, const TCHAR *Extension)

virtual SLATECORE_API FString	RootToCoreContentDir (const ANSICHAR *RelativePath)

virtual SLATECORE_API FString	RootToCoreContentDir (const WIDECHAR *RelativePath)

virtual SLATECORE_API FString	RootToCoreContentDir (const FString &RelativePath)

virtual SLATECORE_API float	GetFloat (const FName PropertyName, const ANSICHAR Specifier=nullptr, float DefaultValue=FStyleDefaults::GetFloat(), const ISlateStyle RequestingStyle=nullptr) const override

virtual SLATECORE_API UE::Slate::FDeprecateVector2DResult	GetVector (const FName PropertyName, const ANSICHAR Specifier=nullptr, UE::Slate::FDeprecateVector2DParameter DefaultValue=FStyleDefaults::GetVector2D(), const ISlateStyle RequestingStyle=nullptr) const override

virtual SLATECORE_API const FLinearColor &	GetColor (const FName PropertyName, const ANSICHAR Specifier=nullptr, const FLinearColor &DefaultValue=FStyleDefaults::GetColor(), const ISlateStyle RequestingStyle=nullptr) const override

virtual SLATECORE_API const FSlateColor	GetSlateColor (const FName PropertyName, const ANSICHAR Specifier=nullptr, const FSlateColor &DefaultValue=FStyleDefaults::GetSlateColor(), const ISlateStyle RequestingStyle=nullptr) const override

virtual SLATECORE_API const FMargin &	GetMargin (const FName PropertyName, const ANSICHAR Specifier=nullptr, const FMargin &DefaultValue=FStyleDefaults::GetMargin(), const ISlateStyle RequestingStyle=nullptr) const override

virtual SLATECORE_API const TSharedPtr< FSlateDynamicImageBrush >	GetDynamicImageBrush (const FName BrushTemplate, const FName TextureName, const ANSICHAR Specifier=nullptr, const ISlateStyle RequestingStyle=nullptr) const override

virtual SLATECORE_API const TSharedPtr< FSlateDynamicImageBrush >	GetDynamicImageBrush (const FName BrushTemplate, const ANSICHAR Specifier, UTexture2D TextureResource, const FName TextureName, const ISlateStyle *RequestingStyle=nullptr) const override

virtual SLATECORE_API const TSharedPtr< FSlateDynamicImageBrush >	GetDynamicImageBrush (const FName BrushTemplate, UTexture2D TextureResource, const FName TextureName, const ISlateStyle RequestingStyle=nullptr) const override

virtual SLATECORE_API FSlateBrush *	GetDefaultBrush () const override

virtual SLATECORE_API const FSlateSound &	GetSound (const FName PropertyName, const ANSICHAR Specifier=nullptr, const ISlateStyle RequestingStyle=nullptr) const override

virtual SLATECORE_API FSlateFontInfo	GetFontStyle (const FName PropertyName, const ANSICHAR *Specifier=nullptr) const override

SLATECORE_API void	SetParentStyleName (const FName &InParentStyleName)

template<typename DefinitionType >
FORCENOINLINE void	Set (const FName PropertyName, const DefinitionType &InStyleDefintion)

FORCENOINLINE void	Set (const FName PropertyName, const float InFloat)

FORCENOINLINE void	Set (const FName PropertyName, const FVector2D &InVector)

FORCENOINLINE void	Set (const FName PropertyName, const UE::Slate::FDeprecateVector2DResult &InVector)

FORCENOINLINE void	Set (const FName PropertyName, const FVector2f &InVector)

FORCENOINLINE void	Set (const FName PropertyName, const FLinearColor &InColor)

FORCENOINLINE void	Set (const FName PropertyName, const FColor &InColor)

FORCENOINLINE void	Set (const FName PropertyName, const FSlateColor &InColor)

FORCENOINLINE void	Set (const FName PropertyName, const FMargin &InMargin)

template<typename BrushType >
FORCENOINLINE void	Set (const FName PropertyName, BrushType *InBrush)

FORCENOINLINE void	Set (FName PropertyName, const FSlateSound &InSound)

FORCENOINLINE void	Set (FName PropertyName, const FSlateFontInfo &InFontInfo)

Public Member Functions inherited from ISlateStyle
	ISlateStyle ()

virtual	~ISlateStyle ()

template<typename WidgetStyleType >
const WidgetStyleType &	GetWidgetStyle (FName PropertyName, const ANSICHAR Specifier, const WidgetStyleType DefaultValue, bool bWarnIfNotFound) const

template<typename WidgetStyleType >
const WidgetStyleType &	GetWidgetStyle (FName PropertyName, const ANSICHAR Specifier=nullptr, const WidgetStyleType DefaultValue=nullptr) const

template<typename WidgetStyleType >
bool	HasWidgetStyle (FName PropertyName, const ANSICHAR *Specifier=nullptr) const

const FSlateWidgetStyle *	GetWidgetStyle (const FName &WidgetStyleTypeName, FName PropertyName, const ANSICHAR Specifier=nullptr, const FSlateWidgetStyle DefaultValue=nullptr, bool bWarnIfNotFound=true) const

Public Member Functions inherited from FGCObject
	FGCObject ()

	FGCObject (const FGCObject &Other)

	FGCObject (FGCObject &&Other)

	FGCObject (EFlags Flags)

virtual	~FGCObject ()

FGCObject &	operator= (const FGCObject &)

FGCObject &	operator= (FGCObject &&)

COREUOBJECT_API void	RegisterGCObject ()

COREUOBJECT_API void	UnregisterGCObject ()

virtual bool	GetReferencerPropertyName (UObject *Object, FString &OutPropertyName) const

Static Public Member Functions
static ENGINE_API TSharedRef< FSlateGameResources >	New (const FName &InStyleSetName, const FString &ScopeToDirectory, const FString &InBasePath=FString())

Static Public Member Functions inherited from ISlateStyle
static FName	Join (FName A, const ANSICHAR *B)

Static Public Member Functions inherited from FGCObject
static COREUOBJECT_API void	StaticInit ()

Protected Member Functions
virtual ENGINE_API const FSlateWidgetStyle *	GetWidgetStyleInternal (const FName DesiredTypeName, const FName StyleName, const FSlateWidgetStyle *DefaultStyle, bool bWarnIfNotFound) const override

virtual ENGINE_API void	Log (ISlateStyle::EStyleMessageSeverity Severity, const FText &Message) const override

virtual ENGINE_API void	Log (const TSharedRef< class FTokenizedMessage > &Message) const

ENGINE_API void	AddAsset (const FAssetData &InAddedAssetData)

ENGINE_API void	RemoveAsset (const FAssetData &InRemovedAssetData)

ENGINE_API bool	ShouldCache (const FAssetData &InAssetData)

ENGINE_API void	AddAssetToCache (UObject *InStyleObject, bool bEnsureUniqueness)

ENGINE_API void	RemoveAssetFromCache (const FAssetData &AssetData)

ENGINE_API FName	GenerateMapName (const FAssetData &AssetData)

ENGINE_API FName	GenerateMapName (UObject *StyleObject)

ENGINE_API FName	GetCleanName (const FName &AssetName) const

virtual ENGINE_API void	AddReferencedObjects (FReferenceCollector &Collector) override

virtual ENGINE_API FString	GetReferencerName () const override

Protected Member Functions inherited from FSlateStyleSet
virtual SLATECORE_API void	LogMissingResource (EStyleMessageSeverity Severity, const FText &Message, const FName &MissingResource) const override

virtual SLATECORE_API const TSharedPtr< FSlateDynamicImageBrush >	MakeDynamicImageBrush (const FName BrushTemplate, UTexture2D *TextureResource, const FName TextureName) const override

virtual SLATECORE_API void	LogUnusedBrushResources ()

virtual SLATECORE_API TSet< FName >	GetStyleKeys () const override

virtual SLATECORE_API const TSet< FName > &	GetWidgetStyleNames () const override

SLATECORE_API bool	IsBrushFromFile (const FString &FilePath, const FSlateBrush *Brush)

SLATECORE_API const ISlateStyle *	GetParentStyle () const

Additional Inherited Members
Public Types inherited from FGCObject
enum class	EFlags : uint32 { None = 0 , RegisterLater = 1 << 0 , AddStableNativeReferencesOnly = 1 << 1 }

Static Public Attributes inherited from FGCObject
static COREUOBJECT_API UGCObjectReferencer *	GGCObjectReferencer = nullptr

Protected Types inherited from ISlateStyle
enum class	EStyleMessageSeverity : uint8 { UE_DEPRECATED =(5.1, "CriticalError was removed because it can't trigger an assert at the callsite. Use 'checkf' instead.") = 0 , Error = 1 , PerformanceWarning = 2 , Warning = 3 , Info = 4 }

Protected Attributes inherited from FSlateStyleSet
FName	StyleSetName

FString	ContentRootDir

FString	CoreContentRootDir

TMap< FName, TSharedRef< struct FSlateWidgetStyle > >	WidgetStyleValues

TSet< FName >	KnownWidgetStyles

TMap< FName, float >	FloatValues

TMap< FName, FVector2f >	Vector2DValues

TMap< FName, FLinearColor >	ColorValues

TMap< FName, FSlateColor >	SlateColorValues

TMap< FName, FMargin >	MarginValues

FSlateBrush *	DefaultBrush

TMap< FName, FSlateBrush * >	BrushResources

TMap< FName, FSlateSound >	Sounds

TMap< FName, FSlateFontInfo >	FontInfoResources

TMap< FName, TWeakPtr< FSlateDynamicImageBrush > >	DynamicBrushes

TSet< FName >	MissingResources

FName	ParentStyleName

Constructor & Destructor Documentation

◆ FSlateGameResources()

FSlateGameResources::FSlateGameResources ( const FName & InStyleSetName )

Construct a style chunk.

Parameters

InStyleSetName The name used to identity this style set

◆ ~FSlateGameResources()

FSlateGameResources::~FSlateGameResources ( )

virtual

Member Function Documentation

◆ AddAsset()

void FSlateGameResources::AddAsset ( const FAssetData & InAddedAssetData )

protected

Callback registered to the Asset Registry to be notified when an asset is added.

◆ AddAssetToCache()

void FSlateGameResources::AddAssetToCache	(	UObject *	InStyleObject,
		bool	bEnsureUniqueness
	)

protected

◆ AddReferencedObjects()

void FSlateGameResources::AddReferencedObjects ( FReferenceCollector & Collector )

overrideprotectedvirtual

Pure virtual that must be overloaded by the inheriting class. Use this method to serialize any UObjects contained that you wish to keep around.

Parameters

Collector The collector of referenced objects.

Implements FGCObject.

◆ GenerateMapName() [1/2]

FName FSlateGameResources::GenerateMapName ( const FAssetData & AssetData )

protected

◆ GenerateMapName() [2/2]

FName FSlateGameResources::GenerateMapName ( UObject * StyleObject )

protected

◆ GetBrush()

const FSlateBrush * FSlateGameResources::GetBrush	(	const FName	PropertyName,
		const ANSICHAR *	Specifier = `NULL`,
		const ISlateStyle *	RequestingStyle = `nullptr`
	)		const

overridevirtual

Parameters

PropertyName	Name of the property to get
Specifier	An optional string to append to the property name

Returns: an FSlateBrush property.

Reimplemented from FSlateStyleSet.

◆ GetCleanName()

FName FSlateGameResources::GetCleanName ( const FName & AssetName ) const

protected

Takes paths from the Editor's "Copy Reference" button and turns them into paths accepted by this object.

Example: This: "SlateBrushAsset'/Game/UI/STeamAndHeroSelection/CS_Port_Brush.CS_Port_Brush'" into This: "/Game/UI/STeamAndHeroSelection/CS_Port_Brush"

◆ GetCurveFloat()

UCurveFloat * FSlateGameResources::GetCurveFloat ( const FName AssetName ) const

◆ GetCurveLinearColor()

UCurveLinearColor * FSlateGameResources::GetCurveLinearColor ( const FName AssetName ) const

◆ GetCurveVector()

UCurveVector * FSlateGameResources::GetCurveVector ( const FName AssetName ) const

◆ GetOptionalBrush()

const FSlateBrush * FSlateGameResources::GetOptionalBrush	(	const FName	PropertyName,
		const ANSICHAR *	Specifier = `NULL`,
		const FSlateBrush *const	DefaultBrush = `FStyleDefaults::GetNoBrush()`
	)		const

overridevirtual

Just like GetBrush, but returns DefaultBrush instead of the "missing brush" image when the resource is not found.

Parameters

PropertyName	Name of the property to get
Specifier	An optional string to append to the property name

Returns: an FSlateBrush property.

Reimplemented from FSlateStyleSet.

◆ GetReferencerName()

FString FSlateGameResources::GetReferencerName ( ) const

overrideprotectedvirtual

Overload this method to report a name for your referencer

Implements FGCObject.

◆ GetResources()

void FSlateGameResources::GetResources ( TArray< const FSlateBrush * > & OutResources ) const

overridevirtual

Populate an array of FSlateBrush with resources consumed by this style chunk.

Parameters

OutResources - the array to populate.

Reimplemented from FSlateStyleSet.

◆ GetWidgetStyleInternal()

const FSlateWidgetStyle * FSlateGameResources::GetWidgetStyleInternal	(	const FName	DesiredTypeName,
		const FName	StyleName,
		const FSlateWidgetStyle *	DefaultStyle,
		bool	bWarnIfNotFound
	)		const

overrideprotectedvirtual

Reimplemented from FSlateStyleSet.

◆ Initialize()

void FSlateGameResources::Initialize	(	const FString &	ScopeToDirectory,
		const FString &	InBasePath
	)

@See New()

◆ Log() [1/2]

void FSlateGameResources::Log ( const TSharedRef< class FTokenizedMessage > & Message ) const

protectedvirtual

◆ Log() [2/2]

void FSlateGameResources::Log	(	ISlateStyle::EStyleMessageSeverity	Severity,
		const FText &	Message
	)		const

overrideprotectedvirtual

Reimplemented from FSlateStyleSet.

◆ New()

TSharedRef< FSlateGameResources > FSlateGameResources::New	(	const FName &	InStyleSetName,
		const FString &	ScopeToDirectory,
		const FString &	InBasePath = `FString()`
	)

static

Create a new Slate resource set that is scoped to the ScopeToDirectory.

All paths will be formed as InBasePath + "/" + AssetPath. Lookups will be restricted to ScopeToDirectory. e.g. Resources.Initialize( "/Game/Widgets/SFortChest", "/Game/Widgets" ) Resources.GetBrush( "SFortChest/SomeBrush" ); // Will look up "/Game/Widgets" + "/" + "SFortChest/SomeBrush" = "/Game/Widgets/SFortChest/SomeBrush" Resources.GetBrush( "SSomeOtherWidget/SomeBrush" ); // Will fail because "/Game/Widgets/SSomeOtherWidget/SomeBrush" is outside directory to which we scoped.

◆ RemoveAsset()

void FSlateGameResources::RemoveAsset ( const FAssetData & InRemovedAssetData )

protected

Callback registered to the Asset Registry to be notified when an asset is removed.

◆ RemoveAssetFromCache()

void FSlateGameResources::RemoveAssetFromCache ( const FAssetData & AssetData )

protected

◆ SetContentRoot()

void FSlateGameResources::SetContentRoot ( const FString & InContentRootDir )

overridevirtual

Reimplemented from FSlateStyleSet.

◆ ShouldCache()

bool FSlateGameResources::ShouldCache ( const FAssetData & InAssetData )

protected

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

Engine/Source/Runtime/Engine/Public/Slate/SlateGameResources.h
Engine/Source/Runtime/Engine/Private/Slate/SlateGameResources.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ FSlateGameResources()

◆ ~FSlateGameResources()

Member Function Documentation

◆ AddAsset()

◆ AddAssetToCache()

◆ AddReferencedObjects()

◆ GenerateMapName() [1/2]

◆ GenerateMapName() [2/2]

◆ GetBrush()

◆ GetCleanName()

◆ GetCurveFloat()

◆ GetCurveLinearColor()

◆ GetCurveVector()

◆ GetOptionalBrush()

◆ GetReferencerName()

◆ GetResources()

◆ GetWidgetStyleInternal()

◆ Initialize()

◆ Log() [1/2]

◆ Log() [2/2]

◆ New()

◆ RemoveAsset()

◆ RemoveAssetFromCache()

◆ SetContentRoot()

◆ ShouldCache()