Squirrel/Server/Functions/Blips/Icon

Revision as of 19:20, 28 September 2010

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

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

Notes

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

Example 2. Setting a new value

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

Notes

The event onPlayerCommand was used in in this example. More info about this in the corresponding page.

Related Functions

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