GetDistanceBetweenCoords - FiveM Natives @ Cfx.re Docs

FiveM Docs / Native Reference

Namespace: MISCAPI set: clientGame: gta5editImprove

GET_DISTANCE_BETWEEN_COORDS

0xF1B760881820C952

0xF698765E

// GetDistanceBetweenCoords
float GET_DISTANCE_BETWEEN_COORDS(float x1, float y1, float z1, float x2, float y2, float z2, BOOL useZ);

Parameters:

x1:
The X coordinate of the first point.
y1:
The Y coordinate of the first point.
z1:
The Z coordinate of the first point.
x2:
The X coordinate of the second point.
y2:
The Y coordinate of the second point.
z2:
The Z coordinate of the second point.
useZ:
Whether or not to use the Z coordinate.

Returns:

The distance between the passed points in units.

Returns the distance between two three-dimensional points, optionally ignoring the Z values. If useZ is false, only the 2D plane (X-Y) will be considered for calculating the distance. Consider using this faster native instead: SYSTEM::VDIST - DVIST always takes in consideration the 3D coordinates.

Examples:

Lua
C#

local dist = GetDistanceBetweenCoords(0.0, 0.0, 0.0, 5.0, 5.0, 5.0, true)

-- language faster equivalent:
local firstVec = vector3(0.0, 0.0, 0.0)
local secondVec = vector3(5.0, 5.0, 5.0)

local dist = #(firstVec - secondVec) -- Use Z
local dist = #(firstVec.xy - secondVec.xy) -- Do not use Z

DISABLE_POLICE_RESTART(int policeIndex, BOOL toggle)

DISABLE_STUNT_JUMP_SET(int p0)

DISPLAY_ONSCREEN_KEYBOARD(int keyboardType, char* windowTitle, char* description, char* defaultText, char* defaultConcat1, char* defaultConcat2, char* defaultConcat3, int maxInputLength)

DISPLAY_ONSCREEN_KEYBOARD_WITH_LONGER_INITIAL_STRING(int keyboardType, char* windowTitle, char* description, char* defaultText, char* defaultConcat1, char* defaultConcat2, char* defaultConcat3, char* defaultConcat4, char* defaultConcat5, char* defaultConcat6, char* defaultConcat7, int maxInputLength)

DOES_POP_MULTIPLIER_AREA_EXIST(int id)

DOES_POP_MULTIPLIER_SPHERE_EXIST(int id)

ENABLE_DISPATCH_SERVICE(int dispatchService, BOOL toggle)

ENABLE_STUNT_JUMP_SET(int p0)

ENABLE_TENNIS_MODE(Ped ped, BOOL toggle, BOOL p2)

END_REPLAY_STATS

FIND_SPAWN_POINT_IN_DIRECTION(float posX, float posY, float posZ, float dirX, float dirY, float dirZ, float distance, Vector3* spawnPoint)

FORCE_GAME_STATE_PLAYING

FORCE_LIGHTNING_FLASH

GET_ALLOCATED_STACK_SIZE

GET_ANGLE_BETWEEN_2D_VECTORS(float x1, float y1, float x2, float y2)

_GET_BASE_ELEMENT_METADATA(Any* p1, Any* p2, Any p3, BOOL p4)

_GET_BENCHMARK_ITERATIONS_FROM_COMMAND_LINE

_GET_BENCHMARK_PASS_FROM_COMMAND_LINE

_GET_BENCHMARK_TIME

GET_BITS_IN_RANGE(int var, int rangeStart, int rangeEnd)

_GET_CLOUD_HAT_OPACITY

GET_COORDS_OF_PROJECTILE_TYPE_IN_AREA(float x1, float y1, float z1, float x2, float y2, float z2, Hash projectileHash, Vector3* projectilePos, BOOL ownedByPlayer)

GET_COORDS_OF_PROJECTILE_TYPE_WITHIN_DISTANCE(Ped ped, Hash weaponHash, float distance, Vector3* outCoords, BOOL ownedByPlayer)

GET_DISTANCE_BETWEEN_COORDS(float x1, float y1, float z1, float x2, float y2, float z2, BOOL useZ)

GET_FAKE_WANTED_LEVEL

GET_FRAME_COUNT

_GET_GLOBAL_CHAR_BUFFER

GET_GROUND_Z_AND_NORMAL_FOR_3D_COORD(float x, float y, float z, float* groundZ, Vector3* normal)

GET_GROUND_Z_EXCLUDING_OBJECTS_FOR_3D_COORD(float x, float y, float z, float* groundZ, BOOL waterAsGround)

GET_GROUND_Z_FOR_3D_COORD(float x, float y, float z, float* groundZ, BOOL includeWater)

GET_HASH_KEY(char* string)

GET_HEADING_FROM_VECTOR_2D(float dx, float dy)