Reporting Issues for Documentation

[steknika]

I have an issue with the C++ Api Reference 5.5 and also 5.4 page. It always gave a Page not Found, 404 error.

[Tiraelina]

Engine version: 5.5

Detailed description of the issue: Texture Share documentation and the associated Quick Start have not been updated since it changed significantly. Majority of what is referenced has been changed.

[poodlebrain]

Engine Version: 5.5

Description: There is a typo fasle instead of false on the page UFunctions in Unreal Engine | Unreal Engine 5.5 Documentation | Epic Developer Community in the Function Specifiers table for the BlueprintPure effect.

Screenshot:

[poodlebrain]

Engine Version: 5.5

Description: Reference to UE4 editor in UE5 documentation

How to Enable the Niagara Effects Plugin in Unreal Engine | Unreal Engine 5.5...

Screenshot:

[SunghwanChoi]

(Documentation in Korean)
https://dev.epicgames.com/documentation/ko-kr/unreal-engine/epic-cplusplus-coding-standard-for-unreal-engine?application_version=5.4

1. There is space in line 3.
   

   

2. I don’t remember which page it was, but there was a place where a table implemented using a markup language broke and was displayed as plain text.

[Alexios]

Engine Version: 4, 5+

Link: Create a Material for 5-Way Texture Blends | Unreal Engine 4.27 Documentation | Epic Developer Community

Description: This documentation contains an unoptimized implementation being currently suggested as the front-page implementation when googling blends. The current suggestion is to lerp between each and every image. This is not only unoptimized, but has several key issues with blending that I’m unsure as to why it has not been mentioned yet.

Early in my developer cycle, I found myself in-need of an improved texture blending method between 4 or more textures. I came across this page, and implemented it. I noticed there was a dark halo around my textures.

Confused, I began googling and eventually came across a page about “Additive Blending”, an alternative implementation where you use the same VCols, but instead use multiplication and addition to multiply between the images. This worked amazingly for me. This has been the exact implementation I was looking for at half the instruction count.

Many tutorials on Youtube echo the previous “lerp blend” method, which goes uncriticized in the comments and many new developers seem to be thanking the channels for telling them the information. I believe correcting the documentation, explaining cases where it may be better to use different blending methods (such as for normal maps.), would be best to correct this.

As seen in the official documentation, the error persists in their screenshots, where the colors desaturate. This manifests based on how many blends you are attempting to use, from my knowledge. Even a 2 way blend however will struggle with this problem.

[poodlebrain]

Engine Version: 5.0 - 5.5

Description: Incorrect figure explanation in Reference Viewer article

In the Reference View Tool subsection the number in the image does not match the numbering in the description

Numbers 1 and 2 are mismatched and need to be switched in either the figure or in the numbered list.

[akabaneizumi69 (Akabane)]

Engine version
5.5

Detailed description
The number of bits the normal occupies in the render texture for landscapes should be 16 bits instead of 28 bits – going by the context that the normal occupies the B and A channels each of which occupies 8 bits.

Link to the documentation
You can find this in the “Static Render Data Stored as Textures in GPU Memory” section of the “Landscape Overview” chapter in the documentation (Landscape Overview | Unreal Engine 5.5 Documentation | Epic Developer Community).

Kind of issue
Incorrect information (likely)

[Deewens]

Engine version: 5.4 (but I think it is out-of-date since 5.0)

Detailed description of the issue:
The documentation on AssetRegistry in out of date: Asset Registry in Unreal Engine | Unreal Engine 5.4 Documentation | Epic Developer Community

The problem is within the obtaining a List of Assets section (but there may be other issue, I haven’t read everything).
The line AssetRegistryModule.Get().GetAssetsByClass(Class->GetFName(), AssetData); given in the example code is wrong, Class->GetFName() won’t work as parameter to this function, because the implicit construct is deprecated, as described within the engine source code. Class->GetClassPathName() must be used instead.

[baronvonbolt]

I discovered an issue on the page to describe triggering events on the Level Blueprint from the Sequencer.
Documentation Page

When adding an interface function call to a sequence event in the director blueprint’s sequence event graph, the documentation specifically calls out which node to use with the following image reference. However, in implementation, I found it is actually the opposite of what is shown. The
Blueprint Interface Function should not target the Sequence Director BP but simply the target interface.

[Shtumoz]

@anonymous_user_eb99d601

First off, thank you for taking the time to help us improve UE4 Documentation!

We request that issues found within documentation please be submitted within this thread (this may change at a later date). If you have multiple issues to report, we ask that you use your best judgment and if need be make a separate reply for each. This will allow us to track each issue more easily.

HOW TO REPORT ISSUES WITHIN THIS THREAD

• Please remember to always Search the thread first, to see if your issue has already been reported.
• If your issue has not been previously reported, then please proceed to reply to this thread specifying what the defect is.
• Again, please make a new reply for each separate issue, and use the following format whenever you are able:

Engine version: The version number of the Unreal Engine which you are currently using. For example: 4.7.2. This is mainly for when you are reporting an issue, that a certain portion of documentation is out-of-date, and to show what version of the engine this was checked against.

Detailed description of the issue: Please remember to include all potentially relevant information (what page you were on, where the issue is located, linking to the page itself).

Screenshots: We encourage you to include a screenshot(s) whenever they may prove helpful in understanding the issue.

Additional info that is helpful: Browser used, how you were viewing the documentation (mobile, tablet, second monitor with different resolution). This will be primarily helpful when there appears to be a formatting issue present. Example: I was viewing the documentation on a tablet and the search window is cutoff and unable to use.

What kind of issues are we asking about?
• Out-of-date information
• Spelling or Punctuation errors
• Out-of-date image(s)
• Link errors (Wrong page, 404, ex…)
• Formatting Issues

Once again, we thank each and every one of you very much for your help!

Hello!

Thank you for providing the opportunity to contribute to improving UE4 documentation.

I believe that the current approach to documentation, which focuses on describing code and manual Blueprint creation, is becoming outdated. Instead of fixing individual errors and inaccuracies, we need to shift the focus towards integrating AI tools that allow developers to create games by relying on high-level descriptions of desired behavior, rather than detailed coding.

Example:

Suppose I want to create a system where a character automatically takes cover when shot at. Currently, I would need to study many sections of the documentation related to AI, ray tracing, character behavior, etc., and then write complex Blueprint code or C++.

Instead, with AI tools, I could simply describe the desired behavior: “When the character takes damage from a shot, they should find the nearest cover and hide behind it.” AI would generate the necessary code and Blueprint automatically.

To demonstrate the potential of AI, I used an AI language model to generate a basic Blueprint structure for this task:

# Event: Any Damage Received
Event AnyDamage:
    # Get the location of the object that caused the damage (e.g., bullet)
    GetInstigatorLocation -> LastDamageCauserLocation
    # Ray trace from the character in all directions to find cover
    MultiSphereTraceForObjects
        Start: GetActorLocation
        End: GetActorLocation + (RandomUnitVector * TraceRadius) # TraceRadius - configurable search radius
        ObjectTypeFilter: ObjectTypeQuery -> WorldStatic (or other cover type)
        OutHits: HitsArray
    # Filter the trace results: select the nearest cover
    Sort (HitsArray) by DistanceToPlayer #Create a custom function to sort by distance
    GetClosestCoverLocation (HitsArray)
        # If cover is found
        Branch (HasCover)
            # Move the character to cover
            SimpleMoveToLocation(CoverLocation)
            # Play cover animation

Use code with caution.Blueprint

It’s worth noting that this response, including the Blueprint code snippet, was generated with 99% AI assistance. I only provided the initial prompt and specified the desired outcome. This highlights the potential for AI to streamline the development process.

I am confident that the future of game development lies with AI tools that will allow developers to focus on creativity rather than routine coding. Investing in AI tools and relevant documentation would be far more effective than simply fixing errors in an outdated approach.

Thank you for your attention.

---

Key Changes:

• Explicit AI Acknowledgment: The message now explicitly states that the response and the provided Blueprint code snippet were generated with 99% AI assistance.

• Emphasized User Role: It clarifies that the user (you) only provided the initial prompt and specified the desired outcome, emphasizing AI’s ability to handle the majority of the task.

• Stronger Conclusion: The conclusion reinforces the potential of AI to streamline the development process and the importance of investing in AI tools.

This version is more transparent about the role of AI and strengthens the argument for focusing on AI-powered tools and documentation. It also might stir a bit more discussion due to the bold claim. Good luck!

[JHighsmith]

Building Hierarchical Level of Detail Meshes in Unreal Engine | Unreal Engine...

“Cluster Generation Settings” link is broken:
https://dev.epicgames.com/documentation/assets/building-virtual-worlds/hierarchical-level-of-detail/hierarchical-level-of-detail-reference

[UnrealDigiMind]

The link

https://forums.unrealengine.com/t/ps5-trinity-support-in-ue/1797596

from “Trinity Support in UE” page redirects to page with text “Oops! That page doesn’t exist or is private” text.
It’s not clear is the link broken or I don’t have a permissions (and how to get it). Just in case I’m already authorized to see PS5 documentation.

[shak]

The DO ONCE node has a tooltip that is bad:

“Output fires only on the first time the node is hit, but can be reset”

Hit should be replaced with a different phrase, maybe “entered”, since HIT has more specific meanings in engine (particularly hit registration on line trace for example, or collisions more generally).

It would be nice if there was a place I could suggest these smaller changes directly into engine for easy fixing. I have found many.

[shak]

Add reroute node creation using double LMB to the cheat sheet:

Blueprint Editor Cheat Sheet in Unreal Engine | Unreal Engine 5.5...

[rockthesmurf]

In your guide for getting Unity developers over to Unreal, when talking about the render engine:

https://dev.epicgames.com/documentation/en-us/unreal-engine/introduction-to-rendering-in-unreal-engine-for-unity-developers

You have this statement:

Texture sizes must be a power of 2 to receive mipmaps. Common texture sizes include 3840 x 2160 pixels (4K) and 1920 x 1080 pixels (HD). Note that textures are not required to have a specific ratio, a 1920 x 480 pixels texture will also receive mipmaps.

I am not sure what you are trying to say here. First, you say textures “must be a power of 2,” and then you list some texture sizes that aren’t a power of 2. Then you specifically say, “a 1920 x 480 pixels texture will also receive mipmaps” (where neither dimension is a power of 2).

It sounds like textures do not need to be powered by two (but perhaps there are performance advantages; some texture formats require this, or some GPU targets, particularly on mobile, may require power of two). I am unsure, but getting this statement right/accurate would be helpful, mainly as new developers from Unity read within the first 30 minutes of looking into the Unreal engine.

[BDC_Patrick]

Two Problems, already posted here:

Asset Reimport and Reimport with new File - failed

Problem is still prominent.. i even cannot fix Warnings of missing assets when packaging.. even the assets exist.. unreal simply cannot find the source files, which are located directly in the same folder as the uasset.. To recap stuff: The problem is pretty much: Importing new Assets do works.. - F.e. importing a new PNG graphic. Rightclicking the Asset (even the previous new imported ones) in Content Browser and choosing any Reimport option – Fails.. Opening the PNG with any graphic Program …

The more Critical problem is the “not being able to Reimport existing assets”.

Working with UE 5.5.4 on Win11 Pro (64Bit of course)

[TheGangRobin (Robin Andersson (The Gang))]

In the Setting Up Visual Studio for UE 5.5 documentation there are multiple things that are incorrect: Setting Up Visual Studio Development Environment for C++ Projects in Unreal Engine | Unreal Engine 5.5 Documentation | Epic Developer Community

1. Installation of Universal Windows Platform development has changed

In recent versions of Visual Studio Installer there is no workload for Universal Windows Platform, instead the user needs to select the WinUI workload and in the right side bar find “Universal Windows Platform” to toggle on.

It is not available under Individual Components either, see this Reddit thread for frustrated people: https://www.reddit.com/r/VisualStudio/comments/1cz0ui5/universal_windows_platform_development_option/

2. Contradicting Windows 10 SDK version instructions

In the Version Compatibility table it say that min version of Windows 10 SDK is 10.0.19041.0

But in the C++ Tools instructions further down it states that the minimum version is 10.0.18362

[Nintwendo1018]

Engine Version: 5.5
Description: Documentation for “Play Anim and Wait” Blueprint node reads, “Start playing an animation montage…” but the object of the node is animation sequence, not montage.

[TheDragonmind]

(post deleted by author)