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

Updated lots of natives #1221

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

Updated lots of natives #1221

wants to merge 10 commits into from

Conversation

BJDubb
Copy link

@BJDubb BJDubb commented Nov 5, 2024

updated the following natives

AUDIO/PlaySoundFrontend.md
AUDIO/SetAudioFlag.md
DECORATOR/DecorSetInt.md
ENTITY/ApplyForceToEntity.md
ENTITY/AttachEntityToEntityPhysically.md
ENTITY/SetEntityLoadCollisionFlag.md
ENTITY/SetEntityLodDist.md
ENTITY/SetEntityProofs.md
GRAPHICS/StartParticleFxLoopedAtCoord.md
HUD/SetMinimapComponent.md
OBJECT/AddExtendedPickupProbeArea.md
OBJECT/N_0xd4a7a435b3710d05.md
OBJECT/SetObjectPhysicsParams.md
PATHFIND/GetRandomVehicleNode.md
TASK/TaskCombatPed.md

Copy link
Contributor

@colistro123 colistro123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if the stance on batch updates remains the same, but from what I understand, they are not accepted due to PRs being time-consuming and prone to human error (to some degree).

#1048 (comment)

@PsychoShock
Copy link
Contributor

I'm not sure if the stance on batch updates remains the same, but from what I understand, they are not accepted due to PRs being time-consuming and prone to human error (to some degree).

#1048 (comment)

I would agree when changes are natives name changed, added params, etc, but here it's mostly descriptions and param descriptions added + re-formatted correctly. I wouldn't see why, this is (from the quick look) nice work and respecting all the signature from docs.

@colistro123
Copy link
Contributor

I'm not sure if the stance on batch updates remains the same, but from what I understand, they are not accepted due to PRs being time-consuming and prone to human error (to some degree).
#1048 (comment)

I would agree when changes are natives name changed, added params, etc, but here it's mostly descriptions and param descriptions added + re-formatted correctly. I wouldn't see why, this is (from the quick look) nice work and respecting all the signature from docs.

Yeah, looked further and it's mostly just parameter name changes and descriptions.

Copy link
Contributor

@JayPaulinCodes JayPaulinCodes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a lot here to digest in this PR.

Overall, very nice work, it's clear a lot of effort was put into this.

Most of my suggestions are smaller things and better ways to word things which match better the way other native's docs are setup.

I'm bound to have missed some stuff here but this should be a good starting point for the review.

DECORATOR/DecorSetInt.md Outdated Show resolved Hide resolved
DECORATOR/DecorSetInt.md Outdated Show resolved Hide resolved
ENTITY/ApplyForceToEntity.md Outdated Show resolved Hide resolved
ENTITY/ApplyForceToEntity.md Outdated Show resolved Hide resolved
ENTITY/AttachEntityToEntityPhysically.md Outdated Show resolved Hide resolved
## ADD_EXTENDED_PICKUP_PROBE_AREA

```c
// AddExtendedPickupProbeArea
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not 100% certain on the exact specifications for the comment here, but I think it may have something to do with aliases, and it may need to be corrected, but I'll let others comment on exactly what that correction would be if any at all.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am also unsure. Based on the contributing guidelines, it did appear to be aliases, however this native did not have alias history from what I could see. Also happy for someone to suggest something more correct here.

Copy link
Contributor

@PsychoShock PsychoShock Nov 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can base yourself on my example on the contributing guidelines or even base yourself on a existing native with no alias. Here's one. So the answer here is yes, you can leave it there.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can base yourself on my example on the contributing guidelines or even base yourself on a existing native with no alias. Here's one. So the answer here is yes, you can leave it there.

Think you're confuse here, this comment is supposed to be the native hash, i.e. // 0xD4A7A435B3710D05

OBJECT/AddExtendedPickupProbeArea.md Outdated Show resolved Hide resolved
PATHFIND/GetRandomVehicleNode.md Outdated Show resolved Hide resolved
TASK/TaskCombatPed.md Outdated Show resolved Hide resolved
TASK/TaskCombatPed.md Outdated Show resolved Hide resolved
@BJDubb
Copy link
Author

BJDubb commented Nov 20, 2024

Thank you for the review @JayPaulinCodes

Waiting on some guidance about OBJECT/AddExtendedPickupProbeArea.md aliases.

@JayPaulinCodes
Copy link
Contributor

Thank you for the review @JayPaulinCodes

Waiting on some guidance about OBJECT/AddExtendedPickupProbeArea.md aliases.

Looks like some guidance was provided here: #1221 (comment)

And there is still a handful of my suggestions outstanding.

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.

5 participants