x

Search in
Sort by:

Question Status:

Search help

  • Simple searches use one or more words. Separate the words with spaces (cat dog) to search cat,dog or both. Separate the words with plus signs (cat +dog) to search for items that may contain cat but must contain dog.
  • You can further refine your search on the search results page, where you can search by keywords, author, topic. These can be combined with each other. Examples
    • cat dog --matches anything with cat,dog or both
    • cat +dog --searches for cat +dog where dog is a mandatory term
    • cat -dog -- searches for cat excluding any result containing dog
    • [cats] —will restrict your search to results with topic named "cats"
    • [cats] [dogs] —will restrict your search to results with both topics, "cats", and "dogs"

How to browse API documentation?

Is there some sensible way to browse class methods and the like?

For example, I see that GetPlayerPawn is documented here: https://docs.unrealengine.com/latest/INT/API/Runtime/Engine/Kismet/UGameplayStatics/GetPlayerPawn/index.html

but if I click on UGameplayStatics from there (to reach https://docs.unrealengine.com/latest/INT/API/Runtime/Engine/Kismet/UGameplayStatics/index.html), there are no members documented/linked whatsoever.

Is there no way to "explore" the API if I don't know the exact name of something I'm searching for? Or is there some clever reason I don't realize why members are documented, but not linked from the class they belong to, in the API documentation?

Currently I'm resorting to Googling blindly, finding answers or wiki pages which are often already outdated, or looking at the names of blueprint nodes and trying to find the corresponding C++ name so I can look up a page like the first one I linked.

Product Version: UE 4.14
Tags:
more ▼

asked Apr 03 '17 at 09:13 PM in C++ Programming

avatar image

gardenvariety
28 2 3 9

(comments are locked)
10|2000 characters needed characters left
Viewable by all users

2 answers: sort voted first

API Refrence since something around 4.6 starting to have holes like that and i reported in documentation bug raport section in forums but without any reponce.

In such cases header files themselves are best documentation you can get, in API Refrence pages you got path to header file where the specific thing is declered and you can do there, since header rarely got any code and just declerations it is quite readable. So in case of UGameplayStatics is here:

https://github.com/EpicGames/UnrealEngine/blob/76085d1106078d8988e4404391428252ba1eb9a7/Engine/Source/Runtime/Engine/Classes/Kismet/GameplayStatics.h

Also in VS if you right click any function or class you can go to deceleration, not to mention all data in header file is used in auto-complete, so you get the same content you would get in API refrence

Ofcorse htis is not excuse to keep API refrence incomplete

more ▼

answered Apr 04 '17 at 09:33 PM

avatar image

Shadowriver
37.2k 936 172 1116

(comments are locked)
10|2000 characters needed characters left
Viewable by all users

There used to be a CHM file you could use to browse the API offline, unfortunately I don't see that file anymore.

https://docs.unrealengine.com/latest/INT/

Is your best bet for documentation and just "browsing". But even that resource can be out of date so I tend to use it as a starting point and then always go read the code itself to verify it behaves the same as the documentation describes.

more ▼

answered Apr 04 '17 at 03:30 PM

avatar image

ExtraLifeMatt
1.6k 34 14 48

(comments are locked)
10|2000 characters needed characters left
Viewable by all users
Your answer
toggle preview:

Up to 5 attachments (including images) can be used with a maximum of 5.2 MB each and 5.2 MB total.

Follow this question

Once you sign in you will be able to subscribe for any updates here

Answers to this question