Navigation
API > API/Runtime > API/Runtime/Engine
Identifies a specific WorldContext that has objects which are allowed to tick and run tasks
| Name | FWorldContextId |
| Type | struct |
| Header File | /Engine/Source/Runtime/Engine/Public/TaskSyncManager.h |
| Include Path | #include "TaskSyncManager.h" |
Syntax
struct FWorldContextId
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Construct an invalid world context id | TaskSyncManager.h | ||
FWorldContextId
(
FInternalId InWorldId |
Construct from an internal id TODO: May make private | TaskSyncManager.h | |
FWorldContextId
(
const UWorld* InWorld |
Construct from a world pointer, if it is null or not part of a tickable world context it will return an invalid id | TaskSyncManager.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FInternalId | int32 | TODO Consider moving this concept into World.h. | TaskSyncManager.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| DefaultWorldContextId | FInternalId | Default id which is used for the default game world outside the editor | TaskSyncManager.h |
| InvalidWorldContextId | FInternalId | TaskSyncManager.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| WorldId | FInternalId | TaskSyncManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool IsValid() |
Returns true if this points to a valid tickable world context | TaskSyncManager.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FWorldContextId GetContextIdForWorld
(
const UWorld* World |
Construct from a world pointer, if it is null or not part of a tickable world context it will return an invalid id | TaskSyncManager.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const FWorldContextId& Other |
TaskSyncManager.h | ||
bool operator==
(
const FWorldContextId& Other |
TaskSyncManager.h |