1. Epic GamesDeveloper
  3. UAvaGameInstance

UAvaGameInstance

API > API/Plugins > API/Plugins/Avalanche > API/Plugins/Avalanche/Framework

Inheritance Hierarchy

References

   
Module Avalanche
Header /Engine/Plugins/Experimental/Avalanche/Source/Avalanche/Public/Framework/AvaGameInstance.h
Include #include "Framework/AvaGameInstance.h"

Syntax

UCLASS (DisplayName="Motion Design Game Instance")  
class UAvaGameInstance : public UGameInstance

Variables

  Type Name Description
Protected variable bool bIsRenderTargetReady  
Protected variable bool bIsTicking Tick reentrancy guard.
Protected variable bool bRequestEndPlayWorld  
Protected variable bool bRequestUnloadWorld  
Protected variable bool bWorldCreated  
Protected variable bool bWorldPlaying  
Protected variable FDelegateHandle EnginePreExitHandle Handle to delegate for EnginePreExit event.
Protected variable double LastDeltaSeconds  
Protected variable FName PlayingChannelName Channel this game instance is playing on.
Protected variable UProperty Transient TObjectPtr< UWorld > PlayWorld  
Protected variable TUniquePtr< FRenderCommandFence > RenderTargetFence Render command fence to ensure the render target has been rendered.
Protected variable TSharedPtr< FSceneViewport > Viewport  
Protected variable UProperty Transient TObjectPtr< UAvaGameViewportClient > ViewportClient  

Functions

  Type Name Description
Public function bool

BeginPlayWorld ( const FAvaInstancePlaySettings& InWorldPlaySettings
)

  
Public function void Cancel any pending EndPlayWorld or UnloadWorld requests.
Public function Static UAvaGameInstance *

Create ( UObject* InOuter
)

 Creates a new Motion Design Game instance from the given Motion Design Template Asset.
Public function bool Create the game world
Protected function void  
Public function Const UAvaGameViewportClient * Get the currently playing game viewport client.
Public function Static FOnAvaGameInstanceEvent & Event called on EndPlayWorld().
Public function Static FOnAvaGameInstanceEvent & Event called when the render target becomes ready.
Public function Const UWorld *  
Public function Const UTextureRenderTarget2D *  
Public function Const TSharedPtr< FSceneViewport > Get the currently playing scene viewport.
Public function Const bool Returns true if the render target has been rendered and is ready to be used for output.
Public function Const bool  
Public function Const bool  
Protected function void  
Protected function void  
Public function void

RequestEndPlayWorld ( bool bForceImmediate
)

 The end play is normally requested to be done on the next Tick().
Public function void

RequestUnloadWorld ( bool bForceImmediate
)

  
Public function void Reset the flag so the OnRenderTargetReady event can be called again on the next render.
Protected function void

Tick ( float DeltaSeconds
)

  
Protected function void  
Public function void  
Public function void

UpdateSceneViewportSize ( const FIntPoint& InViewportSize
)

 The output channels can be resized during playback, if this happens, the scene viewport needs to be updated to reflect the change.

Overridden from UObject

  Type Name Description
Protected function Virtual void Called before destroying the object.

Typedefs

Name Description
FOnAvaGameInstanceEvent  

Constants

Name Description
OnEndPlay  
OnRenderTargetReady  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page