Squirrel/Server/Functions/Blips/FindBlip
From Liberty Unleashed Wiki
(Difference between revisions)
m (moved Squirrel/Functions/Blips/FindBlip to Squirrel/Server/Functions/Blips/FindBlip: Server-side function) |
(→Example 1. Non-player specific) |
||
Line 13: | Line 13: | ||
== Example 1. Non-player specific == | == Example 1. Non-player specific == | ||
− | |||
− | |||
<code lang="squirrel"> | <code lang="squirrel"> | ||
− | + | function onPlayerCommand( pPlayer, szCommand, szText ) | |
+ | { | ||
+ | else if ( szCommand == "find" ) | ||
+ | { | ||
+ | local pBlip; | ||
+ | if ( szText ) pBlip = FindBlip( szText.tointeger() ); | ||
+ | if ( pBlip ) MessagePlayer( "Found Blip ID " + szText, pPlayer ); | ||
+ | } | ||
+ | } | ||
</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 == |
Revision as of 19:15, 28 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.
Syntax
Blip FindBlip( int id [, Player plr ] )
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
Example 1. Non-player specific
function onPlayerCommand( pPlayer, szCommand, szText ) { else if ( szCommand == "find" ) { local pBlip; if ( szText ) pBlip = FindBlip( szText.tointeger() ); if ( pBlip ) MessagePlayer( "Found Blip ID " + szText, pPlayer ); } }
Notes
The function MessagePlayer and event onPlayerCommand were used in in this example. More info about them in the corresponding pages.
Example 2. Player specific
This function needs an example. You can help us complete the wiki by writing one, or maybe even more :o
-- todo
Notes
Example notes and used functions here.