Reporting Issues for Documentation

General Feedback & Requests
,
585

Category: Missing information

There seems to be no doc at all for what variables are available for use within UnrealGameSync.ini. I know that the following all work:
$(ClientName) – source control workspace name
$(Change) – source control changelist number
$(ProjectDir) – obvious
$(UserName) – this is OS username, not source control username, unfortunately
$(Stream) – stream associated with the client. Learned this by trial and error.

What others are available and what do they represent? How can one find this out? Example: is the source control username available?

Thanks.

1 Like
586

Engine Version: 5.3.2

In RPCs in Unreal Engine | Unreal Engine 5.3 Documentation under “RPC invoked from the server” it says for a server-owned actor if the RPC is marked “Client” it’ll run on server. But earlier on this same page it says “to declare a function as an RPC that will be called on the server, but executed on the client, you would do this” (and then says to add Client keyword). I believe it should say that it runs on client.

EDIT: Perhaps I just misunderstood what Client-owned actor means. If so, I think it would be good clarify this.

587

Wrongly spelled console commands:
FORCESKELLOD LOD=X does not appear to exist
a.VizualizeLODs should be a.VisualizeLODs

1 Like
588

Engine version: 5.3.2

Category: Out-of-date information

Description: On the page for the IK editor IK Rig in Unreal Engine | Unreal Engine 5.3 Documentation in the create section, the instructions and image say to go to Animation > IK Rig.

But, IK Rig now in a subfolder within Animation. The correct place is now in Animation > Retargting > IK Rig

image
image1416×1741 220 KB

1 Like
589

Engine Version: 5.3.2

In the Online Subsystem EOS documentation there are two errors caused by bugs in the EOS OnlineSubsystem implementation:

  1. The ini settings tell you to enable bIsUsingP2PSockets under [/Script/OnlineSubsystemEOS.NetDriverEOS]. This is incorrect and does not work. The correct setting is:
[/Script/OnlineSubsystemEOS.NetDriverEOSBase]
bIsUsingP2PSockets=true

(note that ‘Base’ has been appended to the NetDriverEOS entry).

  1. The ini settings tell you to clear the net driver array:
[/Script/Engine.Engine]
!NetDriverDefinitions=ClearArray

...

[/Script/Engine.GameEngine]
!NetDriverDefinitions=ClearArray

This is also incorrect due to a bug in the EOS Socket Subsystem. Using these settings if you try to launch a Play In Editor session as a Listen Server the editor will crash. A fix for this issue was submitted to GitHub here, however because we have cleared the net driver array there is no backup net driver to fallback to.

1 Like
590

There seems to be a switch in documentation since today, the 5.3 version now redirecting to the dev subdomain. Unfortunately, the Inheritance Hierarchy is not correctly shown any more.
Example of old documentation site:

The old link:

nicely shows the inheritance

image
image508×681 31.2 KB

The new link is completely missing that hierarchy.

image

This happens for all classes, just showing the UObjectBase with not hierarchy at all.

2 Likes
591

If that can help, I discovered today that the c++ documentation is available in the Unreal installation folder:
[…]/UE_5.3/Engine/Documentation/Builds/CppAPI-HTML.tgz
It takes time to decompress (30min with windows explorer on my computer), but the hierarchy is present. Also the navigation is not perfect, the browser often shows folders after clicking on links where index.html must be selected…

1 Like
592

The new dark theme for the Documentation layout is much harder to read and inclines the eyes to strain. Most platforms wouldn’t opt for a dark theme for Support Documentation and whilst many applications may provide dark theme layouts in their applications, there’s usually also an option for users to choose a light theme.

Please can Epic review this and at least provide an option for users to view the documentation in a lighter colour theme, or strike a better balance? Integration into the overall website doesn’t have to apply so strictly.

4 Likes
593

Me too. I was learning from the documentation for months and now it just destroys my eyes. The only solution I found is using mozilla firefoz light theme. But it is not good enough. I hope they give us a light theme option.

2 Likes
594

Getting a headache trying to read anything from the new docs page with white text on pitch black background. Theme selection is removed. The layout is worse. There is less screen space left for the actual documentation.

Deleting the documentation page to drive more people to a community hub is insane.

3 Likes
595

Engine version: 5.3.2

Category: Lack of information

Description: On the page for the create-an-automation-project-in-unreal-engine it’d be great to mention that in order to run Automation Script which is located in the project directory (not the engine directory) the RunUAT script must get the -ScriptsForProject=[path_to_uproject] otherwise the Script will not be compiled.

Spent too much time finding this argument somewhere in the source code…

1 Like
596

I agree. A light theme for the documentation should be standard…

1 Like
598

The documentation page about Packaging Projects in UE5 uses outdated screenshots from UE4 whose UI differs in such a way that following the instructions to package a project is not possible:

1 Like
599

The side bar is broken for 5.3 documentation. I can’t scroll through the categories
exp

2 Likes
600

The documentation page for UAnimNotify::Notify overloads list has the same description for each item and all of them marked as deprecated pointing at each other as a replacement.

1 Like
601

One of the Unreal Engine developer documentation pages is broken and won’t load at all on any browsers, had the same issue on mobile as well:

Releasing Your Project

If it helps, this is the message I get in the HTTP 500 response when trying to load the page:

{
"message": "reached end of buffer without matching on tag REGION",
"code": "internal_server_error"
}
1 Like
602

The NNE - Quick Start Guide - 5.3 has in the section ‘Model Data Importing’ a link to the mnist-8 model which results in a 404 because the model is not in the main branch. It is however in the new-models branch. This would then give this link: models/vision/classification/mnist/model/mnist-8.onnx at new-models · onnx/models · GitHub

1 Like
603

“CollapseCatogories” in

1 Like
604

你好，我在UE5.4中无法找到 PrimitiveInstanceUpdateCommand.h，但是很奇怪，文档中存在这个函数，是狗可以回复下结构体转移到了哪里。文档链接：F Instance Update Cmd Buffer | Unreal Engine 5.4 Documentation | Epic Developer Community

1 Like
605
  1. Reporting documentation issues in a Forum thread is not efficient. Please use a bug tracking software. Ideally use the same you use for the engine.
  2. The new documentation website is escaping the C++ code for html.
    Example: U Texture2 D/Get Mip Data | Unreal Engine 5.3 Documentation | Epic Developer Community
    appears as:
    void GetMipData
    &40;
    int32 FirstMipToLoad,
    void &42;&42; OutMipData
    &41;

Please fix.

2 Likes