Blip.Icon

Home   |   Squirrel Scripting   |   Server Functions   |   Server Events   |   Client Functions   |   Client Events

This Blip class member returns or sets the icon (sprite) of the blip.

Syntax

You can either return or set a new value using this member:

int Blip.Icon

Blip.Icon = int sprite

Arguments

• sprite - The new sprite of the blip. For reference, check here.

Example 1. Returning the value

This example command returns the sprite ID of blip 0 when someone types '/icon'.

 
function onPlayerCommand( pPlayer, szCommand, szText )
{
     if ( szCommand == "icon" )
     {
          local pBlip = FindBlip( 0 );
          if ( pBlip ) MessagePlayer( "Blip ID 0 has icon ID - " + pBlip.Icon, pPlayer );
     }
     
     return 1;
}
 

Notes

The functions FindBlip, MessagePlayer and event onPlayerCommand were used in this example. More info about them in the corresponding pages.

Example 2. Setting a new value

This example command sets the icon of blip ID 0 to Ammunation icon.

 
function onPlayerCommand( pPlayer, szCommand, szText )
{
     if ( szCommand == "seticon" )
     {
          local pBlip = FindBlip( 0 );
          if ( pBlip ) pBlip.Icon = BLIP_AMMU;
     }
     
     return 1;
}
 

Notes

The function FindBlip and event onPlayerCommand were used in this example. More info about them in the corresponding pages.

Related Functions

• Blip.DisplayType
• Blip.Colour
• Blip.Icon
• Blip.ID
• Blip.Owner
• Blip.Pos
• Blip.Size
• Blip.Remove
• CreateBlip
• CreateClientBlip
• FindBlip
• GetBlipCount