Navigation
API > API/Plugins > API/Plugins/AvalancheTransition
References
| Module | AvalancheTransition |
| Header | /Engine/Plugins/Experimental/Avalanche/Source/AvalancheTransition/Public/AvaTransitionScene.h |
| Include | #include "AvaTransitionScene.h" |
Syntax
USTRUCT ()
struct FAvaTransitionScene
Remarks
A Transition Scene is a representation of what is transitioning in or out. It's validity is bound to the validity of the scene owner because it does not own the data passed to it (i.e. it holds a data view), and so cannot be used without ensuring (through the scene owner) that the scene data is still valid It can be used to represent a page or, more directly, a level streaming object. For example, an implementation could look something like this:
USTRUCT() struct FSceneData {
... };
USTRUCT() struct FMyTransitionScene : public FAvaTransitionScene {
FMyTransitionScene(FSceneData* InData) : FAvaTransitionScene(InData) { }
virtual EAvaTransitionComparisonResult Compare(const FAvaTransitionScene& InOther) override
{
const FSceneData& MySceneData = GetDataView.Get
Constructors
| Type | Name | Description | |
|---|---|---|---|
FAvaTransitionScene
(
InStructType* InStruct |
|||
FAvaTransitionScene
(
FStateTreeDataView InDataView |
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| InExtensionType & | AddExtension () |
||
| EAvaTransitionComparisonResult | Compare
(
const FAvaTransitionScene& InOther |
Determines whether this Transition Scene is the same as another | |
| InExtensionType * | |||
| const FStateTreeDataView & | GetDataView () |
||
| ULevel * | GetLevel () |
Retrieves the underling Level of the Scene | |
| void | GetOverrideTransitionLayer
(
FAvaTagHandle& OutTransitionLayer |
Optional override of Transition Layer | |
| bool | HasAllFlags
(
EAvaTransitionSceneFlags InFlags |
||
| bool | HasAnyFlags
(
EAvaTransitionSceneFlags InFlags |
||
| void | Called when flags have been added / removed | ||
| void | SetFlags
(
EAvaTransitionSceneFlags InFlags |
||
| void | UpdateSceneDescription
(
FString& InOutDescription |
Optional override for the passed in Scene Description |