CreateBlipAttachedTo: Difference between revisions

Revision as of 20:54, 20 May 2006

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.

Syntax

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

Required Arguments

entityToAttachTo: The entity 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 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
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.
g: The ammount 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.
a: The ammount 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 element 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.

-- Pick a random player
myPlayer = getRandomPlayer ()
-- 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 )
-- See if the blip was created succesfully
if ( myBlip == false )
	-- If it wasn't created succesfully, display an error in the chat
	outputChatBox ( "Couldn't create blip!" )
end

Revision as of 03:33, 19 May 2006 (view source) EAi (talk \| contribs) (→‎Example) ← Older edit		Revision as of 20:54, 20 May 2006 (view source) Ransom (talk \| contribs) No edit summary Newer edit →
Line 37:		Line 37:

	==See Also==		==See Also==
	{{~~Blip_Functions~~}}		{{Blip_functions}}