1. Epic GamesDeveloper
  3. FGauntletModule

FGauntletModule

Main Gauntlet Module.

API > API/Plugins > API/Plugins/Gauntlet

Inheritance Hierarchy

References

   
Module Gauntlet
Header /Engine/Plugins/Experimental/Gauntlet/Source/Gauntlet/Public/GauntletModule.h
Include #include "GauntletModule.h"

Syntax

class FGauntletModule : public IModuleInterface

Remarks

Main Gauntlet Module. This is module is responsible for managing its underlying controllers and propagating events and state changes to them as necessary.

After initialization you should be prepared to feed this module with states that your controllers can respond to. This can be done either manually (BroadcastStateChange), through one of the helpers (e.g. SetGameStateToTestStateMapping), or a combination of both.

Functions

  Type Name Description
Public function void Manually Broadcasts a state change to all current Gauntlet controllers.
Public function Const FName Returns the current state
Public function T * Templated casty version of the above
Public function UGauntletTestController *

GetTestController ( UClass* ControllerClass
)

 Returns the first controller (if any) matching the provided name
Public function Const double Returns the time spent in the current state
Public function void

MarkHeartbeatActive ( const FString& OptionalStatusMessage
)

 Mark the next heartbeat as active.
Public function void This is a convenient way of binding a list of AGameState types to your own state defines.
Public function void

SetScreenshotPeriod ( float Period
)

 Sets the rate for screenshots to be taken (default = 0)
Public function void

SetWorldToTestStateMapping ( const TMap< FString, FName >& Mapping
)

 This is a convenient way of binding a list of maps types to your own state defines.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page