Squirrel/Server/Functions/Pickups/FindPickup

From Liberty Unleashed Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Example)
 
Line 1: Line 1:
−
__NOTOC__
+
{{Squirrel/Title|FindPickup}}
 
This function finds a pickup from an ID and returns the pointer. If no pickup is found, ''null'' will be returned.
 
This function finds a pickup from an ID and returns the pointer. If no pickup is found, ''null'' will be returned.
  

Latest revision as of 11:11, 11 October 2010

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

This function finds a pickup from an ID and returns the pointer. If no pickup is found, null will be returned.

[edit] Syntax 

  1. Pickup FindPickup( int id )

[edit] Arguments

  • id - The ID of the pickup to be found 
  1.  
  2. function onPlayerCommand( player, cmd, text )
  3. {
  4. 	if ( cmd == "findpickup" )
  5. 	{
  6. 		local pup;
  7. 		if ( text ) pup = FindPickup( text.tointeger() );
  8.  
  9. 		if ( pup ) MessagePlayer( "Succesfully found pickup id: " + text + "!", player );
  10. 		else MessagePlayer( "Unable to find an pickup with id: " + text + "!", player );
  11. 	}
  12. }
  13.  

This command will try to find the specified pickup id.

[edit] Notes

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

[edit] Related Functions

Retrieved from "http://liberty-unleashed.co.uk/libertywiki/index.php?title=Squirrel/Server/Functions/Pickups/FindPickup&oldid=1958"
Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox