-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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
Conversation
``` | ||
|
||
## Parameters | ||
* **alarmName**: | ||
|
||
## Return value | ||
Returns a boolean value indicating whether the specified alarm is playing. | ||
- `true`: The alarm is currently playing. |
There was a problem hiding this comment.
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?
where did you get these names? "Walla density" is not something I would have guessed or had in a wordlist |
I used alloc8or.re and native.dotindustries.dev |
Strings in game-code. |
I don't know why but PlaySoundFromEntityHash and SetPedRaceAndVoiceGroup won't build :/ |
You added an extra empty line between the document descriptors and the native decl |
It should be good now! The problem was caused by incorrect parameters. |
any news @4mmonium ? |
AUDIO/BlockAllSpeechFromPed.md
Outdated
@@ -1,11 +1,11 @@ | |||
--- | |||
ns: AUDIO | |||
--- | |||
## _0xF8AD2EED7C47E8FE | |||
## BLOCK_ALL_SPEECH_FROM_PED |
There was a problem hiding this comment.
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
.
AUDIO/BlockSpeechContextGroup.md
Outdated
@@ -1,11 +1,11 @@ | |||
--- | |||
ns: AUDIO | |||
--- | |||
## _0xA8A7D434AFB4B97B | |||
## BLOCK_SPEECH_CONTEXT_GROUP |
There was a problem hiding this comment.
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.
Hey no problem, how can i know if a native is a contribution of the community? |
Because for example when searching for |
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