GetBlipVisibleDistance: Difference between revisions
Jump to navigation
Jump to search
m (Added oop related links) |
(→Syntax) |
||
Line 4: | Line 4: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">float getBlipVisibleDistance ( blip theBlip )</syntaxhighlight> | <syntaxhighlight lang="lua">float getBlipVisibleDistance ( blip theBlip )</syntaxhighlight> | ||
{{OOP||getVisibleDistance| | {{OOP|The element type of this class is [[Blip]].|[[Blip]]:getVisibleDistance||}} | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theBlip:''' The blip whose visible distance you wish to get. | *'''theBlip:''' The blip whose visible distance you wish to get. |
Revision as of 21:24, 5 December 2014
This function will tell you what visible distance a blip has.
Syntax
float getBlipVisibleDistance ( blip theBlip )
OOP Syntax Help! I don't understand this!
Required Arguments
- theBlip: The blip whose visible distance you wish to get.
Returns
Returns one float with the blips visible distance, false if the blip is invalid.
Example
This example will demonstrate basic functionality of getBlipVisibleDistance
local blip = createBlip(0, 0, 0, 47, 0, 0, 0, 0, 0, 0, 1000) outputDebugString("Blip visible distance: "..getBlipVisibleDistance(blip))
This example will combine the total visible distances of all blips
-- Retrieve a table containing all the blips that exist local blips = getElementsByType("blip") local distance = 0 -- 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 distance = distance + getBlipVisibleDistance(blip) or 0 -- "or 0" just incase its false ;) end outputDebugString("Combined total of all blips visible distances: "..distance)
See Also
- createBlip
- createBlipAttachedTo
- getBlipColor
- getBlipIcon
- getBlipOrdering
- getBlipSize
- getBlipVisibleDistance
- setBlipColor
- setBlipIcon
- setBlipOrdering
- setBlipSize
- setBlipVisibleDistance