LockOnTargetInterface.h

Go to the documentation of this file.

// Copyright Blue Isle Studios Inc 2018. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "ProjectX.h"
#include "UObject/Interface.h"
#include "LockOnTargetInterface.generated.h"
 
class UWeaponInstance;
class AProjectile;
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FPawnLockOnSignature, UWeaponInstance*, WeaponLocking);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FPawnImminentMissileWarningSignature, AActor*, EventInstigator);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FPawnIncomingProjectileSignature, AProjectile*, IncomingProjectile);
 
UINTERFACE(meta = (CannotImplementInterfaceInBlueprint))
class ULockOnTargetInterface : public UInterface
{
    GENERATED_UINTERFACE_BODY()
};
 
class PROJECTX_API ILockOnTargetInterface
{
    GENERATED_IINTERFACE_BODY()
 
public:
    FPawnLockOnSignature PawnInterfaceLockOn;
    FPawnImminentMissileWarningSignature OnImminentMissileWarning;
    FPawnIncomingProjectileSignature PawnInterfaceIncomingProjectile;
 
    /* Returns true if this actor can be targeted by Lock-on weapons */
    UFUNCTION(BlueprintCallable, Category = LockOnTargetInterface)
    virtual bool CanBeLockedOn(const AActor* LockInstigator) const { return true; }
    /* Returns true if this actor is generating a signature that the HomingProjectile can read. Counter-measures may inhibit this and invalidate incoming homing projectiles */
    UFUNCTION(BlueprintCallable, Category = LockOnTargetInterface)
    virtual bool CanHomingReadSignature(const AProjectile* HomingProjectile) const { return true; }
    UFUNCTION(BlueprintCallable, Category = LockOnTargetInterface)
    virtual void IssueImminentMissileWarning(bool bToggleWarning, AActor* WarningIntigator);
 
    /*Returns the Screen percentage that this actor is required to have to be considered for Locking-onto.
    If any of the axis values are bigger than GetLockOnScreenPercentage values this actor will be considered as a candidate
    to be locked into. A value of FVector2D(0,0) will by default be ignored by weapons when deciding the locking-into actors */
    UFUNCTION(BlueprintCallable, Category = LockOnTargetInterface)
    virtual FVector2D GetLockOnScreenPercentage() {return FVector2D::ZeroVector;}
 
    /*Returns the max distance this actor will be used when considered for locking-into. This means that if 
    we scan for a 20km target but this actor has a max distance of 100m if this actor is further away than 
    100m it won't be considered as a candidate actor during the target-finding.
    A returned value of 0 is by default ignored by the systems */
    UFUNCTION(BlueprintCallable, Category = LockOnTargetInterface)
    virtual float GetLockOnMaxDistance(){ return .0f;}
 
    /* Returns the delegate to bind events to when this actor is being scanned to be locked onto */
    UFUNCTION(Category = "LockOnTargetInterface Events")
    virtual FPawnLockOnSignature& GetLockOnTentativeStartDelegate() { return PawnInterfaceLockOn; }
    /* Returns the delegate to bind events to when this actor stops being scanned to be locked onto */
    UFUNCTION(Category = "LockOnTargetInterface Events")
    virtual FPawnLockOnSignature& GetLockOnTentativeEndDelegate() { return PawnInterfaceLockOn; }
    /* Returns the delegate to bind events to when this actor gets locked onto */
    UFUNCTION(Category = "LockOnTargetInterface Events")
    virtual FPawnLockOnSignature& GetLockOnStartDelegate() {return PawnInterfaceLockOn;}
    /* Returns the delegate to bind events to when this actor stops being locked onto */
    UFUNCTION(Category = "LockOnTargetInterface Events")
    virtual FPawnLockOnSignature& GetLockOnEndDelegate() { return PawnInterfaceLockOn; }
    /* Returns the delegate to bind events to when this actor gets locked onto */
    UFUNCTION(Category = "LockOnTargetInterface Events")
    virtual FPawnIncomingProjectileSignature& GetIncomingProjectileStartDelegate() { return PawnInterfaceIncomingProjectile; }
    /* Returns the delegate to bind events to when this actor gets locked onto */
    UFUNCTION(Category = "LockOnTargetInterface Events")
    virtual FPawnIncomingProjectileSignature& GetIncomingProjectileEndDelegate() { return PawnInterfaceIncomingProjectile; }
    UFUNCTION(Category = "LockOnTargetInterface Events")
    virtual FPawnImminentMissileWarningSignature& GetImminentMissileWarningStartDelegate() { return OnImminentMissileWarning; }
    UFUNCTION(Category = "LockOnTargetInterface Events")
    virtual FPawnImminentMissileWarningSignature& GetImminentMissileWarningEndDelegate() { return OnImminentMissileWarning; }
};