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

feat(natives/audio): Updated documentation for unnamed audio natives and added examples #890

Closed
wants to merge 2 commits into from

Conversation

ahcenezdh
Copy link
Contributor

@ahcenezdh ahcenezdh commented Jun 26, 2023

I've named all unnamed natives in the AUDIO category, made adjustments, and added examples where applicable. This is my first time doing something like this, so please don't hesitate to point out any issues or concerns

```

## Parameters
* **alarmName**:

## Return value
Returns a boolean value indicating whether the specified alarm is playing.
- `true`: The alarm is currently playing.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't know if i can do a list here?

@ahcenezdh ahcenezdh changed the title feat(natives/audio): named all unnamed natives feat(natives/audio): Updated documentation for unnamed audio natives and added examples Jun 26, 2023
@LWSS
Copy link
Contributor

LWSS commented Jun 26, 2023

where did you get these names? "Walla density" is not something I would have guessed or had in a wordlist

@ahcenezdh
Copy link
Contributor Author

I used alloc8or.re and native.dotindustries.dev

@gottfriedleibniz
Copy link
Contributor

where did you get these names?

Strings in game-code.

@ahcenezdh
Copy link
Contributor Author

I don't know why but PlaySoundFromEntityHash and SetPedRaceAndVoiceGroup won't build :/

@AvarianKnight
Copy link
Collaborator

You added an extra empty line between the document descriptors and the native decl

@ahcenezdh
Copy link
Contributor Author

It should be good now! The problem was caused by incorrect parameters.

@ahcenezdh
Copy link
Contributor Author

any news @4mmonium ?

@@ -1,11 +1,11 @@
---
ns: AUDIO
---
## _0xF8AD2EED7C47E8FE
## BLOCK_​ALL_​SPEECH_​FROM_​PED
Copy link
Contributor

@4mmonium 4mmonium Jul 23, 2023

Choose a reason for hiding this comment

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

From CONTRIBUTING.md under naming convention:

Community-named natives must be prefixed by an underscore, e.g. _EXAMPLE_NATIVE

  • Community-named natives have names that do not match the hash of the native.

So the name should be something such as _BLOCK_​ALL_​SPEECH_​FROM_​PED.

@@ -1,11 +1,11 @@
---
ns: AUDIO
---
## _0xA8A7D434AFB4B97B
## BLOCK_​SPEECH_​CONTEXT_​GROUP
Copy link
Contributor

Choose a reason for hiding this comment

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

The name for this native should start with an underscore too, since it's community named (doesn't match the hash of the native).

More here.

@4mmonium
Copy link
Contributor

any news @4mmonium ?

Hey there!
I will provide a review once I'm done going through all of it, only thing I noticed for now is that the native names provided are community contributed, so they should start with an underscore. Great work nonetheless 🙂

@ahcenezdh
Copy link
Contributor Author

Hey no problem, how can i know if a native is a contribution of the community?

@ahcenezdh
Copy link
Contributor Author

Because for example when searching for BLOCK_​SPEECH_​CONTEXT_​GROUP i can find the native as a gta native

@ahcenezdh ahcenezdh closed this Aug 28, 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.

None yet

5 participants