Squirrel/Server/Functions/Blips/Colour
From Liberty Unleashed Wiki
(Difference between revisions)
(→Example 1. Returning the value) |
|||
| (4 intermediate revisions by one user not shown) | |||
| Line 3: | Line 3: | ||
== Syntax == | == Syntax == | ||
| + | |||
You can either return or set a new value using this member: | You can either return or set a new value using this member: | ||
<code>int Blip.Colour</code> | <code>int Blip.Colour</code> | ||
| Line 12: | Line 13: | ||
== Example 1. Returning the value == | == Example 1. Returning the value == | ||
| + | |||
| + | This command tells the player the colour of blip ID 0 when they type '/colour'. | ||
<code lang="squirrel"> | <code lang="squirrel"> | ||
function onPlayerCommand( pPlayer, szCommand, szText ) | function onPlayerCommand( pPlayer, szCommand, szText ) | ||
{ | { | ||
| − | + | if ( szCommand == "colour" ) | |
| − | + | { | |
| − | + | local pBlip = FindBlip( 0 ); | |
| − | + | if ( pBlip ) MessagePlayer( "Blip ID 0 has the colour ID - " + pBlip.Colour, pPlayer ); | |
| − | + | } | |
| + | |||
| + | return 1; | ||
} | } | ||
</code> | </code> | ||
| Line 26: | Line 31: | ||
=== Notes === | === Notes === | ||
| − | The | + | The functions [[Squirrel/Server/Functions/Messages/MessagePlayer|MessagePlayer]], [[Squirrel/Server/Functions/Blips/FindBlip|FindBlip]] and event [[Squirrel/Server/Events/Player/onPlayerCommand|onPlayerCommand]] were used in in this example. More info about them in the corresponding pages. |
== Example 2. Setting a new value == | == Example 2. Setting a new value == | ||
| − | + | This example command changes blip ID 0 colour to 1. | |
| + | |||
<code lang="squirrel"> | <code lang="squirrel"> | ||
| − | + | function onPlayerCommand( pPlayer, szCommand, szText ) | |
| + | { | ||
| + | if ( szCommand == "colour2" ) | ||
| + | { | ||
| + | local pBlip = FindBlip( 0 ); | ||
| + | if ( pBlip ) pBlip.Colour = 1; | ||
| + | } | ||
| + | |||
| + | return 1; | ||
| + | } | ||
</code> | </code> | ||
=== Notes === | === Notes === | ||
| − | + | The function [[Squirrel/Server/Functions/Blips/FindBlip|FindBlip]] and event [[Squirrel/Server/Events/Player/onPlayerCommand|onPlayerCommand]] were used in in this example. More info about them in the corresponding pages. | |
== Related Functions == | == Related Functions == | ||
{{Squirrel/Server/Functions/Blips}} | {{Squirrel/Server/Functions/Blips}} | ||
Latest revision as of 23:39, 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).
[edit] Syntax
You can either return or set a new value using this member:
[edit] Arguments
- col - This is the colour of the blip. The possible colour values can be customised in content.xml of the server.
[edit] Example 1. Returning the value
This command tells the player the colour of blip ID 0 when they type '/colour'.
[edit] Notes
The functions MessagePlayer, FindBlip and event onPlayerCommand were used in in this example. More info about them in the corresponding pages.
[edit] Example 2. Setting a new value
This example command changes blip ID 0 colour to 1.
[edit] Notes
The function FindBlip and event onPlayerCommand were used in in this example. More info about them in the corresponding pages.
