CreateClientCheckpoint

From Liberty Unleashed Wiki
Jump to: navigation, search
Home   |   Squirrel Scripting   |   Server Functions   |   Server Events   |   Client Functions   |   Client Events

This function creates a new local checkpoint (corona) visible for one player only and returns a pointer to it. If the creation was unsuccessful, the function will return null.

Syntax

CreateClientCheckpoint can take 3 different lists of parameters:

  1. CreateClientCheckpoint( Vector pos, float radius, Player plr )
  1. CreateClientCheckpoint( Vector pos, float radius, Colour col, Player plr )
  1. CreateClientCheckpoint( Vector pos, float radius, int red, int green, int blue, Player plr )

Arguments

  • pos - The position where you want the checkpoint to be created
  • radius - The radius of the checkpoint to be created
  • plr - The owner of this checkpoint (the player who will be able to see it)
  • col - The colour of the checkpoint as a Colour object. If no colour is used the checkpoint will default to red
  • red, green, blue - The colour of the checkpoint as separate RGB values

Example

This command will create a blue checkpoint at the player's location.

  1.  
  2. function onPlayerCommand( player, cmd, text )
  3. {
  4. if ( cmd == "cp" )
  5. {
  6. local pos = player.Pos;
  7. CreateClientCheckpoint( pos, 5.0, Colour( 0, 0, 255 ), player );
  8. }
  9. return 1;
  10. }
  11.  

Notes

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

Related Functions

Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox