SetBlipIcon: Difference between revisions
Jump to navigation
Jump to search
m fix oop |
|||
| Line 5: | Line 5: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">bool setBlipIcon ( blip theBlip, int icon )</syntaxhighlight> | <syntaxhighlight lang="lua">bool setBlipIcon ( blip theBlip, int icon )</syntaxhighlight> | ||
{{OOP| | {{OOP||[[blip]]:setIcon|icon|}} | ||
===Required Arguments=== | ===Required Arguments=== | ||
Revision as of 17:27, 5 January 2016
This function sets the icon for an existing blip element.
Syntax
bool setBlipIcon ( blip theBlip, int icon )
OOP Syntax Help! I don't understand this!
- Method: blip:setIcon(...)
- Variable: .icon
Required Arguments
- theBlip The blip you wish to set the icon of.
- icon: A number indicating the icon you wish to change it do. 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
Returns
Returns true if the icon was succesfully set, false if the element passed was not a valid blip or the icon value was not a valid icon number.
Example
This example resets all blip icons to the default blip icon, 0.
-- 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 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