Squirrel/Server/Functions/Blips/Colour

From Liberty Unleashed Wiki
(Difference between revisions)
Jump to: navigation, search
(Example 1. Returning the value)
(Example 2. Setting a new value)
Line 30: Line 30:
 
== Example 2. Setting a new value ==
 
== Example 2. Setting a new value ==
  
{{Squirrel/NeedsExample}}
 
 
<code lang="squirrel">
 
<code lang="squirrel">
-- todo
+
function onPlayerCommand( pPlayer, szCommand, szText )
 +
{
 +
else if ( szCommand == "colour2" )
 +
{
 +
local pBlip = FindBlip( 0 );
 +
if ( pBlip ) pBlip.Colour = 1;
 +
}
 +
}
 
</code>
 
</code>
  
 
=== Notes ===
 
=== Notes ===
  
Example notes and used functions here.
+
The event [[Squirrel/Server/Events/Player/onPlayerCommand|onPlayerCommand]] were 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 18:58, 28 September 2010

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

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:

  1. int Blip.Colour
  1. 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

  1.  
  2. function onPlayerCommand( pPlayer, szCommand, szText )
  3. {
  4. else if ( szCommand == "colour" )
  5. {
  6. local pBlip = FindBlip( 0 );
  7. if ( pBlip ) MessagePlayer( "Blip ID 0 has the colour ID - " + pBlip.Colour, pPlayer );
  8. }
  9. }
  10.  

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

  1.  
  2. function onPlayerCommand( pPlayer, szCommand, szText )
  3. {
  4. else if ( szCommand == "colour2" )
  5. {
  6. local pBlip = FindBlip( 0 );
  7. if ( pBlip ) pBlip.Colour = 1;
  8. }
  9. }
  10.  

Notes

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

Related Functions

Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox