GetRandomPlayer: Difference between revisions

Revision as of 12:33, 13 August 2007

This function returns a random player.

player getRandomPlayer ( )

Returns a random player, false if the server is empty.

This code outputs a random's player name.

local randomPlayer = getRandomPlayer ( )
outputChatBox ( getClientName ( randomPlayer ).." is now the fugitive!" )

@@ Line 1: / Line 1: @@
 __NOTOC__
-{{server function}}
+{{Server function}}
-This function returns a random [[player]]. It is useful for assigning objectives to random players in a Manhunt mode, for example.
+This function returns a random [[player]].
 ==Syntax==
-<syntaxhighlight lang="lua">player getRandomPlayer ( )</syntaxhighlight>
+<syntaxhighlight lang="lua">
+player getRandomPlayer ( )
+</syntaxhighlight>
-===Required Arguments===
+===Returns===
-''This function has no arguments.''
+Returns a random [[player]], ''false'' if the server is empty.
 ==Example==
 This code outputs a random's player name.
 <syntaxhighlight lang="lua">
-randomPlayer = getRandomPlayer ( )
+local randomPlayer = getRandomPlayer ( )
 outputChatBox ( getClientName ( randomPlayer ).." is now the fugitive!" )
 </syntaxhighlight>