AALSPlayerController Class Reference

#include <ALSPlayerController.h>

Inheritance diagram for AALSPlayerController:

Public Member Functions
virtual void	OnPossess (APawn *NewPawn) override
virtual void	OnRep_Pawn () override
virtual void	SetupInputComponent () override
virtual void	BindActions (UInputMappingContext *Context) override
Public Member Functions inherited from APlayerControllerBase
virtual void	GetAudioListenerPosition (FVector &OutLocation, FVector &OutFrontDir, FVector &OutRightDir) const override
virtual bool	SetPlayerLookInverted (const bool bInvert=true) override
virtual bool	SetPlayerLookHorizontalInverted (const bool bInvert=true) override
virtual float	SetCameraSensitivity (const float NewValue) override
virtual float	SetCameraHorizontalSensitivity (const float NewValue) override
virtual float	SetCameraVerticalSensitivity (const float NewValue) override
virtual void	SetCameraAimedSensitivityMultiplier (const float NewValue) override
virtual void	SetCameraUseSeparateAxisSensitivity (const bool bValue) override
virtual void	SetAimAssistLevel (const int32 Value) override
virtual void	SetPlayerUsingController (const bool bValue) override
virtual bool	GetPlayerUsingController () override
virtual bool	SaveCurrentPlayerOptions (const FAudioPlayerOptions AudioSettings) override
virtual float	GetCameraSensitivity () const override
virtual float	GetCameraAimedSensitivityMultiplier () const override
virtual float	GetCameraHorizontalSensitivity () const override
virtual float	GetCameraVerticalSensitivity () const override
virtual bool	GetCameraUseSeparateAxisSensitivity () const override
virtual bool	GetPlayerLookInverted () const override
virtual bool	GetPlayerHorizontalInverted () const override
virtual int32	GetAimAssistLevel () const override
virtual FAudioPlayerOptions	GetPlayerAudioSettings () const override
virtual bool	RegisterLayer (const FGameplayTag LayerName, UUserWidget *LayerWidget) override
virtual UUserWidget *	PushContentToLayer (const FGameplayTag LayerName, const TSoftClassPtr< UUserWidget > WidgetClass) override
virtual bool	PopContentFromLayer (const FGameplayTag LayerName) override
virtual bool	ClearLayer (const FGameplayTag LayerName) override
virtual bool	ToggleWidget (const FGameplayTag LayerName, UUserWidget *Widget) override
virtual UUserWidget *	AddWidgetToLayer (const FGameplayTag LayerName, const TSoftClassPtr< UUserWidget > WidgetClass) override
virtual UUserWidget *	GetContentFromLayer (const FGameplayTag LayerName, const TSoftClassPtr< UUserWidget > WidgetClass) override
virtual UUserWidget *	AddWidgetToLayerWithSlot (const FGameplayTag LayerName, const FGameplayTag SlotTag, const TSoftClassPtr< UUserWidget > WidgetClass) override
virtual void	OpenRadialMenu (const FRadialMenuData &Data) override
virtual int32	CloseRadialMenu () override
virtual bool	GetIsRadialMenuOpen () const override
virtual void	SetCharacterMode (const FGameplayTag &Mode) override
virtual FGameplayTag	GetCharacterMode () const override
virtual void	ToggleGameLog () override
virtual FVector2D	GetLookAxis () const override
virtual FVector2D	GetMoveAxis () const override
virtual FVector2D	GetScreenCenter () const override
virtual FVector	GetPawnLocation () const override
virtual void	GetControllerViewPoint (FVector &out_Location, FRotator &out_Rotation) const override
virtual bool	SaveGame () override
virtual bool	LoadGame () override
void	OnCharacterModeChanged (const FGameplayTag &Mode)

Public Attributes
TObjectPtr< AALSBaseCharacter >	PossessedCharacter = nullptr
TObjectPtr< UInputMappingContext >	DefaultInputMappingContext = nullptr
TObjectPtr< UInputMappingContext >	DebugInputMappingContext = nullptr
Public Attributes inherited from APlayerControllerBase
TObjectPtr< UInputMappingContext >	MenuInputMappingContext = nullptr
TObjectPtr< UInputMappingContext >	MainInputMappingContext = nullptr
bool	bDebuggingMode = false
FName	AudioSocket = FName("head")

Protected Member Functions
virtual void	SetupInputs () override
void	SetupCamera ()
virtual void	ForwardMovementAction (const FInputActionValue &Value) override
virtual void	RightMovementAction (const FInputActionValue &Value) override
virtual void	CameraUpAction (const FInputActionValue &Value) override
virtual void	CameraRightAction (const FInputActionValue &Value) override
void	JumpAction (const FInputActionValue &Value)
void	SprintAction (const FInputActionValue &Value)
virtual void	AimAction (const FInputActionValue &Value)
void	CameraTapAction (const FInputActionValue &Value)
void	CameraHeldAction (const FInputActionValue &Value)
void	StanceAction (const FInputActionValue &Value)
void	WalkAction (const FInputActionValue &Value)
void	RagdollAction (const FInputActionValue &Value)
void	VelocityDirectionAction (const FInputActionValue &Value)
void	LookingDirectionAction (const FInputActionValue &Value)
void	DebugToggleHudAction (const FInputActionValue &Value)
void	DebugToggleDebugViewAction (const FInputActionValue &Value)
void	DebugToggleTracesAction (const FInputActionValue &Value)
void	DebugToggleShapesAction (const FInputActionValue &Value)
void	DebugToggleLayerColorsAction (const FInputActionValue &Value)
void	DebugToggleCharacterInfoAction (const FInputActionValue &Value)
void	DebugToggleSlomoAction (const FInputActionValue &Value)
void	DebugFocusedCharacterCycleAction (const FInputActionValue &Value)
void	DebugToggleMeshAction (const FInputActionValue &Value)
void	DebugOpenOverlayMenuAction (const FInputActionValue &Value)
void	DebugOverlayMenuCycleAction (const FInputActionValue &Value)
Protected Member Functions inherited from APlayerControllerBase
virtual void	BeginPlay () override
virtual void	SetupComponents ()
virtual bool	SavePlayerOptions (const FString &SlotName="Default")
virtual bool	LoadPlayerOptions (const FString &SlotName="Default")
virtual void	ApplySettings (const class USettingsSaveGame *LoadedPlayerSettings)
virtual USettingsSaveGame *	ApplySettingsToSaveGame (class USettingsSaveGame *LoadedPlayerSettings)
virtual void	OnPawnSpawn ()
virtual void	OnPawnSpawnComplete ()
virtual float	CalculateCameraSensitivity (const float CameraInput) const
virtual void	MenuConfirmAction (const FInputActionValue &Value)
virtual void	MenuBackAction (const FInputActionValue &Value)
virtual void	SelectionUpAction (const FInputActionValue &Value)
virtual void	CharacterModeAction (const FInputActionValue &Value)
IHUDInterface *	GetHUDInterface ()
ICharacterBaseInterface *	GetCharacterInterface ()
void	LogDebugError (const FString &Message) const
void	LogDebugError (const FString &Message, const int32 Value) const
void	LogDebugError (const FString &Message, const float Value) const
void	LogDebugWarning (const FString &Message) const
void	LogDebugWarning (const FString &Message, const int32 Value) const
void	LogDebugWarning (const FString &Message, const float Value) const
void	LogDebugMessage (const FString &Message, const bool bWarning=false, const bool bError=false) const
void	LogDebugMessage (const FString &Message, const int32 Value, const bool bWarning=false, const bool bError=false) const
void	LogDebugMessage (const FString &Message, const float Value, const bool bWarning=false, const bool bError=false) const
void	LogDebugMessage (const FString &Message, const bool bValue, const bool bWarning, const bool bError) const
void	LogOnScreenMessage (const int32 Key, const FString &Message, FColor Color=FColor::Green) const
void	SetCategoryName (const FLogCategoryBase &Category)

Additional Inherited Members
Protected Attributes inherited from APlayerControllerBase
FGameplayTag	CharacterMode = FGameplayTag(CharacterModeTags::Default)
int32	MaxPawnSpawnAttempts = 5
bool	bAimed = false

Detailed Description

Player controller class

Member Function Documentation

AimAction()

void AALSPlayerController::AimAction ( const FInputActionValue & Value )

protectedvirtual

Reimplemented in ACustomPlayerController.

{
    if(PossessedCharacter)
    {
        PossessedCharacter->AimAction(Value.Get<bool>());
    }
}

BindActions()

void AALSPlayerController::BindActions ( UInputMappingContext * Context )

overridevirtual

Reimplemented from APlayerControllerBase.

Reimplemented in ACustomPlayerController.

{
    Super::BindActions(Context);
    if (Context)
    {
        const TArray<FEnhancedActionKeyMapping>& Mappings = Context->GetMappings();
        UEnhancedInputComponent* EnhancedInputComponent = Cast<UEnhancedInputComponent>(InputComponent);
        if (EnhancedInputComponent)
        {
            // There may be more than one keymapping assigned to one action. So, first filter duplicate action entries to prevent multiple delegate bindings
            TSet<const UInputAction*> UniqueActions;
            for (const FEnhancedActionKeyMapping& Keymapping : Mappings)
            {
                UniqueActions.Add(Keymapping.Action);
            }
            for (const UInputAction* UniqueAction : UniqueActions)
            {
                EnhancedInputComponent->BindAction(UniqueAction, ETriggerEvent::Triggered, Cast<UObject>(this), UniqueAction->GetFName());
            }
        }
    }
}

CameraHeldAction()

void AALSPlayerController::CameraHeldAction ( const FInputActionValue & Value )

protected

{
    if (PossessedCharacter)
    {
        PossessedCharacter->CameraHeldAction();
    }
}

CameraRightAction()

void AALSPlayerController::CameraRightAction ( const FInputActionValue & Value )

overrideprotectedvirtual

Reimplemented from APlayerControllerBase.

Reimplemented in ACustomPlayerController.

{
    Super::CameraRightAction(Value);
    if (PossessedCharacter)
    {
        PossessedCharacter->CameraRightAction(Value.GetMagnitude());
    }
}

CameraTapAction()

void AALSPlayerController::CameraTapAction ( const FInputActionValue & Value )

protected

{
    if (PossessedCharacter)
    {
        PossessedCharacter->CameraTapAction();
    }
}

CameraUpAction()

void AALSPlayerController::CameraUpAction ( const FInputActionValue & Value )

overrideprotectedvirtual

Reimplemented from APlayerControllerBase.

Reimplemented in ACustomPlayerController.

{
    Super::CameraUpAction(Value);
    if(PossessedCharacter)
    {
        PossessedCharacter->CameraUpAction(Value.GetMagnitude());
    }
}

DebugFocusedCharacterCycleAction()

void AALSPlayerController::DebugFocusedCharacterCycleAction ( const FInputActionValue & Value )

protected

{
    if (PossessedCharacter)
    {
        UALSDebugComponent* DebugComp = Cast<UALSDebugComponent>(PossessedCharacter->GetComponentByClass(UALSDebugComponent::StaticClass()));
        if (DebugComp)
        {
            DebugComp->FocusedDebugCharacterCycle(Value.GetMagnitude() > 0);
        }
    }
}

DebugOpenOverlayMenuAction()

void AALSPlayerController::DebugOpenOverlayMenuAction ( const FInputActionValue & Value )

protected

{
    if (PossessedCharacter)
    {
        UALSDebugComponent* DebugComp = Cast<UALSDebugComponent>(PossessedCharacter->GetComponentByClass(UALSDebugComponent::StaticClass()));
        if (DebugComp)
        {
            DebugComp->OpenOverlayMenu(Value.Get<bool>());
        }
    }
}

DebugOverlayMenuCycleAction()

void AALSPlayerController::DebugOverlayMenuCycleAction ( const FInputActionValue & Value )

protected

{
    if (PossessedCharacter)
    {
        UALSDebugComponent* DebugComp = Cast<UALSDebugComponent>(PossessedCharacter->GetComponentByClass(UALSDebugComponent::StaticClass()));
        if (DebugComp)
        {
            DebugComp->OverlayMenuCycle(Value.GetMagnitude() > 0);
        }
    }
}

DebugToggleCharacterInfoAction()

void AALSPlayerController::DebugToggleCharacterInfoAction ( const FInputActionValue & Value )

protected

{
    if (PossessedCharacter && Value.Get<bool>())
    {
        UALSDebugComponent* DebugComp = Cast<UALSDebugComponent>(PossessedCharacter->GetComponentByClass(UALSDebugComponent::StaticClass()));
        if (DebugComp)
        {
            DebugComp->ToggleCharacterInfo();
        }
    }
}

DebugToggleDebugViewAction()

void AALSPlayerController::DebugToggleDebugViewAction ( const FInputActionValue & Value )

protected

{
    if (PossessedCharacter && Value.Get<bool>())
    {
        UALSDebugComponent* DebugComp = Cast<UALSDebugComponent>(PossessedCharacter->GetComponentByClass(UALSDebugComponent::StaticClass()));
        if (DebugComp)
        {
            DebugComp->ToggleDebugView();
        }
    }
}

DebugToggleHudAction()

void AALSPlayerController::DebugToggleHudAction ( const FInputActionValue & Value )

protected

{
    if (PossessedCharacter && Value.Get<bool>())
    {
        UALSDebugComponent* DebugComp = Cast<UALSDebugComponent>(PossessedCharacter->GetComponentByClass(UALSDebugComponent::StaticClass()));
        if (DebugComp)
        {
            DebugComp->ToggleHud();
        }
    }
}

DebugToggleLayerColorsAction()

void AALSPlayerController::DebugToggleLayerColorsAction ( const FInputActionValue & Value )

protected

{
    if (PossessedCharacter && Value.Get<bool>())
    {
        UALSDebugComponent* DebugComp = Cast<UALSDebugComponent>(PossessedCharacter->GetComponentByClass(UALSDebugComponent::StaticClass()));
        if (DebugComp)
        {
            DebugComp->ToggleLayerColors();
        }
    }
}

DebugToggleMeshAction()

void AALSPlayerController::DebugToggleMeshAction ( const FInputActionValue & Value )

protected

{
    if (PossessedCharacter && Value.Get<bool>())
    {
        UALSDebugComponent* DebugComp = Cast<UALSDebugComponent>(PossessedCharacter->GetComponentByClass(UALSDebugComponent::StaticClass()));
        if (DebugComp)
        {
            DebugComp->ToggleDebugMesh();
        }
    }
}

DebugToggleShapesAction()

void AALSPlayerController::DebugToggleShapesAction ( const FInputActionValue & Value )

protected

{
    if (PossessedCharacter && Value.Get<bool>())
    {
        UALSDebugComponent* DebugComp = Cast<UALSDebugComponent>(PossessedCharacter->GetComponentByClass(UALSDebugComponent::StaticClass()));
        if (DebugComp)
        {
            DebugComp->ToggleDebugShapes();
        }
    }
}

DebugToggleSlomoAction()

void AALSPlayerController::DebugToggleSlomoAction ( const FInputActionValue & Value )

protected

{
    if (PossessedCharacter && Value.Get<bool>())
    {
        UALSDebugComponent* DebugComp = Cast<UALSDebugComponent>(PossessedCharacter->GetComponentByClass(UALSDebugComponent::StaticClass()));
        if (DebugComp)
        {
            DebugComp->ToggleSlomo();
        }
    }
}

DebugToggleTracesAction()

void AALSPlayerController::DebugToggleTracesAction ( const FInputActionValue & Value )

protected

{
    if (PossessedCharacter && Value.Get<bool>())
    {
        UALSDebugComponent* DebugComp = Cast<UALSDebugComponent>(PossessedCharacter->GetComponentByClass(UALSDebugComponent::StaticClass()));
        if (DebugComp)
        {
            DebugComp->ToggleTraces();
        }
    }
}

ForwardMovementAction()

void AALSPlayerController::ForwardMovementAction ( const FInputActionValue & Value )

overrideprotectedvirtual

Save Default values to be able to get Controller Input

Reimplemented from APlayerControllerBase.

{
    Super::ForwardMovementAction(Value);
    if (PossessedCharacter)
    {
        PossessedCharacter->ForwardMovementAction(Value.GetMagnitude());
    }
}

JumpAction()

void AALSPlayerController::JumpAction ( const FInputActionValue & Value )

protected

{
    if (PossessedCharacter)
    {
        PossessedCharacter->JumpAction(Value.Get<bool>());
    }
}

LookingDirectionAction()

void AALSPlayerController::LookingDirectionAction ( const FInputActionValue & Value )

protected

{
    if (PossessedCharacter && Value.Get<bool>())
    {
        PossessedCharacter->LookingDirectionAction();
    }
}

OnPossess()

void AALSPlayerController::OnPossess ( APawn * NewPawn )

overridevirtual

Reimplemented from APlayerControllerBase.

Reimplemented in ACustomPlayerController.

{
    Super::OnPossess(NewPawn);
    PossessedCharacter = Cast<AALSBaseCharacter>(NewPawn);
    if (!IsRunningDedicatedServer())
    {
        // Servers want to setup camera only in listen servers.
        SetupCamera();
    }
 
    SetupInputs();
 
    if (!IsValid(PossessedCharacter)) return;
    
    UALSDebugComponent* DebugComp = Cast<UALSDebugComponent>(PossessedCharacter->GetComponentByClass(UALSDebugComponent::StaticClass()));
    if (DebugComp)
    {
        DebugComp->OnPlayerControllerInitialized(this);
    }
}

OnRep_Pawn()

void AALSPlayerController::OnRep_Pawn ( )

overridevirtual

Reimplemented from APlayerControllerBase.

Reimplemented in ACustomPlayerController.

{
    Super::OnRep_Pawn();
    PossessedCharacter = Cast<AALSBaseCharacter>(GetPawn());
    SetupCamera();
    SetupInputs();
    
    if (!PossessedCharacter) return;
 
    UALSDebugComponent* DebugComp = Cast<UALSDebugComponent>(PossessedCharacter->GetComponentByClass(UALSDebugComponent::StaticClass()));
    if (DebugComp)
    {
        DebugComp->OnPlayerControllerInitialized(this);
    }
}

RagdollAction()

void AALSPlayerController::RagdollAction ( const FInputActionValue & Value )

protected

{
    if (PossessedCharacter && Value.Get<bool>())
    {
        PossessedCharacter->RagdollAction();
    }
}

RightMovementAction()

void AALSPlayerController::RightMovementAction ( const FInputActionValue & Value )

overrideprotectedvirtual

Reimplemented from APlayerControllerBase.

{
    Super::RightMovementAction(Value);
    if(PossessedCharacter)
    {
        PossessedCharacter->RightMovementAction(Value.GetMagnitude());
    }
}

SetupCamera()

void AALSPlayerController::SetupCamera ( )

protected

{
    // Call "OnPossess" in Player Camera Manager when possessing a pawn
    AALSPlayerCameraManager* CastedMgr = Cast<AALSPlayerCameraManager>(PlayerCameraManager);
    if (PossessedCharacter && CastedMgr)
    {
        CastedMgr->OnPossess(PossessedCharacter);
    }
}

SetupInputComponent()

void AALSPlayerController::SetupInputComponent ( )

overridevirtual

Overridden in Custom Player Controller

Reimplemented from APlayerControllerBase.

Reimplemented in ACustomPlayerController.

{
    Super::SetupInputComponent();
    UEnhancedInputComponent* EnhancedInputComponent = Cast<UEnhancedInputComponent>(InputComponent);
    if(EnhancedInputComponent == nullptr)
    {
        UE_LOG(LogTemp, Fatal, TEXT("ALS Community requires Enhanced Input System to be activated in project settings to function properly"));
        return;
    }
    EnhancedInputComponent->ClearActionEventBindings();
    EnhancedInputComponent->ClearActionValueBindings();
    EnhancedInputComponent->ClearDebugKeyBindings();
    BindActions(DefaultInputMappingContext);
    BindActions(DebugInputMappingContext);
}

SetupInputs()

void AALSPlayerController::SetupInputs ( )

overrideprotectedvirtual

Reimplemented from APlayerControllerBase.

{
    Super::SetupInputs();
    if (PossessedCharacter)
    {
        if (UEnhancedInputLocalPlayerSubsystem* Subsystem = ULocalPlayer::GetSubsystem<UEnhancedInputLocalPlayerSubsystem>(GetLocalPlayer()))
        {
            FModifyContextOptions Options;
            Options.bForceImmediately = 1;
            Subsystem->AddMappingContext(DefaultInputMappingContext, 1, Options);
            UALSDebugComponent* DebugComp = Cast<UALSDebugComponent>(PossessedCharacter->GetComponentByClass(UALSDebugComponent::StaticClass()));
            if (DebugComp)
            {
                // Do only if we have debug component
                Subsystem->AddMappingContext(DebugInputMappingContext, 0, Options);
            }
        }
    }
}

SprintAction()

void AALSPlayerController::SprintAction ( const FInputActionValue & Value )

protected

{
    if (PossessedCharacter)
    {
        PossessedCharacter->SprintAction(Value.Get<bool>());
    }
}

StanceAction()

void AALSPlayerController::StanceAction ( const FInputActionValue & Value )

protected

{
    if (PossessedCharacter && Value.Get<bool>())
    {
        PossessedCharacter->StanceAction();
    }
}

VelocityDirectionAction()

void AALSPlayerController::VelocityDirectionAction ( const FInputActionValue & Value )

protected

{
    if (PossessedCharacter && Value.Get<bool>())
    {
        PossessedCharacter->VelocityDirectionAction();
    }
}

WalkAction()

void AALSPlayerController::WalkAction ( const FInputActionValue & Value )

protected

{
    if (PossessedCharacter && Value.Get<bool>())
    {
        PossessedCharacter->WalkAction();
    }
}

Member Data Documentation

DebugInputMappingContext

TObjectPtr<UInputMappingContext> AALSPlayerController::DebugInputMappingContext = nullptr

DefaultInputMappingContext

TObjectPtr<UInputMappingContext> AALSPlayerController::DefaultInputMappingContext = nullptr

PossessedCharacter

TObjectPtr<AALSBaseCharacter> AALSPlayerController::PossessedCharacter = nullptr

Main character reference

---

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

• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/ALS-Community-main/Source/ALSV4_CPP/Public/Character/ALSPlayerController.h
• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/ALS-Community-main/Source/ALSV4_CPP/Private/Character/ALSPlayerController.cpp