VehicleSeatComponent.h

Go to the documentation of this file.

// Copyright Blue Isle Studios Inc 2018. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Components/ActorComponent.h"
#include "WeaponComponent.h"
#include "VehicleSeatComponent.generated.h"
 
class AProjectXCharacter;
class AProjectXVehicle;
class UWeaponInstanceVehicle;
class UAfflictionInstance;
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOccupantChangedSignature, class UVehicleSeatComponent*, Seat, class AProjectXCharacter*, PreviousOccupant);
 
UCLASS(Blueprintable, ClassGroup = (Custom), HideCategories = (ComponentTick, Collision, Tags, Variable, Activation, ComponentReplication, Cooking), meta = (BlueprintSpawnableComponent))
class PROJECTX_API UVehicleSeatComponent : public UActorComponent
{
    GENERATED_UCLASS_BODY()
    
public:
 
    UFUNCTION(BlueprintCallable, Category = Seat)
    FORCEINLINE bool IsDriverSeat() const { return bDriverSeat; }
    UFUNCTION(BlueprintCallable, Category = Seat)
    FORCEINLINE FName GetSeatName() const { return SeatName; }
    FORCEINLINE void SetSeatName(const FName NewName) { SeatName = NewName; }
    UFUNCTION(BlueprintCallable, Category = Seat)
    FORCEINLINE AProjectXVehicle* GetVehicle() const { return VehicleOwner; }
    UFUNCTION(BlueprintCallable, Category = Seat)
    FORCEINLINE AProjectXCharacter* GetOccupant() const { return Occupant.Get(); }
    UFUNCTION(BlueprintCallable, Category = Seat)
    float GetDistanceFromPlayer(const AProjectXCharacter* Character) const;
    UFUNCTION(Category = Seat)
    bool GetUseCharacterBoundsWhenVisible() const { return bUseCharacterMeshBoundsWhenVisible;}
    UFUNCTION(BlueprintCallable, Category = Seat)
    FORCEINLINE bool ShouldOccupantBeHidden() const { return bHideOccupant; }
    UFUNCTION(BlueprintCallable, Category = Seat)
    void ToggleSeatAttachment(const bool bNewToggle) {bIsAttachedToSeat = bNewToggle;}
    UFUNCTION(BlueprintCallable, Category = Seat)
    void SetManualSeatOffset(const FVector NewOffset) { CurrentSeatOffset = NewOffset; }
    UFUNCTION(BlueprintCallable, Category = Seat)
    void ResetSeatOffset() { CurrentSeatOffset = SeatOffset; }
    UFUNCTION(BlueprintCallable, Category = Seat)
    virtual FTransform GetSeatTransform() const;
    UFUNCTION(BlueprintCallable, Category = Seat)
    virtual FVector GetSeatLocation() const;
    UFUNCTION(BlueprintCallable, Category = Seat)
    virtual FRotator GetSeatRotation() const;
    UFUNCTION(BlueprintCallable, Category = Seat)
    virtual FRotator GetLookDirection() const;
 
    UFUNCTION(BlueprintCallable, Category = Seat)
    virtual FTransform GetExitTransform() const;
 
    UFUNCTION(BlueprintCallable, Category = Seat)
    virtual bool CanEnterSeat(const AProjectXCharacter* Character) const;
    UFUNCTION(BlueprintCallable, Category = Seat)
    virtual bool HasOccupant() const;
 
public:
    virtual void BeginPlay() override;
    virtual void TickComponent(float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction *ThisTickFunction) override;
    
    UFUNCTION()
    virtual void TickOccupant(float DeltaTime);
 
    UFUNCTION()
    virtual bool EnterSeat(AProjectXCharacter* Character);
    UFUNCTION()
    virtual bool LeaveSeat(bool bForced = false, bool bEject = false);
 
    UFUNCTION()
    virtual void TickWeapon(float DeltaTime);
 
    UFUNCTION(BlueprintCallable, Category = Seat)
    virtual UWeaponComponent* GetWeaponComponent() const;
 
    bool GetProjectileTransform(FTransform& Transform);
 
public:
    UPROPERTY(BlueprintAssignable, Category = Seat)
    FOccupantChangedSignature OnOccupantChangedSignature;
 
protected:
    UFUNCTION()
    virtual void OnRep_Occupant();
 
    void UpdateOccupantWeapons(AProjectXCharacter* Character);
    void RemoveInvalidAfflictions(AProjectXCharacter* Character);
    void ToggleSeatAfflictions(AProjectXCharacter* Character, bool bEnterSeat);
 
 
protected:
 
    UPROPERTY()
    AProjectXVehicle* VehicleOwner = NULL;
 
    UPROPERTY(ReplicatedUsing = OnRep_Occupant)
    TWeakObjectPtr<AProjectXCharacter> Occupant = NULL;
    UPROPERTY()
    TWeakObjectPtr<AProjectXCharacter> PreviousOccupant = NULL;
 
    UPROPERTY(EditDefaultsOnly, Category = Seat)
    bool bDriverSeat = false;
 
    /* Name of the seat to be displayed in the UI */
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = Seat, meta = (AllowPrivateAccess = true))
    FName SeatName = NAME_None;
    UPROPERTY(EditDefaultsOnly, Category = Seat)
    FName SeatSocket = NAME_None;
    /* If the Seat socket name should be searched on the parent vehicle instead (Subvehicles) */
    UPROPERTY(EditDefaultsOnly, Category = Seat)
    bool bUseSocketFromParentVehicle = false;
    UPROPERTY(EditDefaultsOnly, Category = Seat)
    FVector SeatOffset = FVector(0);
    UPROPERTY(EditDefaultsOnly, Category = Seat)
    FRotator SeatRotation = FRotator(0);
    /* Third person Animation Instance for the occupant of this seat - Will be overridden if the seat has a weapon with a custom instance */
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Seat|Animation|Third Person")
    TSubclassOf<UAnimInstance> AnimationClass3P;
    /* If this is true, the relative location to the seat will be stored when the player enters it and the same location will be used when exiting the vehicle */
    UPROPERTY(EditDefaultsOnly, Category = Seat)
    bool bUseEnterLocationAsExitLocation = true;
    /*position offset when exiting the vehicle*/
    UPROPERTY(EditDefaultsOnly, Category = Seat)
    FVector ExitOffset = FVector(0, 0, 160);
    /* Vertical force applied when ejecting*/
    UPROPERTY(EditDefaultsOnly, Category = Seat)
    FVector EjectLaunchVelocity = FVector::ZeroVector;
    /*How much of the vehicles velocity is carried over when exiting*/
    UPROPERTY(EditDefaultsOnly, Category = Seat)
    float LaunchVelocityExchangeRate = 1.0f;
    /*Weapon Class used by this seat*/
    UPROPERTY(EditDefaultsOnly, Category = Seat)
    TArray<TSubclassOf<UWeaponInstanceVehicle>> WeaponClasses;
    /*Socket that projectiles are spawned at*/
    UPROPERTY(EditDefaultsOnly, Category = Seat)
    FName ProjectileSocket = NAME_None;
    /*Socket used to rotate the weapon*/
    UPROPERTY(EditDefaultsOnly, Category = Seat)
    FName MeshRotationSocket = NAME_None;
    /*Should the occpuant be hidden while in the seat*/
    UPROPERTY(EditDefaultsOnly, Category = Seat)
    bool bHideOccupant = false;
    /*If the occupant isn't hidden, should we use the character's mesh bounds instead? Some vehicle animations might move the character mesh too far away from the root where its capsule is, toggling this on would mean that instead of using the capsule the mesh will dictate its bounds instead. This should fix some issues with characters being culled from drastic angles in exchange of a performance cost */
    UPROPERTY(EditDefaultsOnly, Category = Seat , meta = (EditCondition = "!bHideOccupant"))
    bool bUseCharacterMeshBoundsWhenVisible = false;
    /* Affliction to apply while in the seat*/
    UPROPERTY(EditDefaultsOnly, Category = Seat)
    TArray<TSubclassOf<UAfflictionInstance>> InvalidSeatAfflictions;
    /* Affliction to apply while in the seat*/
    UPROPERTY(EditDefaultsOnly, Category = Seat)
    TArray<TSubclassOf<UAfflictionInstance>> SeatOccupantAfflictions;
    UPROPERTY()
    bool bOnlyTickWhenOccupied = true;
 
private:
    bool bIsAttachedToSeat = true;
    float OccupantEntranceTime;
    FVector CurrentSeatOffset = FVector::ZeroVector;
    FVector CachedRelativeEntryLocation = FVector::ZeroVector;
};