Squirrel/Server/Functions/Checkpoints/FindCheckpoint

Revision as of 16:04, 7 January 2010

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

Syntax

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

 
function onPlayerCommand( player, command, text )
{
         if ( command == "findcheckpoint" )
         {
                  local Checkpoint = FindCheckpoint( text.tointeger() )
                  
                  if ( Checkpoint ) MessagePlayer( "Checkpoint ID " + text + " has been found!", player );
                  else MessagePlayer( "Unable to find a checkpoint with ID " + text, player );
         }
}
 

Notes

This command is used to find the specified checkpoint ID.

Example 2. Player specific

 
function onPlayerCommand( player, command, text )
{
         if ( command == "findcheckpoint" )
         {
                  local Checkpoint = FindCheckpoint( text.tointeger(), 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 );
         }
}
 

Notes

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

Related Functions

• CreateCheckpoint
• CreateClientCheckpoint
• Checkpoint.Colour
• Checkpoint.ID
• Checkpoint.Owner
• Checkpoint.Pos
• Checkpoint.Radius
• Checkpoint.Remove
• Checkpoint.Type
• Checkpoint.VirtualWorld
• FindCheckpoint
• GetCheckpointCount