CreateBlipAttachedTo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
("Entity" -> "Element")
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
This function creates a [[blip]] [[element]] that is attached to an [[entity]]. This blip is displayed as an icon on the client's radar and will 'follow' the entity that it is attached to around.
This function creates a [[blip]] that is attached to an [[element]]. This blip is displayed as an icon on the client's radar and will 'follow' the element that it is attached to around.


==Syntax==  
==Syntax==  
Line 13: Line 13:
{{Blip_Icons}}
{{Blip_Icons}}
*'''size:''' The size of the radar blip. Default is 2.
*'''size:''' The size of the radar blip. Default is 2.
*'''r:''' The ammount of red in the blip's color (0 - 255). Only applicable to the ''border'' icon. 'Default is 255.  
*'''r:''' The amount of red in the blip's color (0 - 255). Only applicable to the ''border'' icon. 'Default is 255.  
*'''g:''' The ammount of green in the blip's color (0 - 255). Only applicable to the ''border'' icon. Default is 0.
*'''g:''' The amount of green in the blip's color (0 - 255). Only applicable to the ''border'' icon. Default is 0.
*'''b:''' The ammount of blue in the blip's color (0 - 255). Only applicable to the ''border'' icon. Default is 0.
*'''b:''' The amount of blue in the blip's color (0 - 255). Only applicable to the ''border'' icon. Default is 0.
*'''a:''' The ammount of alpha in the blip's color (0 - 255). Default is 255.
*'''a:''' The amount of alpha in the blip's color (0 - 255). Default is 255.
* '''visibleTo:''' What elements can see the blip. Defaults to visible to everyone. See [[visibility]].
* '''visibleTo:''' What elements can see the blip. Defaults to visible to everyone. See [[visibility]].


===Returns===
===Returns===
Returns a [[blip]] [[element]] if the blip was created succesfully, or ''false'' otherwise.
Returns a [[blip]] if the blip was created succesfully, or ''false'' otherwise.


==Example==  
==Example==  
This example creates a radar blip attached to a random player, visible to everyone. The blip will follow the player around as they move. This could be used for manhunt, to emphasise a random player.
This example creates a radar blip attached to a random player, visible to everyone. The blip will follow the player around as they move. This could be used for manhunt, to emphasise a random player.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- Pick a random player
-- Pick a random player
function setupRandomRobber ()
function setupRandomRobber ()
myPlayer = getRandomPlayer ()
local myPlayer = getRandomPlayer ()
-- Create a radar blip at the player's position, with a 'cash' icon and only visible to everyone (no 'visibleTo' parameter)
-- Create a radar blip at the player's position, with a 'cash' icon and only visible to everyone (no 'visibleTo' parameter)
myBlip = createBlipAttachedTo ( myPlayer, 51, 0, 0, 0, 255 )
local myBlip = createBlipAttachedTo ( myPlayer, 51 )
end
end
</syntaxhighlight>
</syntaxhighlight>

Revision as of 11:36, 16 July 2007

This function creates a blip that is attached to an element. This blip is displayed as an icon on the client's radar and will 'follow' the element that it is attached to around.

Syntax

blip createBlipAttachedTo ( element elementToAttachTo, [int icon=0, int size=2, int r=255, int g=0, int b=0, int a=255, visibleTo=getRootElement()] )

Required Arguments

  • elementToAttachTo: The element to attach the marker to.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • icon: The icon that the radar blips should be. Valid values are:
  • 0: Marker  Blipid0s.png     If higher than player: Blipid0u.png   If lower than player: Blipid0d.png
  • 1: White_square Blipid1b.png Note: it's actually white, darkened for display here
  • 2: Centre Blipid2.png
  • 3: Map_here Blipid3.png
  • 4: North Blipid4.png
  • 5: Airyard Blipid5.jpg
  • 6: Gun Blipid6.jpg
  • 7: Barbers Blipid7.jpg
  • 8: Big_smoke Blipid8.jpg
  • 9: Boatyard Blipid9.jpg
  • 10: Burgershot Blipid10.jpg
  • 11: Bulldozer Blipid11.jpg
  • 12: Cat_pink Blipid12.jpg
  • 13: Cesar Blipid13.jpg
  • 14: Chicken Blipid14.jpg
  • 15: Cj Blipid15.jpg
  • 16: Crash1 Blipid16.jpg
  • 17: Diner Blipid17.jpg
  • 18: Emmetgun Blipid18.jpg
  • 19: Enemyattack Blipid19.jpg
  • 20: Fire Blipid20.jpg
  • 21: Girlfriend Blipid21.jpg
  • 22: Hospital Blipid22.jpg
  • 23: Loco Blipid23.jpg
  • 24: Madd Dogg Blipid24.jpg
  • 25: Mafia Blipid25.jpg
  • 26: Mcstrap Blipid26.jpg
  • 27: Mod_garage Blipid27.jpg
  • 28: Ogloc Blipid28.jpg
  • 29: Pizza Blipid29.jpg
  • 30: Police Blipid30.jpg
  • 31: Property_green Blipid31.jpg
  • 32: Property_red Blipid32.jpg
  • 33: Race Blipid33.jpg
  • 34: Ryder Blipid34.jpg
  • 35: Savehouse Blipid35.jpg
  • 36: School Blipid36.jpg
  • 37: Mystery Blipid37.jpg
  • 38: Sweet Blipid38.jpg
  • 39: Tattoo Blipid39.jpg
  • 40: Truth Blipid40.jpg
  • 41: Waypoint Blipid41.png
  • 42: Toreno_ranch Blipid42.jpg
  • 43: Triads Blipid43.jpg
  • 44: Triads_casino Blipid44.jpg
  • 45: Tshirt Blipid45.jpg
  • 46: Woozie Blipid46.jpg
  • 47: Zero Blipid47.jpg
  • 48: Date_disco Blipid48.png
  • 49: Date_drink Blipid49.jpg
  • 50: Date_food Blipid50.jpg
  • 51: Truck Blipid51.jpg
  • 52: Cash Blipid52.jpg
  • 53: Flag Blipid53.jpg
  • 54: Gym Blipid54.jpg
  • 55: Impound Blipid55.jpg
  • 56: Runway_light Blipid56.jpg
  • 57: Runway Blipid57.jpg
  • 58: Gang_b Blipid58.jpg
  • 59: Gang_p Blipid59.jpg
  • 60: Gang_y Blipid60.jpg
  • 61: Gang_n Blipid61.jpg
  • 62: Gang_g Blipid62.jpg
  • 63: Spray Blipid63.jpg
  • size: The size of the radar blip. Default is 2.
  • r: The amount of red in the blip's color (0 - 255). Only applicable to the border icon. 'Default is 255.
  • g: The amount of green in the blip's color (0 - 255). Only applicable to the border icon. Default is 0.
  • b: The amount of blue in the blip's color (0 - 255). Only applicable to the border icon. Default is 0.
  • a: The amount of alpha in the blip's color (0 - 255). Default is 255.
  • visibleTo: What elements can see the blip. Defaults to visible to everyone. See visibility.

Returns

Returns a blip if the blip was created succesfully, or false otherwise.

Example

This example creates a radar blip attached to a random player, visible to everyone. The blip will follow the player around as they move. This could be used for manhunt, to emphasise a random player. 

-- Pick a random player
function setupRandomRobber ()
	local myPlayer = getRandomPlayer ()
	-- Create a radar blip at the player's position, with a 'cash' icon and only visible to everyone (no 'visibleTo' parameter)
	local myBlip = createBlipAttachedTo ( myPlayer, 51 )
end

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/CreateBlipAttachedTo?oldid=9154"