CreateBlipAttachedTo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
Line 81: Line 81:
* '''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]] [[element]] if the blip was created succesfully, or ''false'' otherwise.



Revision as of 00:39, 18 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: Border [default]
    • 1: Centre
    • 2: Map_here
    • 3: North
    • 4: Airyard
    • 5: Gun
    • 6: Barbers
    • 7: Big_smoke
    • 8: Boatyard
    • 9: Burgershot
    • 10:Bulldozer
    • 11:Cat_pink
    • 12:Cesar
    • 13:Chicken
    • 14:Cj
    • 15:Crash1
    • 16:Diner
    • 17: Emmetgun
    • 18: Enemyattack
    • 19: Fire
    • 20: Girlfriend
    • 21: Hospital
    • 22: Loco
    • 23: Maddog
    • 24: Mafia
    • 25: Mcstrap
    • 26: Mod_garage
    • 27: Ogloc
    • 28: Pizza
    • 29: Police
    • 30: Property_green
    • 13: Property_red
    • 32: Race
    • 33: Ryder
    • 34: Savehouse
    • 35: School
    • 36: Mystery
    • 36: Sweet
    • 38: Tattoo
    • 39: Truth
    • 40: Waypoint
    • 41: Toreno_ranch
    • 42: Triads
    • 43: Triads_casino
    • 44: Tshirt
    • 45: Woozie
    • 46: Zero
    • 47: Date_disco
    • 48: Date_drink
    • 49: Date_food
    • 50: Truck
    • 51: Cash
    • 52: Flag
    • 53: Gym
    • 54: Impound
    • 55: Runway_light
    • 56: Runway
    • 57: Gang_b
    • 58: Gang_p
    • 59: Gang_y
    • 60: Gang_n
    • 61: Gang_g
    • 62: 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 Also

Template:Blip Functions