_START_SHAPE_TEST_SURROUNDING_COORDS (SHAPETEST) — FiveM Native Reference

local retval, pVec1, pVec2 = StartShapeTestSurroundingCoords(flag, entity, flag2)

Description

Since it is only used in the PC version, likely some mouse-friendly shape test. Uses in vector arguments.

Asynchronous.

it returns a ShapeTest handle that can be used with GET_SHAPE_TEST_RESULT.
In its only usage in game scripts its called with flag set to 511, entity to player_ped_id and flag2 set to 7

See INLINE_0 for flags.

Parameters

Name	Type	Description
`pVec1`	`Vector3*`	—
`pVec2`	`Vector3*`	—
`flag`	`int`	—
`entity`	`Entity`	—
`flag2`	`int`	—

Quick Snippet: Get Coordinates

pVec1pVec2

Add this command to your client script to retrieve precise locations in-game.

-- Add this to your client.lua. Type /pos in-game to copy coords.
RegisterCommand('pos', function()
    local ped = PlayerPedId()
    local coords = GetEntityCoords(ped)
    local heading = GetEntityHeading(ped)
    local output = string.format("vector4(%.2f, %.2f, %.2f, %.2f)", coords.x, coords.y, coords.z, heading)

    print(output)
    TriggerEvent('chat:addMessage', { args = { '^4[COORD]^0', output } })
end)

Quick Snippet: Get Entity

entity

Use this to obtain an entity handle from the player's aim or crosshair.

-- Get the entity the player is aiming at
local ped = PlayerPedId()
local hit, entity = GetEntityPlayerIsFreeAimingAt(PlayerId())

if hit and entity ~= 0 then
    print("Entity: " .. entity)
    print("Model: " .. GetEntityModel(entity))
    print("Type: " .. GetEntityType(entity)) -- 1=Ped, 2=Vehicle, 3=Object
end

Returns

int

Returns an integer value.

Description

Since it is only used in the PC version, likely some mouse-friendly shape test. Uses in vector arguments.

Asynchronous.

it returns a ShapeTest handle that can be used with GET_SHAPE_TEST_RESULT.
In its only usage in game scripts its called with flag set to 511, entity to player_ped_id and flag2 set to 7

See INLINE_0 for flags.

Name

Type

Description

pVec1

Vector3*

—

pVec2

Vector3*

—

flag

int

—

entity

Entity

—

flag2

int

—

-- Add this to your client.lua. Type /pos in-game to copy coords. RegisterCommand('pos', function() local ped = PlayerPedId() local coords = GetEntityCoords(ped) local heading = GetEntityHeading(ped) local output = string.format("vector4(%.2f, %.2f, %.2f, %.2f)", coords.x, coords.y, coords.z, heading) print(output) TriggerEvent('chat:addMessage', { args = { '^4[COORD]^0', output } }) end)

-- Get the entity the player is aiming at local ped = PlayerPedId() local hit, entity = GetEntityPlayerIsFreeAimingAt(PlayerId()) if hit and entity ~= 0 then print("Entity: " .. entity) print("Model: " .. GetEntityModel(entity)) print("Type: " .. GetEntityType(entity)) -- 1=Ped, 2=Vehicle, 3=Object end