SetBlipVisibleDistance: Difference between revisions
Jump to navigation
Jump to search
(Adding never documented new functions (r2248)) |
m (Added OOP syntax) |
||
Line 5: | Line 5: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">float setBlipVisibleDistance ( blip theBlip, float theDistance )</syntaxhighlight> | <syntaxhighlight lang="lua">float setBlipVisibleDistance ( blip theBlip, float theDistance )</syntaxhighlight> | ||
{{OOP||setVisibleDistance|visibleDistance|getBlipVisibleDistance}} | |||
===Required Arguments=== | ===Required Arguments=== |
Revision as of 02:00, 26 June 2014
This function will set the visible distance of a blip.
Syntax
float setBlipVisibleDistance ( blip theBlip, float theDistance )
OOP Syntax Help! I don't understand this!
- Method: 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
- createBlip
- createBlipAttachedTo
- getBlipColor
- getBlipIcon
- getBlipOrdering
- getBlipSize
- getBlipVisibleDistance
- setBlipColor
- setBlipIcon
- setBlipOrdering
- setBlipSize
- setBlipVisibleDistance