HU/setBlipVisibleDistance

From Multi Theft Auto: Wiki
Revision as of 20:13, 24 July 2018 by Surge (talk | contribs) (Created page with "{{Server client function}} __NOTOC__ This function will set the visible distance of a blip. ==Syntax== <syntaxhighlight lang="lua">bool setBlipVisibleDistance ( blip theBlip...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This function will set the visible distance of a blip.

Syntax

bool setBlipVisibleDistance ( blip theBlip, float theDistance )

OOP Syntax Help! I don't understand this!

Method: blip:setVisibleDistance(...)
Variable: .visibleDistance
Counterpart: getBlipVisibleDistance


Required Arguments

  • theBlip: The blip whose visible distance you wish to get.
  • theDistance: The distance you want the blip to be visible for.

Returns

Returns true if successful, false otherwise.

Example

This example will demonstrate basic functionality of setBlipVisibleDistance

local blip = createBlip(0, 0, 0, 47, 0, 0, 0, 0, 0, 0, 1000)
outputDebugString("Blip visible distance: "..getBlipVisibleDistance(blip)) --1000
setBlipVisibleDistance(blip, 2000)
outputDebugString("Blip visible distance: "..getBlipVisibleDistance(blip)) --2000

This example will set the visible distance of all blips to half the original value.

-- Retrieve a table containing all the blips that exist
local blips = getElementsByType("blip")
-- Loop through the list, storing the blips visible distance with the rest.
for index, blip in ipairs(blips) do
	-- Retrieve the blip's visible distance and divide by 2
	setBlipVisibleDistance(blip, getBlipVisibleDistance(blip) / 2)
end

See Also