UAtomGameplayVolumeComponent Class Reference

#include <AtomGameplayVolumeComponent.h>

Inheritance diagram for UAtomGameplayVolumeComponent:

Public Member Functions
	UAtomGameplayVolumeComponent (const FObjectInitializer &ObjectInitializer)
virtual	~UAtomGameplayVolumeComponent ()=default
void	EnterProxy () const
void	ExitProxy () const
UAtomGameplayVolumeProxy *	GetProxy () const
void	OnComponentDataChanged ()
void	SetProxy (UAtomGameplayVolumeProxy *NewProxy)
Public Member Functions inherited from UAtomGameplayComponent
	UAtomGameplayComponent (const FObjectInitializer &ObjectInitializer)
virtual	~UAtomGameplayComponent ()=default
virtual void	Activate (bool bReset=false) override
virtual void	Deactivate () override
virtual void	EndPlay (const EEndPlayReason::Type EndPlayReason) override
virtual bool	HasPayloadType (PayloadFlags InType) const

Public Attributes
FOnAtomGameplayVolumeProxyStateChange	OnProxyEnter
FOnAtomGameplayVolumeProxyStateChange	OnProxyExit

Protected Member Functions
void	AddProxy () const
virtual void	Disable () override
virtual void	Enable () override
UAtomGameplayVolumeSubsystem *	GetSubsystem () const
virtual void	OnUnregister () override
void	RemoveProxy () const
void	UpdateProxy () const

Protected Attributes
TObjectPtr< UAtomGameplayVolumeProxy >	Proxy = nullptr
Protected Attributes inherited from UAtomGameplayComponent
PayloadFlags	PayloadType = PayloadFlags::AGCP_None

Additional Inherited Members
Public Types inherited from UAtomGameplayComponent
using	PayloadFlags = AtomGameplay::EComponentPayload

Detailed Description

UAtomGameplayVolumeComponent - Component used to drive interaction with AtomGameplayVolumeSubsystem. NOTE: Do not inherit from this class, use UAtomGameplayVolumeComponentBase or UAtomGameplayVolumeMutator to create extendable functionality

Constructor & Destructor Documentation

UAtomGameplayVolumeComponent()

UAtomGameplayVolumeComponent::UAtomGameplayVolumeComponent

(

const FObjectInitializer &

ObjectInitializer

)

~UAtomGameplayVolumeComponent()

virtual UAtomGameplayVolumeComponent::~UAtomGameplayVolumeComponent ( )

virtualdefault

Member Function Documentation

AddProxy()

void UAtomGameplayVolumeComponent::AddProxy ( ) const

protected

Disable()

void UAtomGameplayVolumeComponent::Disable ( )

overrideprotectedvirtual

Reimplemented from UAtomGameplayComponent.

Enable()

void UAtomGameplayVolumeComponent::Enable ( )

overrideprotectedvirtual

Reimplemented from UAtomGameplayComponent.

EnterProxy()

void UAtomGameplayVolumeComponent::EnterProxy

(

)

const

Called when the proxy is 'entered' - This is when the proxy goes from zero listeners to at least one.

ExitProxy()

void UAtomGameplayVolumeComponent::ExitProxy

(

)

const

Called when the proxy is 'exited' - This is when the proxy goes from at least one listeners to zero.

GetProxy()

UAtomGameplayVolumeProxy * UAtomGameplayVolumeComponent::GetProxy ( ) const

inline

GetSubsystem()

UAtomGameplayVolumeSubsystem * UAtomGameplayVolumeComponent::GetSubsystem ( ) const

protected

OnComponentDataChanged()

void UAtomGameplayVolumeComponent::OnComponentDataChanged

(

)

Called by a component on same actor to notify our proxy may need updating

OnUnregister()

void UAtomGameplayVolumeComponent::OnUnregister ( )

overrideprotectedvirtual

RemoveProxy()

void UAtomGameplayVolumeComponent::RemoveProxy ( ) const

protected

SetProxy()

void UAtomGameplayVolumeComponent::SetProxy

(

UAtomGameplayVolumeProxy *

NewProxy

)

UpdateProxy()

void UAtomGameplayVolumeComponent::UpdateProxy ( ) const

protected

Member Data Documentation

OnProxyEnter

FOnAtomGameplayVolumeProxyStateChange UAtomGameplayVolumeComponent::OnProxyEnter

Blueprint event for proxy enter

OnProxyExit

FOnAtomGameplayVolumeProxyStateChange UAtomGameplayVolumeComponent::OnProxyExit

Blueprint event for proxy exit

Proxy

TObjectPtr<UAtomGameplayVolumeProxy> UAtomGameplayVolumeComponent::Proxy = nullptr

protected

---

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

• C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Public/Atom/Gameplay/AtomGameplayVolumeComponent.h
• C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Private/Atom/Gameplay/AtomGameplayVolumeComponent.cpp