Checkpoint.Pos

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

This Checkpoint class member returns or sets the position of the given checkpoint.

Syntax

You can either return or set a new value using this member:

  1. Vector Checkpoint.Pos
  1. Checkpoint.Pos = Vector vPos

Arguments

  • vPos - This is the position of the checkpoint as a vector.

Example 1. Returning

This example will message the player with the current position of the checkpoint.

  1.  
  2. function onPlayerEnterCheckpoint( player, checkpoint )
  3. {
  4. local pos = checkpoint.Pos;
  5. MessagePlayer( format( "The current position of this checkpoint is: %.2f, %.2f, %.2f", pos.x, pos.y, pos.z ), player );
  6. return 1;
  7. }
  8.  

Notes

The event onPlayerEnterCheckpoint was used in this example. More info about it in the corresponding page.

Example 2. Setting

This example will move the checkpoint 2 x coordinates away from the player when they enter the checkpoint.

  1.  
  2. function onPlayerEnterCheckpoint( player, checkpoint )
  3. {
  4. local pos = player.Pos;
  5. checkpoint.Pos = Vector( pos.x + 2, pos.y, pos.z );
  6. return 1;
  7. }
  8.  

Notes

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

Related Functions

Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox