LEAP Documentation 40220
Documentation for the LEAP project
AFlagSpawn Class Reference

#include <FlagSpawn.h>

Inheritance diagram for AFlagSpawn:
IReactsToMatchEvents ITeamInterface ISpawnTargetInterface ITrackableInterface ATransportObjectiveSpawnPoint

Public Member Functions

virtual FORCEINLINE int32 GetTeam () const override
 
virtual int32 SetTeam (int32 NewTeam) override
 
AFlagGetFlag () const
 
bool IsFlagHome () const
 
void ResetFlag (AFlag *FlagReset, AProjectXCharacter *Character, int32 FlagTeam)
 
void UpdateBehaviour (EFlagSpawnBehaviour NewSpawnBehaviour)
 
virtual bool CanSpawnPlayer (const AProjectXPlayerState *Instigator) const override
 
virtual float GetSpawnScoreForInstigator (const AActor *const QueryInstigator, FVector &TargetLocation, bool bUseDistanceToTargetLocation=false) const override
 
virtual TSoftObjectPtr< UTexture2D > GetRadarIcon () const override
 
virtual float GetRadarIconOpacity () const
 
virtual void SetRadarIconOpacity (float Opacity) override
 
virtual bool CanFlagBeCaptured () const
 
virtual bool CanFlagBeSpawned () const
 
- Public Member Functions inherited from IReactsToMatchEvents
void OnMatchStarted ()
 
virtual void MatchStarted ()
 
void OnMatchEnded ()
 
virtual void MatchEnded ()
 
virtual int32 GetTeam () const
 
virtual int32 SetTeam (int32 NewTeam)
 
- Public Member Functions inherited from ISpawnTargetInterface
virtual void RegisterActorForScoring ()
 
virtual void DeRegisterActorForScoring ()
 
virtual bool CanSpawnPlayer (const AProjectXPlayerState *Instigator) const
 
virtual bool GetSpawnLocation (AProjectXPlayerState *Instigator, FTransform &Transform) const
 
virtual float GetSpawnScoreForInstigator (const AActor *const QueryInstigator, FVector &TargetLocation, bool bUseDistanceToTargetLocation=false) const
 
virtual bool GetCanSpawnOnCombatTarget () const
 
virtual void UpdateCanSpawnOnCombatTarget (bool bNewInCombatSpawnTarget)
 
virtual bool ShouldRegisterForScoringOnStart () const
 
- Public Member Functions inherited from ITrackableInterface
virtual void BroadcastTrackableActor ()
 
virtual FStopTrackingActorSignature & GetStopTrackingEvent ()
 
virtual TSoftObjectPtr< UTexture2D > GetMapIcon () const
 
virtual TSoftObjectPtr< UTexture2D > GetRadarIcon () const
 
virtual TSoftObjectPtr< UTexture2D > GetHudIcon () const
 
virtual AActor * GetTrackableInterfaceActor ()
 
virtual float GetRadarIconSize () const
 
virtual float GetRadarIconOpacity () const
 
virtual float GetRadarIconEnemyOpacity () const
 
virtual bool GetRadarIconCompensantesRotation () const
 
virtual bool GetAllyVisibilityResponse ()
 
virtual const FText & GetRadarLabel () const
 
virtual void SetRadarIconOpacity (float Opacity)
 
virtual bool IsCloaked () const
 
virtual bool RegisterOnStart () const
 

Public Attributes

FFlagSpawnEventSignature OnFlagUpdatedEvent
 
FFlagCarrierEventSignature OnFlagCapturedEvent
 
FFlagStateUpdatedEventSignature OnFlagStateUpdatedEvent
 

Protected Member Functions

virtual void BeginPlay () override
 
virtual void CollectPlayerStartList ()
 
AFlagSpawnFlag ()
 
virtual bool GetSpawnLocation (AProjectXPlayerState *Instigator, FTransform &Transform) const override
 
virtual AActor * GetPlayerStart (class AController *Player) const
 
virtual AActor * GetTrackableInterfaceActor () override
 
void OnFlagReset ()
 
virtual void OnFlagPickedUp (AFlag *FlagPickedUp, AProjectXCharacter *Character, int32 FlagTeam)
 
void OnRep_Flag ()
 
void OnRep_FlagState ()
 
virtual void OnOverlap (UPrimitiveComponent *OverlappedComponent, AActor *OtherActor, UPrimitiveComponent *OtherComp, int32 OtherBodyIndex, bool bFromSweep, const FHitResult &SweepResult)
 
void Multicast_OnFlagCaptured ()
 
void OnFlagCaptured ()
 

Protected Attributes

TArray< AActor * > PlayerStartList
 
bool bFlagIsHome = false
 
AFlagFlag
 
TSoftObjectPtr< UTexture2D > RadarIcon = nullptr
 
float RadarIconOpacity = 0.3f
 
float FlagSpawnDistanceScoringWeight = 10000.f
 
TSubclassOf< AFlagFlagClass
 
TArray< class AStartPointVolume * > StartPointVolumes
 
int32 Team = MAX_uint8
 
USphereComponent * Sphere
 
bool bDoesFlagResetIfCaptured = true
 
bool bCanFlagBeCapturedWhenNotHome = false
 
EFlagSpawnBehaviour FlagBehaviour = EFlagSpawnBehaviour::Both
 

Additional Inherited Members

- Static Public Member Functions inherited from ITeamInterface
static bool IsValidTeam (const ITeamInterface *const TeamInferface)
 
- Static Public Member Functions inherited from ISpawnTargetInterface
static const void GetAverageEnemyTeamLocation (const UObject *Caller, TArray< AActor * > &AvailableSpawnPoints, FVector &AverageEnemyLocation)
 
static AActor * GetFurthestLocationFromOtherPlayers (const UObject *Caller, TArray< AActor * > &AvailableSpawnPoints)
 
static AActor * GetRandomSafeSpawnLocation (const UObject *Caller, TArray< AActor * > &AvailableSpawnPoints, float MaximumSpawnDistance, float MinimumSpawnDistance)
 

Member Function Documentation

◆ BeginPlay()

void AFlagSpawn::BeginPlay ( )
overrideprotectedvirtual

◆ CanFlagBeCaptured()

bool AFlagSpawn::CanFlagBeCaptured ( ) const
virtual

◆ CanFlagBeSpawned()

bool AFlagSpawn::CanFlagBeSpawned ( ) const
virtual

◆ CanSpawnPlayer()

bool AFlagSpawn::CanSpawnPlayer ( const AProjectXPlayerState Instigator) const
overridevirtual

Reimplemented from ISpawnTargetInterface.

Reimplemented in ATransportObjectiveSpawnPoint.

◆ CollectPlayerStartList()

void AFlagSpawn::CollectPlayerStartList ( )
protectedvirtual

Reimplemented in ATransportObjectiveSpawnPoint.

◆ GetFlag()

AFlag * AFlagSpawn::GetFlag ( ) const
inline

◆ GetPlayerStart()

AActor * AFlagSpawn::GetPlayerStart ( class AController *  Player) const
protectedvirtual

◆ GetRadarIcon()

virtual TSoftObjectPtr< UTexture2D > AFlagSpawn::GetRadarIcon ( ) const
inlineoverridevirtual

Reimplemented from ITrackableInterface.

◆ GetRadarIconOpacity()

virtual float AFlagSpawn::GetRadarIconOpacity ( ) const
inlinevirtual

Reimplemented from ITrackableInterface.

◆ GetSpawnLocation()

bool AFlagSpawn::GetSpawnLocation ( AProjectXPlayerState Instigator,
FTransform &  Transform 
) const
overrideprotectedvirtual

Reimplemented from ISpawnTargetInterface.

◆ GetSpawnScoreForInstigator()

float AFlagSpawn::GetSpawnScoreForInstigator ( const AActor *const  QueryInstigator,
FVector &  TargetLocation,
bool  bUseDistanceToTargetLocation = false 
) const
overridevirtual

Reimplemented from ISpawnTargetInterface.

Reimplemented in ATransportObjectiveSpawnPoint.

◆ GetTeam()

virtual FORCEINLINE int32 AFlagSpawn::GetTeam ( ) const
inlineoverridevirtual

Reimplemented from ITeamInterface.

◆ GetTrackableInterfaceActor()

virtual AActor * AFlagSpawn::GetTrackableInterfaceActor ( )
inlineoverrideprotectedvirtual

Reimplemented from ITrackableInterface.

◆ IsFlagHome()

bool AFlagSpawn::IsFlagHome ( ) const
inline

◆ Multicast_OnFlagCaptured()

void AFlagSpawn::Multicast_OnFlagCaptured ( )
protected

◆ OnFlagCaptured()

void AFlagSpawn::OnFlagCaptured ( )
protected

◆ OnFlagPickedUp()

void AFlagSpawn::OnFlagPickedUp ( AFlag FlagPickedUp,
AProjectXCharacter Character,
int32  FlagTeam 
)
protectedvirtual

Reimplemented in ATransportObjectiveSpawnPoint.

◆ OnFlagReset()

void AFlagSpawn::OnFlagReset ( )
protected

◆ OnOverlap()

void AFlagSpawn::OnOverlap ( UPrimitiveComponent *  OverlappedComponent,
AActor *  OtherActor,
UPrimitiveComponent *  OtherComp,
int32  OtherBodyIndex,
bool  bFromSweep,
const FHitResult &  SweepResult 
)
protectedvirtual

Reimplemented in ATransportObjectiveSpawnPoint.

◆ OnRep_Flag()

void AFlagSpawn::OnRep_Flag ( )
protected

◆ OnRep_FlagState()

void AFlagSpawn::OnRep_FlagState ( )
protected

◆ ResetFlag()

void AFlagSpawn::ResetFlag ( AFlag FlagReset,
AProjectXCharacter Character,
int32  FlagTeam 
)

◆ SetRadarIconOpacity()

virtual void AFlagSpawn::SetRadarIconOpacity ( float  Opacity)
inlineoverridevirtual

Reimplemented from ITrackableInterface.

◆ SetTeam()

virtual int32 AFlagSpawn::SetTeam ( int32  NewTeam)
inlineoverridevirtual

Reimplemented from ITeamInterface.

◆ SpawnFlag()

AFlag * AFlagSpawn::SpawnFlag ( )
protected

◆ UpdateBehaviour()

void AFlagSpawn::UpdateBehaviour ( EFlagSpawnBehaviour  NewSpawnBehaviour)
inline

Member Data Documentation

◆ bCanFlagBeCapturedWhenNotHome

bool AFlagSpawn::bCanFlagBeCapturedWhenNotHome = false
protected

◆ bDoesFlagResetIfCaptured

bool AFlagSpawn::bDoesFlagResetIfCaptured = true
protected

◆ bFlagIsHome

bool AFlagSpawn::bFlagIsHome = false
protected

◆ Flag

AFlag* AFlagSpawn::Flag
protected

◆ FlagBehaviour

EFlagSpawnBehaviour AFlagSpawn::FlagBehaviour = EFlagSpawnBehaviour::Both
protected

◆ FlagClass

TSubclassOf<AFlag> AFlagSpawn::FlagClass
protected

◆ FlagSpawnDistanceScoringWeight

float AFlagSpawn::FlagSpawnDistanceScoringWeight = 10000.f
protected

◆ OnFlagCapturedEvent

FFlagCarrierEventSignature AFlagSpawn::OnFlagCapturedEvent

◆ OnFlagStateUpdatedEvent

FFlagStateUpdatedEventSignature AFlagSpawn::OnFlagStateUpdatedEvent

◆ OnFlagUpdatedEvent

FFlagSpawnEventSignature AFlagSpawn::OnFlagUpdatedEvent

◆ PlayerStartList

TArray<AActor*> AFlagSpawn::PlayerStartList
protected

◆ RadarIcon

TSoftObjectPtr<UTexture2D> AFlagSpawn::RadarIcon = nullptr
protected

◆ RadarIconOpacity

float AFlagSpawn::RadarIconOpacity = 0.3f
protected

◆ Sphere

USphereComponent* AFlagSpawn::Sphere
protected

◆ StartPointVolumes

TArray<class AStartPointVolume*> AFlagSpawn::StartPointVolumes
protected

◆ Team

int32 AFlagSpawn::Team = MAX_uint8
protected

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