Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document various HUD/CAM natives #933

Closed
wants to merge 12 commits into from
Closed

Document various HUD/CAM natives #933

wants to merge 12 commits into from

Conversation

freedy69
Copy link
Contributor

Used actual names and documented what purpose they serve.

Used actual names and documented what purpose they serve.
HUD/GetMenuLayoutChangedEventDetails.md Outdated Show resolved Hide resolved
HUD/GetMenuLayoutChangedEventDetails.md Outdated Show resolved Hide resolved
HUD/GetMenuLayoutChangedEventDetails.md Outdated Show resolved Hide resolved
HUD/GetMenuLayoutChangedEventDetails.md Show resolved Hide resolved
HUD/GetMenuTriggerEventDetails.md Outdated Show resolved Hide resolved
HUD/HasMenuLayoutChangedEventOccurred.md Outdated Show resolved Hide resolved
HUD/HasMenuTriggerEventOccurred.md Outdated Show resolved Hide resolved
HUD/IsMouseRolledOverInstructionalButtons.md Outdated Show resolved Hide resolved
HUD/PauseMenuGetMouseHoverIndex.md Outdated Show resolved Hide resolved
HUD/PauseMenuGetMouseHoverUniqueId.md Outdated Show resolved Hide resolved
freedy69 and others added 10 commits November 18, 2023 13:59
* Update SetCamFarDof.md

Reduce redundancy by referencing examples instead.

* Update SetUseHiDof.md

Better to not link to URLs that could get lost in the future.

---------

Co-authored-by: ammonia-cfx <[email protected]>
* Update SetMinimapComponent.md

Add more component id's, an example and make some minor adjustments.

* Accommodate review requests

Reverted back to ID instead of id, and correct the return value to state that it is hardcoded to return 1.

I'm going to leave the Any to int change as I think it would be better to specify it than not (However, I do see your point), if you desire it to be changed I'll do so.

* Additional information

Add info on component ID 9 and add information about what component IDs 6 through 14 are used for in the game.

* Update SetMinimapComponent.md

Slight corrections to the markdown, moved hud colors to parameters section.

---------

Co-authored-by: ammonia-cfx <[email protected]>
#934)

* feat(natives): expand example and update natives for enhanced functionality

* Update ClearWeatherTypeNowPersistNetwork.md

Provide a usage example, remove wrongly assigned alias and rename the `milliseconds` parameter to `transitionTimeInMs`.

---------

Co-authored-by: ammonia-cfx <[email protected]>
…sition (#935)

* feat(natives/streaming): examples and updated natives for switch transition

* Update SwitchToMultiFirstpart.md

Moved the note out of the code block.

* Update SetCloudsAlpha.md

Nitpicking on some grammar and slight correctness on what this native actually does.

---------

Co-authored-by: ammonia-cfx <[email protected]>
* Update GetInteriorHeading.md

Added information about return value

* Update GetInteriorHeading.md

Added alias, added inroduction version back and changed return value text
* IsPlayerDrivingAgainstTraffic

* Change name

* Update IsPlayerDrivingDangerously.md

Added an enum with different violation types.
Added type 0 which I was able to test in-game, it only returns true when driving on paved sidewalks.

---------

Co-authored-by: ammonia-cfx <[email protected]>
@freedy69 freedy69 changed the title Document various HUD natives Document various HUD/CAM natives Dec 2, 2023
@freedy69 freedy69 closed this Dec 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants