FindKeyHanger - MXC Products Docs

Finds the nearest keyhanger, optionally filtered by distance and model. Only enabled keyhangers are searched.

Argument	Data Type	Needed	Default	Description
`coords`	vector3	❌	`nil`	The coordinates to search from, if `nil` the distance is ignored and a matching keyhanger is returned
`distance`	number	❌	`nil`	The maximum distance from `coords`, if `nil` there is no limit
`model`	string	❌	`nil`	Only match keyhangers of this model, if `nil` every model is matched

Returns

Type	Description
number \| nil	The id of the nearest matching keyhanger, or `nil` if none was found

Example

local hangerId = exports["utility_keyhanger"]:FindKeyHanger(GetEntityCoords(GetPlayerPed(source)), 3.0)

if hangerId then
    print("Found the keyhanger", hangerId)
end