Squirrel/Server/Functions/Checkpoints/Remove

Revision as of 20:12, 24 September 2010

This function removes the checkpoint.

bool Checkpoint.Remove()

This example will remove the checkpoint when a player enters it.

 
function onPlayerEnterCheckpoint( player, checkpoint )
{
     checkpoint.Remove();
     
     return 1;
}

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

@@ Line 1: / Line 1: @@
-__NOTOC__
+{{Squirrel/Title|Checkpoint.Colour}}
-This function removes the given checkpoint.
+This function removes the checkpoint.
 == Syntax ==
@@ Line 10: / Line 10: @@
 == Example ==
+This example will remove the checkpoint when a player enters it.
 <code lang="squirrel">
-function onPlayerFootCheckpointHit( player, checkpoint )
+function onPlayerEnterCheckpoint( player, checkpoint )
 {
- checkpoint.Remove()
+    checkpoint.Remove();
+    return 1;
 }
 </code>
@@ Line 20: / Line 24: @@
 === Notes ===
-This example will remove the checkpoint when a player enters it.
+The event [[Squirrel/Server/Events/Marker/onPlayerEnterCheckpoint|onPlayerEnterCheckpoint]] was used in this example. More info about it in the corresponding page.
 == Related Functions ==
 {{Squirrel/Server/Functions/Checkpoints}}