Navigation
API > API/Runtime > API/Runtime/ChaosVehiclesCore
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.
| Name | FVehicleBlackboard |
| Type | class |
| Header File | /Engine/Source/Runtime/Experimental/ChaosVehicles/ChaosVehiclesCore/Public/SimModule/VehicleBlackboard.h |
| Include Path | #include "SimModule/VehicleBlackboard.h" |
Syntax
class FVehicleBlackboard
Classes
| Name | Remarks |
|---|---|
| BlackboardObject |
Enums
Public
| Name | Remarks |
|---|---|
| EInvalidationReason |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ObjectsByName | TMap< FName, TSharedPtr< BlackboardObject > > | SimModule/VehicleBlackboard.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool Contains
(
FName ObjName |
Returns true/false to indicate if an object is stored with that name | SimModule/VehicleBlackboard.h | |
void Invalidate
(
FName ObjName |
Invalidate an object by name | SimModule/VehicleBlackboard.h | |
void Invalidate
(
EInvalidationReason Reason |
Invalidate all objects that can be affected by a particular circumstance (such as a rollback) | SimModule/VehicleBlackboard.h | |
void InvalidateAll() |
Invalidate all objects | SimModule/VehicleBlackboard.h | |
void Set
(
FName ObjName, |
Store object by a named key, overwriting any existing object | SimModule/VehicleBlackboard.h | |
| Attempt to retrieve an object from the blackboard. | SimModule/VehicleBlackboard.h |