I’m fairly new to Unreal Engine, and I have to say the tooltips and documentation are a hit or miss.
For example in my UI widget I’m working on, I binded the text to a function. In the details panel there is a boolean for “Pure”, and when you hover over it, it says “Force this to be a pure function?”. LOL. What does that even mean?
An example of the documentation needing work. I looked up “On Component Begin Overlap” for blueprints. This is what is has on the Docs page, “Event called when something starts to overlaps this component, for example a player walking into a trigger. For events when objects have a blocking collision, for example a player hitting a wall, see ‘Hit’ events.”
Well that’s all fine and dandy, but it doesn’t tell me how to use it, what each pin on the blueprint does, and doesn’t show any example of how to use it.
That’s like looking for a specific type of cat and going to a documentation page saying “It’s a cat.”
For example in my UI widget I’m working on, I binded the text to a function. In the details panel there is a boolean for “Pure”, and when you hover over it, it says “Force this to be a pure function?”
That has nothing to do with documentation. Pure functions are a concept in programming and such a simple Google would have answered all you needed to know.
Well that’s all fine and dandy, but it doesn’t tell me how to use it, what each pin on the blueprint does, and doesn’t show any example of how to use it.
Yeah examples would be good but the pins are pretty self explanatory. One literally says Other Actor. What would the docs say here? Something like “The other actor?”.
I’m not saying the docs/tooltips are perfect but your lack of understanding in these concepts isn’t going to be fixed by having overly verbose and redundant documentation. It will come with time.
I do agree that basic documentation examples would be a nice feature.
Oh I love learning UE, but some documentation would be good. Luckly for me, there seems to be a pretty big community and 99% of the time, I can usually find the answer I am looking for.
I’ve only been learning UE for about 1-2 months and I’ve already created a full prototype game, so at least I am moving forward.