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.

Sign up for GitHub

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

Jump to bottom

tweak(native-decls): add docs for undocumented natives #2366

Closed
wants to merge 1 commit into from
Closed

tweak(native-decls): add docs for undocumented natives #2366

wants to merge 1 commit into from

Conversation

kams3
Copy link

@kams3 kams3 commented Jan 30, 2024 •
edited
Loading

Current changes in this PR

  • Added SetVehicleCurrentGear.md for extra native SET_VEHICLE_CURRENT_GEAR

RegisterNativeHandler lookup

Here's a list of extra natives that are registered but not documented:

Code_2024-01-30_17-22-17
Click here to reveal github blame links for each native
SET_ENTITY_ROTATION_VELOCITY
  • A gta native doing the same thing was introduced in b2372 under the name SET_ENTITY_ANGULAR_VELOCITY
  • This is essentially an undocumented shim for <b2372 named "rotation" instead of "angular"
  • using the term "rotation" instead of "angular" is also done in server-side GET_ENTITY_ROTATION_VELOCITY
  • SET_ENTITY_ROTATION_VELOCITY is listed in rpc_spec_natives.lua, but doesn't generate a file to /native_md/
  • I guess it's fine undocumented?
SET_VEHICLE_NEXT_GEAR
  • This name is wrong as it actually sets the PREV gear (at least in >=b2802)
  • The getter GET_VEHICLE_NEXT_GEAR (which is documented) retrieves the PREV gear as well
  • This variable doesn't appear to have any effect in the game whatsoever anyway
  • Renaming the getter and/or documenting the setter would probably cause more trouble than it's worth

What else?

Let me know if I should generate an md file for any of the other ones

@thorium-cfx thorium-cfx added the triage Needs a preliminary assessment to determine the urgency and required action label Feb 12, 2024
@FabianTerhorst
Copy link
Contributor

Duplicate of #2404

@FabianTerhorst FabianTerhorst marked this as a duplicate of #2404 Aug 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
triage Needs a preliminary assessment to determine the urgency and required action
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@kams3 @FabianTerhorst @thorium-cfx