createBlipAttachedTo | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

createBlipAttachedTo

Client-side
Server-side
Shared

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.

OOP Syntax Help! I don't understand this!

  • Method: Blip.createAttachedTo(...)

Client Syntax

blip|false createBlipAttachedTo ( element elementToAttachTo, [ int icon = 0, int size = 2, int r = 255, int g = 0, int b = 0, int a = 255, int ordering = 0, float visibleDistance = 16383.0 ] )
Required Arguments
  • elementToAttachTo: The element to attach the blip to.
Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use.

  • icon (default: 0): The icon that the radar blips should be. Default is 0. Valid values can be seen at Radar Blips.
  • size (default: 2): The size of the radar blip. Only applicable to the Marker icon. Default is 2. Maximum is 25.
  • r (default: 255): The amount of red in the blip's color (0-255). Only applicable to the Marker icon. Default is 255.
  • g (default: 0): The amount of green in the blip's color (0-255). Only applicable to the Marker icon. Default is 0.
  • b (default: 0): The amount of blue in the blip's color (0-255). Only applicable to the Marker icon. Default is 0.
  • a (default: 255): The amount of alpha in the blip's color (0-255). Only applicable to the Marker icon. Default is 255.
  • ordering (default: 0): This defines the blip's Z-level ordering (-32768-32767). Default is 0.
  • visibleDistance (default: 16383.0): The maximum distance from the camera at which the blip is still visible (0-65535).

Returns

  • blip|false: created-blip

Returns an element of the blip if it was created successfully, false otherwise.

Server Syntax

blip|false createBlipAttachedTo ( element elementToAttachTo, [ int icon = 0, int size = 2, int r = 255, int g = 0, int b = 0, int a = 255, int ordering = 0, float visibleDistance = 16383.0, element visibleTo = getRootElement() ] )
Required Arguments
  • elementToAttachTo: The element to attach the blip to.
Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use.

  • icon (default: 0): The icon that the radar blips should be. Default is 0. Valid values can be seen at Radar Blips.
  • size (default: 2): The size of the radar blip. Only applicable to the Marker icon. Default is 2. Maximum is 25.
  • r (default: 255): The amount of red in the blip's color (0-255). Only applicable to the Marker icon. Default is 255.
  • g (default: 0): The amount of green in the blip's color (0-255). Only applicable to the Marker icon. Default is 0.
  • b (default: 0): The amount of blue in the blip's color (0-255). Only applicable to the Marker icon. Default is 0.
  • a (default: 255): The amount of alpha in the blip's color (0-255). Only applicable to the Marker icon. Default is 255.
  • ordering (default: 0): This defines the blip's Z-level ordering (-32768-32767). Default is 0.
  • visibleDistance (default: 16383.0): The maximum distance from the camera at which the blip is still visible (0-65535).
  • visibleTo (default: getRootElement()): This defines which elements can see the blip. Defaults to visible to everyone. See visibility.

Returns

  • blip|false: created-blip

Returns an element of the blip if it was created successfully, false otherwise.

Code Examples

server

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, 52 )
end

See Also

Blip Functions
Reference