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

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

APainCausingVolume

============================================================================= PhysicsVolume: a bounding volume which affects actor physics Each AActor is affected at any time by one PhysicsVolume

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

FActiveForceFeedbackEffect

Public class

FActorBeginCursorOverSignature

Public class

FActorBeginOverlapSignature

Public class

FActorBeginTouchOverSignature

Public class

FActorDestroyedSignature

Public class

FActorEndCursorOverSignature

Public class

FActorEndOverlapSignature

Public class

FActorEndPlaySignature

Public class

FActorEndTouchOverSignature

Public class

FActorHitSignature

Public class

FActorOnClickedSignature

Public class

FActorOnInputTouchBeginSignature

Public class

FActorOnInputTouchEndSignature

Public class

FActorOnReleasedSignature

Public struct

FBasedMovementInfo

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

Public struct

FCharacterMovementComponentPostPhysicsTickFunction

Tick function that calls UCharacterMovementComponent::PostPhysicsTickComponent

Public class

FCharacterMovementUpdatedSignature

Public class

FCharacterReachedApexSignature

Public class

FCharacterReplaySample

Public struct

FClientAdjustment

ClientAdjustPosition replication (event called at end of frame by server)

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

FDynamicForceFeedbackDetails

Public struct

FFindFloorResult

Data about the floor for walking movement, used by CharacterMovementComponent.

Public struct

FForceFeedbackAttenuationSettings

The struct for defining the properties used when determining attenuation for a force feedback effect

Public struct

FForceFeedbackChannelDetails

Public struct

FForceFeedbackEffectHistoryEntry

Used to display the force feedback history of what was played most recently.

Public class

FGameModeEvents

GameModeBase events, particularly for use by plugins

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

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

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

FMarkActorIsBeingDestroyed

Public class

FMovementModeChangedSignature

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

FOnGameUserSettingsUINeedsUpdate

Noexport class

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 class

FSimpleReticle

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

Public struct

FSimulatedRootMotionReplicatedMove

Public class

FTakeAnyDamageSignature

Delegate signatures.

Public struct

FTouchInputControl

Public struct

FUniqueNetIdRepl

Wrapper for opaque type FUniqueNetId

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

UCharacterMovementComponent

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

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

UInputSettings

Project wide settings for input handling

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

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

Typedefs

Name

Description

FCanUnpause

Default delegate that provides an implementation for those that don't have special needs other than a toggle

FCanUnpause

Default delegate that provides an implementation for those that don't have special needs other than a toggle

FGetAudioListenerPos

Delegate used to override default viewport audio listener position calculated from camera

FMakeNoiseDelegate

FOnProcessEvent

FOnShowDebugInfo

FRepRelativeMovement

Allow the old name to continue to work for one release.

FSavedMovePtr

Shared pointer for easy memory management of FSavedMove_Character , for accumulating and replaying network moves.

Enums

Name

Description

Public enum

EDynamicForceFeedbackAction::Type

Public enum

EPlaneConstraintAxisSetting

Setting that controls behavior when movement is restricted to a 2D plane defined by a specific axis/normal, so that movement along the locked axis is not be possible.

Public enum

ERootMotionAccumulateMode

Enumeration for RootMotionSource accumulation mode

Public enum

ERootMotionFinishVelocityMode

Public enum

ERootMotionSourceID

Public enum

ERootMotionSourceSettingsFlags

Enumeration for RootMotionSource settings

Public enum

ERootMotionSourceStatusFlags

Enumeration for RootMotionSource status flags

Public enum

EStandbyType

Describes which standby detection event occured so the game can take appropriate action.

Public enum

EVisibilityAggressiveness

Functions

Name Description

Public function

 

DECLARE_DYNAMIC_MULTICAST_DELEGATE_NineParams

(
    FTakePointDamageSignature,
    AActor *,
    DamagedActor,
    float,
    Damage,
    AController *,
    InstigatedBy,
    FVector ,
    HitLocation,
    UPrimitiveComponent *,
    FHitComponent,
    FName ,
    BoneName,
    FVector ,
    ShotFromDirection,
    const UDamageType *,
    DamageType,
    AActor *,
    DamageCauser
)

Public function

[ENGINE_API](API\Runtime\Engine\AI\Navigation\ENGINE_API)FS ...

 

DumpMutelistState

(
    UWorld * World
)

Dump out information about all player controller mute state

Public function

[ENGINE_API](API\Runtime\Engine\AI\Navigation\ENGINE_API)AP ...

 

GetPlayerControllerFromNetId

(
    UWorld * World,
    const FUniqueNetId & PlayerNetId
)

Returns the player controller associated with this net id

Public function

bool

 

MovementBaseUtility::UseRelativeLocation

(
    const UPrimitiveComponent * Mov...
)

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

Public function

bool

 

MovementBaseUtility::UseRelativePosition

(
    const UPrimitiveComponent * Mov...
)

Deprecated function.

Public function

[ENGINE_API](API\Runtime\Engine\AI\Navigation\ENGINE_API) v...

 

TestUniqueIdRepl

(
    UWorld * InWorld
)

Test harness for Unique Id replication

Variables

Name Description

Public variable

 

ENGINE_API

Public variable

 

ENGINE_API

Public variable

 

ENGINE_API

Public variable

 

ENGINE_API