CreateBlipAttachedTo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
 
(49 intermediate revisions by 22 users not shown)
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.
{{Server client function}}
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==
<syntaxhighlight lang="lua">blip createBlipAttachedTo ( entity entityToAttachTo, [int icon=0, int size=2, int r=255, int g=0, int b=0, int a=255, visibleTo=getRootElement()] )</syntaxhighlight>  
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
blip 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( ) ] )
</syntaxhighlight>
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
blip 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 ] )
</syntaxhighlight>
</section>
 
{{OOP||[[Blip]].createAttachedTo||}}


===Required Arguments===  
===Required Arguments===  
*'''entityToAttachTo:''' The [[entity]] to attach the marker to.
*'''elementToAttachTo:''' The [[element]] to attach the blip to.


===Optional Arguments===  
===Optional Arguments===  
{{OptionalArg}}  
{{OptionalArg}}  
*'''icon:''' The icon that the radar blips should be. Valid values are:
*'''icon:''' The icon that the radar blips should be. Valid values can be seen at [[Radar Blips]]
** '''0:''' Border [default]
*'''size:''' The size of the radar blip. Only applicable to the ''Marker'' icon. Default value is 2. Maximum is 25.
** '''1:''' Centre
*'''r:''' The amount of red in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 255.  
** '''2:''' Map_here
*'''g:''' The amount of green in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 0.
** '''3:''' North
*'''b:''' The amount of blue in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 0.
** '''4:''' Airyard
*'''a:''' The amount of alpha in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 255.
** '''5:''' Gun
{{New feature/item|3|1.0||
** '''6:''' Barbers
*'''ordering:''' This defines the blip's Z-level ordering (-32768 - 32767). Default is 0.
** '''7:''' Big_smoke
*'''visibleDistance:''' The maximum distance from the camera at which the blip is still visible (0-65535)
** '''8:''' Boatyard
}}
** '''9:''' Burgershot
<section name="Server" class="server" show="true">
** '''10:'''Bulldozer
*'''visibleTo:''' What elements can see the blip. Defaults to visible to everyone. See [[visibility]].
** '''11:'''Cat_pink
</section>
** '''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===
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.
<section name="Server" class="server" show="true">
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
myPlayer = getRandomPlayer ()
function setupRandomRobber ()
-- Create a radar blip at the player's position, with a 'cash' icon and only visible to everyone (no 'visibleTo' parameter)
local myPlayer = getRandomPlayer ()
myBlip = createBlipAttachedTo ( myPlayer, 51, 0, 0, 0, 255 )
-- 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
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Blip_Functions}}
{{Blip_functions}}
 
[[en:createBlipAttachedTo]]
[[hu:createBlipAttachedTo]]
[[pt-br:createBlipAttachedTo]]
[[ru:createBlipAttachedTo]]
[[ro:createBlipAttachedTo]]

Latest revision as of 17:42, 21 February 2021

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

Click to collapse [-]
Server
blip 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( ) ] )
Click to collapse [-]
Client
blip 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 ] )


OOP Syntax Help! I don't understand this!

Method: Blip.createAttachedTo(...)


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. For more information on optional arguments, see optional arguments.

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

Click to collapse [-]
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

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