Skip to content
YetiTech Studios

IViewportWorldInterface

#include <ViewportWorlds/Public/ViewportWorldInterface.h>
class IViewportWorldInterface

Defined in ViewportWorldInterface.h:20

Subclassed by: AViewportWorldCharacter, AViewportWorldPawn, AViewportWorldPlayerController

Inheritance diagram

Section titled “Inheritance diagram”
---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class IViewportWorldInterface["IViewportWorldInterface"]
  class AViewportWorldCharacter["AViewportWorldCharacter"]
  IViewportWorldInterface <|-- AViewportWorldCharacter
  class AViewportWorldPawn["AViewportWorldPawn"]
  IViewportWorldInterface <|-- AViewportWorldPawn
  class AViewportWorldPlayerController["AViewportWorldPlayerController"]
  IViewportWorldInterface <|-- AViewportWorldPlayerController

Class detail

Section titled “Class detail”
---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class IViewportWorldInterface {
    +SetPlayerInput(APlayerController *PlayerController)
    +UpdatePlayerInputImpl(UObject *Caller, const APlayerController *P bool
    +OnPlayerInputUpdated(UInputMappingContext *InputMappingContext)
  }

Caller impact — SetPlayerInput

Section titled “Caller impact — SetPlayerInput”

Documented call sites inside the plugin (3):

flowchart LR
  IViewportWorldInterface__SetPlayerInput["IViewportWorldInterface::SetPlayerInput"]
  AViewportWorldPlayerController__SetupInputComponent["AViewportWorldPlayerController::SetupInputComponent"]
  AViewportWorldPlayerController__SetupInputComponent --> IViewportWorldInterface__SetPlayerInput
  AViewportWorldCharacter__SetupPlayerInputComponent["AViewportWorldCharacter::SetupPlayerInputComponent"]
  AViewportWorldCharacter__SetupPlayerInputComponent --> IViewportWorldInterface__SetPlayerInput
  AViewportWorldPawn__SetupPlayerInputComponent["AViewportWorldPawn::SetupPlayerInputComponent"]
  AViewportWorldPawn__SetupPlayerInputComponent --> IViewportWorldInterface__SetPlayerInput

Caller impact — UpdatePlayerInputImpl

Section titled “Caller impact — UpdatePlayerInputImpl”

Documented call sites inside the plugin (3):

flowchart LR
  IViewportWorldInterface__UpdatePlayerInputImpl["IViewportWorldInterface::UpdatePlayerInputImpl"]
  AViewportWorldCharacter__UpdatePlayerInput["AViewportWorldCharacter::UpdatePlayerInput"]
  AViewportWorldCharacter__UpdatePlayerInput --> IViewportWorldInterface__UpdatePlayerInputImpl
  AViewportWorldPawn__UpdatePlayerInput["AViewportWorldPawn::UpdatePlayerInput"]
  AViewportWorldPawn__UpdatePlayerInput --> IViewportWorldInterface__UpdatePlayerInputImpl
  AViewportWorldPlayerController__UpdatePlayerInput["AViewportWorldPlayerController::UpdatePlayerInput"]
  AViewportWorldPlayerController__UpdatePlayerInput --> IViewportWorldInterface__UpdatePlayerInputImpl

Public Static Methods

Section titled “Public Static Methods”
ReturnNameDescription
voidSetPlayerInput staticSets the player input for the specified player controller.
boolUpdatePlayerInputImpl staticUpdates the player input for the specified player controller using the provided input mapping context.

SetPlayerInput

Section titled “SetPlayerInput”

static

static void SetPlayerInput(APlayerController * PlayerController)

Defined in ViewportWorldInterface.h:31 Sets the player input for the specified player controller.

Parameters

Section titled “Parameters”
  • PlayerController The player controller for which the input is set.
Referenced by
Section titled “Referenced by”

UpdatePlayerInputImpl

Section titled “UpdatePlayerInputImpl”

static

static bool UpdatePlayerInputImpl(UObject * Caller, const APlayerController * PlayerController, UInputMappingContext * MappingContext, bool bApplyImmediately)

Defined in ViewportWorldInterface.h:42 Updates the player input for the specified player controller using the provided input mapping context.

Parameters

Section titled “Parameters”

  • Caller The object that is calling this method.

  • PlayerController The player controller for which the input is updated.

  • MappingContext The input mapping context to be applied.

  • bApplyImmediately Whether to apply the mapping context immediately or not.

Returns

Section titled “Returns”

true if the player input was updated successfully, false otherwise.

Referenced by
Section titled “Referenced by”
References
Section titled “References”
  • Error

Protected Methods

Section titled “Protected Methods”
ReturnNameDescription
voidOnPlayerInputUpdatedUpdates the player input for the specified player controller using the provided input mapping context.

OnPlayerInputUpdated

Section titled “OnPlayerInputUpdated”
void OnPlayerInputUpdated(UInputMappingContext * InputMappingContext)

Defined in ViewportWorldInterface.h:52 Updates the player input for the specified player controller using the provided input mapping context.

Parameters

Section titled “Parameters”
  • InputMappingContext The input mapping context to be applied.