Skip to content

Commit

Permalink
Document current and upcoming world context changes
Browse files Browse the repository at this point in the history
  • Loading branch information
landelare committed Jan 28, 2024
1 parent b05568c commit ba87170
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 5 deletions.
8 changes: 7 additions & 1 deletion Docs/Async.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,12 +94,18 @@ If your function (probably a UFUNCTION in this case but this is **not** checked
or required) takes `FLatentActionInfo` or `FForceLatentCoroutine`, the coroutine
is running in "latent mode".
The world will be fetched from the first UObject* parameter that returns a valid
pointer from GetWorld() with GWorld used as a last resort fallback.
pointer from GetWorld().
If there's a FLatentActionInfo parameter, its callback target will be used with
the highest priority.
The latent info will be registered with that world's latent action manager,
there's no need to call FLatentActionManager::AddNewAction().

> [!IMPORTANT]
> A future update will simplify this logic to make it more performant, reliable,
> and match BP behavior even more closely.
> To prepare, make sure your world context object is the first parameter (`this`
> for nonstatic members).
The detected world context (most often `this` for non-static member UFUNCTIONs)
will act as the latent action's owner, and the coroutine will enjoy a measure of
lifetime tracking and protection from the latent action manager, mostly
Expand Down
2 changes: 1 addition & 1 deletion Plugins/UE5Coro/UE5Coro.uplugin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"FileVersion": 3,
"Version": 1,
"VersionName": "1.10",
"VersionName": "1.10.1",
"FriendlyName": "UE5Coro",
"Description": "C++17/20 coroutine implementation for Unreal Engine",
"Category": "Programming",
Expand Down
2 changes: 1 addition & 1 deletion Plugins/UE5CoroAI/UE5CoroAI.uplugin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"FileVersion": 3,
"Version": 1,
"VersionName": "0.10",
"VersionName": "0.10.1",
"FriendlyName": "UE5Coro – AI",
"Description": "C++20 coroutines for AI",
"Category": "Programming",
Expand Down
4 changes: 2 additions & 2 deletions Plugins/UE5CoroGAS/UE5CoroGAS.uplugin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"FileVersion": 3,
"Version": 1,
"VersionName": "0.10",
"VersionName": "1.10.1",
"FriendlyName": "UE5Coro – Gameplay Ability System",
"Description": "C++17/20 coroutines for GAS",
"Category": "Programming",
Expand All @@ -14,7 +14,7 @@
"CanContainContent": false,
"CanContainVerse": false,
"IsBetaVersion": false,
"IsExperimentalVersion": true,
"IsExperimentalVersion": false,
"Installed": false,
"Modules": [
{
Expand Down

0 comments on commit ba87170

Please sign in to comment.