FVehicleBlackboard Class Reference

#include <VehicleBlackboard.h>

Public Types
enum class	EInvalidationReason : uint8 { FullReset , Rollback }

Public Member Functions
template<typename T >
bool	TryGet (FName ObjName, T &OutFoundValue) const
bool	Contains (FName ObjName)
template<typename T >
void	Set (FName ObjName, T Obj)
UE_API void	Invalidate (FName ObjName)
UE_API void	Invalidate (EInvalidationReason Reason)
void	InvalidateAll ()

Detailed Description

VehicleBlackboard: this is a simple generic map that can store any type, used as a way for decoupled modules to share calculations or transient state data (on the physics thread only). Values submitted are copy-in, copy-out. Unlike a traditional blackboard pattern, there is no support for subscribing to changes.

Member Enumeration Documentation

EInvalidationReason

enum class FVehicleBlackboard::EInvalidationReason : uint8

strong

Enumerator
FullReset
Rollback

Member Function Documentation

Contains()

bool FVehicleBlackboard::Contains ( FName  ObjName )

inline

Returns true/false to indicate if an object is stored with that name

Invalidate() [1/2]

void FVehicleBlackboard::Invalidate

(

EInvalidationReason

Reason

)

Invalidate all objects that can be affected by a particular circumstance (such as a rollback)

Invalidate() [2/2]

void FVehicleBlackboard::Invalidate

(

FName

ObjName

)

Invalidate an object by name

InvalidateAll()

void FVehicleBlackboard::InvalidateAll ( )

inline

Invalidate all objects

Set()

template<typename T >

void FVehicleBlackboard::Set ( FName  ObjName, T  Obj  )

inline

Store object by a named key, overwriting any existing object

TryGet()

template<typename T >

bool FVehicleBlackboard::TryGet ( FName  ObjName, T &  OutFoundValue  ) const

inline

Attempt to retrieve an object from the blackboard. If found, OutFoundValue will be set. Returns true/false to indicate whether it was found.

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Experimental/ChaosVehicles/ChaosVehiclesCore/Public/SimModule/VehicleBlackboard.h
• Engine/Source/Runtime/Experimental/ChaosVehicles/ChaosVehiclesCore/Private/SimModule/VehicleBlackboard.cpp