UGameFeaturesProjectPolicies

This class allows project-specific rules to be implemented for game feature plugins.

API > API/Plugins > API/Plugins/GameFeatures

Inheritance Hierarchy

References

   
Module GameFeatures
Header /Engine/Plugins/Runtime/GameFeatures/Source/GameFeatures/Public/GameFeaturesProjectPolicies.h
Include #include "GameFeaturesProjectPolicies.h"

Syntax

UCLASS ()  
class UGameFeaturesProjectPolicies : public UObject

Remarks

This class allows project-specific rules to be implemented for game feature plugins. Create a subclass and choose it in Project Settings .. Game Features

Functions

  Type Name Description
Public function Virtual void

ExplicitLoadGameFeaturePlugin ( const FString& PluginURL,
const FGameFeaturePluginLoadComplete& CompleteDelegate,
const bool bActivateGameFeatures
)

 Called by code that explicitly wants to load a specific plugin (e.g., when using a fast cook a game might want to allow explicitly loaded game feature plugins)
Public function Virtual Const void

GetGameFeatureLoadingMode ( bool& bLoadClientData,
bool& bLoadServerData
)

 Called to determine if this should be treated as a client, server, or both for data preloading Actions can use this to decide what to load at runtime
Public function Virtual Const bool

GetGameFeaturePluginURL ( const TSharedRef< IPlugin >& Plugin,
FString& OutPluginURL
)

 Called to determine the plugin URL for a given known Plugin. Can be used if the policy wants to deliver non file based URLs.
Public function Virtual Const TArray< FPrimaryAssetId >

GetPreloadAssetListForGameFeature ( const UGameFeatureData* GameFeatureToLoad,
bool bIncludeLoadedAssets
)

 Called when a game feature plugin enters the Loading state to determine additional assets to load.
Public function Virtual Const const TArray< FName > Returns the bundle state to use for assets returned by GetPreloadAssetListForGameFeature() See the Asset Manager documentation for more information about asset bundles
Public function Virtual Const TValueOrError< TArray< FName >, FString > Called to resolve install bundles for streaming asset dependencies.
Public function Virtual void Called when the game feature manager is initialized.
Public function Virtual Const bool

IsPluginAllowed ( const FString& PluginURL
)

 Called to determine if a plugin is allowed to be loaded or not (e.g., when doing a fast cook a game might want to disable some or all game feature plugins)
Public function Virtual Const TValueOrError< FString, FString >

ResolvePluginDependency ( const FString& PluginURL,
const FString& DependencyName
)

 Called to resolve plugin dependencies, will successfully return an empty string if a dependency is not a GFP.
Public function Virtual void Called when the game feature manager is shut down.
Public function Virtual Const bool

WillPluginBeCooked ( const FString& PluginFilename,
const FGameFeaturePluginDetails& PluginDetails
)

 Called to determined the expected state of a plugin under the WhenLoading conditions.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page