Where is the C++ API?

Development Programming & Scripting
1

This feels kind of silly to ask, but is there an somewhat thorough API somewhere online? How do people go about programming in C++? I just want to find the function signature for something like “OnActorEndOverlap()” and I can’t seem to find it anywhere. For instance, I found this: OnActorEndOverlap | Unreal Engine Documentation
But the information is not complete, unless I am missing something…

2

The API is written here where you found that. Programming with C++ | Unreal Engine Documentation

There are some points that are slightly out of date, but they are constantly being updated and imho is much better than most documentations out there. What is incomplete about what you found? It might be you have found a problem and then you can report it.

HTH

3

Good call, thanks mate!

4

You can look at the GitHub repository. https://github.com/EpicGames/UnrealEngine

OnActorEndOverlay is declared here: https://github.com/EpicGames/UnrealEngine/blob/55c9f3ba0010e2e483d49a4cd378f36a46601fad/Engine/Source/Runtime/Engine/Classes/GameFramework/Actor.h#L623

Otherwise the docs that you linked would be the way to go.

5

I can only agreed that this kind of documentation https://docs.unrealengine.com/latest/INT/API/Runtime/Engine/GameFramework/AActor/OnActorEndOverlap/index.html is almost 100% useless and frustrating :smiley:

6

Really? What more would you want? An example?

7

Something is clearing missing there. Like @hardballs, said, you have no idea about the function signature. When you click on FActorEndOverlapSignature to get more info, you get this page which is this time really useless.

For example, the BeginPlay function is way more documented here. You have the function signature, an example, the source file to look at if you want more infos and a small comment.

I don’t think it’s normal that it’s faster to find your answer doing a “Find All” withing Visual Studio than looking in the documentation.

Why is there no Doxygen style API documentation ? This would be sooooo much better :slight_smile:

Examples and tutorials are great and a very nice resources to understand how things work together withing UE4, but as soon as you get into C++, you find yourself alone in the middle of UE4 magics.

I think most of UE4 users agrees on the fact that the documentation is great for starting and doing middle advanced stuff with UE4. But I think they also agrees that as soon as you “get of the road”, it gets painful to use and almost a time killer.

That was my though about UE4 documentation :D.

EDIT: Oh and my faster, most complete UE4 documentation is actually the Answers Hub :smiley:

8

I never have this problem because I have intellisense/resharper that gives me the signature and the documentation to give me some info. I do agree that the documentation should include the signatures.

9

Intellisense is slow AF on my UE4 project, I can’t use it properly :smiley:

10

How do people go about programming in C++?

Visual Assist and Alt+G to jump to the source (after you’ve setup visual studio). It’s easier to jump around the source code than open up a web page doc. Ctrl+Shift+F is also handy to find examples of usage.

However, the docs do need some love. I would like to see this feature request added and people voting for it.