Navigation
API > API/Plugins > API/Plugins/WorldConditions
Runtime state of a world conditions. The structure of the data for the state is defined in a query definition. The definition and conditions are stored in FWorldConditionQueryDefinition. This allows to reuse the definitions and minimize the runtime memory needed to run queries.
Note: Any code embedding this struct is responsible for calling AddReferencedObjects().
| Name | FWorldConditionQueryState |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/WorldConditions/Source/WorldConditions/Public/WorldConditionQuery.h |
| Include Path | #include "WorldConditionQuery.h" |
Syntax
USTRUCT ()
struct FWorldConditionQueryState
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FWorldConditionQueryState
(
FWorldConditionQueryState&& Other |
WorldConditionQuery.h | ||
FWorldConditionQueryState
(
const FWorldConditionQueryState& Other |
WorldConditionQuery.h | ||
| WorldConditionQuery.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FWorldConditionQueryState() |
WorldConditionQuery.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| CachedResultOffset | int32 | Offset in state memory where cached result is. | WorldConditionQuery.h |
| ItemsOffset | int32 | Offset in state memory where condition items are. | WorldConditionQuery.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bAreConditionsActivated | uint8 | WorldConditionQuery.h | ||
| bIsInitialized | uint8 | WorldConditionQuery.h | ||
| Memory | TSharedPtr< uint8 > | WorldConditionQuery.h | ||
| NumConditions | uint8 | WorldConditionQuery.h | ||
| Owner | TObjectPtr< const UObject > | WorldConditionQuery.h |
|
|
| SharedDefinition | FSharedStruct | WorldConditionQuery.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddStructReferencedObjects
(
FReferenceCollector& Collector |
Adds referenced objects to the collector. | WorldConditionQuery.h | |
bool AreConditionsActivated() |
WorldConditionQuery.h | ||
void Free () |
Frees the allocated data and objects. | WorldConditionQuery.h | |
EWorldConditionResultValue GetCachedResult() |
WorldConditionQuery.h | ||
FWorldConditionResultInvalidationHandle GetInvalidationHandle
(
const FWorldConditionBase& Condition |
Returns handle that can be used to invalidate specific condition and recalculate the condition. | WorldConditionQuery.h | |
FWorldConditionItem & GetItem
(
const int32 Index |
WorldConditionQuery.h | ||
int32 GetNumConditions() |
WorldConditionQuery.h | ||
const UObject * GetOwner() |
WorldConditionQuery.h | ||
const FWorldConditionQuerySharedDefinition * GetSharedDefinition() |
WorldConditionQuery.h | ||
UObject * GetStateObject
(
const FWorldConditionBase& Condition |
WorldConditionQuery.h | ||
FStructView GetStateStruct
(
const FWorldConditionBase& Condition |
WorldConditionQuery.h | ||
void Initialize
(
const UObject& Owner, |
Initialized the state for a specific query definition. | WorldConditionQuery.h | |
bool IsInitialized() |
WorldConditionQuery.h | ||
void SetCachedResult
(
const EWorldConditionResultValue InResult |
Sets the combined cached result of the query. | WorldConditionQuery.h | |
void SetConditionsActivated
(
const bool bConditionsActivated |
Sets the status of the conditions for this state. | WorldConditionQuery.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FWorldConditionQueryState & operator=
(
FWorldConditionQueryState&& Other |
WorldConditionQuery.h | ||
FWorldConditionQueryState & operator=
(
const FWorldConditionQueryState& RHS |
WorldConditionQuery.h |