CreateBlip: Difference between revisions
Jump to navigation
Jump to search
(Updated example for a11 scripting) |
mNo edit summary |
||
| (63 intermediate revisions by 34 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server client function}} | |||
This function creates a [[blip]] [[element]], which is displayed as an icon on the client's radar. | This function creates a [[blip]] [[element]], which is displayed as an icon on the client's radar. | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">blip createBlip ( float x, float y, float z, | <section name="Server" class="server" show="true"> | ||
<syntaxhighlight lang="lua"> | |||
blip createBlip ( float x, float y, float z [, 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 createBlip ( float x, float y, float z [, 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> | |||
[[File:Blip-New.png|thumb|example]] | |||
{{OOP||[[Blip]]}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''x:''' The x position of the blip, in | *'''x:''' The x position of the blip, in world coordinates. | ||
*'''y:''' The y position of the blip, in | *'''y:''' The y position of the blip, in world coordinates. | ||
*'''z:''' The z position of the blip, in | *'''z:''' The z position of the blip, in world coordinates. | ||
===Optional Arguments=== | ===Optional Arguments=== | ||
{{OptionalArg}} | {{OptionalArg}} | ||
*'''icon:''' The icon that the radar blips should be. Valid values | *'''icon:''' The icon that the radar blips should be. Default is 0. Valid values can be seen at [[Radar Blips]] | ||
*'''size:''' The size of the radar blip. Only applicable to the ''Marker'' icon. Default is 2. Maximum is 25. | |||
*'''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 ''Marker'' icon. Default is 255. | ||
*'''r:''' The | *'''g:''' The amount of green in the blip's color (0–255). Only applicable to the ''Marker'' icon. Default is 0. | ||
*'''g:''' The | *'''b:''' The amount of blue in the blip's color (0–255). Only applicable to the ''Marker'' icon. Default is 0. | ||
*'''b:''' The | *'''a:''' The amount of alpha in the blip's color (0–255). Only applicable to the ''Marker'' icon. Default is 255. | ||
*'''a:''' The | {{New feature/item|3|1.0|| | ||
* '''visibleTo:''' | *'''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). | |||
}} | |||
<section name="Server" class="server" show="true"> | |||
*'''visibleTo:''' This defines which elements can see the blip. Defaults to visible to everyone. See [[visibility]]. | |||
</section> | |||
==Returns== | |||
Returns an [[element]] of the [[blip]] if it was created successfully, ''false'' otherwise. | |||
==Example== | ==Example== | ||
<section name="Server" class="server" show="true"> | |||
'''Example 1:''' This example creates a radar blip at a random player's position and makes it so that it is only visible to that player. | '''Example 1:''' This example creates a radar blip at a random player's position and makes it so that it is only visible to that player. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- Pick a random player | -- Pick a random player | ||
myPlayer = getRandomPlayer () | local myPlayer = getRandomPlayer( ) | ||
-- Retrieve the player's position and store it in the variables x, y and z | -- Retrieve the player's position and store it in the variables x, y and z | ||
x,y,z = getElementPosition ( myPlayer ) | local x, y, z = getElementPosition( myPlayer ) | ||
-- Create a radar blip at the player's position, with a 'cash' icon and only visible to the player | -- Create a radar blip at the player's position, with a 'cash' icon and only visible to the player | ||
myBlip = createBlip ( x, y, z, 51, 0, 0, 0, 255, myPlayer ) | local myBlip = createBlip( x, y, z, 51, 0, 0, 0, 255, myPlayer ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 35: | Line 55: | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- Pick a random player | -- Pick a random player | ||
myPlayer = getRandomPlayer () | local myPlayer = getRandomPlayer( ) | ||
-- Create a radar blip in the middle of the map | -- Create a radar blip in the middle of the map | ||
myBlip = createBlip ( 0, 0, 0 ) | local myBlip = createBlip( 0, 0, 0 ) | ||
-- Make the player the parent of the blip, so that the blip follows the player around | -- Make the player the parent of the blip, so that the blip follows the player around | ||
setElementParent ( myBlip, myPlayer ) | setElementParent( myBlip, myPlayer ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | |||
==See Also== | ==See Also== | ||
{{Blip_functions}} | {{Blip_functions}} | ||
[[HU:createBlip]] | |||
[[AR:createBlip]] | |||
[[DE:createBlip]] | |||
[[ES:CreateBlip]] | |||
[[IT:createBlip]] | |||
[[PL:createBlip]] | |||
[[RO:createBlip]] | |||
Latest revision as of 15:04, 11 June 2023
This function creates a blip element, which is displayed as an icon on the client's radar.
Syntax
Click to collapse [-]
Serverblip createBlip ( float x, float y, float z [, 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 [-]
Clientblip createBlip ( float x, float y, float z [, 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(...)
Required Arguments
- x: The x position of the blip, in world coordinates.
- y: The y position of the blip, in world coordinates.
- z: The z position of the blip, in world coordinates.
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. Default is 0. Valid values can be seen at Radar Blips
- size: The size of the radar blip. Only applicable to the Marker icon. Default 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: This defines which elements can see the blip. Defaults to visible to everyone. See visibility.
Returns
Returns an element of the blip if it was created successfully, false otherwise.
Example
Click to collapse [-]
ServerExample 1: This example creates a radar blip at a random player's position and makes it so that it is only visible to that player.
-- Pick a random player local myPlayer = getRandomPlayer( ) -- Retrieve the player's position and store it in the variables x, y and z local x, y, z = getElementPosition( myPlayer ) -- Create a radar blip at the player's position, with a 'cash' icon and only visible to the player local myBlip = createBlip( x, y, z, 51, 0, 0, 0, 255, myPlayer )
Example 2: This example attaches a blip to a player. You can attach a blip to an element by just setting the blip's parent to that element.
-- Pick a random player local myPlayer = getRandomPlayer( ) -- Create a radar blip in the middle of the map local myBlip = createBlip( 0, 0, 0 ) -- Make the player the parent of the blip, so that the blip follows the player around setElementParent( myBlip, myPlayer )