Reporting Issues for Documentation

Engine version: 5.7 or earlier

Detailed description of the issue:

  • All of the “Meta Quest” devices themselves should be considered “Mobile Head-Mounted“ instead of “Desktop”. Only the “with Link“ is on PC: “Supported with Meta Quest Link Cable and Air Link to connect your headset to the power of your PC to unlock yet another level of gameplay (available separately).“ The VR Template page basically does it correctly but without mentioning 3.
  • All of the “Developing for Oculus” links point to page “Developing for Head-Mounted Experiences with OpenXR”.

A minor issue, the link:

“%sharing-and-releasing-projects/xr-development/supported-xr-platforms:topic%“

Minor documentation bug - on this page:

There is a bullet point which says:

Create active or passive Gameplay Abilities, for Actors that coordinate with your project’s gameplay mechanics, visual effects,animations, sounds, and other data-driven elements.

“Gameplay Abilities” is a link - but it is linked to the same page - I assume that it should be linked to:

HTH

Greg

The “Node Filtering” and “Graph Filtering” sections in PCG Overview docs have images that are very small, making it hard to read.

The documentation no longer include the module name. You need this in order to add the dependencies in the build.cs.
May you please add this back?
it used to appear where header file, include, type, and name are. Now it’s missing.

There is a typo on the Static Code Analysis page in Supported Analyzers section:

It should read “PVS-Studio static analyzer”.

Engine version:
5.7

Relevant Page(s):

And all of its sub-pages.

Description:
The documentation for the Iris Replication System is still marked as Experimental, but the plugin has been upgraded to Beta as of UE 5.7.

Screenshot:

Engine version:
5.6-5.7

Relevant Page:

https://dev.epicgames.com/documentation/en-us/unreal-engine/migrate-to-iris-in-unreal-engine?application_version=5.6

Description:
There are multiple hyperlinks on the page “Migrate to Iris in Unreal Engine” which lead to a 404 error page instead of a page relevant to the topic.

Screenshots:

Glossary of Iris Terms page is empty

Description:
The Glossary of Iris Terms page for UE 5.7 has zero related terms listed. In UE 5.6 and prior the page had ~30 terms listed.

Engine version:
5.7

Relevant Page:

Glossary of Iris Terms in Unreal Engine | Unreal Engine 5.7 Documentation | Epic Developer Community

Screenshots:

I can’t reply to this thread more than 3 times in a row, so I’ll add any more bugs I find to this post:

bUseIris is no longer defined in Target.cs

Description:
bUseIris is no longer defined in the engine as of UE 5.7 and shouldn’t be recommended as part of setting up Iris.

Engine version:
5.7

Relevant Page:

Introduction to Iris in Unreal Engine | Unreal Engine 5.7 Documentation | Epic Developer Community

Screenshots:

Most of the links in the Gameplay Tutorial section of the documentation do not work right now.

Maybe ‘T’ not ‘S’.

image

Engine version:

5.7

Description:

The TMap and TSet Slack documentation sections both initially refer to Collapsefunctions in relation to Shrink, but Collapse does not exist. They should refer to Compact instead, which it does later in those sections.

Screenshot:

From TSet

Links:

Engine Version:

5.7

Description:

Broken link in Console Variables C++ documentation. The link in the Creating / Registering a Console Variable section that is supposed to go to the EConsoleVariableFlags API reference instead goes directly to a 404 page.

It should instead link to the actual API reference page: EConsoleVariableFlags | Unreal Engine 5.7 Documentation | Epic Developer Community

Screenshots:

Unable to expand or copy code snippets in online documentation.

For example:

  1. Go to Gameplay Ability System - Best Practices for Setup | Tutorial
  2. Scroll down to any subsection containing a code snippet, such as Gameplay Ability System - Best Practices for Setup | Tutorial ?
  3. Click on Expand code button
  4. Observe an error such as “Error loading snippet Could not find snippet with id 28708” (ID is different per snippet):

  1. Since the copy button is now disabled, reload the page and repeat previous steps, but this time press on the copy button.
  2. Observe the same error.

https://dev.epicgames.com/documentation/en-us/unreal-engine/create-an-automation-project-in-unreal-engine?application_version=5.4

Starting from Version 5.4 this page added Foreign Project path, but it has too many issues. Worst part, it does not work.
And there a plenty of inconsistencies, like version of the .NET, pressing .bat file when we right clicking .uproject, folders that change names in different parts.

Following the documentation around the example tick-based Update() implementation, it seems like there are some obsolete references for 5.7.4.

World is a member of the UGameViewportClient, and retrieval of the USignificanceManager is now done via static Get(UWorld*) on itself and not the FSignificanceManagerModule.

Suggested revision to the sample code:

#include "MyGameViewportClient.h"

#include "SignificanceManager.h"
#include "Kismet/GameplayStatics.h"

void UMyGameViewportClient::Tick(float DeltaTime)
{
    // Call the superclass' Tick function.
	Super::Tick(DeltaTime);
	
    // Ensure we have a valid World and Significance Manager instance.
	if (UWorld* MyWorld = GetWorld())
	{
		if (USignificanceManager* SignificanceManager = USignificanceManager::Get(MyWorld))
		{
            // Update once per frame, using only Player 0's world Transform.
			if (APawn* PlayerPawn = UGameplayStatics::GetPlayerPawn(MyWorld, 0))
			{
               // The Significance Manager uses an ArrayView. Construct a single-element Array to hold the Transform.
				TArray<FTransform> TransformArray;
				TransformArray.Add(PlayerPawn->GetTransform());
				// Update the Significance Manager with our single-element Array passed through an ArrayView.
				SignificanceManager->Update(TArrayView<FTransform>(TransformArray));
			}
		}
	}
}