kts.IsEliminated

Name

kts.IsEliminated – determine whether a player has been eliminated from the game

Synopsis

result = kts.IsEliminated(player)

Description

This function takes one parameter, which must be a Player object (e.g. as returned from kts.GetPlayer). The function returns true if the player has been eliminated from the game for any reason, or false if they are still in the game.

Return Value

Returns a boolean value as described above.

Errors

If the parameter is not a valid player then the function will raise an error.

See Also

kts.GetAllPlayers

kts.GetPlayer

kts.EliminatePlayer