Squirrel/Server/Functions/Checkpoints/FindCheckpoint

From Liberty Unleashed Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Example 1. Non-player specific)
(→‎Example 2. Player specific)
Line 39: Line 39:
 
         if ( command == "findcheckpoint" )
 
         if ( command == "findcheckpoint" )
 
         {
 
         {
−
                   local Checkpoint = FindCheckpoint( text.tointeger(), player )
+
                   local checkpoint = FindCheckpoint( text.tointeger(), player )
 
                    
 
                    
−
                   if ( Checkpoint ) MessagePlayer( "Checkpoint ID " + text + " has been found belonging to you!", player );
+
                   if ( checkpoint ) MessagePlayer( "Checkpoint ID " + text + " has been found belonging to you!", player );
 
                   else MessagePlayer( "Unable to find a checkpoint with ID " + text + " belonging to you!", player );
 
                   else MessagePlayer( "Unable to find a checkpoint with ID " + text + " belonging to you!", player );
 
         }
 
         }
 
}
 
}
 
</code>
 
</code>
−
 
−
=== Notes ===
 
  
 
This command is used to find the specified checkpoint ID for the player typing the command.
 
This command is used to find the specified checkpoint ID for the player typing the command.
 +
 +
=== 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.
 
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.

Revision as of 04:02, 8 March 2010

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

Syntax 

  1. Checkpoint FindCheckpoint( int id [, Player plr ] )

Arguments

  • id - The ID of the checkpoint to be found
  • plr - If the checkpoint you want to find is for a specific client only, use this to specify a pointer to the player who owns the checkpoint. If you don't use this argument the checkpoint will be returned from the global checkpoint pool

Example 1. Non-player specific 

  1.  
  2. function onPlayerCommand( player, command, text )
  3. {
  4.          if ( command == "findcheckpoint" )
  5.          {
  6.                   local checkpoint = FindCheckpoint( text.tointeger() )
  7.                   
  8.                   if ( checkpoint ) MessagePlayer( "Checkpoint ID " + text + " has been found!", player );
  9.                   else MessagePlayer( "Unable to find a checkpoint with ID " + text, player );
  10.          }
  11. }
  12.  

Notes

This command is used to find the specified checkpoint ID.

The function MessagePlayer and event onPlayerCommand were used in in this example. More info about them in the corresponding pages.

Example 2. Player specific 

  1.  
  2. function onPlayerCommand( player, command, text )
  3. {
  4.          if ( command == "findcheckpoint" )
  5.          {
  6.                   local checkpoint = FindCheckpoint( text.tointeger(), player )
  7.                   
  8.                   if ( checkpoint ) MessagePlayer( "Checkpoint ID " + text + " has been found belonging to you!", player );
  9.                   else MessagePlayer( "Unable to find a checkpoint with ID " + text + " belonging to you!", player );
  10.          }
  11. }
  12.  

This command is used to find the specified checkpoint ID for the player typing the command.

Notes

The function MessagePlayer and event onPlayerCommand were used in in this example. More info about them in the corresponding pages.

Related Functions

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

Variants
Actions
Navigation
scripting
Toolbox