Squirrel/Server/Functions/Blips/Size
From Liberty Unleashed Wiki
(Difference between revisions)
(Created page with '{{Squirrel/Title|Blip.Icon}} 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 memb…') |
|||
(5 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | {{Squirrel/Title|Blip. | + | {{Squirrel/Title|Blip.Size}} |
This ''Blip'' class member returns or sets the size (scale) of the radar blip. | This ''Blip'' class member returns or sets the size (scale) of the radar blip. | ||
Line 13: | Line 13: | ||
== Example 1. Returning the value == | == Example 1. Returning the value == | ||
− | + | This command returns the scale of blip ID 0. | |
+ | |||
<code lang="squirrel"> | <code lang="squirrel"> | ||
− | - | + | function onPlayerCommand( pPlayer, szCommand, szText ) |
+ | { | ||
+ | if ( szCommand == "size" ) | ||
+ | { | ||
+ | local pBlip = FindBlip( 0 ); | ||
+ | if ( pBlip ) MessagePlayer( "Blip ID 0 size is - " + pBlip.Size, pPlayer ); | ||
+ | } | ||
+ | |||
+ | return 1; | ||
+ | } | ||
</code> | </code> | ||
=== Notes === | === Notes === | ||
− | + | The functions [[Squirrel/Server/Functions/Blips/FindBlip|FindBlip]], [[Squirrel/Server/Functions/Messages/MessagePlayer|MessagePlayer]] 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 command sets the scale of blip ID 0 to 4 when someone types '/setsize'. | |
+ | |||
<code lang="squirrel"> | <code lang="squirrel"> | ||
− | + | function onPlayerCommand( pPlayer, szCommand, szText ) | |
+ | { | ||
+ | if ( szCommand == "setsize" ) | ||
+ | { | ||
+ | local pBlip = FindBlip( 0 ); | ||
+ | if ( pBlip ) pBlip.Size = 4; | ||
+ | } | ||
+ | |||
+ | 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 00:08, 29 September 2010
This Blip class member returns or sets the size (scale) of the radar blip.
[edit] Syntax
You can either return or set a new value using this member:
int Blip.Size
Blip.Size = int size
[edit] Arguments
- size - The size of the blip
[edit] Example 1. Returning the value
This command returns the scale of blip ID 0.
function onPlayerCommand( pPlayer, szCommand, szText ) { if ( szCommand == "size" ) { local pBlip = FindBlip( 0 ); if ( pBlip ) MessagePlayer( "Blip ID 0 size is - " + pBlip.Size, pPlayer ); } return 1; }
[edit] Notes
The functions FindBlip, MessagePlayer 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 command sets the scale of blip ID 0 to 4 when someone types '/setsize'.
function onPlayerCommand( pPlayer, szCommand, szText ) { if ( szCommand == "setsize" ) { local pBlip = FindBlip( 0 ); if ( pBlip ) pBlip.Size = 4; } return 1; }
[edit] Notes
The function FindBlip and event onPlayerCommand were used in in this example. More info about them in the corresponding pages.