Squirrel/Server/Functions/Checkpoints/FindCheckpoint

From Liberty Unleashed Wiki
(Difference between revisions)
Jump to: navigation, search
m (returns for events)
 
Line 25: Line 25:
 
           else MessagePlayer( "Unable to find a checkpoint with ID " + text, player );
 
           else MessagePlayer( "Unable to find a checkpoint with ID " + text, player );
 
     }
 
     }
 +
   
 +
    return 1;
 
}
 
}
 
</code>
 
</code>
Line 46: Line 48:
 
           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 );
 
     }
 
     }
 +
   
 +
    return 1;
 
}
 
}
 
</code>
 
</code>

Latest revision as of 20:26, 24 September 2010

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

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

[edit] Syntax 

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

[edit] Arguments

  • id - The ID of the checkpoint to be found
  • plr - If the checkpoint you want to find is owned by a specific client, 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

[edit] Example 1. Non-player specific

This command is used to check if the specified checkpoint ID exists. 

  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.      return 1;
  13. }
  14.  

[edit] Notes

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

[edit] Example 2. Player specific

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

  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.      return 1;
  13. }
  14.  

[edit] Notes

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

[edit] Related Functions

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

Variants
Actions
Navigation
scripting
Toolbox