Squirrel/Server/Functions/Blips/Size

From Liberty Unleashed Wiki
(Difference between revisions)
Jump to: navigation, search
(Notes)
(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 )
 +
{
 +
if ( szCommand == "size2" )
 +
{
 +
local pBlip = FindBlip( 0 );
 +
if ( pBlip ) pBlip.Size = 4;
 +
}
 +
}
 
</code>
 
</code>
  
 
=== Notes ===
 
=== Notes ===
  
Example notes and used functions here.
+
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:35, 28 September 2010

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

This Blip class member returns or sets the size (scale) of the radar blip.

Syntax

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

  1. int Blip.Size
  1. Blip.Size = int size

Arguments

  • size - The size of the blip

Example 1. Returning the value

  1.  
  2. function onPlayerCommand( pPlayer, szCommand, szText )
  3. {
  4. if ( szCommand == "size" )
  5. {
  6. local pBlip = FindBlip( 0 );
  7. if ( pBlip ) MessagePlayer( "Blip ID 0 size is - " + pBlip.Size, 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. if ( szCommand == "size2" )
  5. {
  6. local pBlip = FindBlip( 0 );
  7. if ( pBlip ) pBlip.Size = 4;
  8. }
  9. }
  10.  

Notes

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

Related Functions

Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox