Squirrel/Server/Functions/Blips/FindBlip
From Liberty Unleashed Wiki
(Difference between revisions)
(Created page with '{{Squirrel/Title|FindBlip}} This function finds a blip from an ID and returns a pointer to it. If there is no such blip, ''null'' will be returned. == Syntax == <code>Blip Find…') |
|||
(5 intermediate revisions by 2 users not shown) | |||
Line 10: | Line 10: | ||
* '''id''' - The ID of the blip to be found | * '''id''' - The ID of the blip to be found | ||
* '''plr''' - If the blip you want to find is owned by a specific client, use this to specify the owner. If you don't use this argument the blip will be returned from the global blip pool | * '''plr''' - If the blip you want to find is owned by a specific client, use this to specify the owner. If you don't use this argument the blip will be returned from the global blip pool | ||
− | |||
== Example 1. Non-player specific == | == Example 1. Non-player specific == | ||
− | + | This example command will look for a global blip id asked by the player and print a message if it exists then someone types '/find'. | |
+ | |||
<code lang="squirrel"> | <code lang="squirrel"> | ||
− | + | function onPlayerCommand( pPlayer, szCommand, szText ) | |
+ | { | ||
+ | if ( szCommand == "find" ) | ||
+ | { | ||
+ | local pBlip = null; | ||
+ | if ( szText ) pBlip = FindBlip( szText.tointeger() ); | ||
+ | if ( pBlip ) MessagePlayer( "Found Blip ID " + szText, pPlayer ); | ||
+ | } | ||
+ | |||
+ | return 1; | ||
+ | } | ||
</code> | </code> | ||
=== Notes === | === Notes === | ||
− | + | The function [[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. Player specific == | == Example 2. Player specific == | ||
− | + | This example command will look for a local blip ID asked by the player and print a message if it exists then someone types '/findlocal'. | |
+ | |||
<code lang="squirrel"> | <code lang="squirrel"> | ||
− | + | function onPlayerCommand( pPlayer, szCommand, szText ) | |
+ | { | ||
+ | if ( szCommand == "findlocal" ) | ||
+ | { | ||
+ | local pBlip = null; | ||
+ | if ( szText ) pBlip = FindBlip( szText.tointeger(), pPlayer ); | ||
+ | if ( pBlip ) MessagePlayer( "Found Blip ID " + szText, pPlayer ); | ||
+ | } | ||
+ | |||
+ | return 1; | ||
+ | } | ||
</code> | </code> | ||
=== Notes === | === Notes === | ||
− | + | The function [[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. | |
== Related Functions == | == Related Functions == | ||
{{Squirrel/Server/Functions/Blips}} | {{Squirrel/Server/Functions/Blips}} |
Latest revision as of 00:04, 29 September 2010
This function finds a blip from an ID and returns a pointer to it. If there is no such blip, null will be returned.
[edit] Syntax
Blip FindBlip( int id [, Player plr ] )
[edit] Arguments
- id - The ID of the blip to be found
- plr - If the blip you want to find is owned by a specific client, use this to specify the owner. If you don't use this argument the blip will be returned from the global blip pool
[edit] Example 1. Non-player specific
This example command will look for a global blip id asked by the player and print a message if it exists then someone types '/find'.
function onPlayerCommand( pPlayer, szCommand, szText ) { if ( szCommand == "find" ) { local pBlip = null; if ( szText ) pBlip = FindBlip( szText.tointeger() ); if ( pBlip ) MessagePlayer( "Found Blip ID " + szText, pPlayer ); } return 1; }
[edit] Notes
The function MessagePlayer and event onPlayerCommand were used in in this example. More info about them in the corresponding pages.
[edit] Example 2. Player specific
This example command will look for a local blip ID asked by the player and print a message if it exists then someone types '/findlocal'.
function onPlayerCommand( pPlayer, szCommand, szText ) { if ( szCommand == "findlocal" ) { local pBlip = null; if ( szText ) pBlip = FindBlip( szText.tointeger(), pPlayer ); if ( pBlip ) MessagePlayer( "Found Blip ID " + szText, pPlayer ); } return 1; }
[edit] Notes
The function MessagePlayer and event onPlayerCommand were used in in this example. More info about them in the corresponding pages.