FLightWeightInstanceSubsystem

Choose your operating system:

Windows

macOS

Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/GameFramework/LightWeightInstanceSubsystem.h

Include

#include "GameFramework/LightWeightInstanceSubsystem.h"

Syntax

struct FLightWeightInstanceSubsystem

Constructors

Destructors

Functions

Name Description

Public function

FActorInstan...

 

CreateNewLightWeightInstance

(
    UClass* ActorClass,
    FLWIData* InitData,
    UDataLayer* Layer,
    UWorld* World
)

Returns a handle to a new light weight instance that represents an object of type ActorClass.

Public function

void

 

DeleteInstance

(
    const FActorInstanceHandle& Handle
)

Deletes the instance identified by Handle

Public function

AActor *

 

FetchActor

(
    const FActorInstanceHandle& Handle
)

Returns the actor specified by Handle. This may require loading and creating the actor object.

Public function

I *

 

FetchInterfaceObject

(
    const FActorInstanceHandle& Handle
)

Returns an object that implements the interface I for Handle.

Protected function

UClass *

 

FindBestInstanceManagerClass

(
    const UClass* ActorClass
)

Returns the class of the instance manager best suited to support instances of type ActorClass.

Public function Const

ALightWeight...

 

FindLightWeightInstanceManager

(
    const FActorInstanceHandle& Handle
)

Returns the instance manager that handles the given handle.

Public function Const

ALightWeight...

 

FindLightWeightInstanceManager

(
    UClass* ActorClass,
    const UDataLayer* Layer
)

Returns the instance manager that handles actors of type ActorClass in level Level.

Public function

ALightWeight...

 

FindOrAddLightWeightInstanceManager

(
    UClass* ActorClass,
    const UDataLayer* Layer,
    UWorld* World
)

Returns the instance manager that handles instances of type Class that live in Level.

Public function Static

FLightWeight...

 

Get()

Public function Const

AActor *

 

GetActor_NoCreate

(
    const FActorInstanceHandle& Handle
)

Returns the actor specified by Handle if it exists. Returns nullptr if it doesn't.

Public function

UClass *

 

GetActorClass

(
    const FActorInstanceHandle& Handle
)

Returns the class of the actor specified by Handle.

Public function

ULevel *

 

GetLevel

(
    const FActorInstanceHandle& Handle
)

Public function

FVector

 

GetLocation

(
    const FActorInstanceHandle& Handle
)

Protected function Const

const ALight...

 

GetManagerAt

(
    int32 Index
)

Returns the light weight instance manager at index Index.

Protected function Const

int32

 

GetManagerIndex

(
    const ALightWeightInstanceManager&...
)

Returns the index associated with Manager.

Public function

FString

 

GetName

(
    const FActorInstanceHandle& Handle
)

Public function

bool

 

IsInLevel

(
    const FActorInstanceHandle& Handle,
    const ULevel* InLevel
)

Returns true if the object represented by Handle is in InLevel.

Public function Const

bool

 

IsInterfaceSupported

(
    const FActorInstanceHandle& Handle
)

Returns true if the handle can return an object that implements the interface U.

Constants

Name

Description

GetFunctionCS

LWISubsystem

Application singleton