AViewportWorldCharacter

#include <ViewportWorlds/Public/Player/ViewportWorldCharacter.h>

class AViewportWorldCharacter

Defined in ViewportWorldCharacter.h:14

Inherits: ACharacter, IViewportWorldInterface

Inheritance diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class AViewportWorldCharacter["AViewportWorldCharacter"]
  class ACharacter["ACharacter"]
  ACharacter <|-- AViewportWorldCharacter
  class IViewportWorldInterface["IViewportWorldInterface"]
  IViewportWorldInterface <|-- AViewportWorldCharacter

Class detail

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class AViewportWorldCharacter {
    +AViewportWorldCharacter()
    +SetupPlayerInputComponent(class UInputComponent *PlayerInputComponent
    +UpdatePlayerInput(UInputMappingContext *NewInputMapping, cons bool
    +InputMapping : TObjectPtr< UInputMappingContext >
    +bApplyInputMappingImmediately : bool
  }

A character class representing a character in the viewport world.

Public Methods

Return	Name	Description
	AViewportWorldCharacter
void	SetupPlayerInputComponent virtual override
bool	UpdatePlayerInput	Updates the player input for the character.

---

AViewportWorldCharacter

AViewportWorldCharacter()

Defined in ViewportWorldCharacter.h:41

SetupPlayerInputComponent

virtual override

virtual void SetupPlayerInputComponent(class UInputComponent * PlayerInputComponent) override

Defined in ViewportWorldCharacter.h:43

References

• bApplyInputMappingImmediately
• InputMapping
• SetPlayerInput
• UpdatePlayerInput

---

UpdatePlayerInput

bool UpdatePlayerInput(UInputMappingContext * NewInputMapping, const bool bApplyImmediately = true)

Defined in ViewportWorldCharacter.h:55 Updates the player input for the character.

This method updates the player input for the character using the provided input mapping context.

Parameters

• NewInputMapping The input mapping context to be applied.

• bApplyImmediately Whether to apply the mapping context immediately or not. Default value is true.

Returns

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

Referenced by

• SetupPlayerInputComponent

References

• UpdatePlayerInputImpl

Private Attributes

Return	Name	Description
TObjectPtr< UInputMappingContext >	InputMapping	Store and manage the input mapping context for the viewport world pawn. The input mapping context defines the mapping between user input events and actions in the game.
bool	bApplyInputMappingImmediately	Indicates whether to apply the input mapping immediately or not.

---

InputMapping

TObjectPtr< UInputMappingContext > InputMapping

Defined in ViewportWorldCharacter.h:25 Store and manage the input mapping context for the viewport world pawn. The input mapping context defines the mapping between user input events and actions in the game.

See also: UpdatePlayerInput()

Referenced by

• SetupPlayerInputComponent

---

bApplyInputMappingImmediately

bool bApplyInputMappingImmediately

Defined in ViewportWorldCharacter.h:37 Indicates whether to apply the input mapping immediately or not.

This variable determines whether the input mapping should be applied immediately when updating the player input for the character or not. If set to true, the input mapping will be applied immediately. If set to false, you will have to manually apply to the Enhanced Input Subsystem.

See also: AViewportWorldCharacter::UpdatePlayerInput()

Referenced by

• SetupPlayerInputComponent