GetBlipIcon: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Added OOP syntax) |
||
Line 4: | Line 4: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">int getBlipIcon ( blip theBlip )</syntaxhighlight> | <syntaxhighlight lang="lua">int getBlipIcon ( blip theBlip )</syntaxhighlight> | ||
{{OOP||getIcon|icon|setBlipIcon}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theBlip''': the blip we're getting the icon number of. | *'''theBlip''': the blip we're getting the icon number of. |
Revision as of 01:54, 26 June 2014
This function returns the icon a blip currently has.
Syntax
int getBlipIcon ( blip theBlip )
OOP Syntax Help! I don't understand this!
- Method: getIcon(...)
- Variable: .icon
- Counterpart: setBlipIcon
Required Arguments
- theBlip: the blip we're getting the icon number of.
Returns
Returns an int indicating which icon the blip has. Valid values are:
- 0: Marker If higher than player: If lower than player:
- 1: White_square Note: it's actually white, darkened for display here
- 2: Centre
- 3: Map_here
- 4: North
- 5: Airyard
- 6: Gun
- 7: Barbers
- 8: Big_smoke
- 9: Boatyard
- 10: Burgershot
- 11: Bulldozer
- 12: Cat_pink
- 13: Cesar
- 14: Chicken
- 15: Cj
- 16: Crash1
- 17: Diner
- 18: Emmetgun
- 19: Enemyattack
- 20: Fire
- 21: Girlfriend
- 22: Hospital
- 23: Loco
- 24: Madd Dogg
- 25: Mafia
- 26: Mcstrap
- 27: Mod_garage
- 28: Ogloc
- 29: Pizza
- 30: Police
- 31: Property_green
- 32: Property_red
- 33: Race
- 34: Ryder
- 35: Savehouse
- 36: School
- 37: Mystery
- 38: Sweet
- 39: Tattoo
- 40: Truth
- 41: Waypoint
- 42: Toreno_ranch
- 43: Triads
- 44: Triads_casino
- 45: Tshirt
- 46: Woozie
- 47: Zero
- 48: Date_disco
- 49: Date_drink
- 50: Date_food
- 51: Truck
- 52: Cash
- 53: Flag
- 54: Gym
- 55: Impound
- 56: Runway_light
- 57: Runway
- 58: Gang_b
- 59: Gang_p
- 60: Gang_y
- 61: Gang_n
- 62: Gang_g
- 63: Spray
Example
This example will find all the blips that exist and set them all to the default blip icon.
-- Retrieve a table containing all the blips that exist blips = getElementsByType ( "blip" ) -- Loop through the list, storing the blip from the table in the variable blipValue for blipKey, blipValue in ipairs(blips) do -- Retrieve the blip's icon into the variable 'blipIcon' blipIcon = getBlipIcon ( blipValue ) -- If the blip's icon wasn't the default already if ( blipIcon ~= 0 ) then -- Set the blip's icon to the default setBlipIcon ( blipValue, 0 ) end end
See Also
- createBlip
- createBlipAttachedTo
- getBlipColor
- getBlipIcon
- getBlipOrdering
- getBlipSize
- getBlipVisibleDistance
- setBlipColor
- setBlipIcon
- setBlipOrdering
- setBlipSize
- setBlipVisibleDistance