Squirrel/Server/Functions/Blips/CreateClientBlip
From Liberty Unleashed Wiki
(Difference between revisions)
(→Example) |
|||
Line 17: | Line 17: | ||
== Example == | == Example == | ||
+ | |||
+ | This commands creates an 8-Ball marker on the radar at player's position. | ||
<code lang="squirrel"> | <code lang="squirrel"> | ||
function onPlayerCommand( pPlayer, szCommand, szText ) | function onPlayerCommand( pPlayer, szCommand, szText ) | ||
{ | { | ||
− | + | if ( szCommand == "createblip" ) | |
− | + | { | |
− | + | CreateClientBlip( pPlayer, BLIP_8BALL, pPlayer.Pos, 0 ); | |
− | + | } | |
+ | |||
+ | return 1; | ||
} | } | ||
</code> | </code> | ||
Line 30: | Line 34: | ||
=== Notes === | === Notes === | ||
− | The | + | The function [[Squirrel/Server/Functions/Players/Pos|Player.Pos]] and call [[Squirrel/Server/Events/Player/onPlayerCommand|onPlayerCommand]] were used in this example. More info about them in the corresponding pages. |
== Related Functions == | == Related Functions == | ||
{{Squirrel/Server/Functions/Blips}} | {{Squirrel/Server/Functions/Blips}} |
Revision as of 23:45, 28 September 2010
This function creates a new local radar blip, which is only visible for the player it's created for. It will return a pointer to the blip or null if creating the blip was unsuccessful.
Syntax
CreateClientBlip can take 2 different lists of parameters. These are:
Blip CreateClientBlip( Player client, int sprite, Vector pos, int colour )
Blip CreateClientBlip( Player client, int sprite, float x, float y, float z, int colour )
Arguments
- client - The client who will be the owner of this blip and who will be the only one able to see it
- sprite - This is the sprite (icon) of the blip. For reference, check here
- pos - The position of the blip on radar
- colour - The colour ID for the blip. These values can be customised in content.xml of the server
- x, y, z - The position of the blip as floats
Example
This commands creates an 8-Ball marker on the radar at player's position.
function onPlayerCommand( pPlayer, szCommand, szText ) { if ( szCommand == "createblip" ) { CreateClientBlip( pPlayer, BLIP_8BALL, pPlayer.Pos, 0 ); } return 1; }
Notes
The function Player.Pos and call onPlayerCommand were used in this example. More info about them in the corresponding pages.