Squirrel/Server/Functions/Blips/Colour
From Liberty Unleashed Wiki
(Difference between revisions)
(→Example 2. Setting a new value) |
(→Notes) |
||
Line 43: | Line 43: | ||
=== Notes === | === Notes === | ||
− | The event [[Squirrel/Server/Events/Player/onPlayerCommand|onPlayerCommand]] | + | The event [[Squirrel/Server/Events/Player/onPlayerCommand|onPlayerCommand]] was used in in this example. More info about this in the corresponding page. |
== Related Functions == | == Related Functions == | ||
{{Squirrel/Server/Functions/Blips}} | {{Squirrel/Server/Functions/Blips}} |
Revision as of 19:00, 28 September 2010
This Blip class member returns or sets the colour of the radar blip. Note that this will only work for blips with their sprite set to BLIP_NONE (default blip).
Syntax
You can either return or set a new value using this member:
int Blip.Colour
Blip.Colour = int col
Arguments
- col - This is the colour of the blip. The possible colour values can be customised in content.xml of the server.
Example 1. Returning the value
function onPlayerCommand( pPlayer, szCommand, szText ) { else if ( szCommand == "colour" ) { local pBlip = FindBlip( 0 ); if ( pBlip ) MessagePlayer( "Blip ID 0 has the colour ID - " + pBlip.Colour, 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 == "colour2" ) { local pBlip = FindBlip( 0 ); if ( pBlip ) pBlip.Colour = 1; } }
Notes
The event onPlayerCommand was used in in this example. More info about this in the corresponding page.