GameFramework

Classes

Name

Description

Public class

AActor

Actor is the base class for an Object that can be placed or spawned in a level.

Public class

ACameraBlockingVolume

A volume which blocks the Camera channel by default.

Public class

ACharacter

Characters are Pawns that have a mesh, collision, and built-in movement logic.

Public class

AController

Controllers are non-physical actors that can possess a Pawn to control its actions.

Public class

ADefaultPawn

DefaultPawn implements a simple Pawn with spherical collision and built-in flying movement.

Public class

ADefaultPhysicsVolume

DefaultPhysicsVolume: the default physics volume for areas of the level with no physics volume specified DefaultPhysicsVolume determines the physical effects an actor will experience if they are not inside any user specified PhysicsVolume

Public class

AGameMode

GameMode is a subclass of GameModeBase that behaves like a multiplayer match-based game.

Public class

AGameModeBase

The GameModeBase defines the game being played.

Public class

AGameNetworkManager

Handles game-specific networking management (cheat detection, bandwidth management, etc.).

Public class

AGameSession

Acts as a game-specific wrapper around the session interface.

Public class

AGameState

GameState is a subclass of GameStateBase that behaves like a multiplayer match-based game.

Public class

AGameStateBase

GameStateBase is a class that manages the game's global state, and is spawned by GameModeBase.

Public class

AHUD

Base class of the heads-up display.

Public class

AInfo

Info, the root of all information holding classes.

Public class

AKillZVolume

KillZVolume is a volume used to determine when actors should be killed.

Public class

ALightWeightInstanceManager

Public class

ALightWeightInstanceStaticMeshManager

Public class

APainCausingVolume

PhysicsVolume: a bounding volume which affects actor physics Each AActor is affected at any time by one PhysicsVolume Volume that causes damage over time to any Actor that overlaps its collision.

Public class

APawn

Pawn is the base class of all actors that can be possessed by players or AI.

Public class

APhysicsVolume

PhysicsVolume: A bounding volume which affects actor physics.

Public class

APlayerController

PlayerControllers are used by human players to control Pawns.

Public class

APlayerStart

This class indicates a location where a player can spawn when the game begins.

Public class

APlayerState

A PlayerState is created for every player on a server (or in a standalone game).

Public class

ASpectatorPawn

SpectatorPawns are simple pawns that can fly around the world, used by PlayerControllers when in the spectator state.

Public class

AVolume

An editable 3D volume placed in a level. Different types of volumes perform different functions

Public class

AWorldSettings

Actor containing all script accessible world properties.

Public struct

FActivateDevicePropertyParams

Parameters for the UInputDeviceSubsystem::ActivateDeviceProperty function

Public struct

FActiveDeviceProperty

Contains a pointer to an active device property and keeps track of how long it has been evaluated for

Public struct

FActiveForceFeedbackEffect

Public struct

FActorBeginCursorOverSignature

Public struct

FActorBeginOverlapSignature

Public struct

FActorBeginTouchOverSignature

Public struct

FActorDestroyedSignature

Public struct

FActorEndCursorOverSignature

Public struct

FActorEndOverlapSignature

Public struct

FActorEndPlaySignature

Public struct

FActorEndTouchOverSignature

Public struct

FActorHitSignature

Public struct

FActorLastRenderTime

Helper struct that allows UPrimitiveComponent and FPrimitiveSceneInfo write to the Actor's LastRenderTime member

Public struct

FActorOnClickedSignature

Public struct

FActorOnInputTouchBeginSignature

Public struct

FActorOnInputTouchEndSignature

Public class

FActorOnPackagingModeChanged

Public struct

FActorOnReleasedSignature

Public struct

FAsyncPhysicsTimestamp

Public struct

FAudioBasedVibrationData

Public struct

FBasedMovementInfo

Struct to hold information about the "base" object the character is standing on.

Public struct

FBroadphaseSettings

Settings pertaining to which PhysX broadphase to use, and settings for MBP if that is the chosen broadphase type

Public struct

FCharacterMovementComponentPostPhysicsTickFunction

Tick function that calls UCharacterMovementComponent::PostPhysicsTickComponent

Public struct

FCharacterMovementComponentPrePhysicsTickFunction

Public class

FCharacterMovementUpdatedSignature

Public struct

FCharacterMoveResponseDataContainer

Response from the server to the client about a move that is being acknowledged.

Public struct

FCharacterMoveResponsePackedBits

Structure used internally to handle serialization of FCharacterMoveResponseDataContainer over the network.

Public struct

FCharacterNetworkMoveData

Client to Server movement data.

Public struct

FCharacterNetworkMoveDataContainer

Struct used for network RPC parameters between client/server by ACharacter and UCharacterMovementComponent.

Public struct

FCharacterNetworkSerializationPackedBits

Intermediate data stream used for network serialization of Character RPC data.

Public struct

FCharacterNetworkSerializationPackedBitsNetSerializerConfig

Public struct

FCharacterNetworkSerializationPackedBitsNetSerializerNetSerializerInfo

Public class

FCharacterReachedApexSignature

Public class

FCharacterReplaySample

Public struct

FCharacterServerMovePackedBits

Structure used internally to handle serialization of FCharacterNetworkMoveDataContainer over the network.

Public struct

FClientAdjustment

Server to Client response.

Public struct

FClientReceiveData

Handles the many pieces of data passed into Client Receive

Public struct

FDebugTextInfo

Single entry of a debug text item to render.

Public struct

FDebugTraceInfo

CheatManager Object within playercontroller that manages development "cheat" commands only spawned in single player mode No cheat manager is created in shipping builds.

Public struct

FDeviceColorCurveData

Data required for setting the Input Device Color

Public struct

FDeviceColorData

Data required for setting the Input Device Color

Public struct

FDeviceTriggerBaseData

Public struct

FDeviceTriggerFeedbackData

Public struct

FDeviceTriggerTriggerResistanceData

Public struct

FDeviceTriggerTriggerVibrationData

Public struct

FDynamicForceFeedbackDetails

Public struct

FForceFeedbackAttenuationSettings

Copyright Epic Games, Inc. All Rights Reserved.

Public struct

FForceFeedbackChannelDetails

Public struct

FForceFeedbackEffectOverridenChannelDetails

A wrapper struct for setting channel details on a per-platform basis

Public struct

FForceFeedbackParameters

Copyright Epic Games, Inc. All Rights Reserved.

Public class

FGameModeEvents

GameModeBase events, particularly for use by plugins

Public struct

FHardwareDeviceIdentifier

An identifier that can be used to determine what input devices are available based on the FInputDeviceScope.

Public class

FHardwareInputDeviceChanged

Delegate called when a user changed the hardware they are using for input.

Public struct

FHierarchicalSimplification

Public class

FHUDHitBox

Hitbox used for clickable HUD elements.

Public struct

FInputActionKeyMapping

Defines a mapping between an action and key

Public struct

FInputActionSpeechMapping

Defines a mapping between an action and speech recognition

Public struct

FInputAxisConfigEntry

Configurable properties for control axes.

Public struct

FInputAxisKeyMapping

Defines a mapping between an axis and key

Public struct

FInputAxisProperties

Configurable properties for control axes, used to transform raw input into game ready values.

Public struct

FInputDevicePropertyHandle

A handle to an active input device property that is being used by the InputDeviceSubsytem.

Public struct

FInputKeyParams

Paramaters to be considered when calling UPlayerInput::InputKey.

Public struct

FInputModeDataBase

Abstract base class for Input Mode structures

Public struct

FInputModeGameAndUI

Data structure used to setup an input mode that allows the UI to respond to user input, and if the UI doesn't handle it player input / player controller gets a chance.

Public struct

FInputModeGameOnly

Data structure used to setup an input mode that allows only the player input / player controller to respond to user input.

Public struct

FInputModeUIOnly

Data structure used to setup an input mode that allows only the UI to respond to user input.

Public class

FInstigatedAnyDamageSignature

Public struct

FKeyBind

Struct containing mappings for legacy method of binding keys to exec commands.

Public class

FLandedSignature

Public struct

FLightmassWorldInfoSettings

Public struct

FLightWeightInstanceSubsystem

Public struct

FLWIData

Used for initializing light weight instances.

Public struct

FMarkActorIsBeingDestroyed

Internal struct used by level code to mark actors as destroyed

Public class

FMovementModeChangedSignature

Public struct

FNetLevelVisibilityTransactionId

This structure is used to to identify NetLevelVisibility transactions between server and client

Public struct

FNetViewer

Stores information on a viewer that actors need to be checked against for relevancy

Public class

FNetworkPredictionData_Client_Character

Public class

FNetworkPredictionData_Server_Character

Public class

FOnActorReady

Public class

FOnAsyncHandleSaveGame

Public class

FOnGameUserSettingsUINeedsUpdate

Public class

FOnPlayerStatePawnSet

Public class

FOnPossessedPawnChanged

Public struct

FPawnControllerChangedSignature

Public struct

FPawnRestartedSignature

Public struct

FPlayerMuteList

Container responsible for managing the mute state of a player controller at the gameplay level (VoiceInterface handles actual muting)

Public struct

FRepRootMotionMontage

Replicated data when playing a root motion montage.

Public struct

FRootMotionFinishVelocitySettings

Struct for RootMotion Finish Velocity options.

Public struct

FRootMotionServerToLocalIDMapping

Structure for mapping RootMotionSource server IDs to those on this client

Public struct

FRootMotionSource

Generalized source of Root Motion to a CharacterMovementComponent.

Public struct

FRootMotionSource_ConstantForce

ConstantForce applies a fixed force to the target

Public struct

FRootMotionSource_JumpForce

JumpForce moves the target in a jump-like manner (ends when landing, applied force is relative)

Public struct

FRootMotionSource_MoveToDynamicForce

MoveToDynamicForce moves the target to a given location in world space over the duration, where the end location is dynamic and can change during the move (meant to be used for things like moving to a moving target)

Public struct

FRootMotionSource_MoveToForce

MoveToForce moves the target to a given fixed location in world space over the duration

Public struct

FRootMotionSource_RadialForce

RadialForce applies a force pulling or pushing away from a given world location to the target

Public struct

FRootMotionSourceGroup

Group of Root Motion Sources that are applied

Public struct

FRootMotionSourceSettings

Structure for RootMotionSource option flags (used for convenience instead of having to manually manipulate flag bitfields)

Public struct

FRootMotionSourceStatus

Structure for RootMotionSource status flags (used for convenience instead of having to manually manipulate flag bitfields)

Public class

FSavedMove_Character

FSavedMove_Character represents a saved move on the client that has been sent to the server and might need to be played back.

Public struct

FSetActorContentBundleGuid

Public struct

FSetActorGuid

Public struct

FSetActorHiddenInSceneOutliner

Public struct

FSetActorWantsDestroyDuringBeginPlay

This should only be used by UWorld::DestroyActor when the actor is in the process of beginning play so it can't be destroyed yet

Public struct

FSetPlayerStatePawn

Public class

FSimpleReticle

Simple reticle. A very simple crosshair reticle that can be draw on the HUD canvas.

Public struct

FSimulatedRootMotionReplicatedMove

Public struct

FTakeAnyDamageSignature

Public struct

FTakePointDamageSignature

Public struct

FTakeRadialDamageSignature

Public struct

FTouchInputControl

Public struct

FUniqueNetIdRepl

Wrapper for opaque type FUniqueNetId

Public struct

FUniqueNetIdReplNetSerializerConfig

Public struct

FUniqueNetIdReplNetSerializerNetSerializerInfo

Public struct

FUpdateLevelStreamingLevelStatus

This structure is used to pass arguments to ClientUpdateMultipleLevelsStreamingStatus() client RPC function

Public struct

FUpdateLevelVisibilityLevelInfo

This structure is used to pass arguments to ServerUpdateLevelVisibilty() and ServerUpdateMultipleLevelsVisibility() server RPC functions

Public struct

PingAvgData

Struct containing one seconds worth of accumulated ping data (for averaging) NOTE: Maximum PingCount is 7, and maximum PingSum is 8191 (1170*7)

Public struct

RootMotionSourceDebug

Public class

TInlineComponentArray

TInlineComponentArray is simply a TArray that reserves a fixed amount of space on the stack to try to avoid heap allocation when there are fewer than a specified number of elements expected in the result.

Public class

UActorInstanceHandleInterface

Base class for interfaces for each handle.

Public class

UAsyncActionHandleSaveGame

Async action to handle async load/save of a USaveGame.

Public class

UCharacterMovementComponent

CharacterMovementComponent handles movement logic for the associated Character owner.

Public class

UCheatManager

Cheat Manager is a central blueprint to implement test and debug code and actions that are not to ship with the game.

Public class

UCheatManagerExtension

A cheat manager extension can extend the main cheat manager in a modular way, being enabled or disabled when the system associated with the cheats is enabled or disabled

Public class

UColorInputDeviceCurveProperty

A property that can be used to change the color of an input device's light over time with a curve

Public class

UColorInputDeviceProperty

Set the color of an Input Device to a static color.

Public class

UDamageType

A DamageType is intended to define and describe a particular form of damage and to provide an avenue for customizing responses to damage from various sources.

Public class

UEngineMessage

Public class

UFloatingPawnMovement

Movement component updates position of associated PrimitiveComponent during its tick FloatingPawnMovement is a movement component that provides simple movement for any Pawn class.

Public class

UForceFeedbackAttenuation

Wrapper class that can be created as an asset for force feedback attenuation properties which allows reuse of the properties for multiple attenuation components

Public class

UForceFeedbackEffect

A predefined force-feedback effect to be played on a controller

Public class

UGameUserSettings

Stores user settings for a game (for example graphics and sound settings), with the ability to save and load to and from a file.

Public class

UHierarchicalLODSetup

Public class

UInputDeviceAudioBasedVibrationProperty

Plays a sound to an input device's speaker.

Public class

UInputDeviceLibrary

A static BP library that exposes Input Device data to blueprints

Public class

UInputDeviceProperty

Base class that represents a single Input Device Property.

Public class

UInputDeviceSubsystem

The input device subsystem provides an interface to allow users to set Input Device Properties on any Platform User.

Public class

UInputDeviceTriggerEffect

A property that effect the triggers on a gamepad

Public class

UInputDeviceTriggerFeedbackProperty

Sets simple trigger feedback

Public class

UInputDeviceTriggerResistanceProperty

Provides linear resistance to a trigger while it is being pressed between a start and end value

Public class

UInputDeviceTriggerVibrationProperty

Sets trigger vibration

Public class

UInputPlatformSettings

Per-Platform input options

Public class

UInputSettings

Project wide settings for input handling

Public class

ULightWeightInstanceBlueprintFunctionLibrary

Public class

ULocalMessage

Public class

UMovementComponent

MovementComponent is an abstract component class that defines functionality for moving a PrimitiveComponent (our UpdatedComponent) each tick.

Public class

UNavMovementComponent

NavMovementComponent defines base functionality for MovementComponents that move any 'agent' that may be involved in AI pathfinding.

Public class

UOnlineSession

Public class

UPawnMovementComponent

PawnMovementComponent can be used to update movement for an associated Pawn.

Public class

UPlayerInput

Object within PlayerController that processes player input.

Public class

UPlayerStateCountLimiterConfig

If one wishes to use the NetObjectCountLimiter prioritizer for PlayerStates this class makes it possible to have specific settings for PlayerStates in case other classes also wish to use said prioritizer.

Public class

UProjectileMovementComponent

ProjectileMovementComponent updates the position of another component during its tick.

Public class

URotatingMovementComponent

Performs continuous rotation of a component at a specific rotation rate.

Public class

USaveGame

This class acts as a base class for a save game object that can be used to save state about the game.

Public class

USpectatorPawnMovement

Movement component used by SpectatorPawn.

Public class

USpringArmComponent

This component tries to maintain its children at a fixed distance from the parent, but will retract the children if there is a collision, and spring back when there is no collision.

Public class

UTouchInterface

Defines an interface by which touch input can be controlled using any number of buttons and virtual joysticks

Enums

Functions

Name Description

Public function Static

bool

 

LWIUtils::DoesHandleSupportInterface

(
    const FActorInstanceHandle& Handle
)

Returns true if the object this handle represents supports the interface of type U

Public function Static

I *

 

LWIUtils::FetchInterfaceFromHandle

(
    const FActorInstanceHandle& Handle
)

Returns an object implementing the interface I.

Public function

bool

 

MovementBaseUtility::UseRelativeLocation

(
    const UPrimitiveComponent* Mov...
)

Determine if we should use relative positioning when based on a component (because it may move).

Variables

Name Description

Public variable

int32

 

AsyncCharacterMovement

Is Async Character Movement enabled?

Public variable

int32

 

ForceJumpPeakSubstep

Public variable

const float

 

MAX_STEP_SIDE_Z

Public variable

int32

 

MoveIgnoreFirstBlockingOverlap

Typically we want to depenetrate regardless of direction, so we can get all the way out of penetration quickly.

Public variable

float

 

PenetrationOverlapCheckInflation

Public variable

float

 

PenetrationPullbackDistance

Public variable

const float

 

VERTICAL_SLOPE_NORMAL_Z
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Cancel