Squirrel/Server/Functions/Checkpoints/Pos
From Liberty Unleashed Wiki
(Difference between revisions)
(→Example 2. Setting) |
|||
| Line 1: | Line 1: | ||
| − | + | {{Squirrel/Title|Checkpoint.Pos}} | |
This ''Checkpoint'' class member returns or sets the position of the given checkpoint. | This ''Checkpoint'' class member returns or sets the position of the given checkpoint. | ||
== Syntax == | == Syntax == | ||
| + | |||
You can either return or set a new value using this member: | You can either return or set a new value using this member: | ||
<code>Vector Checkpoint.Pos</code> | <code>Vector Checkpoint.Pos</code> | ||
| Line 12: | Line 13: | ||
== Example 1. Returning == | == Example 1. Returning == | ||
| + | |||
| + | This example will message the player with the current position of the checkpoint. | ||
<code lang="squirrel"> | <code lang="squirrel"> | ||
| − | function | + | function onPlayerEnterCheckpoint( player, checkpoint ) |
{ | { | ||
| − | + | local pos = checkpoint.Pos; | |
| + | MessagePlayer( format( "The current position of this checkpoint is: %.2f, %.2f, %.2f", pos.x, pos.y, pos.z ), player ); | ||
| + | |||
| + | return 1; | ||
} | } | ||
</code> | </code> | ||
| Line 22: | Line 28: | ||
=== Notes === | === Notes === | ||
| − | + | The function [[Squirrel/Server/Functions/Messages/MessagePlayer|MessagePlayer]] and event [[Squirrel/Server/Events/Marker/onPlayerEnterCheckpoint|onPlayerEnterCheckpoint]] were used in in this example. More info about them in the corresponding pages. | |
== Example 2. Setting == | == Example 2. Setting == | ||
| + | |||
| + | This example will move the checkpoint 2 x coordinates away from the player when they enter the checkpoint. | ||
<code lang="squirrel"> | <code lang="squirrel"> | ||
| − | function | + | function onPlayerEnterCheckpoint( player, checkpoint ) |
{ | { | ||
| − | + | local pos = player.Pos; | |
| + | checkpoint.Pos = Vector( pos.x + 2, pos.y, pos.z ); | ||
| + | |||
| + | return 1; | ||
} | } | ||
</code> | </code> | ||
| Line 35: | Line 46: | ||
=== Notes === | === Notes === | ||
| − | + | The function [[Squirrel/Server/Functions/Messages/MessagePlayer|MessagePlayer]] and event [[Squirrel/Server/Events/Marker/onPlayerEnterCheckpoint|onPlayerEnterCheckpoint]] were used in this example. More info about them in the corresponding pages. | |
== Related Functions == | == Related Functions == | ||
{{Squirrel/Server/Functions/Checkpoints}} | {{Squirrel/Server/Functions/Checkpoints}} | ||
Revision as of 19:54, 24 September 2010
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:
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.
Notes
The function MessagePlayer and event onPlayerEnterCheckpoint were used in in this example. More info about them in the corresponding pages.
Example 2. Setting
This example will move the checkpoint 2 x coordinates away from the player when they enter the checkpoint.
Notes
The function MessagePlayer and event onPlayerEnterCheckpoint were used in this example. More info about them in the corresponding pages.
