SHVDN Docs
-
I was very surprised, and pleased today, when I realized that the documentation that is spread all over the web on SHVDN was right under my nose all this time. It's a friend who develops AAA games who chewed me out when I complained I couldn't find any docs for the object models. Even though he doesn't even use Visual Studio, he knew that if i stuck my cursor on any key word and hit F12, all the metadata would appear - including tooltips when you hover over the properties, methods, functions, etc.
Much more convenient and easier to understand than just using the intellisense feature of VS.
and more practical than the official docs which I also found today at:https://nitanmarcel.github.io/shvdn-docs.github.io/index.html
Passing this on so hopefully other noobs can benefit.
So in summary, when you are in the .cs window, just stick your cursor in the middle of a keyword like world or scenario and hit F12. To return to .cs, click the x in the purple box at the top right of this new window that appeared.
And to kill 2 birds, here are some other useful links:
Native functions: https://alloc8or.re/gta5/nativedb/
Native functions: http://www.dev-c.com/nativedb/
crosire /scripthookvdotnet : https://github.com/crosire/scripthookvdotnet/tree/main/source/scripting_v2/GTA
Good resource for entities (pictures and hashes): http://test.raccoon72.ru/
Animation List: https://alexguirre.github.io/animations-list/
Ped Tasks: https://github.com/crosire/scripthookvdotnet/blob/main/source/scripting_v2/GTA/Entities/Peds/Tasks.csScreenshots below from Visual Studio 2019 just to illustrate you have almost everything you will need to interact with SHVDN - once reference is added to your project. You will have one page for every keyword, click and F12 and hover over with mouse if necessary. Of course you also have intellisense as a great tool.
Some updates:
Object Browser (ctrl + alt + J) in VS will allow you to view references including SHVDN. (thanks @mcal9909)
Meta data will also contain useful information for example on how scenarios change depending on character model and other conditions. (thanks @grateful_for_mods)
As an example for Meta data, check out Scenarios.meta. Path to file will depend on your installation, mine as an example:
P:\SteamLibrary\steamapps\common\Grand Theft Auto V\common.rpf\data\ai\scenarios.meta
(Use OpenIV to view this .xml file)Top pic clicking on Class World. Bottom on Class Tasks.
-
@JohnFromGWN P.S. If anyone cares to share other docs, please post them here and I'll append the list above. That would really be appreciated.
-
Object browser is also a good tool for figuring out what you can do.
View > Object Browser (ctrl + alt + J) > select your reference to scripthookVdotnet > GTA. Then from there you can view a list of all the classes, and the methods, properties these classes contain and how to use them.
You can also use this to view enums used in SHVDN.
-
@mcal9909 Good to know. Thanks. Will check it out.