GetRandomPlayer: Difference between revisions

Latest revision as of 22:42, 6 September 2024

This function returns a random player.

player getRandomPlayer ( )

OOP Syntax Help! I don't understand this!

Method: Player.getRandom(...)

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

This code outputs a random player's name.

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

@@ Line 1: / Line 1: @@
 __NOTOC__
-==Description==
+{{Server function}}
-This function returns a random [[player]] object. It is useful for assigning objectives to random players in a Manhunt mode, for example.
+This function returns a random [[player]].
 ==Syntax==
- [[player]] [[GetRandomPlayer]] ()
+<syntaxhighlight lang="lua">
+player getRandomPlayer ( )
-===Required Arguments===
+</syntaxhighlight>
-''This function has no arguments.''
+{{OOP||[[Player]].getRandom}}
+===Returns===
+Returns a random [[player]], ''false'' if the server is empty.
 ==Example==
- player = [[GetRandomPlayer]] ( )
+This code outputs a random player's name.
- [[serverChat]] ( [[GetPlayerName]] ( player ) , " is now the fugitive!" )
+<syntaxhighlight lang="lua">
+local randomPlayer = getRandomPlayer ( )
+outputChatBox ( getPlayerName ( randomPlayer ).." is now the fugitive!" )
+</syntaxhighlight>
-Edit to fix bad links.
+==See Also==
+{{Player functions|server}}
+[[pl:getRandomPlayer]]