tweak(docs/native): Update Task Native Enums & Params #1130
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updated parameters and description to be styled as PR [citizenfx#1128](citizenfx#1128). All previous unk params now labelled, and added MissionFlag enums for respective functions.
Changed wording of 'except driver and boat' to 'except ped and boat' to reflect parameter names and updated parameter descriptions to end in periods as per the first two descriptions.
Updated with enum for driving flag values, possibly for reference from other natives which utilise driving flags (ie. `TaskBoatMission`, `TaskVehicleMission` etc.).
AvarianKnight
suggested changes
Jun 12, 2024
Removed the native docs codeblock, and added a bit of extra info from the link housed there to ensure it's not lost. Minor wording changes around parameter descriptions to shorten them.
As per other commits, removing old code block, added a working lua example and referenced other natives in relevant parameters.
Co-authored-by: Dillon Skaggs <dillskaggs@gmail.com>
Co-authored-by: Dillon Skaggs <dillskaggs@gmail.com>
In testing the example, I found speed was not an optional param; updated accordingly.
When testing this example as well, confirmed task won't execute if target entity isn't a vehicle as well as speed is not an optional param and updated accordingly. I find this strange when it definitely is optional for `TaskBoatMission` but alas.
|
This should be all suggested changes (so far) implemented. |
Fixes for [suggestion](citizenfx#1130 (comment)).
|
I've pushed requested changes to the examples, is there anything else you'd like me to update? Is it also worth updating |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changed
TaskHeliMission&TaskVehicleMissionparameters and enums, as well as updating their descriptions and styling to be in-line with PR #1128. Also fixed some minor typos inTaskBoatMissionrelated in the styling of the first two 'Task_Mission' natives.Added a small description and the driving style flag enum (see here and here). This could be used as reference to the description of drivingStyle to the 'Task_Mission' natives.