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

📝 Update TaskGoToCoordAnyMeansExtraParams and TaskGoToCoordAnyMeansExtraParamsWithCruiseSpeed #1089

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

📝 Update TaskGoToCoordAnyMeansExtraParams and TaskGoToCoordAnyMeansExtraParamsWithCruiseSpeed #1089

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
4f8a602
📝 Update TaskGoToCoordAnyMeansExtraParams and TaskGoToCoordAnyMeansEx…
MonsieurBibo Apr 22, 2024
dd51289
📝 Fix the docs according to the review
MonsieurBibo Apr 22, 2024
50891db
Merge branch 'citizenfx:master' into patch-alltaskgotocoordsanymeans
MonsieurBibo Apr 23, 2024
716c54c
Update TaskGoToCoordAnyMeansExtraParamsWithCruiseSpeed.md
4mmonium Apr 23, 2024
44a4b3f
Update TaskGoToCoordAnyMeansExtraParams.md
4mmonium Apr 23, 2024
2a81638
Update TaskGoToCoordAnyMeansExtraParamsWithCruiseSpeed.md
4mmonium Apr 23, 2024
925bca9
Update TaskGoToCoordAnyMeansExtraParams.md
4mmonium Apr 23, 2024
6b08a0f
Update TaskGoToCoordAnyMeansExtraParamsWithCruiseSpeed.md
4mmonium Apr 23, 2024
9441c74
Update TaskGoToCoordAnyMeansExtraParams.md
4mmonium Apr 23, 2024
562f0c8
Update TaskGoToCoordAnyMeansExtraParamsWithCruiseSpeed.md
4mmonium Apr 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 95 additions & 15 deletions TASK/TaskGoToCoordAnyMeansExtraParams.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,104 @@ ns: TASK

```c
// 0x1DD45F9ECFDB1BC9 0x094B75EF
void TASK_GO_TO_COORD_ANY_MEANS_EXTRA_PARAMS(Ped ped, float x, float y, float z, float speed, Any p5, BOOL p6, int walkingStyle, float p8, Any p9, Any p10, Any p11);
void TASK_GO_TO_COORD_ANY_MEANS_EXTRA_PARAMS(Ped ped, float x, float y, float z, float fMoveBlendRatio, cs_type(Any) Vehicle vehicle, BOOL bUseLongRangeVehiclePathing, int drivingFlags, float fMaxRangeToShootTargets, cs_type(Any) float fExtraVehToTargetDistToPreferVeh, cs_type(Any) float fDriveStraightLineDistance, cs_type(Any) int iExtraFlags, float fWarpTimerMS);
```

```
NativeDB Added Parameter 13: Any p12
Same as `TASK_GO_TO_COORD_ANY_MEANS` but with extra parameters.

```c
enum eDrivingMode {
MonsieurBibo marked this conversation as resolved.
Show resolved Hide resolved
DF_StopForCars = 1,
DF_StopForPeds = 2,
DF_SwerveAroundAllCars = 4,
DF_SteerAroundStationaryCars = 8,
DF_SteerAroundPeds = 16,
DF_SteerAroundObjects = 32,
DF_DontSteerAroundPlayerPed = 64,
DF_StopAtLights = 128,
DF_GoOffRoadWhenAvoiding = 256,
DF_DriveIntoOncomingTraffic = 512,
DF_DriveInReverse = 1024,

// If pathfinding fails, cruise randomly instead of going on a straight line
DF_UseWanderFallbackInsteadOfStraightLine = 2048,

DF_AvoidRestrictedAreas = 4096,

// These only work on MISSION_CRUISE
DF_PreventBackgroundPathfinding = 8192,
DF_AdjustCruiseSpeedBasedOnRoadSpeed = 16384,

DF_UseShortCutLinks = 262144,
DF_ChangeLanesAroundObstructions = 524288,
DF_UseSwitchedOffNodes = 2097152, // cruise tasks ignore this anyway--only used for goto's
DF_PreferNavmeshRoute = 4194304, // if you're going to be primarily driving off road

// Only works for planes using MISSION_GOTO, will cause them to drive along the ground instead of fly
DF_PlaneTaxiMode = 8388608,

DF_ForceStraightLine = 16777216,
DF_UseStringPullingAtJunctions = 33554432,

DF_AvoidHighways = 536870912,
DF_ForceJoinInRoadDirection = 1073741824,

// Standard driving mode. stops for cars, peds, and lights, goes around stationary obstructions
DRIVINGMODE_STOPFORCARS = 786603, // DF_StopForCars|DF_StopForPeds|DF_SteerAroundObjects|DF_SteerAroundStationaryCars|DF_StopAtLights|DF_UseShortCutLinks|DF_ChangeLanesAroundObstructions, // Obey lights too

// Like the above, but doesn't steer around anything in its way - will only wait instead.
DRIVINGMODE_STOPFORCARS_STRICT = 262275, // DF_StopForCars|DF_StopForPeds|DF_StopAtLights|DF_UseShortCutLinks, // Doesn't deviate an inch.

// Default "alerted" driving mode. drives around everything, doesn't obey lights
DRIVINGMODE_AVOIDCARS = 786469, // DF_SwerveAroundAllCars|DF_SteerAroundObjects|DF_UseShortCutLinks|DF_ChangeLanesAroundObstructions|DF_StopForCars,

// Very erratic driving. difference between this and AvoidCars is that it doesn't use the brakes at ALL to help with steering
DRIVINGMODE_AVOIDCARS_RECKLESS = 786468, // DF_SwerveAroundAllCars|DF_SteerAroundObjects|DF_UseShortCutLinks|DF_ChangeLanesAroundObstructions,

// Smashes through everything
DRIVINGMODE_PLOUGHTHROUGH = 262144, // DF_UseShortCutLinks

// Drives normally except for the fact that it ignores lights
DRIVINGMODE_STOPFORCARS_IGNORELIGHTS = 786475, // DF_StopForCars|DF_SteerAroundStationaryCars|DF_StopForPeds|DF_SteerAroundObjects|DF_UseShortCutLinks|DF_ChangeLanesAroundObstructions

// Try to swerve around everything, but stop for lights if necessary
DRIVINGMODE_AVOIDCARS_OBEYLIGHTS = 786597, // DF_SwerveAroundAllCars|DF_StopAtLights|DF_SteerAroundObjects|DF_UseShortCutLinks|DF_ChangeLanesAroundObstructions|DF_StopForCars

// Swerve around cars, be careful around peds, and stop for lights
DRIVINGMODE_AVOIDCARS_STOPFORPEDS_OBEYLIGHTS = 786599 // DF_SwerveAroundAllCars|DF_StopAtLights|DF_StopForPeds|DF_SteerAroundObjects|DF_UseShortCutLinks|DF_ChangeLanesAroundObstructions|DF_StopForCars
};

enum TaskGoToCoordsAnyMeansFlags {
TGCAM_DEFAULT = 0,
// Ignore the health of the vehicle (default behaviour is to not use any vehicle with less than 600 health)
TGCAM_IGNORE_VEHICLE_HEALTH = 1,
// Considers all nearby vehicles for suitability (default behaviour is to consider only the vehicle closest to the ped)
TGCAM_CONSIDER_ALL_NEARBY_VEHICLES = 2,
// Performs the same tests as is done in IS_VEHICLE_DRIVEABLE (default behaviour is to just check the vehicle's health)
TGCAM_PROPER_IS_DRIVEABLE_CHECK = 4,
// Instructs the ped to remain in the vehicle at the end, so that multiple tasks can be chained together (see url:bugstar:1778387)
TGCAM_REMAIN_IN_VEHICLE_AT_DESTINATION = 8,
// Ped will never abandon the vehicle it is in (see url:bugstar:2196034)
TGCAM_NEVER_ABANDON_VEHICLE = 16,
// Ped will never abandon the vehicle it is in if vehicle is moving (see url:bugstar:2225456)
TGCAM_NEVER_ABANDON_VEHICLE_IF_MOVING = 32,
// Peds will use the targeting system for threats and register any threats they can attack (rather than just using the closest targetable ped)
TGCAM_USE_AI_TARGETING_FOR_THREATS = 64
};
```

## Parameters
* **ped**:
* **x**:
* **y**:
* **z**:
* **speed**:
* **p5**:
* **p6**:
* **walkingStyle**:
* **p8**:
* **p9**:
* **p10**:
* **p11**:
* **ped**: The `Ped` Handle.
* **x**: The goto target coordinate.
* **y**: The goto target coordinate.
* **z**: The goto target coordinate.
* **fMoveBlendRatio**: 0.0 = still, 1.0 = walk, 2.0 = run, 3.0 = sprint.
* **vehicle**: If defined, the pedestrian will only move if said vehicle exists. If you don't want any sort of association, just set it to `0`.
* **bUseLongRangeVehiclePathing**: Setting to `true` tells the vehicle to use longrange vehicle pathing.
* **drivingFlags**: See `eDrivingMode` enum.
MonsieurBibo marked this conversation as resolved.
Show resolved Hide resolved
* **fMaxRangeToShootTargets**: Determines the maximum distance at which the `Ped` will engage in combat with threatening targets.
* **fExtraVehToTargetDistToPreferVeh**:
* **fDriveStraightLineDistance**:
* **iExtraFlags**: See `TaskGoToCoordAnyMeansFlags` enum.
MonsieurBibo marked this conversation as resolved.
Show resolved Hide resolved
* **fWarpTimerMS**: If the ped is stuck for that amount of milliseconds, it gets warped to the targeted position. Doesn't work if the ped is in a aircraft nor a boat.

112 changes: 96 additions & 16 deletions TASK/TaskGoToCoordAnyMeansExtraParamsWithCruiseSpeed.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,105 @@ ns: TASK

```c
// 0xB8ECD61F531A7B02 0x86DC03F9
void TASK_GO_TO_COORD_ANY_MEANS_EXTRA_PARAMS_WITH_CRUISE_SPEED(Ped ped, float x, float y, float z, float speed, Any p5, BOOL p6, int walkingStyle, float p8, Any p9, Any p10, Any p11, Any p12);
void TASK_GO_TO_COORD_ANY_MEANS_EXTRA_PARAMS_WITH_CRUISE_SPEED(Ped ped, float x, float y, float z, float fMoveBlendRatio, cs_type(Any) Vehicle vehicle, BOOL bUseLongRangeVehiclePathing, int drivingFlags, float fMaxRangeToShootTargets, cs_type(Any) float fExtraVehToTargetDistToPreferVeh, cs_type(Any) float fDriveStraightLineDistance, cs_type(Any) int iExtraFlags, float fCruiseSpeed, float fTargetArriveDist);
```

```
NativeDB Added Parameter 14: Any p13
Same as `TASK_GO_TO_COORD_ANY_MEANS` but with cruise speed control and other parameters.

```c
enum eDrivingMode {
MonsieurBibo marked this conversation as resolved.
Show resolved Hide resolved
DF_StopForCars = 1,
DF_StopForPeds = 2,
DF_SwerveAroundAllCars = 4,
DF_SteerAroundStationaryCars = 8,
DF_SteerAroundPeds = 16,
DF_SteerAroundObjects = 32,
DF_DontSteerAroundPlayerPed = 64,
DF_StopAtLights = 128,
DF_GoOffRoadWhenAvoiding = 256,
DF_DriveIntoOncomingTraffic = 512,
DF_DriveInReverse = 1024,

// If pathfinding fails, cruise randomly instead of going on a straight line
DF_UseWanderFallbackInsteadOfStraightLine = 2048,

DF_AvoidRestrictedAreas = 4096,

// These only work on MISSION_CRUISE
DF_PreventBackgroundPathfinding = 8192,
DF_AdjustCruiseSpeedBasedOnRoadSpeed = 16384,

DF_UseShortCutLinks = 262144,
DF_ChangeLanesAroundObstructions = 524288,
DF_UseSwitchedOffNodes = 2097152, // cruise tasks ignore this anyway--only used for goto's
DF_PreferNavmeshRoute = 4194304, // if you're going to be primarily driving off road

// Only works for planes using MISSION_GOTO, will cause them to drive along the ground instead of fly
DF_PlaneTaxiMode = 8388608,

DF_ForceStraightLine = 16777216,
DF_UseStringPullingAtJunctions = 33554432,

DF_AvoidHighways = 536870912,
DF_ForceJoinInRoadDirection = 1073741824,

// Standard driving mode. stops for cars, peds, and lights, goes around stationary obstructions
DRIVINGMODE_STOPFORCARS = 786603, // DF_StopForCars|DF_StopForPeds|DF_SteerAroundObjects|DF_SteerAroundStationaryCars|DF_StopAtLights|DF_UseShortCutLinks|DF_ChangeLanesAroundObstructions, // Obey lights too

// Like the above, but doesn't steer around anything in its way - will only wait instead.
DRIVINGMODE_STOPFORCARS_STRICT = 262275, // DF_StopForCars|DF_StopForPeds|DF_StopAtLights|DF_UseShortCutLinks, // Doesn't deviate an inch.

// Default "alerted" driving mode. drives around everything, doesn't obey lights
DRIVINGMODE_AVOIDCARS = 786469, // DF_SwerveAroundAllCars|DF_SteerAroundObjects|DF_UseShortCutLinks|DF_ChangeLanesAroundObstructions|DF_StopForCars,

// Very erratic driving. difference between this and AvoidCars is that it doesn't use the brakes at ALL to help with steering
DRIVINGMODE_AVOIDCARS_RECKLESS = 786468, // DF_SwerveAroundAllCars|DF_SteerAroundObjects|DF_UseShortCutLinks|DF_ChangeLanesAroundObstructions,

// Smashes through everything
DRIVINGMODE_PLOUGHTHROUGH = 262144, // DF_UseShortCutLinks

// Drives normally except for the fact that it ignores lights
DRIVINGMODE_STOPFORCARS_IGNORELIGHTS = 786475, // DF_StopForCars|DF_SteerAroundStationaryCars|DF_StopForPeds|DF_SteerAroundObjects|DF_UseShortCutLinks|DF_ChangeLanesAroundObstructions

// Try to swerve around everything, but stop for lights if necessary
DRIVINGMODE_AVOIDCARS_OBEYLIGHTS = 786597, // DF_SwerveAroundAllCars|DF_StopAtLights|DF_SteerAroundObjects|DF_UseShortCutLinks|DF_ChangeLanesAroundObstructions|DF_StopForCars

// Swerve around cars, be careful around peds, and stop for lights
DRIVINGMODE_AVOIDCARS_STOPFORPEDS_OBEYLIGHTS = 786599 // DF_SwerveAroundAllCars|DF_StopAtLights|DF_StopForPeds|DF_SteerAroundObjects|DF_UseShortCutLinks|DF_ChangeLanesAroundObstructions|DF_StopForCars
};

enum TaskGoToCoordsAnyMeansFlags {
TGCAM_DEFAULT = 0,
// Ignore the health of the vehicle (default behaviour is to not use any vehicle with less than 600 health)
TGCAM_IGNORE_VEHICLE_HEALTH = 1,
// Considers all nearby vehicles for suitability (default behaviour is to consider only the vehicle closest to the ped)
TGCAM_CONSIDER_ALL_NEARBY_VEHICLES = 2,
// Performs the same tests as is done in IS_VEHICLE_DRIVEABLE (default behaviour is to just check the vehicle's health)
TGCAM_PROPER_IS_DRIVEABLE_CHECK = 4,
// Instructs the ped to remain in the vehicle at the end, so that multiple tasks can be chained together (see url:bugstar:1778387)
TGCAM_REMAIN_IN_VEHICLE_AT_DESTINATION = 8,
// Ped will never abandon the vehicle it is in (see url:bugstar:2196034)
TGCAM_NEVER_ABANDON_VEHICLE = 16,
// Ped will never abandon the vehicle it is in if vehicle is moving (see url:bugstar:2225456)
TGCAM_NEVER_ABANDON_VEHICLE_IF_MOVING = 32,
// Peds will use the targeting system for threats and register any threats they can attack (rather than just using the closest targetable ped)
TGCAM_USE_AI_TARGETING_FOR_THREATS = 64
};
```

## Parameters
* **ped**:
* **x**:
* **y**:
* **z**:
* **speed**:
* **p5**:
* **p6**:
* **walkingStyle**:
* **p8**:
* **p9**:
* **p10**:
* **p11**:
* **p12**:
* **ped**: The `Ped` Handle.
* **x**: The goto target coordinate.
* **y**: The goto target coordinate.
* **z**: The goto target coordinate.
* **fMoveBlendRatio**: 0.0 = still, 1.0 = walk, 2.0 = run, 3.0 = sprint.
* **vehicle**: If defined, the pedestrian will only move if said vehicle exists. If you don't want any sort of association, just set it to `0`.
* **bUseLongRangeVehiclePathing**: Setting to `true` tells the vehicle to use longrange vehicle pathing.
* **drivingFlags**: See `eDrivingMode` enum.
MonsieurBibo marked this conversation as resolved.
Show resolved Hide resolved
* **fMaxRangeToShootTargets**: Determines the maximum distance at which the `Ped` will engage in combat with threatening targets.
* **fExtraVehToTargetDistToPreferVeh**:
* **fDriveStraightLineDistance**:
* **iExtraFlags**: See `TaskGoToCoordAnyMeansFlags` enum.
Copy link
Contributor

Choose a reason for hiding this comment

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

Ok, where do I find the enum you are talking about? 🙂

Here you go:

enum eTaskGoToCoordAnyMeansFlags {
  TGCAM_DEFAULT = 0,
  // Ignore the health of the vehicle (default behaviour is to not use any vehicle with less than 600 health)
  TGCAM_IGNORE_VEHICLE_HEALTH = 1,
  // Considers all nearby vehicles for suitability (default behaviour is to consider only the vehicle closest to the ped)
  TGCAM_CONSIDER_ALL_NEARBY_VEHICLES = 2,
  // Performs the same tests as is done in IS_VEHICLE_DRIVEABLE (default behaviour is to just check the vehicle's health)
  TGCAM_PROPER_IS_DRIVEABLE_CHECK = 4,
  // Instructs the ped to remain in the vehicle at the end, so that multiple tasks can be chained together.
  TGCAM_REMAIN_IN_VEHICLE_AT_DESTINATION = 8,
  // Ped will never abandon the vehicle it is in.
  TGCAM_NEVER_ABANDON_VEHICLE = 16,
  // Ped will never abandon the vehicle it is in if vehicle is moving.
  TGCAM_NEVER_ABANDON_VEHICLE_IF_MOVING = 32,
  // Peds will use the targeting system for threats and register any threats they can attack (rather than just using the closest targetable ped)
  TGCAM_USE_AI_TARGETING_FOR_THREATS = 64
};

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Isn't the enum already in this file ?

* **fCruiseSpeed**: The initial cruise speed of the vehicle
* **fTargetArriveDist**: The distance at which the pedestrian will quit the vehicle (by default 4 meters).

Loading