Squirrel/Server/Functions/Checkpoints/GetCheckpointCount
From Liberty Unleashed Wiki
(Difference between revisions)
| Line 1: | Line 1: | ||
| − | + | {{Squirrel/Title|GetCheckpointCount}} | |
This function returns the number of checkpoints in the server. If the optional player argument is used, the function will return how many client-side checkpoints does the given player have. Without the argument it will return the number of global checkpoints. | This function returns the number of checkpoints in the server. If the optional player argument is used, the function will return how many client-side checkpoints does the given player have. Without the argument it will return the number of global checkpoints. | ||
| Line 8: | Line 8: | ||
== Arguments == | == Arguments == | ||
| − | * '''plr''' - If you want to get the number of | + | * '''plr''' - If you want to get the number of local checkpoints for a specific client, use this argument to indicate the player. If you don't use this argument the global checkpoint count will be returned |
== Example == | == Example == | ||
| + | This example command returns the count of checkpoints ingame (global and local checkpoints). | ||
<code lang="squirrel"> | <code lang="squirrel"> | ||
| − | |||
| − | |||
function onPlayerCommand( player, command, text ) | function onPlayerCommand( player, command, text ) | ||
{ | { | ||
| − | + | if ( command == "checkpoints" ) | |
| − | + | { | |
| − | + | local checkpoints = GetCheckpointCount(); | |
| − | + | local PlrCheckpoints = GetCheckpointCount( player ); | |
| − | + | ||
| − | + | MessagePlayer( "There are currently " + checkpoints + " global checkpoints in-game.", player ); | |
| − | + | MessagePlayer( "There are also " + PlrCheckpoints + " checkpoints which belong to you!", player ); | |
| − | + | } | |
| + | |||
| + | return 1; | ||
} | } | ||
</code> | </code> | ||
Latest revision as of 20:25, 24 September 2010
This function returns the number of checkpoints in the server. If the optional player argument is used, the function will return how many client-side checkpoints does the given player have. Without the argument it will return the number of global checkpoints.
[edit] Syntax
[edit] Arguments
- plr - If you want to get the number of local checkpoints for a specific client, use this argument to indicate the player. If you don't use this argument the global checkpoint count will be returned
[edit] Example
This example command returns the count of checkpoints ingame (global and local checkpoints).
[edit] Notes
The function MessagePlayer and event onPlayerCommand were used in in this example. More info about them in the corresponding pages.
