Reporting Issues for Documentation

[AlwysAnrchy]

Howdy master_rigel,

@master_rigel;388752

Using Menu Anchors in UMG for Unreal Engine | Unreal Engine 5.3 Documentation
Menu Anchor

> Widget Details
> > Options Table
change “Placement” to “Render Transform”

I have just checked this option in 4.9.1 and in the latest main branch. Both versions have this feature listed as ‘Placement’.

@master_rigel;388809

https://docs.unrealengine.com/latest/INT/Engine/Blueprints/QuickStart/5/index.html
5. Test the Overlapping Actor

8. Connect the output pin of the Equals node to the input (-Boolean) (+Condition) pin on the Branch node.

This fix has been made and will show live after the next publishing.

@master_rigel;388765

Perhaps move “Blueprints Visual Scripting” above “Engine Features”

I am placing this feedback inside the issues topic because it is a serious issue for me. It is slowing down my learning of UE4 substantially.

I understand this change could be a bit drastic, but Blueprint is so pervasive across the engine (in materials, in umg, in “Gamplay Guide”, and almost all other scripting), that perhaps it should be introduced much earlier than it is presently. At the very least consider it an “engine feature”, and move to the top of that section because it has so many hooks into the way the engine works. Without it, someone who does not know C++ practically has their hands tied.

A) Following the documentation in linear form and cross-referencing the blueprints docs as I go, I am having to learn much by trial and error that is spelt out plain and simple in the blueprint docs.
B) It appears as though I can follow the blueprint docs relatively easily without having to reference other engine features so long as I’ve finished “Get Started with UE4” and “Unreal Editor ManuaL”

Regards,

I will bring up this topic during our next meeting and see what everyone’s response for this change is.

Thanks again!

@;389025

HI,

In https://docs.unrealengine.com/latest/INT/Resources/ContentExamples/MaterialProperties/1_5/index.html and all the Material page that refers to “Domain”, it is not updated with 4.9 possible Values.
Now there is a “UI” one.

thanks,

Howdy ,

Thank you for your feedback. I have fixed the Documentation to include Interface in the Table. I have also entered UEDOC-2497 into our Database so that we can address the issue.

@Drout;388657

Hi! me again:) Could you, please, take a look at https://docs.unrealengine.com/latest/INT/Programming/Tutorials/Components/4/index.html, on the Step #2 we can read: … so let’s open CollidingPawn.cpp …] - it should be CollidingPawn.h instead. Thanks in advance

Howdy Drout,

I have just entered ticket UEDOC-2500 into our database so that this page can be fixed. I am unsure as to when this will be fixed but I will be sure to keep you posted when I see an activity on this ticket.

Thanks!

[Richard_Hinckley]

@Drout;388657

Hi! me again:) Could you, please, take a look at https://docs.unrealengine.com/latest/INT/Programming/Tutorials/Components/4/index.html, on the Step #2 we can read: … so let’s open CollidingPawn.cpp …] - it should be CollidingPawn.h instead. Thanks in advance

Hi, Drout. Thanks for your suggestion! What you said will work fine, but the way that the code is currently written should also work. You’ve brought up an interesting issue that I think is worthy of some explanation.

As long as the compiler knows that UCollidingPawnMovementComponent is a class, and we don’t refer to anything inside of that class, a pointer to it can be declared in CollidingPawn.h without including UCollidingPawnMovementComponent’s class definition. This is because pointers are all the same size (they are just memory addresses, ultimately), so the compiler doesn’t care what a UCollidingPawnMovementComponent is, beyond the fact that we promise it’s a real class somewhere in our code base. Putting the word “class” in front of UCollidingPawnMovementComponent is all the the compiler needs to handle CollidingPawn.h, although the linker will complain if we don’t fulfill that promise.

CollidingPawn.cpp, on the other hand, actually uses the UCollidingPawnMovementComponent class, meaning that the compiler does need to know what’s inside UCollidingPawnMovementComponent to compile CollidingPawn.cpp. Including CollidingPawnMovementComponent.h directly in the CollidingPawn.cpp is good enough to handle this. Including it from CollidingPawn.h as you suggested would also work, and we could remove the word “class” before the pointer to UCollidingPawnMovementComponent if we did it that way.

However, if we include CollidingPawnMovementComponent.h from CollidingPawn.h, then any other file that includes CollidingPawn.h will also include CollidingPawnMovementComponent.h, which means the compiler will be forced to parse CollidingPawnMovementComponent.h (and anything included by it) every time CollidingPawn.h is #included, regardless of whether UCollidingPawnMovementComponent is used for anything other than declaring a pointer. For this tiny project, to be honest, it doesn’t matter. In large projects, though, unnecessary #includes can increase compile time substantially.

Again, thanks for bringing this up. This technique is really more general C++ software engineering than Unreal Engine-specific, but it’s still good to discuss.

[master_rigel]

Blueprints Visual Scripting

Possibly move Blueprints - How To’s up beside Blueprints Quick Start Guide

The How-To’s appear to have allot of getting started content and don’t seem to belong almost at the end of this page. What do you think?

[AlwysAnrchy]

@master_rigel;389475

Blueprints Visual Scripting in Unreal Engine | Unreal Engine 5.3 Documentation

Possibly move Blueprints - How To’s up beside Blueprints Quick Start Guide

The How-To’s appear to have allot of getting started content and don’t seem to belong almost at the end of this page. What do you think?

Howdy Howdy,

I spoke with a couple of Team members about their thoughts on moving the Blueprints How-To. We are planning on possibly doing a major overhaul on the TOC, but I am unsure as to when this will take place (should be fairly soon). I will be sure to update you when I know more.

Thanks for the feedback!

[master_rigel]

What about using PHP imports?

I was wondering if the documenation backend is written in PHP. If it is, then you could actually make references to other pages without having to redirect the to other links. Using PHP imports, one can display content from other pages directly inisde an element on the page that the is currently viewing. I use this feature extensively throughout my own website to get around some convoluted details of CSS. For example my header and footer are separate pages, but I import them. One could forseeably break up the documentation pages into separate pages that act as containers and then display them wherever they want them. In my case what this did for me, is that it reduced the issue of typographical errors. It created consistency across my pages and I didn’t have to re-write content or code.

[master_rigel]

Guide and Reference

UE4 is a rather large piece of software and perhaps should have two different forms of documentation? A guide that can be read from start to finish, and a reference that can be used to quickly find details on a specific feaure. I’m not sure how feasable this is, but I see it done with lots of other software products. I think that many companies might turn to this model because things get muddled when they try to mix a guide with a reference. It would be like trying to learn english from a dictionary that has the lessons thrown in where the words use a particular rule or rules english.

[master_rigel]

Hi guys. I have some unfortunate news. I will be stopping using Unreal Engine for the time being. I’m feeling really stuck with the state of affairs of the blueprint documentation and I don’t particuarly want to learn C++. Yet another language. I already know javascript, C#, Java, PHP, and ASP among others. I’m very resistant to learning C++ because I quite prefer the idea of managed code. I will check back in in a week and see how things are going. For now I’m going to pursue Unity and if my game is finished on Unity before I can finish the Unreal Engine documentation for blueprints and make something sensible ontop of it, then I guess my choice of engines will be made. I like to use the best tools, but I need to use the tools that I can put into my work.

Best of luck!

[Pierdek]

Command-Line Arguments

SEEKFREELOADING: Only use cooked data.
SEEKFREEPACKAGEMAP: Override the package map with the seekfree (cooked) version.
SEEKFREELOADINGPCCONSOLE: Only use cooked data for PC console mode.
SEEKFREELOADINGSERVER: Only use cooked data for server.

These entries should be removed, they aren’t used in UE4, but I remember them from the UE3. Besides it would be nice to have some kind of switch to load cooked content only…

[Flakky (Alexander Blintsov)]

Collision How To's

“Add a Custom Trace Type to your Project” link leads to a blank page

You should remove this link, because there are instructions to this inside “Add a Custom Object Type to your Project”

[AlwysAnrchy]

@AlFlakky;397294

Collision Tutorials in Unreal Engine | Unreal Engine 5.3 Documentation

“Add a Custom Trace Type to your Project” link leads to a blank page

You should remove this link, because there are instructions to this inside “Add a Custom Object Type to your Project”

Howdy AlFlakky,

Thank you for the feedback about these pages. We has a couple of pages go through our publishing that had minimal to no information on them. These pages were supposed to be placeholders but got pushed live. We are hoping to get these pages filled out with information soon.

Thanks again and have a great day!

[Kashaar]

Article: https://docs.unrealengine.com/latest/INT/Programming/Tutorials/AutoCamera/2/index.html

Engine version: 4.9.2

Description:

3. In CameraDirector.cpp, add the following line of code to the top of the file, right underneath the other include lines:

include “Kismet/GameplayStatics.h”

The GameplayStatics header file gives us access to some useful general-purpose functions, one of which we will need for this tutorial.

If you follow those instructions, it produces a compiler error:

fatal error C1083: Cannot open include file: ‘Kismet/GameplayStatistics.h’: No such file or directory

Could it be that this is outdated? The tutorial project works just fine if you simply leave out that line.

[Elvince]

On page:

EWorldType::Type

Tha Struct value are not in front of the comment. There is a gap of 1 row.

[Mosel3y]

@Kashaar;407526

Article: https://docs.unrealengine.com/latest/INT/Programming/Tutorials/AutoCamera/2/index.html

Engine version: 4.9.2

Description:

If you follow those instructions, it produces a compiler error:

Could it be that this is outdated? The tutorial project works just fine if you simply leave out that line.

It’s GameplayStatics.h not GameplaStatistics.h

[Pierdek]

Component Replication

/** FActory method for instantiating templatized TobjectReplicator class for subobject replication */
virtual class FObjectReplicatorBase * InstantiateReplicatorForSubObject(UClass *SubobjClass);

There is no such thing as FObjectReplicatorBase or InstantiateReplicatorForSubObject in the engine code, probably was removed in <=4.9.

[BadgerBone]

https://docs.unrealengine.com/latest/INT/Engine/Components/Lights/index.html

There are two mistakes:

1. The “See More Information” lines under Sky Light and Spot Light are switched, each referring to the other one.

2. That page’s link to the page on Sky Lights is currently listed as:

Sky Lights

but that does not work (I am on a Windows 10 PC using Chrome Version 46.0.2490.86 m, though I also tested it on MS Edge).
I found the proper link at:

Sky Lights

The only difference is the use of a lowercase L in “Skylight” in the link when the actual page uses a capital L.

[BadgerBone]

On the Rendering Components page

Rendering Components

under “Instanced Static Mesh Component” it attempts to link to a Procedural Room Generation video using the link
https://docs.unrealengine.com/latest/INT/Videos/Player/index.html?series=PLZlv_N0_O1ga0aV9jVqJgog0VWz1cLL5f&video=mI7eYXMJ5eI&utm_source=uelauncher&utm_medium=software&utm_campaign=learntab

That link is not found, but I did find this page, which is maybe what that link is suppoed to point to:
https://docs.unrealengine.com/latest/INT/Videos/PLZlv_N0_O1ga0aV9jVqJgog0VWz1cLL5f/mI7eYXMJ5eI/index.html

[AlwysAnrchy]

Howdy Badger Bone,

Thank you for your feedback!

@Badger Bone;423554

https://docs.unrealengine.com/latest/INT/Engine/Components/Lights/index.html

There are two mistakes:

1. The “See More Information” lines under Sky Light and Spot Light are switched, each referring to the other one.

2. That page’s link to the page on Sky Lights is currently listed as:

Sky Lights in Unreal Engine | Unreal Engine 5.3 Documentation

but that does not work (I am on a Windows 10 PC using Chrome Version 46.0.2490.86 m, though I also tested it on MS Edge).
I found the proper link at:

Sky Lights in Unreal Engine | Unreal Engine 5.3 Documentation

The only difference is the use of a lowercase L in “Skylight” in the link when the actual page uses a capital L.

I have gone in and switched the links on the page you have reported. These links should be updated after the next publishing.

@Badger Bone;423572

On the Rendering Components page
Rendering Components in Unreal Engine | Unreal Engine 5.3 Documentation

under “Instanced Static Mesh Component” it attempts to link to a Procedural Room Generation video using the link
https://docs.unrealengine.com/latest/INT/Videos/Player/index.html?series=PLZlv_N0_O1ga0aV9jVqJgog0VWz1cLL5f&video=mI7eYXMJ5eI&utm_source=uelauncher&utm_medium=software&utm_campaign=learntab

That link is not found, but I did find this page, which is maybe what that link is suppoed to point to:
https://docs.unrealengine.com/latest/INT/Videos/PLZlv_N0_O1ga0aV9jVqJgog0VWz1cLL5f/mI7eYXMJ5eI/index.html

I have updated the link so that you are no longer brought to a 404 page and are sent to the Wiki page where that tutorial is located. This will link correctly once the next publishing is complete.

Thanks again and have a great day!

[anonymous_user_8233602d]

Thanks for the heads up Chariots! I think this is an easy fix. On that page it looks like the 14 mips info got added to the chart but just not updated as the number in the info located higher up on the page.

[BadgerBone]

On the FString page, section “Numeric and Other Variables”

FString

The first section is titled “From FString” but the table is to string.

Likewise, the second section is titled “To FString” but the table is from string. It also incorrectly labels the column in the table as “Conversion to String” instead of from.

[AlwysAnrchy]

@Badger Bone;440809

On the FString page, section “Numeric and Other Variables”
FString in Unreal Engine | Unreal Engine 5.3 Documentation

The first section is titled “From FString” but the table is to string.

Likewise, the second section is titled “To FString” but the table is from string. It also incorrectly labels the column in the table as “Conversion to String” instead of from.

Howdy Badger Bone,

Thanks for pointing out this error in our Documentation. I have just fixed this page internally with the fixes you have provided. This page fix will show correctly after the next publishing.

Thanks again and have a great day!